todon-api 2.0.0

data/lib/mastodon/rest/request.rb

@@ -0,0 +1,41 @@
+require 'addressable/uri'
+require 'http'
+require 'oj'
+require 'mastodon/error'
+require 'mastodon/headers'
+
+module Mastodon
+  module REST
+    class Request
+      def initialize(client, request_method, path, options = {})
+        @client         = client
+        @request_method = request_method
+        @uri            = Addressable::URI.parse(@client.base_url + path)
+        @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)
+
+        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
+
+      def fail_or_return(code, body)
+        raise Mastodon::Error::ERRORS[code].from_response(body) if Mastodon::Error::ERRORS.include?(code)
+        body
+      end
+
+      def http_client
+        HTTP.timeout(connect: @client.timeout[:connect], read: @client.timeout[:read], write: @client.timeout[:write])
+      end
+    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

@@ -0,0 +1,124 @@
+require 'mastodon/rest/utils'
+require 'mastodon/status'
+
+module Mastodon
+  module REST
+    module Statuses
+      include Mastodon::REST::Utils
+
+      # Create new status
+      # @param text [String]
+      # @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
+      # @param id [Integer]
+      # @return [Mastodon::Status]
+      def status(id)
+        perform_request_with_object(:get, "/api/v1/statuses/#{id}", {}, Mastodon::Status)
+      end
+
+      # Destroy status
+      # @param id [Integer]
+      # @return [Boolean]
+      def destroy_status(id)
+        !perform_request(:delete, "/api/v1/statuses/#{id}").nil?
+      end
+
+      # Reblog a status
+      # @param id [Integer]
+      # @return [Mastodon::Status]
+      def reblog(id)
+        perform_request_with_object(:post, "/api/v1/statuses/#{id}/reblog", {}, Mastodon::Status)
+      end
+
+      # Undo a reblog of a status
+      # @param id [Integer]
+      # @return [Mastodon::Status]
+      def unreblog(id)
+        perform_request_with_object(:post, "/api/v1/statuses/#{id}/unreblog", {}, Mastodon::Status)
+      end
+
+      # Favourite a status
+      # @param id [Integer]
+      # @return [Mastodon::Status]
+      def favourite(id)
+        perform_request_with_object(:post, "/api/v1/statuses/#{id}/favourite", {}, Mastodon::Status)
+      end
+
+      # Undo a favourite of a status
+      # @param id [Integer]
+      # @return [Mastodon::Status]
+      def unfavourite(id)
+        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)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/suggestions.rb

@@ -0,0 +1,27 @@
+require 'mastodon/rest/utils'
+require 'mastodon/account'
+
+module Mastodon
+  module REST
+    module Suggestions
+      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(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
+end

data/lib/mastodon/rest/timelines.rb

@@ -0,0 +1,60 @@
+require 'mastodon/rest/utils'
+require 'mastodon/status'
+
+module Mastodon
+  module REST
+    module Timelines
+      include Mastodon::REST::Utils
+
+      # Retrieve statuses from the home timeline
+      # @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 = {})
+        perform_request_with_collection(:get, '/api/v1/timelines/home', options, Mastodon::Status)
+      end
+
+      # Retrieve statuses from the public timeline
+      # @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)
+      end
+
+      # Retrieve statuses from a hashtag
+      # @param hashtag [String]
+      # @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

@@ -0,0 +1,40 @@
+require 'mastodon/rest/request'
+
+module Mastodon
+  module REST
+    module Utils
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      def perform_request(request_method, path, options = {})
+        Mastodon::REST::Request.new(self, request_method, path, options).perform
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_request_with_object(request_method, path, options, klass)
+        response = perform_request(request_method, path, options)
+        klass.new(response)
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_request_with_collection(request_method, path, options, klass)
+        response = perform_request(request_method, path, options)
+        Mastodon::Collection.new(response, klass)
+      end
+
+      # Format an array of values into a query param
+      # @param key [Symbol]
+      # @param values [Enumerable]
+      # @return [Array]
+      def array_param(key, values)
+        values.map.with_index { |value, i| ["#{key}[]", value] }
+      end
+    end
+  end
+end

data/lib/mastodon/results.rb

@@ -0,0 +1,18 @@
+require 'mastodon/account'
+require 'mastodon/status'
+require 'mastodon/hashtag'
+
+module Mastodon
+  class Results < Mastodon::Base
+    # @!attribute [r] accounts
+    #   @return [Mastodon::Collection<Mastodon::Account>]
+    # @!attribute [r] statuses
+    #   @return [Mastodon::Collection<Mastodon::Status>]
+    # @!attribute [r] hashtags
+    #   @return [Mastodon::Collection<Mastodon::Hashtag>]
+
+    collection_attr_reader :accounts, Mastodon::Account
+    collection_attr_reader :statuses, Mastodon::Status
+    collection_attr_reader :hashtags, Mastodon::Hashtag
+  end
+end

data/lib/mastodon/scheduled_status.rb

@@ -0,0 +1,25 @@
+require 'mastodon/entities/media'
+
+module Mastodon
+  class ScheduledStatus < Mastodon::Base
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] scheduled_at
+    #   @return [String]
+    # @!attribute [r] params
+    #   @return [Hash]
+    # @!attribute [r] media_attachments
+    #   @return [Mastodon::Collection<Mastodon::Entities::Media>]
+
+    normal_attr_reader :id,
+                       :scheduled_at,
+                       :params
+
+    collection_attr_reader :media_attachments, Mastodon::Entities::Media
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/status.rb

@@ -0,0 +1,96 @@
+require 'mastodon/account'
+require 'mastodon/entities/media'
+require 'mastodon/entities/mention'
+require 'mastodon/entities/app'
+require 'mastodon/entities/hashtag'
+require 'mastodon/emoji'
+require 'mastodon/card'
+
+module Mastodon
+  class Status < Mastodon::Base
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] in_reply_to_id
+    #   @return [String]
+    # @!attribute [r] in_reply_to_account_id
+    #   @return [String]
+    # @!attribute [r] spoiler_text
+    #   @return [String]
+    # @!attribute [r] content
+    #   @return [String]
+    # @!attribute [r] url
+    #   @return [String]
+    # @!attribute [r] uri
+    #   @return [String]
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] reblogs_count
+    #   @return [Integer]
+    # @!attribute [r] favourites_count
+    #   @return [Integer]
+    # @!attribute [r] visibility
+    #   @return [String]
+    # @!attribute [r] language
+    #   @return [String]
+    # @!attribute [r] account
+    #   @return [Mastodon::Account]
+    # @!attribute [r] reblog
+    #   @return [Mastodon::Status]
+    # @!attribute [r] application
+    #   @return [Mastodon::Entities::App]
+    # @!attribute [r] favourited?
+    #   @return [Boolean]
+    # @!attribute [r] reblogged?
+    #   @return [Boolean]
+    # @!attribute [r] sensitive?
+    #   @return [Boolean]
+    # @!attribute [r] muted?
+    #   @return [Boolean]
+    # @!attribute [r] pinned?
+    #   @return [Boolean]
+    # @!attribute [r] media_attachments
+    #   @return [Mastodon::Collection<Mastodon::Entities::Media>]
+    # @!attribute [r] mentions
+    #   @return [Mastodon::Collection<Mastodon::Entities::Mention>]
+    # @!attribute [r] tags
+    #   @return [Mastodon::Collection<Mastodon::Entities::Hashtag>]
+    # @!attribute [r] emojis
+    #   @return [Mastodon::Collection<Mastodon::Emoji>]
+    # @!attribute [r] card
+    #   @return [Mastodon::Card]
+
+    normal_attr_reader :id,
+                       :content,
+                       :in_reply_to_id,
+                       :in_reply_to_account_id,
+                       :url,
+                       :uri,
+                       :created_at,
+                       :reblogs_count,
+                       :favourites_count,
+                       :visibility,
+                       :spoiler_text,
+                       :language
+
+    predicate_attr_reader :favourited,
+                          :reblogged,
+                          :sensitive,
+                          :muted,
+                          :pinned
+
+    object_attr_reader :account, Mastodon::Account
+    object_attr_reader :reblog, Mastodon::Status
+    object_attr_reader :application, Mastodon::Entities::App
+    object_attr_reader :card, Mastodon::Card
+
+    collection_attr_reader :media_attachments, Mastodon::Entities::Media
+    collection_attr_reader :mentions, Mastodon::Entities::Mention
+    collection_attr_reader :emojis, Mastodon::Emoji
+    collection_attr_reader :tags, Mastodon::Entities::Hashtag
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/streaming/client.rb

@@ -0,0 +1,97 @@
+require 'http/request'
+require 'mastodon/client'
+require 'mastodon/streaming/connection'
+require 'mastodon/streaming/message_parser'
+require 'mastodon/streaming/response'
+
+module Mastodon
+  module Streaming
+    class Client < Mastodon::Client
+      attr_writer :connection
+
+      # Initializes a new Client object
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :tcp_socket_class A class that Connection will use to create a new TCP socket.
+      # @option options [String] :ssl_socket_class A class that Connection will use to create a new SSL socket.
+      # @return [Mastodon::Streaming::Client]
+      def initialize(options = {})
+        super
+        options[:using_ssl] ||= base_url =~ /^https/
+        @connection = Streaming::Connection.new(options)
+      end
+
+      # Streams messages for a single user
+      #
+      # @yield [Mastodon::Status, Mastodon::Notification, Mastodon::Streaming::Events::StatusDelete, Mastodon::Streaming::Events::FiltersChange] A stream of Mastodon objects.
+      def user(**options, &block)
+        stream('user', **options, &block)
+      end
+
+      # Returns statuses that contain the specified hashtag
+      #
+      # @yield [Mastodon::Status, Mastodon::Streaming::Events::StatusDelete] A stream of Mastodon objects.
+      def hashtag(tag, **options, &block)
+        stream('hashtag', **{ tag: tag, **options}, &block)
+      end
+
+      # Returns all public statuses
+      #
+      # @yield [Mastodon::Status, Mastodon::Streaming::Events::StatusDelete] A stream of Mastodon objects.
+      def public(**options, &block)
+        stream('public', **options, &block)
+      end
+
+      # Returns conversations for a single user
+      #
+      # @yield [Mastodon::Conversation] A stream of Mastodon objects.
+      def direct(**options, &block)
+        stream('direct', options, &block)
+      end
+
+      #
+      # Calls an arbitrary streaming endpoint and returns the results
+      # @yield [Mastodon::Status, Mastodon::Notification, Mastodon::Streaming::DeletedStatus] A stream of Mastodon objects.
+      def stream(path, **options, &block)
+        request(:get, "/api/v1/streaming/#{path}", **options, &block)
+      end
+
+      # Set a Proc to be run when connection established.
+      def before_request(&block)
+        if block_given?
+          @before_request = block
+          self
+        elsif instance_variable_defined?(:@before_request)
+          @before_request
+        else
+          proc {}
+        end
+      end
+
+      private
+
+
+      def request(method, path, **params)
+        before_request.call
+
+        uri     = Addressable::URI.parse(base_url + path)
+        headers = Mastodon::Headers.new(self).request_headers
+        request = HTTP::Request.new(verb: method, uri: uri + '?' + to_url_params(params), headers: headers)
+
+        response = Streaming::Response.new do |type, data|
+          if item = Streaming::MessageParser.parse(type, data) # rubocop:disable AssignmentInCondition
+            yield(item)
+          end
+        end
+
+        @connection.stream(request, response)
+      end
+
+      def to_url_params(params)
+        uri = Addressable::URI.new
+        uri.query_values = params
+        uri.query
+      end
+    end
+  end
+end

data/lib/mastodon/streaming/connection.rb

@@ -0,0 +1,44 @@
+require 'openssl'
+require 'resolv'
+
+module Mastodon
+  module Streaming
+    class Connection
+      attr_reader :tcp_socket_class, :ssl_socket_class
+
+      def initialize(options = {})
+        @tcp_socket_class = options.fetch(:tcp_socket_class) { TCPSocket }
+        @ssl_socket_class = options.fetch(:ssl_socket_class) { OpenSSL::SSL::SSLSocket }
+        @using_ssl        = options.fetch(:using_ssl)        { false }
+      end
+
+      def stream(request, response)
+        client = connect(request)
+
+        request.stream(client)
+
+        while body = client.readpartial(1024) # rubocop:disable AssignmentInCondition
+          response << body
+        end
+      end
+
+      def connect(request)
+        client = new_tcp_socket(request.socket_host, request.socket_port)
+
+        return client if !@using_ssl || (!@using_ssl && request.using_proxy?)
+
+        client_context      = OpenSSL::SSL::SSLContext.new
+        ssl_client          = @ssl_socket_class.new(client, client_context)
+        ssl_client.hostname = request.socket_host
+
+        ssl_client.connect
+      end
+
+      private
+
+      def new_tcp_socket(host, port)
+        @tcp_socket_class.new(Resolv.getaddress(host), port)
+      end
+    end
+  end
+end

data/lib/mastodon/streaming/events/filters_change.rb

@@ -0,0 +1,7 @@
+module Mastodon
+  module Streaming
+    module Events
+      class FiltersChange; end
+    end
+  end
+end

data/lib/mastodon/streaming/events/status_delete.rb

@@ -0,0 +1,16 @@
+module Mastodon
+  module Streaming
+    module Events
+      class StatusDelete
+        # @!attribute [r] id
+        #   @return [Integer]
+
+        attr_reader :id
+
+        def initialize(id)
+          @id = id.to_i
+        end
+      end
+    end
+  end
+end