Add annotations to actions

alouanemed · alouanemed · commit 8f5413a9e756 · 2015-08-29T13:38:30.000+01:00
diff --git a/app/controllers/accounts_controller.rb b/app/controllers/accounts_controller.rb
@@ -40,6 +40,7 @@ def update
     end
   end
 
+  # GET                   /webhooks/stripe(.:format)
   def webhook
     data = JSON.parse request.body.read
     if data[:type] == "invoice.payment_succeeded"
diff --git a/app/controllers/achievements_controller.rb b/app/controllers/achievements_controller.rb
@@ -14,6 +14,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/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/follows_controller.rb b/app/controllers/follows_controller.rb
@@ -16,6 +16,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/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
@@ -69,13 +69,13 @@ def visit
     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 +94,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/protips_controller.rb b/app/controllers/protips_controller.rb
@@ -18,10 +18,13 @@ class ProtipsController < ApplicationController
 
   layout :choose_protip_layout
 
+  #                        root                       /
+  #GET                   /p(.:format)
   def index
     trending
   end
 
+  # GET                   /p/t/trending(.:format)
   def trending
     @context = "trending"
     track_discovery
@@ -30,6 +33,7 @@ def trending
     render :index
   end
 
+  # GET                   /p/popular(.:format)
   def popular
     @context = "popular"
     track_discovery
@@ -38,6 +42,7 @@ def popular
     render :index
   end
 
+  # GET                   /p/fresh(.:format)
   def fresh
     redirect_to_signup_if_unauthenticated(protips_path, "You must login/signup to view fresh protips from coders, teams and networks you follow") do
       @context = "fresh"
@@ -48,6 +53,7 @@ def fresh
     end
   end
 
+  # GET                   /p/liked(.:format)
   def liked
     redirect_to_signup_if_unauthenticated(protips_path, "You must login/signup to view protips you have liked/upvoted") do
       @context = "liked"
@@ -58,6 +64,7 @@ def liked
     end
   end
 
+  # GET                   /p/u/:username(.:format)
   def user
     user_params = params.permit(:username, :page, :per_page)
 
@@ -71,6 +78,7 @@ def user
     render :topic
   end
 
+  # GET                   /p/team/:team_slug(.:format)
   def team
     team_params = params.permit(:team_slug, :page, :per_page)
 
@@ -83,6 +91,7 @@ def team
     render :topic
   end
 
+  # GET                   /p/d/:date(/:start)(.:format)
   def date
     date_params = params.permit(:date, :query, :page, :per_page)
 
@@ -98,6 +107,7 @@ def date
     render :topic
   end
 
+  # GET                   /p/me(.:format)
   def me
     me_params = params.permit(:section, :page, :per_page)
 
@@ -108,6 +118,9 @@ def me
     @topic_user = nil
   end
 
+  # GET                   /p/dpvbbg(.:format)
+  # GET                   /gh(.:format)
+  # GET                   /p/:id/:slug(.:format)
   def show
     show_params = if is_admin?
                     params.permit(:reply_to, :q, :t, :i, :p)
@@ -127,11 +140,13 @@ def show
     respond_with @protip
   end
 
+  # GET                   /p/random(.:format)
   def random
     @protip = Protip.random(1).first
     render :show
   end
 
+  # GET                   /p/new(.:format)
   def new
     new_params = params.permit(:topic_list)
 
@@ -140,10 +155,12 @@ def new
     respond_with @protip
   end
 
+  # GET                   /p/:id/edit(.:format)
   def edit
     respond_with @protip
   end
 
+  # POST                  /p(.:format)
   def create
     create_params = if params[:protip] && params[:protip].keys.present?
                       params.require(:protip).permit(:title, :body, :user_id, :topic_list)
@@ -165,6 +182,7 @@ def create
     end
   end
 
+  #              protips_update GET|PUT               /protips/update(.:format)                              protips#update
   def update
     # strong_parameters will intentionally fail if a key is present but has an empty hash. :(
     update_params = if params[:protip] && params[:protip].keys.present?
@@ -197,16 +215,19 @@ def destroy
     end
   end
 
+  # POST                  /p/:id/upvote(.:format)
   def upvote
     @protip.upvote_by(viewing_user, tracking_code, request.remote_ip)
     @protip
   end
 
+  # POST                  /p/:id/tag(.:format)
   def tag
     tag_params = params.permit(:topic_list)
     @protip.topic_list.add(tag_params[:topic_list]) unless tag_params[:topic_list].nil?
   end
 
+  # PUT                   /p/t(/*tags)/subscribe(.:format)
   def subscribe
     tags = params.permit(:tags)
     redirect_to_signup_if_unauthenticated(view_context.topic_protips_path(tags)) do
@@ -217,6 +238,7 @@ def subscribe
     end
   end
 
+  # PUT                   /p/t(/*tags)/unsubscribe(.:format)
   def unsubscribe
     tags = params.permit(:tags)
     redirect_to_signup_if_unauthenticated(view_context.topic_protips_path(tags)) do
@@ -227,6 +249,7 @@ def unsubscribe
     end
   end
 
+  # POST                  /p/:id/report_inappropriate(.:format)
   def report_inappropriate
     protip_public_id = params[:id]
     protip = Protip.find_by_public_id!(protip_public_id)
@@ -241,7 +264,8 @@ def report_inappropriate
     end
   end
 
-   def flag
+  # POST                  /p/:id/flag(.:format)
+  def flag
     times_to_flag = is_moderator? ? Protip::MIN_FLAG_THRESHOLD : 1
     times_to_flag.times do
       @protip.flag
@@ -270,6 +294,7 @@ def unflag
     end
   end
 
+  # POST                  /p/:id/feature(.:format)
   def feature
     #TODO change with @protip.toggle_featured_state!
     if @protip.featured?
@@ -287,6 +312,7 @@ def feature
     end
   end
 
+  #POST                  /p/:id/delete_tag/:topic(.:format)                     protips#delete_tag {:topic=>/[A-Za-z0-9#\$\+\-_\.(%23)(%24)(%2B)]+/}
   def delete_tag
     @protip.topic_list.remove(params.permit(:topic))
     respond_to do |format|
@@ -300,6 +326,7 @@ def delete_tag
     end
   end
 
+  # GET                   /p/admin(.:format)
   def admin
     admin_params = params.permit(:page, :per_page)
 
@@ -309,6 +336,7 @@ def admin
     render :topic
   end
 
+  # GET                   /p/t/by_tags(.:format)
   def by_tags
     by_tags_params = params.permit(:page, :per_page)
 
@@ -318,6 +346,7 @@ def by_tags
     @tags = ActsAsTaggableOn::Tag.joins('inner join taggings on taggings.tag_id = tags.id').group('tags.id').order('count(tag_id) desc').page(page).per(per_page)
   end
 
+  # POST                  /p/preview(.:format)
   def preview
     preview_params = params.require(:protip).permit(:title, :body)
 
@@ -330,6 +359,7 @@ def preview
     render partial: 'protip', locals: { protip: protip, mode: 'preview', include_comments: false, job: nil }
   end
 
+  # POST - GET                   /p/search(.:format)
   def search
     search_params = params.permit(:search)
 
diff --git a/app/controllers/sessions_controller.rb b/app/controllers/sessions_controller.rb
diff --git a/app/controllers/teams_controller.rb b/app/controllers/teams_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
diff --git a/config/routes.rb~ b/config/routes.rb~
