Add annotations to actions [ci skip]

alouanemed · mdeiters · commit b23c3d5846c3 · 2016-01-18T19:51:17.000-08:00
diff --git a/app/controllers/accounts_controller.rb b/app/controllers/accounts_controller.rb
@@ -6,11 +6,13 @@ class AccountsController < ApplicationController
   before_action :determine_plan, only: [:create, :update]
   before_action :ensure_eligibility, only: [:new]
 
+  # GET                   /teams/:team_id/account/new(.:format)
   def new
     @account ||= current_user.team.build_account
     @plan    = params[:public_id]
   end
 
+  # POST                  /teams/:team_id/account(.:format)
   def create
     redirect_to teamname_path(slug: @team.slug) if @plan.free?
 
@@ -31,6 +33,7 @@ def create
     end
   end
 
+  # PUT                   /teams/:team_id/account(.:format)
   def update
     if @account.update_attributes(account_params) && @account.save_with_payment(@plan)
       redirect_to new_team_opportunity_path(@team), notice: "You are subscribed to #{@plan.name}." + plan_capability(@plan, @team)
@@ -40,6 +43,7 @@ def update
     end
   end
 
+  # GET                   /webhooks/stripe(.:format)
   def webhook
     data = JSON.parse request.body.read
     if data[:type] == "invoice.payment_succeeded"
@@ -55,6 +59,7 @@ def webhook
     end
   end
 
+  # POST                  /teams/:team_id/account/send_invoice(.:format)
   def send_invoice
     team, period = Team.find(params[:team_id]), 1.month.ago
 
diff --git a/app/controllers/achievements_controller.rb b/app/controllers/achievements_controller.rb
@@ -6,6 +6,7 @@ class AchievementsController < ApplicationController
 
   respond_to :json, only: [:award]
 
+  # GET                   /:username/achievements/:id(.:format)
   def show
     show_achievements_params = params.permit(:id, :username)
 
@@ -14,6 +15,7 @@ def show
     redirect_to(destination_url) if @badge && @user.username.downcase != show_achievements_params[:username].downcase
   end
 
+  # POST                  /award(.:format)
   def award
 
     award_params = params.permit(:badge, :twitter, :linkedin, :github, :date)
diff --git a/app/controllers/alerts_controller.rb b/app/controllers/alerts_controller.rb
@@ -7,6 +7,7 @@ class AlertsController < ApplicationController
   GA_VISITORS_ALERT_INTERVAL = 30.minutes
   TRACTION_ALERT_INTERVAL    = 30.minutes
 
+  # GET                   /alerts(.:format)
   def create
     case @alert[:type].to_sym
       when :traction
@@ -18,6 +19,7 @@ def create
     head(:ok)
   end
 
+  #GET                   /alerts(.:format)
   def index
     @alerts = []
     [:traction, :google_analytics].each do |type|
diff --git a/app/controllers/bans_controller.rb b/app/controllers/bans_controller.rb
@@ -1,4 +1,6 @@
 class BansController < BaseAdminController
+
+  # POST                  /users/:user_id/bans(.:format)
   def create
     ban_params = params.permit(:user_id)
     user = User.find(ban_params[:user_id])
diff --git a/app/controllers/callbacks/hawt_controller.rb b/app/controllers/callbacks/hawt_controller.rb
@@ -7,6 +7,7 @@ class Callbacks::HawtController < ApplicationController
   protect_from_forgery with: :null_session
   respond_to :json
 
+  # POST                  /callbacks/hawt/feature(.:format)
   def feature
     logger.ap(params, :debug)
 
@@ -17,6 +18,7 @@ def feature
     end
   end
 
+  # POST                  /callbacks/hawt/unfeature(.:format)
   def unfeature
     unfeature!(hawt_callback_params[:protip_id], hawt_callback_params[:hawt?])
 
diff --git a/app/controllers/comments_controller.rb b/app/controllers/comments_controller.rb
@@ -7,6 +7,7 @@ class CommentsController < ApplicationController
   before_action :lookup_protip, only: [:create]
   before_action :require_moderator!, only: [:mark_as_spam]
 
+  # POST                  /p/:protip_id/comments(.:format)
   def create
     redirect_to_signup_if_unauthenticated(request.referer + "?" + (comment_params.try(:to_query) || ""), "You must signin/signup to add a comment") do
       @comment = @protip.comments.build(comment_params)
@@ -26,6 +27,7 @@ def create
     end
   end
 
+  # PUT                   /p/:protip_id/comments/:id(.:format)
   def update
     respond_to do |format|
       if @comment.update_attributes(comment_params)
@@ -38,6 +40,7 @@ def update
     end
   end
 
+  # DELETE                /p/:protip_id/comments/:id(.:format)
   def destroy
     return head(:forbidden) if @comment.nil?
     @comment.destroy
@@ -47,6 +50,7 @@ def destroy
     end
   end
 
+  # POST                  /p/:protip_id/comments/:id/like(.:format)
   def like
     redirect_to_signup_if_unauthenticated(request.referer, "You must signin/signup to like a comment") do
       @comment.like_by(current_user)
@@ -57,6 +61,7 @@ def like
     end
   end
 
+  # POST                  /p/:protip_id/comments/:id/mark_as_spam(.:format)
   def mark_as_spam
     @comment.mark_as_spam
     respond_to do |format|
diff --git a/app/controllers/emails_controller.rb b/app/controllers/emails_controller.rb
@@ -1,4 +1,6 @@
 class EmailsController < ApplicationController
+
+  # GET                   /unsubscribe(.:format)
   def unsubscribe
     Rails.logger.info("Mailgun Unsubscribe: #{params.inspect}")
     if mailgun?(ENV['MAILGUN_API_KEY'], params['token'], params['timestamp'], params['signature'])
@@ -17,6 +19,7 @@ def unsubscribe
     return head(200)
   end
 
+  # GET                   /delivered(.:format)
   def delivered
     Rails.logger.info("Mailgun Delivered: #{params.inspect}")
     if mailgun?(ENV['MAILGUN_API_KEY'], params['token'], params['timestamp'], params['signature'])
diff --git a/app/controllers/endorsements_controller.rb b/app/controllers/endorsements_controller.rb
@@ -1,5 +1,6 @@
 class EndorsementsController < ApplicationController
 
+  # GET                   /users/:user_id/endorsements(.:format)
   def index
     flash[:notice] = 'You must be signed in to make an endorsement.'
     #This is called when someone tries to endorse while unauthenticated
@@ -8,6 +9,7 @@ def index
     redirect_to(signin_path)
   end
 
+  # POST                  /users/:user_id/endorsements(.:format)
   def create
     return head(:forbidden) unless signed_in? && params[:user_id] != current_user.id.to_s
     @user  = User.find(params[:user_id])
@@ -21,6 +23,8 @@ def create
                  }
   end
 
+  # GET                   /users/:user_id/endorsements/:id(.:format)
+  # GET                   /:username/endorsements.json(.:format)
   def show #Used by api.coderwall.com
     @user = User.find_by_username(params[:username])
     return head(:not_found) if @user.nil?
diff --git a/app/controllers/errors_controller.rb b/app/controllers/errors_controller.rb
@@ -1,8 +1,11 @@
 class ErrorsController < ApplicationController
+
+  # GET|POST|PATCH|DELETE /404(.:format)
   def not_found
     render status: :not_found
   end
 
+  # GET|POST|PATCH|DELETE /422(.:format)
   def unacceptable
     respond_to do |format|
       format.html { render 'public/422', status: :unprocessable_entity }
@@ -11,6 +14,7 @@ def unacceptable
     end
   end
 
+  # GET|POST|PATCH|DELETE /500(.:format)
   def internal_error
     respond_to do |format|
       format.html { render 'public/500', status: :internal_server_error }
diff --git a/app/controllers/follows_controller.rb b/app/controllers/follows_controller.rb
@@ -4,6 +4,9 @@ class FollowsController < ApplicationController
 
   helper_method :is_viewing_followers?
 
+  # GET                   /users/:user_id/follows(.:format)
+  # GET                   /:username/followers(.:format)
+  # GET                   /:username/following(.:format)
   def index
     @user = User.find_by_username(params[:username])
     return redirect_to(user_follows_url(username: current_user.username)) unless @user == current_user || current_user.admin?
@@ -16,6 +19,7 @@ def index
     @network = @network.order('score_cache DESC').page(params[:page]).per(50)
   end
 
+  # POST                  /users/:username/follow(.:format)
   def create
     apply_cache_buster
 
diff --git a/app/controllers/home_controller.rb b/app/controllers/home_controller.rb
@@ -1,6 +1,6 @@
 class HomeController < ApplicationController
   layout 'home4-layout'
-
+  # GET                   /welcome(.:format)
   def index
     return redirect_to destination_url, flash: flash if signed_in?
   end
diff --git a/app/controllers/invitations_controller.rb b/app/controllers/invitations_controller.rb
@@ -1,5 +1,7 @@
 class InvitationsController < ApplicationController
 
+  # GET                   /invitations/:id(.:format)
+  # GET                   /i/:id/:r(.:format)
   def show
     @team = Team.find(params[:id])
     invitation_failed! unless @team.has_user_with_referral_token?(params[:r])
diff --git a/app/controllers/members_controller.rb b/app/controllers/members_controller.rb
@@ -1,6 +1,7 @@
 class MembersController < ApplicationController
   before_action :set_team
 
+  # DELETE                /teams/:team_id/members/:id(.:format)
   def destroy
     self_removal = current_user.id == params[:id]
     return head(:forbidden) unless signed_in? && (@team.admin?(current_user) || self_removal)
diff --git a/app/controllers/networks_controller.rb b/app/controllers/networks_controller.rb
@@ -7,6 +7,7 @@ class NetworksController < ApplicationController
   respond_to :html, :json, :js
   cache_sweeper :follow_sweeper, only: [:join, :leave]
 
+  # GET                   /n(.:format)
   def index
     @index_networks_params = params.permit(:sort, :action)
 
@@ -18,6 +19,7 @@ def index
     end
   end
 
+  #POST                  /n/:id/join(.:format)
   def join
     redirect_to_signup_if_unauthenticated(request.referer, 'You must login/signup to join a network') do
       return leave if current_user.member_of?(@network)
@@ -28,6 +30,7 @@ def join
     end
   end
 
+  # POST                  /n/:id/leave(.:format)
   def leave
     redirect_to_signup_if_unauthenticated(request.referer, 'You must login/signup to leave a network') do
       return join unless current_user.member_of?(@network)
diff --git a/app/controllers/opportunities_controller.rb b/app/controllers/opportunities_controller.rb
@@ -6,6 +6,7 @@ class OpportunitiesController < ApplicationController
   before_action :verify_payment, only: [:new, :create]
   before_action :stringify_location, only: [:create, :update]
 
+  # POST                  /teams/:team_id/opportunities/:id/apply(.:format)
   def apply
     redirect_to_signup_if_unauthenticated(request.referer, "You must login/signup to apply for an opportunity") do
       job = Opportunity.find(params[:id])
@@ -20,14 +21,17 @@ def apply
     end
   end
 
+  # GET                   /teams/:team_id/opportunities/new(.:format)
   def new
     team_id = params[:team_id]
     @job = Opportunity.new(team_id: team_id)
   end
 
+  # GET                   /teams/:team_id/opportunities/:id/edit(.:format)
   def edit
   end
 
+  # POST                  /teams/:team_id/opportunities(.:format)
   def create
     opportunity_create_params = params.require(:opportunity).permit(:name, :team_id, :opportunity_type, :description, :tag_list, :location, :link, :salary, :apply, :remote)
     @job = Opportunity.new(opportunity_create_params)
@@ -41,6 +45,7 @@ def create
     end
   end
 
+  # PUT                   /teams/:team_id/opportunities/:id(.:format)
   def update
     opportunity_update_params = params.require(:opportunity).permit(:id, :name, :team_id, :opportunity_type, :description, :tag_list, :location, :link, :salary, :apply)
     respond_to do |format|
@@ -52,30 +57,33 @@ def update
     end
   end
 
+  # GET                   /teams/:team_id/opportunities/:id/activate(.:format)
   def activate
     @job.activate!
     header_ok
   end
 
+  # GET                   /teams/:team_id/opportunities/:id/deactivate(.:format)
   def deactivate
     @job.deactivate!
     header_ok
   end
 
+  # POST                  /teams/:team_id/opportunities/:id/visit(.:format)
   def visit
     unless is_admin?
       viewing_user.track_opportunity_view!(@job) if viewing_user
       @job.viewed_by(viewing_user || session_id)
     end
     header_ok
   end
-
+  
+  # GET                   /jobs(/:location(/:skill))(.:format)
   def index
     current_user.seen(:jobs) if signed_in?
     store_location! unless signed_in?
     chosen_location = (params[:location] || closest_to_user(current_user)).try(:titleize)
     chosen_location = nil if chosen_location == 'Worldwide'
-
     @remote_allowed = params[:remote]     == 'true'
 
     @page = params[:page].try(:to_i) || 1
@@ -94,13 +102,14 @@ def index
     @lat, @lng = geocode_location(chosen_location)
 
     respond_to do |format|
-      format.html { render layout: 'jobs' }
+      format.html { render layout: 'coderwallv2' }
       format.json { render json: @jobs.map(&:to_public_hash) }
       format.js
     end
 
   end
 
+  # GET                   /jobs-map(.:format)
   def map
     @job_locations = all_job_locations
     @job_skills = all_job_skills
diff --git a/app/controllers/pages_controller.rb b/app/controllers/pages_controller.rb
@@ -1,6 +1,12 @@
 class PagesController < ApplicationController
 
-
+  # GET                   /faq(.:format)
+  # GET                   /tos(.:format)
+  # GET                   /privacy_policy(.:format)
+  # GET                   /contact_us(.:format)
+  # GET                   /api(.:format)
+  # GET                   /achievements(.:format)
+  # GET                   /pages/:page(.:format)
   def show
     show_pages_params = params.permit(:page, :layout)
 
diff --git a/app/controllers/pictures_controller.rb b/app/controllers/pictures_controller.rb
@@ -1,4 +1,6 @@
 class PicturesController < ApplicationController
+
+  # POST                  /users/:user_id/pictures(.:format)
   def create
     picture = current_user.create_picture(file: params[:picture])
     render json: picture
diff --git a/app/controllers/protips_controller.rb b/app/controllers/protips_controller.rb
diff --git a/app/controllers/provider_user_lookups_controller.rb b/app/controllers/provider_user_lookups_controller.rb
diff --git a/app/controllers/sessions_controller.rb b/app/controllers/sessions_controller.rb
diff --git a/app/controllers/skills_controller.rb b/app/controllers/skills_controller.rb
diff --git a/app/controllers/teams_controller.rb b/app/controllers/teams_controller.rb
diff --git a/app/controllers/unbans_controller.rb b/app/controllers/unbans_controller.rb
diff --git a/app/controllers/usernames_controller.rb b/app/controllers/usernames_controller.rb
diff --git a/app/controllers/users_controller.rb b/app/controllers/users_controller.rb
