todon-api 2.0.0

data/lib/mastodon/rest/accounts.rb

@@ -0,0 +1,87 @@
+require 'mastodon/rest/utils'
+require 'mastodon/account'
+require 'mastodon/access_token'
+
+module Mastodon
+  module REST
+    module Accounts
+      include Mastodon::REST::Utils
+
+      # Retrieve account of authenticated user
+      # @return [Mastodon::Account]
+      def verify_credentials
+        perform_request_with_object(:get, '/api/v1/accounts/verify_credentials', {}, Mastodon::Account)
+      end
+
+      # Update authenticated account attributes
+      # @param params [Hash]
+      # @option params :display_name [String] The name to display in the user's profile
+      # @option params :note [String] A new biography for the user
+      # @option params :avatar [File, StringIO, HTTP::FormData::File]
+      # @option params :header [File, StringIO, HTTP::FormData::File]
+      # @return [Mastodon::Account]
+      def update_credentials(params = {})
+        %i(avatar header).each do |key|
+          next unless params.key?(key)
+          params[key] = params[key].is_a?(HTTP::FormData::File) ? params[key] : HTTP::FormData::File.new(params[key])
+        end
+
+        perform_request_with_object(:patch, '/api/v1/accounts/update_credentials', params, Mastodon::Account)
+      end
+
+      # Retrieve account
+      # @param id [Integer]
+      # @return [Mastodon::Account]
+      def account(id)
+        perform_request_with_object(:get, "/api/v1/accounts/#{id}", {}, Mastodon::Account)
+      end
+
+      # Get a list of followers
+      # @param id [Integer]
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def followers(id, options = {})
+        perform_request_with_collection(:get, "/api/v1/accounts/#{id}/followers", options, Mastodon::Account)
+      end
+
+      # Get a list of followed accounts
+      # @param id [Integer]
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def following(id, options = {})
+        perform_request_with_collection(:get, "/api/v1/accounts/#{id}/following", options, Mastodon::Account)
+      end
+
+      # Sign up (requires authentication with client credentials)
+      # @param params [Hash]
+      # @option params :username [String]
+      # @option params :email [String]
+      # @option params :password [String]
+      # @option params :agreement [Boolean]
+      # @option params :locale [String]
+      # @return [Mastodon::AccessToken]
+      def create_account(params = {})
+        perform_request_with_object(:post, '/api/v1/accounts', params, Mastodon::AccessToken)
+      end
+
+      # Search accounts
+      # @param query [String]
+      # @param params [Hash]
+      # @option params :limit [Integer]
+      # @option params :resolve [Boolean] Whether to attempt resolving unknown remote accounts
+      # @option params :following [Boolean] Only return matches the authenticated user follows
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def search_accounts(query, params = {})
+        perform_request_with_collection(:get, '/api/v1/accounts/search', { q: query }.merge(params), Mastodon::Account)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/api.rb

@@ -0,0 +1,45 @@
+require 'mastodon/rest/statuses'
+require 'mastodon/rest/accounts'
+require 'mastodon/rest/timelines'
+require 'mastodon/rest/notifications'
+require 'mastodon/rest/search'
+require 'mastodon/rest/relationships'
+require 'mastodon/rest/media'
+require 'mastodon/rest/suggestions'
+require 'mastodon/rest/apps'
+require 'mastodon/rest/instances'
+require 'mastodon/rest/custom_emojis'
+require 'mastodon/rest/domain_blocks'
+require 'mastodon/rest/filters'
+require 'mastodon/rest/endorsements'
+require 'mastodon/rest/suggestions'
+require 'mastodon/rest/reports'
+require 'mastodon/rest/lists'
+require 'mastodon/rest/scheduled_statuses'
+require 'mastodon/rest/conversations'
+
+module Mastodon
+  module REST
+    module API
+      include Mastodon::REST::Statuses
+      include Mastodon::REST::Accounts
+      include Mastodon::REST::Timelines
+      include Mastodon::REST::Notifications
+      include Mastodon::REST::Search
+      include Mastodon::REST::Relationships
+      include Mastodon::REST::Media
+      include Mastodon::REST::Suggestions
+      include Mastodon::REST::Apps
+      include Mastodon::REST::Instances
+      include Mastodon::REST::CustomEmojis
+      include Mastodon::REST::DomainBlocks
+      include Mastodon::REST::Filters
+      include Mastodon::REST::Endorsements
+      include Mastodon::REST::Suggestions
+      include Mastodon::REST::Reports
+      include Mastodon::REST::Lists
+      include Mastodon::REST::ScheduledStatuses
+      include Mastodon::REST::Conversations
+    end
+  end
+end

data/lib/mastodon/rest/apps.rb

@@ -0,0 +1,27 @@
+require 'mastodon/rest/utils'
+require 'mastodon/app'
+require 'mastodon/entities/app'
+
+module Mastodon
+  module REST
+    module Apps
+      include Mastodon::REST::Utils
+
+      # Register a new OAuth client app on the target instance
+      # @param name [String]
+      # @param redirect_uri [String]
+      # @param scopes [String]
+      # @param website [String]
+      # @return [Mastodon::App]
+      def create_app(name, redirect_uri, scopes = 'read', website = nil)
+        perform_request_with_object(:post, '/api/v1/apps', { client_name: name, redirect_uris: redirect_uri, scopes: scopes, website: website }, Mastodon::App)
+      end
+
+      # Return currently used app and confirm that client credentials are valid
+      # @return [Mastodon::Entities::App]
+      def verify_app_credentials
+        perform_request_with_object(:get, '/api/v1/apps/verify_credentials', {}, Mastodon::Entities::App)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/client.rb

@@ -0,0 +1,10 @@
+require 'mastodon/client'
+require 'mastodon/rest/api'
+
+module Mastodon
+  module REST
+    class Client < Mastodon::Client
+      include Mastodon::REST::API
+    end
+  end
+end

data/lib/mastodon/rest/conversations.rb

@@ -0,0 +1,34 @@
+require 'mastodon/rest/utils'
+require 'mastodon/conversation'
+
+module Mastodon
+  module REST
+    module Conversations
+      include Mastodon::REST::Utils
+
+      # Get a list of conversations
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Conversation>]
+      def conversations(options = {})
+        perform_request_with_collection(:get, '/api/v1/conversations', options, Mastodon::Conversation)
+      end
+
+      # Mark a conversation as read
+      # @param id [Integer]
+      # @return [Mastodon::Conversation]
+      def mark_conversation_as_read(id)
+        perform_request_with_object(:post, "/api/v1/conversations/#{id}/read", {}, Mastodon::Conversation)
+      end
+
+      # Delete a conversation. Does not delete statuses in the conversation
+      # @param id [Integer]
+      def delete_conversation(id)
+        perform_request(:delete, "/api/v1/conversations/#{id}")
+      end
+    end
+  end
+end

data/lib/mastodon/rest/custom_emojis.rb

@@ -0,0 +1,16 @@
+require 'mastodon/rest/utils'
+require 'mastodon/emoji'
+
+module Mastodon
+  module REST
+    module CustomEmojis
+      include Mastodon::REST::Utils
+
+      # Get a list of custom emojis on the server
+      # @return [Mastodon::Collection<Mastodon::Emoji>]
+      def custom_emojis
+        perform_request_with_collection('/api/v1/custom_emojis', {}, Mastodon::Emoji)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/domain_blocks.rb

@@ -0,0 +1,32 @@
+require 'mastodon/rest/utils'
+
+module Mastodon
+  module REST
+    module DomainBlocks
+      include Mastodon::REST::Utils
+
+      # Get a list of blocked domains
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<String>]
+      def domain_blocks(options = {})
+        perform_request_with_collection('/api/v1/domain_blocks', options, String)
+      end
+
+      # Block a domain
+      # @param domain [String]
+      def block_domain(domain)
+        perform_request(:post, '/api/v1/domain_blocks', domain: domain)
+      end
+
+      # Unblock a domain
+      # @param domain [String]
+      def unblock_domain(domain)
+        perform_request(:delete, '/api/v1/domain_blocks', domain: domain)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/endorsements.rb

@@ -0,0 +1,36 @@
+require 'mastodon/rest/utils'
+require 'mastodon/account'
+require 'mastodon/relationship'
+
+module Mastodon
+  module REST
+    module Endorsements
+      include Mastodon::REST::Utils
+
+      # Get a list of endorsed accounts
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def endorsements(options = {})
+        perform_request_with_collection('/api/v1/endorsements', options, Mastodon::Account)
+      end
+
+      # Endorse an account (feature on own profile)
+      # @param account_id [Integer]
+      # @return [Mastodon::Relationship]
+      def endorse(account_id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{account_id}/pin", {}, Mastodon::Relationship)
+      end
+
+      # Unendorse an account (no longer feature it on own profile)
+      # @param account_id [Integer]
+      # @return [Mastodon::Relationship]
+      def unendorse(account_id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{account_id}/unpin", {}, Mastodon::Relationship)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/filters.rb

@@ -0,0 +1,61 @@
+require 'mastodon/rest/utils'
+require 'mastodon/filter'
+
+module Mastodon
+  module REST
+    module Filters
+      include Mastodon::REST::Utils
+
+      # Get a list of filters
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Filter>]
+      def filters(options = {})
+        perform_request_with_collection('/api/v1/filters', options, Mastodon::Filter)
+      end
+
+      # Retrieve a filter
+      # @param id [Integer]
+      # @return [Mastodon::Filter]
+      def filter(id)
+        perform_request_with_object(:put, "/api/v1/filters/#{id}", {}, Mastodon::Filter)
+      end
+
+      # Create a filter
+      # @param params [Hash]
+      # @option params :phrase [String]
+      # @option params :context [Array<String>]
+      # @option params :irreversible [Boolean]
+      # @option params :whole_word [Boolean]
+      # @option params :expires_in [Integer]
+      # @return [Mastodon::Filter]
+      def create_filter(params = {})
+        params[:'context[]'] = params.delete(:context) if params.key?(:context)
+        perform_request_with_object(:post, '/api/v1/filters', params, Mastodon::Filter)
+      end
+
+      # Update a filter
+      # @param id [Integer]
+      # @param params [Hash]
+      # @option params :phrase [String]
+      # @option params :context [Array<String>]
+      # @option params :irreversible [Boolean]
+      # @option params :whole_word [Boolean]
+      # @option params :expires_in [Integer]
+      # @return [Mastodon::Filter]
+      def update_filter(id, params = {})
+        params[:'context[]'] = params.delete(:context) if params.key?(:context)
+        perform_request_with_object(:put, "/api/v1/filters/#{id}", params, Mastodon::Filter)
+      end
+
+      # Delete a filter
+      # @param id [Integer]
+      def delete_filter(id)
+        perform_request(:delete, "/api/v1/filters/#{id}")
+      end
+    end
+  end
+end

data/lib/mastodon/rest/instances.rb

@@ -0,0 +1,28 @@
+require 'mastodon/rest/utils'
+require 'mastodon/instance'
+
+module Mastodon
+  module REST
+    module Instances
+      include Mastodon::REST::Utils
+
+      # Retrieve the current instance. Does not require authentication
+      # @return [Mastodon::Instance]
+      def instance
+        perform_request_with_object(:get, '/api/v1/instance', {}, Mastodon::Instance)
+      end
+
+      # Retrieve activity statistics for the current instance. Does not require authentication
+      # @return [Mastodon::Collection<Hash>]
+      def activity
+        perform_request_with_collection(:get, '/api/v1/instance/activity', {}, Hash)
+      end
+
+      # Retrieve domains of instances known to the current instance. Does not require authentication
+      # @return [Mastodon::Collection<String>]
+      def peers
+        perform_request_with_collection(:get, '/api/v1/instance/peers', {}, String)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/lists.rb

@@ -0,0 +1,77 @@
+require 'mastodon/rest/utils'
+require 'mastodon/list'
+require 'mastodon/account'
+
+module Mastodon
+  module REST
+    module Lists
+      include Mastodon::REST::Utils
+
+      # Get a list of your lists
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::List>]
+      def lists(options = {})
+        perform_request_with_collection(:get, '/api/v1/lists', options, Mastodon::List)
+      end
+
+      # Retrieve a list
+      # @param id [Integer]
+      # @return [Mastodon::List]
+      def list(id)
+        perform_request_with_object(:get, "/api/v1/lists/#{id}", {}, Mastodon::List)
+      end
+
+      # Create a list
+      # @param params [Hash]
+      # @option params :title
+      # @return [Mastodon::List]
+      def create_list(params = {})
+        perform_request_with_object(:post, '/api/v1/lists/', params, Mastodon::List)
+      end
+
+      # Update a list
+      # @param id [Integer]
+      # @param params [Hash]
+      # @option params :title
+      # @return [Mastodon::List]
+      def update_list(id, params = {})
+        perform_request_with_object(:put, "/api/v1/lists/#{id}", params, Mastodon::List)
+      end
+
+      # Delete a list
+      # @param id [Integer]
+      def delete_list(id)
+        perform_request(:delete, "/api/v1/lists/#{id}")
+      end
+
+      # Get a list of accounts on the list
+      # @param id [Integer]
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def list_accounts(id, options = {})
+        perform_request_with_collection(:get, "/api/v1/lists/#{id}/accounts", options, Mastodon::Account)
+      end
+
+      # Add accounts to a list
+      # @param id [Integer]
+      # @param account_ids [Array<Integer>]
+      def add_accounts_to_list(id, account_ids = [])
+        perform_request(:post, "/api/v1/lists/#{id}/accounts", { 'account_ids[]': account_ids })
+      end
+
+      # Remove accounts from list
+      # @param id [Integer]
+      # @param account_ids [Array<Integer>]
+      def remove_accounts_from_list(id, account_ids = [])
+        perform_request(:delete, "/api/v1/lists/#{id}/accounts", { 'account_ids[]': account_ids })
+      end
+    end
+  end
+end

data/lib/mastodon/rest/media.rb

@@ -0,0 +1,31 @@
+require 'mastodon/rest/utils'
+require 'mastodon/media'
+
+module Mastodon
+  module REST
+    module Media
+      include Mastodon::REST::Utils
+
+      # Upload a media file
+      # @param file [File, StringIO, HTTP::FormData::File]
+      # @param params [Hash]
+      # @option params :description [String] Alternative text
+      # @option params :focus [String] Two floating points, comma-delimited
+      # @return [Mastodon::Media]
+      def upload_media(file, params = {})
+        file = file.is_a?(HTTP::FormData::File) ? file : HTTP::FormData::File.new(file)
+        perform_request_with_object(:post, '/api/v1/media', { file: file }.merge(params), Mastodon::Media)
+      end
+
+      # Update a media description, can only be updated while it's not associated to a status
+      # @param id [Integer]
+      # @param params [Hash]
+      # @option params :description [String] Alternative text
+      # @option params :focus [String] Two floating points, comma-delimited
+      # @return [Mastodon::Media]
+      def update_media(id, params)
+        perform_request_with_object(:put, "/api/v1/media/#{id}", params, Mastodon::Media)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/notifications.rb

@@ -0,0 +1,34 @@
+require 'mastodon/rest/utils'
+require 'mastodon/notification'
+
+module Mastodon
+  module REST
+    module Notifications
+      include Mastodon::REST::Utils
+
+      # Get a list of notifications for the authenticated user
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @option options :exclude_types [Array<String>]
+      # @return [Mastodon::Collection<Mastodon::Notification>]
+      def notifications(options = {})
+        options[:'exclude_types[]'] = options.delete(:exclude_types) if options.key?(:exclude_types)
+        perform_request_with_collection(:get, '/api/v1/notifications', options, Mastodon::Notification)
+      end
+
+      # Dismiss a notification
+      # @param id [Integer]
+      def dismiss_notification(id)
+        perform_request(:post, "/api/v1/notifications/#{id}/dismiss")
+      end
+
+      # Clear all notifications
+      def clear_notifications
+        perform_request(:post, '/api/v1/notifications/clear')
+      end
+    end
+  end
+end

data/lib/mastodon/rest/relationships.rb

@@ -0,0 +1,126 @@
+require 'mastodon/rest/utils'
+require 'mastodon/relationship'
+require 'mastodon/status'
+
+module Mastodon
+  module REST
+    module Relationships
+      include Mastodon::REST::Utils
+
+      # Get the relationships of authenticated user towards given other users
+      # @param ids [Integer]
+      # @return [Mastodon::Collection<Mastodon::Relationship>]
+      def relationships(*ids)
+        perform_request_with_collection(:get, '/api/v1/accounts/relationships', { 'id[]': ids }, Mastodon::Relationship)
+      end
+
+      # Get a list of pending follow requests
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def follow_requests(options = {})
+        perform_request_with_collection(:get, '/api/v1/follow_requests', options, Mastodon::Account)
+      end
+
+      # Authorize a follow request
+      # @param id [Integer]
+      def authorize_follow_request(id)
+        perform_request(:post, "/api/v1/follow_requests/#{id}/authorize")
+      end
+
+      # Reject a follow request
+      # @param id [Integer]
+      def reject_follow_request(id)
+        perform_request(:post, "/api/v1/follow_requests/#{id}/reject")
+      end
+
+      # Follow a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def follow(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/follow", {}, Mastodon::Relationship)
+      end
+
+      # Follow a remote user
+      # @param uri [String] username@domain of the person you want to follow
+      # @return [Mastodon::Account]
+      def remote_follow(uri)
+        perform_request_with_object(:post, '/api/v1/follows', { uri: uri }, Mastodon::Account)
+      end
+
+      # Unfollow a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def unfollow(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/unfollow", {}, Mastodon::Relationship)
+      end
+
+      # Get a list of blocked accounts
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def blocks(options = {})
+        perform_request_with_collection(:get, '/api/v1/blocks', options, Mastodon::Account)
+      end
+
+      # Block a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def block(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/block", {}, Mastodon::Relationship)
+      end
+
+      # Unblock a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def unblock(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/unblock", {}, Mastodon::Relationship)
+      end
+
+      # Get a list of muted accounts
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def mutes(options = {})
+        perform_request_with_collection(:get, '/api/v1/mutes', options, Mastodon::Account)
+      end
+
+      # Mute a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def mute(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/mute", {}, Mastodon::Relationship)
+      end
+
+      # Unmute a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def unmute(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/unmute", {}, Mastodon::Relationship)
+      end
+
+      # Mute notifications for a status
+      # @param id [Integer]
+      # @return [Mastodon::Status]
+      def mute_status(id)
+        perform_request_with_object(:post, "/api/v1/statuses/#{id}/mute", {}, Mastodon::Status)
+      end
+
+      # Unmute notifications for a status
+      # @param id [Integer]
+      # @return [Mastodon::Status]
+      def unmute_status(id)
+        perform_request_with_object(:post, "/api/v1/statuses/#{id}/unmute", {}, Mastodon::Status)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/reports.rb

@@ -0,0 +1,20 @@
+require 'mastodon/rest/utils'
+
+module Mastodon
+  module REST
+    module Reports
+      include Mastodon::REST::Utils
+
+      # Create a report
+      # @param account_id [Integer]
+      # @param params [Hash]
+      # @option params :status_ids [Array<Integer>] Statuses to be included in the report
+      # @option params :comment [String] Description of the report
+      # @option params :forward [Boolean] Whether to forward a copy of the report to the origin of the account
+      def create_report(account_id, params = {})
+        params[:'status_ids[]'] = params.delete(:status_ids) if params.key?(:status_ids)
+        perform_request(:post, '/api/v1/reports', { account_id: account_id }.merge(params))
+      end
+    end
+  end
+end