mastodon-api 1.1.0 → 2.0.0

data/lib/mastodon/rest/media.rb

@@ -7,10 +7,24 @@ module Mastodon
       include Mastodon::REST::Utils
 
       # Upload a media file
-      # @param file [HTTP::FormData::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)
-        perform_request_with_object(:post, '/api/v1/media', { file: file }, 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/#{media_id}", params, Mastodon::Media)
       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

@@ -1,5 +1,6 @@
 require 'mastodon/rest/utils'
 require 'mastodon/relationship'
+require 'mastodon/status'
 
 module Mastodon
   module REST
@@ -10,7 +11,30 @@ module Mastodon
       # @param ids [Integer]
       # @return [Mastodon::Collection<Mastodon::Relationship>]
       def relationships(*ids)
-        perform_request_with_collection(:get, '/api/v1/accounts/relationships', array_param(:id, ids), Mastodon::Relationship)
+        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
@@ -20,6 +44,13 @@ module Mastodon
         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]
@@ -27,6 +58,17 @@ module Mastodon
         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]
@@ -41,6 +83,17 @@ module Mastodon
         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]
@@ -54,6 +107,20 @@ module Mastodon
       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

data/lib/mastodon/rest/request.rb

@@ -1,6 +1,6 @@
 require 'addressable/uri'
 require 'http'
-require 'json'
+require 'oj'
 require 'mastodon/error'
 require 'mastodon/headers'
 
@@ -14,12 +14,16 @@ module Mastodon
         @headers        = Mastodon::Headers.new(@client).request_headers
         @path           = @uri.path
         @options        = options
+        @headers        = @options.delete(:headers).merge @headers if @options.is_a?(Hash) && @options[:headers]
       end
 
       def perform
         options_key = @request_method == :get ? :params : :form
         response    = http_client.headers(@headers).public_send(@request_method, @uri.to_s, options_key => @options)
-        fail_or_return(response.code, response.body.empty? ? '' : response.parse)
+
+        STDERR.puts response.body if ENV['DEBUG'] == 'true'
+
+        fail_or_return(response.code, response.body.empty? ? '' : Oj.load(response.to_s, mode: :null))
       end
 
       private
@@ -30,7 +34,7 @@ module Mastodon
       end
 
       def http_client
-        HTTP
+        HTTP.timeout(:per_operation, connect: @client.timeout[:connect], read: @client.timeout[:read], write: @client.timeout[:write])
       end
     end
   end

data/lib/mastodon/rest/scheduled_statuses.rb

@@ -0,0 +1,43 @@
+require 'mastodon/rest/utils'
+require 'mastodon/scheduled_status'
+
+module Mastodon
+  module REST
+    module ScheduledStatuses
+      include Mastodon::REST::Utils
+
+      # Get a list of scheduled statuses
+      # @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::ScheduledStatus>]
+      def scheduled_statuses(options = {})
+        perform_request_with_collection(:get, '/api/v1/scheduled_statuses', options, Mastodon::ScheduledStatus)
+      end
+
+      # Retrieve a scheduled status
+      # @param id [Integer]
+      # @return [Mastodon::ScheduledStatus]
+      def scheduled_status(id)
+        perform_request_with_object(:get, "/api/v1/scheduled_statuses/#{id}", {}, Mastodon::ScheduledStatus)
+      end
+
+      # Update a scheduled status
+      # @param id [Integer]
+      # @param params [Hash]
+      # @option params :scheduled_at [String]
+      # @return [Mastodon::ScheduledStatus]
+      def update_scheduled_status(id, params = {})
+        perform_request_with_object(:put, "/api/v1/scheduled_statuses/#{id}", params, Mastodon::ScheduledStatus)
+      end
+
+      # Cancel a scheduled status
+      # @param id [Integer]
+      def delete_scheduled_status(id)
+        perform_request(:delete, "/api/v1/scheduled_statuses/#{id}")
+      end
+    end
+  end
+end

data/lib/mastodon/rest/search.rb

@@ -0,0 +1,20 @@
+require 'mastodon/rest/utils'
+require 'mastodon/status'
+
+module Mastodon
+  module REST
+    module Search
+      include Mastodon::REST::Utils
+
+      # Search for content
+      # @param options [Hash]
+      # @option options :q [String] The search query
+      # @option options :resolve [Boolean] Whether to resolve non-local accounts
+      # @option options :limit [Integer]
+      # @return [Mastodon::Results]
+      def search(query, options = {})
+        perform_request_with_object(:get, '/api/v2/search', { q: query }.merge(options), Mastodon::Results)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/statuses.rb

@@ -8,11 +8,20 @@ module Mastodon
 
       # Create new status
       # @param text [String]
-      # @param in_reply_to_id [Integer]
-      # @param media_ids [Array<Integer>]
-      # @return [Mastodon::Status]
-      def create_status(text, in_reply_to_id = nil, media_ids = [])
-        perform_request_with_object(:post, '/api/v1/statuses', array_param(:media_ids, media_ids).merge(status: text, in_reply_to_id: in_reply_to_id), Mastodon::Status)
+      # @param params [Hash]
+      # @option params :in_reply_to_id [Integer]
+      # @option params :media_ids [Array<Integer>]
+      # @option params :visibility [String]
+      # @option params :language [String]
+      # @option params :sensitive [Boolean]
+      # @option params :spoiler_text [String]
+      # @option params :scheduled_at [String]
+      # @return <Mastodon::Status>
+      def create_status(text, params = {})
+        params[:status]        = text
+        params[:'media_ids[]'] = params.delete(:media_ids) if params.key?(:media_ids)
+
+        perform_request_with_object(:post, '/api/v1/statuses', params, Mastodon::Status)
       end
 
       # Retrieve status
@@ -57,12 +66,55 @@ module Mastodon
         perform_request_with_object(:post, "/api/v1/statuses/#{id}/unfavourite", {}, Mastodon::Status)
       end
 
+      # Get a list of accounts that reblogged a toot
+      # @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 reblogged_by(id, options = {})
+        perform_request_with_collection(:get, "/api/v1/statuses/#{id}/reblogged_by", options, Mastodon::Account)
+      end
+
+      # Get a list of accounts that favourited a toot
+      # @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 favourited_by(id, options = {})
+        perform_request_with_collection(:get, "/api/v1/statuses/#{id}/favourited_by", options, Mastodon::Account)
+      end
+
+      # Pin status on own profile
+      # @param id [Integer]
+      # @return [Mastodon::Status]
+      def pin(id)
+        perform_request_with_object(:post, "/api/v1/statuses/#{id}/pin", {}, Mastodon::Status)
+      end
+
+      # Unpin status from own profile
+      # @param id [Integer]
+      # @return [Mastodon::Status]
+      def unpin(id)
+        perform_request_with_object(:post, "/api/v1/statuses/#{id}/unpin", {}, Mastodon::Status)
+      end
+
       # Get a list of statuses by a user
       # @param account_id [Integer]
       # @param options [Hash]
       # @option options :max_id [Integer]
       # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
       # @option options :limit [Integer]
+      # @option options :only_media [Boolean]
+      # @option options :pinned [Boolean]
+      # @option options :exclude_replies [Boolean]
+      # @option options :exclude_reblogs [Boolean]
       # @return [Mastodon::Collection<Mastodon::Status>]
       def statuses(account_id, options = {})
         perform_request_with_collection(:get, "/api/v1/accounts/#{account_id}/statuses", options, Mastodon::Status)

data/lib/mastodon/rest/suggestions.rb

@@ -7,9 +7,20 @@ module Mastodon
       include Mastodon::REST::Utils
 
       # Get "who to follow" suggestions for authenticated user
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :min_id [Boolean]
+      # @option options :limit [Integer]
       # @return [Mastodon::Collection<Mastodon::Account>]
-      def suggestions
-        perform_request_with_collection(:get, '/api/v1/accounts/suggestions', {}, Mastodon::Account)
+      def suggestions(options = {})
+        perform_request_with_collection(:get, '/api/v1/suggestions', options, Mastodon::Account)
+      end
+
+      # Remove a suggestion
+      # @param account_id [Integer]
+      def delete_suggestion(account_id)
+        perform_request(:delete, "/api/v1/suggestions/#{account_id}")
       end
     end
   end

data/lib/mastodon/rest/timelines.rb

@@ -10,6 +10,7 @@ module Mastodon
       # @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::Status>]
       def home_timeline(options = {})
@@ -20,7 +21,10 @@ module Mastodon
       # @param options [Hash]
       # @option options :max_id [Integer]
       # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
       # @option options :limit [Integer]
+      # @option options :local [Boolean]
+      # @option options :only_media [Boolean]
       # @return [Mastodon::Collection<Mastodon::Status>]
       def public_timeline(options = {})
         perform_request_with_collection(:get, '/api/v1/timelines/public', options, Mastodon::Status)
@@ -31,11 +35,26 @@ module Mastodon
       # @param options [Hash]
       # @option options :max_id [Integer]
       # @option options :since_id [Integer]
+      # @option options :min_id [Integer]
       # @option options :limit [Integer]
+      # @option options :local [Boolean]
+      # @option options :only_media [Boolean]
       # @return [Mastodon::Collection<Mastodon::Status>]
       def hashtag_timeline(hashtag, options = {})
         perform_request_with_collection(:get, "/api/v1/timelines/tag/#{hashtag}", options, Mastodon::Status)
       end
+
+      # Retrieve statuses from a list
+      # @param id [String]
+      # @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::Status>]
+      def list_timeline(id, options = {})
+        perform_request_with_collection(:get, "/api/v1/timelines/list/#{id}", options, Mastodon::Status)
+      end
     end
   end
 end

data/lib/mastodon/rest/utils.rb

@@ -28,12 +28,12 @@ module Mastodon
         Mastodon::Collection.new(response, klass)
       end
 
-      # Format an array of values into a query param hash
+      # Format an array of values into a query param
       # @param key [Symbol]
       # @param values [Enumerable]
-      # @return [Hash]
+      # @return [Array]
       def array_param(key, values)
-        values.map.with_index { |value, i| ["#{key}[#{i}]", value] }.to_h
+        values.map.with_index { |value, i| ["#{key}[]", value] }
       end
     end
   end