mastodon-api 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 041943ed6a812cb1b332f5bc67d9578a1fe8ff1f
-  data.tar.gz: 5dd6f241c077678c79aa39a4943923bc02f8a5fe
+  metadata.gz: 964fc483f0637a71cd58ef1b86f1a94dd31dd3a6
+  data.tar.gz: 3188dfd0d8f30b4cc65f12c8e46548340e324159
 SHA512:
-  metadata.gz: 4d94b3e4745d4b832b8c5a9b04c9422a3262e852c11483fad08460148bb6ee065bc4f3e9756d059ecfff6ed28dc589d14ca3c28e113e524aed55689d1a78804d
-  data.tar.gz: 43faaa2dcd228681f2d07c6be1155fcf84b78183f60f3f7503eec7223e0a96290a2f5b98102154d0c028a80fd553dd9491ad8a531cad2a61eef9c18f2c6968c4
+  metadata.gz: 7ac8a2fcad9cb903a21e699ff33397d0c4976bf4eb26304a5cfb9982dc2e493fef0d6790831d8ee0dd143d65c3681f9090711594930b9f2f905bc2415c54c9e6
+  data.tar.gz: a69549432a0183c1e0d5d5faac7eb8635569c149e903b268058ce78afa7e2e843aa588692ce730e8eb7c7896c0478266e4fd5e5b02582dad3aec40acf1d824f3

data/lib/mastodon.rb

@@ -1,4 +1,6 @@
 require 'addressable/uri'
 require 'mastodon/base'
 require 'mastodon/collection'
+require 'mastodon/results'
 require 'mastodon/rest/client'
+require 'mastodon/streaming/client'

data/lib/mastodon/access_token.rb

@@ -0,0 +1,21 @@
+module Mastodon
+  class AccessToken < Mastodon::Base
+    # @!attribute [r] access_token
+    #   @return [String]
+    # @!attribute [r] token_type
+    #   @return [String]
+    # @!attribute [r] scope
+    #   @return [String]
+    # @!attribute [r] created_at
+    #   @return [String]
+    normal_attr_reader :access_token,
+                       :token_type,
+                       :scope,
+                       :created_at
+
+    def initialize(attributes = {})
+      attributes.fetch('access_token')
+      super
+    end
+  end
+end

data/lib/mastodon/account.rb

@@ -1,17 +1,26 @@
+require 'mastodon/emoji'
+require 'mastodon/field'
+
 module Mastodon
   class Account < Mastodon::Base
     # @!attribute [r] id
-    #   @return [Integer]
+    #   @return [String]
     # @!attribute [r] username
     #   @return [String]
     # @!attribute [r] acct
     #   @return [String]
+    # @!attribute [r] display_name
+    #   @return [String]
     # @!attribute [r] url
     #   @return [String]
     # @!attribute [r] avatar
     #   @return [String]
+    # @!attribute [r] avatar_static
+    #   @return [String]
     # @!attribute [r] header
     #   @return [String]
+    # @!attribute [r] header_static
+    #   @return [String]
     # @!attribute [r] note
     #   @return [String]
     # @!attribute [r] followers_count
@@ -20,8 +29,41 @@ module Mastodon
     #   @return [Integer]
     # @!attribute [r] statuses_count
     #   @return [Integer]
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] locked?
+    #   @return [Boolean]
+    # @!attribute [r] bot?
+    #   @return [Boolean]
+    # @!attribute [r] moved
+    #   @return [Mastodon::Account]
+    # @!attribute [r] emojis
+    #   @return [Mastodon::Collection<Mastodon::Emoji>]
+    # @!attribute [r] fields
+    #   @return [Mastodon::Collection<Mastodon::Field>]
+
+    normal_attr_reader :id,
+                       :username,
+                       :acct,
+                       :display_name,
+                       :created_at,
+                       :url,
+                       :avatar,
+                       :avatar_static,
+                       :header,
+                       :header_static,
+                       :note,
+                       :followers_count,
+                       :following_count,
+                       :statuses_count
+
+    predicate_attr_reader :locked,
+                          :bot
+
+    object_attr_reader :moved, Mastodon::Account
 
-    normal_attr_reader :id, :username, :acct, :url, :avatar, :header, :note, :followers_count, :following_count, :statuses_count
+    collection_attr_reader :emojis, Mastodon::Emoji
+    collection_attr_reader :fields, Mastodon::Field
 
     def initialize(attributes = {})
       attributes.fetch('id')

data/lib/mastodon/app.rb

@@ -4,7 +4,14 @@ module Mastodon
     #   @return [String]
     # @!attribute [r] client_secret
     #   @return [String]
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] website
+    #   @return [String]
 
-    normal_attr_reader :client_id, :client_secret
+    normal_attr_reader :client_id,
+                       :client_secret,
+                       :name,
+                       :website
   end
 end

data/lib/mastodon/card.rb

@@ -0,0 +1,41 @@
+module Mastodon
+  class Card < Mastodon::Base
+    # @!attribute [r] url
+    #   @return [String]
+    # @!attribute [r] title
+    #   @return [String]
+    # @!attribute [r] description
+    #   @return [String]
+    # @!attribute [r] image
+    #   @return [String]
+    # @!attribute [r] type
+    #   @return [String]
+    # @!attribute [r] author_name
+    #   @return [String]
+    # @!attribute [r] author_url
+    #   @return [String]
+    # @!attribute [r] provider_name
+    #   @return [String]
+    # @!attribute [r] provider_url
+    #   @return [String]
+    # @!attribute [r] html
+    #   @return [String]
+    # @!attribute [r] width
+    #   @return [String]
+    # @!attribute [r] height
+    #   @return [String]
+
+    normal_attr_reader :url,
+                       :title,
+                       :description,
+                       :image,
+                       :type,
+                       :author_name,
+                       :author_url,
+                       :provider_name,
+                       :provider_url,
+                       :html,
+                       :width,
+                       :height
+  end
+end

data/lib/mastodon/client.rb

@@ -2,7 +2,13 @@ require 'mastodon/version'
 
 module Mastodon
   class Client
-    attr_reader :base_url, :bearer_token
+    DEFAULT_TIMEOUT = {
+      connect: 2,
+      read: 5,
+      write: 20,
+    }.freeze
+
+    attr_reader :base_url, :bearer_token, :timeout
 
     # @param options [Hash]
     # @option options :base_url [String] URL of the instance you want to connect to
@@ -10,6 +16,7 @@ module Mastodon
     def initialize(options = {})
       @base_url     = options[:base_url]
       @bearer_token = options[:bearer_token]
+      @timeout      = DEFAULT_TIMEOUT.merge(options[:timeout] || {})
     end
 
     # User agent of the client

data/lib/mastodon/conversation.rb

@@ -0,0 +1,25 @@
+require 'mastodon/account'
+require 'mastodon/status'
+
+module Mastodon
+  class Conversation < Mastodon::Base
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] unread?
+    #   @return [Boolean]
+    # @!attribute [r] accounts
+    #   @return [Mastodon::Collection<Mastodon::Account>]
+    # @!attribute [r] last_status
+    #   @return [Mastodon::Status]
+
+    normal_attr_reader :id
+    predicate_attr_reader :unread
+    collection_attr_reader :accounts, Mastodon::Account
+    object_attr_reader :last_status, Mastodon::Status
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/emoji.rb

@@ -0,0 +1,21 @@
+module Mastodon
+  class Emoji < Mastodon::Base
+    # @!attribute [r] shortcode
+    #   @return [String]
+    # @!attribute [r] static_url
+    #   @return [String]
+    # @!attribute [r] url
+    #   @return [String]
+    # @!attribute [r] visible_in_picker?
+    #   @return [Boolean]
+
+    normal_attr_reader :shortcode, :static_url, :url
+
+    predicate_attr_reader :visible_in_picker
+
+    def initialize(attributes = {})
+      attributes.fetch('shortcode')
+      super
+    end
+  end
+end

data/lib/mastodon/entities/app.rb

@@ -0,0 +1,12 @@
+module Mastodon
+  module Entities
+    class App < Mastodon::Base
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] website
+      #   @return [String]
+
+      normal_attr_reader :name, :website
+    end
+  end
+end

data/lib/mastodon/entities/hashtag.rb

@@ -0,0 +1,12 @@
+module Mastodon
+  module Entities
+    class Hashtag < Mastodon::Base
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] url
+      #   @return [String]
+
+      normal_attr_reader :name, :url
+    end
+  end
+end

data/lib/mastodon/entities/media.rb

@@ -5,12 +5,24 @@ module Mastodon
       #   @return [Integer]
       # @!attribute [r] url
       #   @return [String]
+      # @!attribute [r] remote_url
+      #   @return [String]
       # @!attribute [r] preview_url
       #   @return [String]
       # @!attribute [r] type
       #   @return [String]
+      # @!attribute [r] meta
+      #   @return [Hash]
+      # @!attribute [r] description
+      #   @return [String]
 
-      normal_attr_reader :id, :url, :preview_url, :type
+      normal_attr_reader :id,
+                         :url,
+                         :remote_url,
+                         :preview_url,
+                         :type,
+                         :meta,
+                         :description
     end
   end
 end

data/lib/mastodon/entities/mention.rb

@@ -2,7 +2,7 @@ module Mastodon
   module Entities
     class Mention < Mastodon::Base
       # @!attribute [r] id
-      #   @return [Integer] Account ID
+      #   @return [String] Account ID
       # @!attribute [r] acct
       #   @return [String]
       # @!attribute [r] url

data/lib/mastodon/field.rb

@@ -0,0 +1,18 @@
+module Mastodon
+  class Field < Mastodon::Base
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] value
+    #   @return [String]
+    # @!attribute [r] verified_at
+    #   @return [String]
+
+    normal_attr_reader :name, :value, :verified_at
+
+    # Is this field a verified link?
+    # @return [Boolean]
+    def verified?
+      attributes['verified_at'].present?
+    end
+  end
+end

data/lib/mastodon/filter.rb

@@ -0,0 +1,29 @@
+module Mastodon
+  class Filter < Mastodon::Base
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] phrase
+    #   @return [String]
+    # @!attribute [r] context
+    #   @return [Array<String>]
+    # @!attribute [r] expires_at
+    #   @return [String]
+    # @!attribute [r] irreversible?
+    #   @return [Boolean]
+    # @!attribute [r] whole_word?
+    #   @return [Boolean]
+
+    normal_attr_reader :id,
+                       :phrase,
+                       :context,
+                       :expires_at
+
+    predicate_attr_reader :irreversible,
+                          :whole_word
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/hashtag.rb

@@ -0,0 +1,19 @@
+module Mastodon
+  class Hashtag < Mastodon::Base
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] url
+    #   @return [String]
+    # @!attribute [r] history
+    #   @return [Array<Hash>]
+
+    normal_attr_reader :name,
+                       :url,
+                       :history
+
+    def initialize(attributes = {})
+      attributes.fetch('name')
+      super
+    end
+  end
+end

data/lib/mastodon/instance.rb

@@ -0,0 +1,33 @@
+module Mastodon
+  class Instance < Mastodon::Base
+    # @!attribute [r] uri
+    #   @return [String]
+    # @!attribute [r] title
+    #   @return [String]
+    # @!attribute [r] description
+    #   @return [String]
+    # @!attribute [r] email
+    #   @return [String]
+    # @!attribute [r] version
+    #   @return [String]
+    # @!attribute [r] urls
+    #   @return [Hash]
+    # @!attribute [r] stats
+    #   @return [Hash]
+    # @!attribute [r] languages
+    #   @return [Array<String>]
+    # @!attribute [r] contact_account
+    #   @return [Mastodon::Account]
+
+    normal_attr_reader :uri,
+                       :title,
+                       :description,
+                       :email,
+                       :version,
+                       :urls,
+                       :stats,
+                       :languages
+
+    object_attr_reader :contact_account, Mastodon::Account
+  end
+end

data/lib/mastodon/list.rb

@@ -0,0 +1,15 @@
+module Mastodon
+  class List < Mastodon::Base
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] title
+    #   @return [String]
+
+    normal_attr_reader :id, :title
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/media.rb

@@ -1,20 +1,34 @@
 module Mastodon
   class Media < Mastodon::Base
     # @!attribute [r] id
-    #   @return [Integer]
+    #   @return [String]
     # @!attribute [r] type
     #   @return [String] Image or video
     # @!attribute [r] url
     #   @return [String] Full file URL
+    # @!attribute [r] remote_url
+    #   @return [String]
     # @!attribute [r] preview_url
     #   @return [String] URL to preview image
     # @!attribute [r] text_url
     #   @return [String] URL that can be put into status body and will redirect to the status/media
+    # @!attribute [r] meta
+    #   @return [Hash]
+    # @!attribute [r] description
+    #   @return [String]
 
-    normal_attr_reader :id, :type, :url, :preview_url, :text_url
+    normal_attr_reader :id,
+                       :type,
+                       :url,
+                       :remote_url,
+                       :preview_url,
+                       :text_url,
+                       :meta,
+                       :description
 
     def initialize(attributes = {})
       attributes.fetch('id')
+      super
     end
   end
 end