todon-api 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bfef8b8f59185cd936d9d4936d5047099826bf9a3bd49d9021608f798905588a
+  data.tar.gz: 2e4b6bffc0a0afaeb70ac5c9cb326042720cf5e444fbfb65dcfd90af40137dab
+SHA512:
+  metadata.gz: ffd1a0d8e10d7b226150b2b005ec99ba4bc74650bc2756edc48d1ae3a019168521f43637c3c2f7e158b1e2990e19f8275540f24bd19cec02e73227254dd455cf
+  data.tar.gz: 97ddb307f95f1cad6401187c0f0bece7ab3fedf5b5b2ee61adb068888d2d9768e8b19386485856b8e41c3c0fee7161c8d1e9c74b5bde89b793391951cb6b36c9

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

@@ -0,0 +1,73 @@
+require 'mastodon/emoji'
+require 'mastodon/field'
+
+module Mastodon
+  class Account < Mastodon::Base
+    # @!attribute [r] id
+    #   @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
+    #   @return [Integer]
+    # @!attribute [r] following_count
+    #   @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
+
+    collection_attr_reader :emojis, Mastodon::Emoji
+    collection_attr_reader :fields, Mastodon::Field
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/app.rb

@@ -0,0 +1,17 @@
+module Mastodon
+  class App < Mastodon::Base
+    # @!attribute [r] client_id
+    #   @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,
+                       :name,
+                       :website
+  end
+end

data/lib/mastodon/base.rb

@@ -0,0 +1,50 @@
+module Mastodon
+  class Base
+    attr_reader :attributes
+
+    alias to_h    attributes
+    alias to_hash attributes
+
+    def initialize(attributes = {})
+      @attributes = attributes
+    end
+
+    class << self
+      def normal_attr_reader(*attributes)
+        attributes.each do |attribute|
+          define_attribute_method(attribute)
+        end
+      end
+
+      def object_attr_reader(attribute, klass)
+        define_method(attribute) do
+          klass.new(@attributes[attribute.to_s])
+        end
+      end
+
+      def collection_attr_reader(attribute, klass)
+        define_method(attribute) do
+          Mastodon::Collection.new(@attributes[attribute.to_s], klass)
+        end
+      end
+
+      def predicate_attr_reader(*attributes)
+        attributes.each do |attribute|
+          define_predicate_method(attribute)
+        end
+      end
+
+      def define_predicate_method(key)
+        define_method("#{key}?") do
+          @attributes[key.to_s]
+        end
+      end
+
+      def define_attribute_method(key)
+        define_method(key) do
+          @attributes[key.to_s]
+        end
+      end
+    end
+  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

@@ -0,0 +1,28 @@
+require 'mastodon/version'
+
+module Mastodon
+  class Client
+    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
+    # @option options :bearer_token [String] OAuth access token for your authenticated user
+    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
+    # @return [String]
+    def user_agent
+      @user_agent ||= "MastodonRubyGem/#{Mastodon::Version}"
+    end
+  end
+end

data/lib/mastodon/collection.rb

@@ -0,0 +1,27 @@
+module Mastodon
+  class Collection
+    include ::Enumerable
+
+    def initialize(items, klass)
+      @collection = items.map { |attributes| klass.new(attributes) }
+    end
+
+    def each(start = 0)
+      return to_enum(:each, start) unless block_given?
+
+      Array(@collection[start..-1]).each do |element|
+        yield(element)
+      end
+
+      self
+    end
+
+    def size
+      @collection.size
+    end
+
+    def last
+      @collection.last
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Mastodon
+  module Entities
+    class Media < Mastodon::Base
+      # @!attribute [r] id
+      #   @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,
+                         :remote_url,
+                         :preview_url,
+                         :type,
+                         :meta,
+                         :description
+    end
+  end
+end

data/lib/mastodon/entities/mention.rb

@@ -0,0 +1,14 @@
+module Mastodon
+  module Entities
+    class Mention < Mastodon::Base
+      # @!attribute [r] id
+      #   @return [String] Account ID
+      # @!attribute [r] acct
+      #   @return [String]
+      # @!attribute [r] url
+      #   @return [String]
+
+      normal_attr_reader :id, :acct, :url
+    end
+  end
+end

data/lib/mastodon/error.rb

@@ -0,0 +1,34 @@
+module Mastodon
+  class Error < StandardError
+    ClientError         = Class.new(self)
+    BadRequest          = Class.new(ClientError)
+    Unauthorized        = Class.new(ClientError)
+    Forbidden           = Class.new(ClientError)
+    UnprocessableEntity = Class.new(ClientError)
+    TooManyRequests     = Class.new(ClientError)
+
+    ServerError         = Class.new(self)
+    InternalServerError = Class.new(ServerError)
+    BadGateway          = Class.new(ServerError)
+    ServiceUnavailable  = Class.new(ServerError)
+    GatewayTimeout      = Class.new(ServerError)
+
+    ERRORS = {
+      400 => Mastodon::Error::BadRequest,
+      401 => Mastodon::Error::Unauthorized,
+      403 => Mastodon::Error::Forbidden,
+      422 => Mastodon::Error::UnprocessableEntity,
+      429 => Mastodon::Error::TooManyRequests,
+      500 => Mastodon::Error::InternalServerError,
+      502 => Mastodon::Error::BadGateway,
+      503 => Mastodon::Error::ServiceUnavailable,
+      504 => Mastodon::Error::GatewayTimeout,
+    }.freeze
+
+    class << self
+      def from_response(body)
+        new(body['error'])
+      end
+    end
+  end
+end

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/headers.rb

@@ -0,0 +1,17 @@
+module Mastodon
+  class Headers
+    # @param client [Mastodon::Client]
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [Hash]
+    def request_headers
+      {
+        user_agent: @client.user_agent,
+        accept: '*/*',
+        authorization: "Bearer #{@client.bearer_token}",
+      }
+    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

@@ -0,0 +1,34 @@
+module Mastodon
+  class Media < Mastodon::Base
+    # @!attribute [r] id
+    #   @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,
+                       :remote_url,
+                       :preview_url,
+                       :text_url,
+                       :meta,
+                       :description
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/notification.rb

@@ -0,0 +1,30 @@
+module Mastodon
+  class Notification < Mastodon::Base
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] type
+    #   @return [String]
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] account
+    #   @return [Mastodon::Account]
+    # @!attribute [r] status
+    #   @return [Mastodon::Status]
+
+    normal_attr_reader :id, :type, :created_at
+
+    object_attr_reader :account, Mastodon::Account
+    object_attr_reader :status, Mastodon::Status
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+
+    # Does this notification include a status?
+    # @return [Boolean] true if a status is included, false otherwise
+    def status?
+      attributes.key?('status')
+    end
+  end
+end

data/lib/mastodon/relationship.rb

@@ -0,0 +1,41 @@
+module Mastodon
+  class Relationship < Mastodon::Base
+    # @!attribute [r] id
+    #   @return [String] Account ID
+    # @!attribute [r] following?
+    #   @return [Boolean]
+    # @!attribute [r] followed_by?
+    #   @return [Boolean]
+    # @!attribute [r] blocking?
+    #   @return [Boolean]
+    # @!attribute [r] muting?
+    #   @return [Boolean]
+    # @!attribute [r] muting_notifications?
+    #   @return [Boolean]
+    # @!attribute [r] requested?
+    #   @return [Boolean]
+    # @!attribute [r] domain_blocking?
+    #   @return [Boolean]
+    # @!attribute [r] showing_reblogs?
+    #   @return [Boolean]
+    # @!attribute [r] endorsed?
+    #   @return [Boolean]
+
+    normal_attr_reader :id
+
+    predicate_attr_reader :following,
+                          :followed_by,
+                          :blocking,
+                          :muting,
+                          :muting_notifications,
+                          :requested,
+                          :domain_blocking,
+                          :showing_reblogs,
+                          :endorsed
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end