From 4289ed1d13b9c3b91663581c44635105c4bc0412 Mon Sep 17 00:00:00 2001
From: Matt Jankowski <mjankowski@thoughtbot.com>
Date: Tue, 23 May 2017 12:11:39 -0400
Subject: Refactor of API timeline actions (#3263)

- Increase coverage to exercise all parts of each action
- Move into namespace to share common code
- Misc refactor of each action for smaller methods, simpler code
---
 .../api/v1/timelines/base_controller.rb            | 30 +++++++++++++
 .../api/v1/timelines/home_controller.rb            | 44 +++++++++++++++++++
 .../api/v1/timelines/public_controller.rb          | 41 +++++++++++++++++
 app/controllers/api/v1/timelines/tag_controller.rb | 51 ++++++++++++++++++++++
 4 files changed, 166 insertions(+)
 create mode 100644 app/controllers/api/v1/timelines/base_controller.rb
 create mode 100644 app/controllers/api/v1/timelines/home_controller.rb
 create mode 100644 app/controllers/api/v1/timelines/public_controller.rb
 create mode 100644 app/controllers/api/v1/timelines/tag_controller.rb

(limited to 'app/controllers/api/v1/timelines')

diff --git a/app/controllers/api/v1/timelines/base_controller.rb b/app/controllers/api/v1/timelines/base_controller.rb
new file mode 100644
index 000000000..4eb29e74a
--- /dev/null
+++ b/app/controllers/api/v1/timelines/base_controller.rb
@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Api::V1::Timelines
+  class BaseController < ApiController
+    respond_to :json
+    after_action :insert_pagination_headers, unless: -> { @statuses.empty? }
+
+    private
+
+    def cache_collection(raw)
+      super(raw, Status)
+    end
+
+    def pagination_params(core_params)
+      params.permit(:local, :limit).merge(core_params)
+    end
+
+    def insert_pagination_headers
+      set_pagination_headers(next_path, prev_path)
+    end
+
+    def next_path
+      raise 'Override in child controllers'
+    end
+
+    def prev_path
+      raise 'Override in child controllers'
+    end
+  end
+end
diff --git a/app/controllers/api/v1/timelines/home_controller.rb b/app/controllers/api/v1/timelines/home_controller.rb
new file mode 100644
index 000000000..33ff48b39
--- /dev/null
+++ b/app/controllers/api/v1/timelines/home_controller.rb
@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Api::V1::Timelines
+  class HomeController < BaseController
+    before_action -> { doorkeeper_authorize! :read }, only: [:show]
+    before_action :require_user!, only: [:show]
+
+    def show
+      @statuses = load_statuses
+    end
+
+    private
+
+    def load_statuses
+      cached_home_statuses.tap do |statuses|
+        set_maps(statuses)
+      end
+    end
+
+    def cached_home_statuses
+      cache_collection home_statuses
+    end
+
+    def home_statuses
+      account_home_feed.get(
+        limit_param(DEFAULT_STATUSES_LIMIT),
+        params[:max_id],
+        params[:since_id]
+      )
+    end
+
+    def account_home_feed
+      Feed.new(:home, current_account)
+    end
+
+    def next_path
+      api_v1_timelines_home_url pagination_params(max_id: @statuses.last.id)
+    end
+
+    def prev_path
+      api_v1_timelines_home_url pagination_params(since_id: @statuses.first.id)
+    end
+  end
+end
diff --git a/app/controllers/api/v1/timelines/public_controller.rb b/app/controllers/api/v1/timelines/public_controller.rb
new file mode 100644
index 000000000..644c7a6f1
--- /dev/null
+++ b/app/controllers/api/v1/timelines/public_controller.rb
@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Api::V1::Timelines
+  class PublicController < BaseController
+    def show
+      @statuses = load_statuses
+    end
+
+    private
+
+    def load_statuses
+      cached_public_statuses.tap do |statuses|
+        set_maps(statuses)
+      end
+    end
+
+    def cached_public_statuses
+      cache_collection public_statuses
+    end
+
+    def public_statuses
+      public_timeline_statuses.paginate_by_max_id(
+        limit_param(DEFAULT_STATUSES_LIMIT),
+        params[:max_id],
+        params[:since_id]
+      )
+    end
+
+    def public_timeline_statuses
+      Status.as_public_timeline(current_account, params[:local])
+    end
+
+    def next_path
+      api_v1_timelines_public_url pagination_params(max_id: @statuses.last.id)
+    end
+
+    def prev_path
+      api_v1_timelines_public_url pagination_params(since_id: @statuses.first.id)
+    end
+  end
+end
diff --git a/app/controllers/api/v1/timelines/tag_controller.rb b/app/controllers/api/v1/timelines/tag_controller.rb
new file mode 100644
index 000000000..818f49d3d
--- /dev/null
+++ b/app/controllers/api/v1/timelines/tag_controller.rb
@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Api::V1::Timelines
+  class TagController < BaseController
+    before_action :load_tag
+
+    def show
+      @statuses = load_statuses
+    end
+
+    private
+
+    def load_tag
+      @tag = Tag.find_by(name: params[:id].downcase)
+    end
+
+    def load_statuses
+      cached_tagged_statuses.tap do |statuses|
+        set_maps(statuses)
+      end
+    end
+
+    def cached_tagged_statuses
+      cache_collection tagged_statuses
+    end
+
+    def tagged_statuses
+      if @tag.nil?
+        []
+      else
+        tag_timeline_statuses.paginate_by_max_id(
+          limit_param(DEFAULT_STATUSES_LIMIT),
+          params[:max_id],
+          params[:since_id]
+        )
+      end
+    end
+
+    def tag_timeline_statuses
+      Status.as_tag_timeline(@tag, current_account, params[:local])
+    end
+
+    def next_path
+      api_v1_timelines_tag_url params[:id], pagination_params(max_id: @statuses.last.id)
+    end
+
+    def prev_path
+      api_v1_timelines_tag_url params[:id], pagination_params(since_id: @statuses.first.id)
+    end
+  end
+end
-- 
cgit