mastodon-api 1.1.0 → 2.0.0

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

@@ -1,13 +1,21 @@
 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 [Integer]
+    #   @return [String]
     # @!attribute [r] in_reply_to_id
-    #   @return [Integer]
+    #   @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
@@ -20,28 +28,65 @@ module Mastodon
     #   @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, :url, :uri, :created_at, :reblogs_count, :favourites_count
+    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
+    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')

data/lib/mastodon/streaming/client.rb

@@ -0,0 +1,96 @@
+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 }.merge(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 'http/parser'
+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.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

data/lib/mastodon/streaming/message_parser.rb

@@ -0,0 +1,23 @@
+require 'mastodon/status'
+require 'mastodon/conversation'
+require 'mastodon/streaming/events/filters_change'
+require 'mastodon/streaming/events/status_delete'
+
+module Mastodon
+  module Streaming
+    class MessageParser
+      MESSAGE_TYPES = {
+        'update' => Status,
+        'notification' => Notification,
+        'conversation' => Conversation,
+        'delete' => Events::StatusDelete,
+        'filters_changed' => Events::FiltersChange,
+      }.freeze
+
+      def self.parse(type, data)
+        klass = MESSAGE_TYPES[type]
+        klass.new(data) if klass
+      end
+    end
+  end
+end

data/lib/mastodon/streaming/response.rb

@@ -0,0 +1,42 @@
+require 'buftok'
+require 'http'
+require 'json'
+require 'mastodon/error'
+
+module Mastodon
+  module Streaming
+    class Response
+      # Initializes a new Response object
+      #
+      # @return [Mastodon::Streaming::Response]
+      def initialize(&block)
+        @block     = block
+        @parser    = Http::Parser.new(self)
+        @tokenizer = BufferedTokenizer.new("\n\n")
+        @match = Regexp.new(/event: ([a-z]+)\ndata: (.+)/m)
+      end
+
+      def <<(data)
+        @parser << data
+      end
+
+      # @note this does get called
+      def on_headers_complete(_headers)
+        error = Mastodon::Error::ERRORS[@parser.status_code]
+        raise error if error
+      end
+
+      def on_body(data)
+        @tokenizer.extract(data).each do |line|
+          has_data = @match.match(line)
+          next if has_data.nil?
+
+          type = has_data[1]
+          data = has_data[2]
+
+          @block.call(type, JSON.parse(data))
+        end
+      end
+    end
+  end
+end

data/lib/mastodon/version.rb

@@ -3,11 +3,11 @@ module Mastodon
     module_function
 
     def major
-      1
+      2
     end
 
     def minor
-      1
+      0
     end
 
     def patch

data/mastodon.gemspec

@@ -14,8 +14,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w(lib)
   spec.version       = Mastodon::Version
 
-  spec.add_dependency 'http', '~> 2.0'
-  spec.add_dependency 'addressable', '~> 2.4'
+  spec.add_dependency 'http', '~> 3.3'
+  spec.add_dependency 'oj', '~> 3.7'
+  spec.add_dependency 'addressable', '~> 2.6'
+  spec.add_dependency 'buftok', '~> 0'
 
-  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mastodon-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Eugen Rochko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,42 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: buftok
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.7'
 description: A ruby interface to the Mastodon API
 email: eugen@zeonfederated.com
 executables: []
@@ -59,29 +87,60 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/mastodon.rb
+- lib/mastodon/access_token.rb
 - lib/mastodon/account.rb
 - lib/mastodon/app.rb
 - lib/mastodon/base.rb
+- lib/mastodon/card.rb
 - lib/mastodon/client.rb
 - lib/mastodon/collection.rb
+- lib/mastodon/conversation.rb
+- lib/mastodon/emoji.rb
+- lib/mastodon/entities/app.rb
+- lib/mastodon/entities/hashtag.rb
 - lib/mastodon/entities/media.rb
 - lib/mastodon/entities/mention.rb
 - lib/mastodon/error.rb
+- lib/mastodon/field.rb
+- lib/mastodon/filter.rb
+- lib/mastodon/hashtag.rb
 - lib/mastodon/headers.rb
+- lib/mastodon/instance.rb
+- lib/mastodon/list.rb
 - lib/mastodon/media.rb
+- lib/mastodon/notification.rb
 - lib/mastodon/relationship.rb
 - lib/mastodon/rest/accounts.rb
 - lib/mastodon/rest/api.rb
 - lib/mastodon/rest/apps.rb
 - lib/mastodon/rest/client.rb
+- lib/mastodon/rest/conversations.rb
+- lib/mastodon/rest/custom_emojis.rb
+- lib/mastodon/rest/domain_blocks.rb
+- lib/mastodon/rest/endorsements.rb
+- lib/mastodon/rest/filters.rb
+- lib/mastodon/rest/instances.rb
+- lib/mastodon/rest/lists.rb
 - lib/mastodon/rest/media.rb
+- lib/mastodon/rest/notifications.rb
 - lib/mastodon/rest/relationships.rb
+- lib/mastodon/rest/reports.rb
 - lib/mastodon/rest/request.rb
+- lib/mastodon/rest/scheduled_statuses.rb
+- lib/mastodon/rest/search.rb
 - lib/mastodon/rest/statuses.rb
 - lib/mastodon/rest/suggestions.rb
 - lib/mastodon/rest/timelines.rb
 - lib/mastodon/rest/utils.rb
+- lib/mastodon/results.rb
+- lib/mastodon/scheduled_status.rb
 - lib/mastodon/status.rb
+- lib/mastodon/streaming/client.rb
+- lib/mastodon/streaming/connection.rb
+- lib/mastodon/streaming/events/filters_change.rb
+- lib/mastodon/streaming/events/status_delete.rb
+- lib/mastodon/streaming/message_parser.rb
+- lib/mastodon/streaming/response.rb
 - lib/mastodon/version.rb
 - mastodon.gemspec
 homepage: https://github.com/tootsuite/mastodon-api
@@ -104,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A ruby interface to the Mastodon API