Browse Source
* Add structure for lists * Add list timeline streaming API * Add list APIs, bind list-account relation to follow relation * Add API for adding/removing accounts from lists * Add pagination to lists API * Add pagination to list accounts API * Adjust scopes for new APIs - Creating and modifying lists merely requires "write" scope - Fetching information about lists merely requires "read" scope * Add test for wrong user context on list timeline * Clean up testscustom
Eugen Rochko
5 years ago
committed by
GitHub
GitHub
67 changed files with 856 additions and 225 deletions
@ -0,0 +1,81 @@ |
|||
# frozen_string_literal: true |
|||
|
|||
class Api::V1::Lists::AccountsController < Api::BaseController |
|||
before_action -> { doorkeeper_authorize! :read }, only: [:show] |
|||
before_action -> { doorkeeper_authorize! :write }, except: [:show] |
|||
|
|||
before_action :require_user! |
|||
before_action :set_list |
|||
|
|||
after_action :insert_pagination_headers, only: :show |
|||
|
|||
def show |
|||
@accounts = @list.accounts.paginate_by_max_id(limit_param(DEFAULT_ACCOUNTS_LIMIT), params[:max_id], params[:since_id]) |
|||
render json: @accounts, each_serializer: REST::AccountSerializer |
|||
end |
|||
|
|||
def create |
|||
ApplicationRecord.transaction do |
|||
list_accounts.each do |account| |
|||
@list.accounts << account |
|||
end |
|||
end |
|||
|
|||
render_empty |
|||
end |
|||
|
|||
def destroy |
|||
ListAccount.where(list: @list, account_id: account_ids).destroy_all |
|||
render_empty |
|||
end |
|||
|
|||
private |
|||
|
|||
def set_list |
|||
@list = List.where(account: current_account).find(params[:list_id]) |
|||
end |
|||
|
|||
def list_accounts |
|||
Account.find(account_ids) |
|||
end |
|||
|
|||
def account_ids |
|||
Array(resource_params[:account_ids]) |
|||
end |
|||
|
|||
def resource_params |
|||
params.permit(account_ids: []) |
|||
end |
|||
|
|||
def insert_pagination_headers |
|||
set_pagination_headers(next_path, prev_path) |
|||
end |
|||
|
|||
def next_path |
|||
if records_continue? |
|||
api_v1_list_accounts_url pagination_params(max_id: pagination_max_id) |
|||
end |
|||
end |
|||
|
|||
def prev_path |
|||
unless @accounts.empty? |
|||
api_v1_list_accounts_url pagination_params(since_id: pagination_since_id) |
|||
end |
|||
end |
|||
|
|||
def pagination_max_id |
|||
@accounts.last.id |
|||
end |
|||
|
|||
def pagination_since_id |
|||
@accounts.first.id |
|||
end |
|||
|
|||
def records_continue? |
|||
@accounts.size == limit_param(DEFAULT_ACCOUNTS_LIMIT) |
|||
end |
|||
|
|||
def pagination_params(core_params) |
|||
params.permit(:limit).merge(core_params) |
|||
end |
|||
end |
|||
@ -0,0 +1,79 @@ |
|||
# frozen_string_literal: true |
|||
|
|||
class Api::V1::ListsController < Api::BaseController |
|||
LISTS_LIMIT = 50 |
|||
|
|||
before_action -> { doorkeeper_authorize! :read }, only: [:index, :show] |
|||
before_action -> { doorkeeper_authorize! :write }, except: [:index, :show] |
|||
|
|||
before_action :require_user! |
|||
before_action :set_list, except: [:index, :create] |
|||
|
|||
after_action :insert_pagination_headers, only: :index |
|||
|
|||
def index |
|||
@lists = List.where(account: current_account).paginate_by_max_id(limit_param(LISTS_LIMIT), params[:max_id], params[:since_id]) |
|||
render json: @lists, each_serializer: REST::ListSerializer |
|||
end |
|||
|
|||
def show |
|||
render json: @list, serializer: REST::ListSerializer |
|||
end |
|||
|
|||
def create |
|||
@list = List.create!(list_params.merge(account: current_account)) |
|||
render json: @list, serializer: REST::ListSerializer |
|||
end |
|||
|
|||
def update |
|||
@list.update!(list_params) |
|||
render json: @list, serializer: REST::ListSerializer |
|||
end |
|||
|
|||
def destroy |
|||
@list.destroy! |
|||
render_empty |
|||
end |
|||
|
|||
private |
|||
|
|||
def set_list |
|||
@list = List.where(account: current_account).find(params[:id]) |
|||
end |
|||
|
|||
def list_params |
|||
params.permit(:title) |
|||
end |
|||
|
|||
def insert_pagination_headers |
|||
set_pagination_headers(next_path, prev_path) |
|||
end |
|||
|
|||
def next_path |
|||
if records_continue? |
|||
api_v1_lists_url pagination_params(max_id: pagination_max_id) |
|||
end |
|||
end |
|||
|
|||
def prev_path |
|||
unless @lists.empty? |
|||
api_v1_lists_url pagination_params(since_id: pagination_since_id) |
|||
end |
|||
end |
|||
|
|||
def pagination_max_id |
|||
@lists.last.id |
|||
end |
|||
|
|||
def pagination_since_id |
|||
@lists.first.id |
|||
end |
|||
|
|||
def records_continue? |
|||
@lists.size == limit_param(LISTS_LIMIT) |
|||
end |
|||
|
|||
def pagination_params(core_params) |
|||
params.permit(:limit).merge(core_params) |
|||
end |
|||
end |
|||
@ -0,0 +1,66 @@ |
|||
# frozen_string_literal: true |
|||
|
|||
class Api::V1::Timelines::ListController < Api::BaseController |
|||
before_action -> { doorkeeper_authorize! :read } |
|||
before_action :require_user! |
|||
before_action :set_list |
|||
before_action :set_statuses |
|||
|
|||
after_action :insert_pagination_headers, unless: -> { @statuses.empty? } |
|||
|
|||
def show |
|||
render json: @statuses, |
|||
each_serializer: REST::StatusSerializer, |
|||
relationships: StatusRelationshipsPresenter.new(@statuses, current_user.account_id) |
|||
end |
|||
|
|||
private |
|||
|
|||
def set_list |
|||
@list = List.where(account: current_account).find(params[:id]) |
|||
end |
|||
|
|||
def set_statuses |
|||
@statuses = cached_list_statuses |
|||
end |
|||
|
|||
def cached_list_statuses |
|||
cache_collection list_statuses, Status |
|||
end |
|||
|
|||
def list_statuses |
|||
list_feed.get( |
|||
limit_param(DEFAULT_STATUSES_LIMIT), |
|||
params[:max_id], |
|||
params[:since_id] |
|||
) |
|||
end |
|||
|
|||
def list_feed |
|||
ListFeed.new(@list) |
|||
end |
|||
|
|||
def insert_pagination_headers |
|||
set_pagination_headers(next_path, prev_path) |
|||
end |
|||
|
|||
def pagination_params(core_params) |
|||
params.permit(:limit).merge(core_params) |
|||
end |
|||
|
|||
def next_path |
|||
api_v1_timelines_list_url params[:id], pagination_params(max_id: pagination_max_id) |
|||
end |
|||
|
|||
def prev_path |
|||
api_v1_timelines_list_url params[:id], pagination_params(since_id: pagination_since_id) |
|||
end |
|||
|
|||
def pagination_max_id |
|||
@statuses.last.id |
|||
end |
|||
|
|||
def pagination_since_id |
|||
@statuses.first.id |
|||
end |
|||
end |
|||
@ -0,0 +1,25 @@ |
|||
# frozen_string_literal: true |
|||
|
|||
class HomeFeed < Feed |
|||
def initialize(account) |
|||
@type = :home |
|||
@id = account.id |
|||
@account = account |
|||
end |
|||
|
|||
def get(limit, max_id = nil, since_id = nil) |
|||
if redis.exists("account:#{@account.id}:regeneration") |
|||
from_database(limit, max_id, since_id) |
|||
else |
|||
super |
|||
end |
|||
end |
|||
|
|||
private |
|||
|
|||
def from_database(limit, max_id, since_id) |
|||
Status.as_home_timeline(@account) |
|||
.paginate_by_max_id(limit, max_id, since_id) |
|||
.reject { |status| FeedManager.instance.filter?(:home, status, @account.id) } |
|||
end |
|||
end |
|||
@ -0,0 +1,22 @@ |
|||
# frozen_string_literal: true |
|||
# == Schema Information |
|||
# |
|||
# Table name: lists |
|||
# |
|||
# id :integer not null, primary key |
|||
# account_id :integer |
|||
# title :string default(""), not null |
|||
# created_at :datetime not null |
|||
# updated_at :datetime not null |
|||
# |
|||
|
|||
class List < ApplicationRecord |
|||
include Paginable |
|||
|
|||
belongs_to :account |
|||
|
|||
has_many :list_accounts, inverse_of: :list, dependent: :destroy |
|||
has_many :accounts, through: :list_accounts |
|||
|
|||
validates :title, presence: true |
|||
end |
|||
@ -0,0 +1,24 @@ |
|||
# frozen_string_literal: true |
|||
# == Schema Information |
|||
# |
|||
# Table name: list_accounts |
|||
# |
|||
# id :integer not null, primary key |
|||
# list_id :integer not null |
|||
# account_id :integer not null |
|||
# follow_id :integer not null |
|||
# |
|||
|
|||
class ListAccount < ApplicationRecord |
|||
belongs_to :list, required: true |
|||
belongs_to :account, required: true |
|||
belongs_to :follow, required: true |
|||
|
|||
before_validation :set_follow |
|||
|
|||
private |
|||
|
|||
def set_follow |
|||
self.follow = Follow.find_by(account_id: list.account_id, target_account_id: account.id) |
|||
end |
|||
end |
|||
@ -0,0 +1,8 @@ |
|||
# frozen_string_literal: true |
|||
|
|||
class ListFeed < Feed |
|||
def initialize(list) |
|||
@type = :list |
|||
@id = list.id |
|||
end |
|||
end |
|||
@ -0,0 +1,5 @@ |
|||
# frozen_string_literal: true |
|||
|
|||
class REST::ListSerializer < ActiveModel::Serializer |
|||
attributes :id, :title |
|||
end |
|||
@ -0,0 +1,10 @@ |
|||
class CreateLists < ActiveRecord::Migration[5.1] |
|||
def change |
|||
create_table :lists do |t| |
|||
t.references :account, foreign_key: { on_delete: :cascade } |
|||
t.string :title, null: false, default: '' |
|||
|
|||
t.timestamps |
|||
end |
|||
end |
|||
end |
|||
@ -0,0 +1,12 @@ |
|||
class CreateListAccounts < ActiveRecord::Migration[5.1] |
|||
def change |
|||
create_table :list_accounts do |t| |
|||
t.belongs_to :list, foreign_key: { on_delete: :cascade }, null: false |
|||
t.belongs_to :account, foreign_key: { on_delete: :cascade }, null: false |
|||
t.belongs_to :follow, foreign_key: { on_delete: :cascade }, null: false |
|||
end |
|||
|
|||
add_index :list_accounts, [:account_id, :list_id], unique: true |
|||
add_index :list_accounts, [:list_id, :account_id] |
|||
end |
|||
end |
|||
@ -0,0 +1,54 @@ |
|||
require 'rails_helper' |
|||
|
|||
describe Api::V1::Lists::AccountsController do |
|||
render_views |
|||
|
|||
let(:user) { Fabricate(:user, account: Fabricate(:account, username: 'alice')) } |
|||
let(:token) { Fabricate(:accessible_access_token, resource_owner_id: user.id, scopes: 'read write') } |
|||
let(:list) { Fabricate(:list, account: user.account) } |
|||
|
|||
before do |
|||
follow = Fabricate(:follow, account: user.account) |
|||
list.accounts << follow.target_account |
|||
allow(controller).to receive(:doorkeeper_token) { token } |
|||
end |
|||
|
|||
describe 'GET #index' do |
|||
it 'returns http success' do |
|||
get :show, params: { list_id: list.id } |
|||
|
|||
expect(response).to have_http_status(:success) |
|||
end |
|||
end |
|||
|
|||
describe 'POST #create' do |
|||
let(:bob) { Fabricate(:account, username: 'bob') } |
|||
|
|||
before do |
|||
user.account.follow!(bob) |
|||
post :create, params: { list_id: list.id, account_ids: | |||