mastodon-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc0c9787cd86d495ceab2625291f4aceb8cdc6d6
+  data.tar.gz: 4f93ab9cd2a539f1db0b5d894be11673784a1322
+SHA512:
+  metadata.gz: 8f10d250823c02c2ad8292dcbc524bb22907509e94b3c8586ae98a5027278aa02329aab1644fc0634ad12c850c9759ab31e3412ad193cd96fdd19030df45b6f8
+  data.tar.gz: e9f4fcd13cc8cd60152d174e8cad4a8716c97514c89dfb62081b53477708973ece9f7273830311ca6d5930d2af72d7b91a6d73b4a2a44fcbf9364c9f7f318c47

data/lib/mastodon.rb

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

data/lib/mastodon/account.rb

@@ -0,0 +1,31 @@
+module Mastodon
+  class Account < Mastodon::Base
+    # @!attribute [r] id
+    #   @return [Integer]
+    # @!attribute [r] username
+    #   @return [String]
+    # @!attribute [r] acct
+    #   @return [String]
+    # @!attribute [r] url
+    #   @return [String]
+    # @!attribute [r] avatar
+    #   @return [String]
+    # @!attribute [r] header
+    #   @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]
+
+    normal_attr_reader :id, :username, :acct, :url, :avatar, :header, :note, :followers_count, :following_count, :statuses_count
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/app.rb

@@ -0,0 +1,10 @@
+module Mastodon
+  class App < Mastodon::Base
+    # @!attribute [r] client_id
+    #   @return [String]
+    # @!attribute [r] client_secret
+    #   @return [String]
+
+    normal_attr_reader :client_id, :client_secret
+  end
+end

data/lib/mastodon/base.rb

@@ -0,0 +1,44 @@
+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 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/client.rb

@@ -0,0 +1,21 @@
+require 'mastodon/version'
+
+module Mastodon
+  class Client
+    attr_reader :base_url, :bearer_token
+
+    # @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]
+    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,19 @@
+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
+  end
+end

data/lib/mastodon/error.rb

@@ -0,0 +1,18 @@
+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)
+
+    ERRORS = {
+      400 => Mastodon::Error::BadRequest,
+      401 => Mastodon::Error::Unauthorized,
+      403 => Mastodon::Error::Forbidden,
+      422 => Mastodon::Error::UnprocessableEntity,
+      429 => Mastodon::Error::TooManyRequests
+    }.freeze
+  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/relationship.rb

@@ -0,0 +1,11 @@
+module Mastodon
+  class Relationship < Mastodon::Base
+    normal_attr_reader :id
+    predicate_attr_reader :following, :followed_by, :blocking
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/rest/accounts.rb

@@ -0,0 +1,44 @@
+require 'mastodon/rest/utils'
+require 'mastodon/account'
+
+module Mastodon
+  module REST
+    module Accounts
+      include Mastodon::REST::Utils
+
+      # Retrieve account of authenticated user
+      # @return [Mastodon::Account]
+      def verify_credentials
+        perform_request_with_object(:get, '/api/v1/accounts/verify_credentials', {}, Mastodon::Account)
+      end
+
+      # Retrieve account
+      # @param id [Integer]
+      # @return [Mastodon::Account]
+      def account(id)
+        perform_request_with_object(:get, "/api/v1/accounts/#{id}", {}, Mastodon::Account)
+      end
+
+      # Get a list of followers
+      # @param id [Integer]
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def followers(id)
+        perform_request_with_collection(:get, "/api/v1/accounts/#{id}/followers", {}, Mastodon::Account)
+      end
+
+      # Get a list of followed accounts
+      # @param id [Integer]
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def following(id)
+        perform_request_with_collection(:get, "/api/v1/accounts/#{id}/following", {}, Mastodon::Account)
+      end
+
+      # Follow a remote user
+      # @param uri [String] The URI of the remote user, in the format of username@domain
+      # @return [Mastodon::Account]
+      def follow_by_uri(uri)
+        perform_request_with_object(:post, "/api/v1/follows", { uri: uri }, Mastodon::Account)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/api.rb

@@ -0,0 +1,21 @@
+require 'mastodon/rest/statuses'
+require 'mastodon/rest/accounts'
+require 'mastodon/rest/timelines'
+require 'mastodon/rest/relationships'
+require 'mastodon/rest/media'
+require 'mastodon/rest/suggestions'
+require 'mastodon/rest/apps'
+
+module Mastodon
+  module REST
+    module API
+      include Mastodon::REST::Statuses
+      include Mastodon::REST::Accounts
+      include Mastodon::REST::Timelines
+      include Mastodon::REST::Relationships
+      include Mastodon::REST::Media
+      include Mastodon::REST::Suggestions
+      include Mastodon::REST::Apps
+    end
+  end
+end

data/lib/mastodon/rest/apps.rb

@@ -0,0 +1,18 @@
+require 'mastodon/rest/utils'
+require 'mastodon/app'
+
+module Mastodon
+  module REST
+    module Apps
+      include Mastodon::REST::Utils
+
+      # Register a new OAuth client app on the target instance
+      # @param name [String]
+      # @param redirect_uri [String]
+      # @return [Mastodon::App]
+      def create_app(name, redirect_uri)
+        perform_request_with_object(:post, '/api/v1/apps', { name: name, redirect_uris: redirect_uri }, Mastodon::App)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/client.rb

@@ -0,0 +1,10 @@
+require 'mastodon/client'
+require 'mastodon/rest/api'
+
+module Mastodon
+  module REST
+    class Client < Mastodon::Client
+      include Mastodon::REST::API
+    end
+  end
+end

data/lib/mastodon/rest/media.rb

@@ -0,0 +1,13 @@
+require 'mastodon/rest/utils'
+
+module Mastodon
+  module REST
+    module Media
+      include Mastodon::REST::Utils
+
+      def upload_media(file)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/mastodon/rest/relationships.rb

@@ -0,0 +1,45 @@
+require 'mastodon/rest/utils'
+require 'mastodon/relationship'
+
+module Mastodon
+  module REST
+    module Relationships
+      include Mastodon::REST::Utils
+
+      # Get the relationships of authenticated user towards given other users
+      # @param ids [Integer]
+      # @return [Mastodon::Collection<Mastodon::Relationship>]
+      def relationships(*ids)
+        perform_request_with_collection(:get, '/api/v1/accounts/relationships', { id: ids }, Mastodon::Relationship)
+      end
+
+      # Follow a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def follow(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/follow", {}, Mastodon::Relationship)
+      end
+
+      # Unfollow a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def unfollow(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/unfollow", {}, Mastodon::Relationship)
+      end
+
+      # Block a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def block(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/block", {}, Mastodon::Relationship)
+      end
+
+      # Unblock a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def unblock(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/unblock", {}, Mastodon::Relationship)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/request.rb

@@ -0,0 +1,37 @@
+require 'addressable/uri'
+require 'http'
+require 'json'
+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
+      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)
+      end
+
+      private
+
+      def fail_or_return(code, body)
+        raise Mastodon::Error::ERRORS[code] if Mastodon::Error::ERRORS.include?(code)
+        body
+      end
+
+      def http_client
+        HTTP
+      end
+    end
+  end
+end

data/lib/mastodon/rest/statuses.rb

@@ -0,0 +1,72 @@
+require 'mastodon/rest/utils'
+require 'mastodon/status'
+
+module Mastodon
+  module REST
+    module Statuses
+      include Mastodon::REST::Utils
+
+      # 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", { status: text, in_reply_to_id: in_reply_to_id, media_ids: media_ids }, 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 statuses by a user
+      # @param account_id [Integer]
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :limit [Integer]
+      # @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,16 @@
+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
+      # @return [Mastodon::Collection<Mastodon::Account>]
+      def suggestions
+        perform_request_with_collection(:get, '/api/v1/accounts/suggestions', {}, Mastodon::Account)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/timelines.rb

@@ -0,0 +1,40 @@
+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 :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Status>]
+      def home_timeline(options = {})
+        perform_request_with_collection(:get, '/api/v1/statuses/home', options, Mastodon::Status)
+      end
+
+      # Retrieve statuses from the mentions timeline
+      # @param options [Hash]
+      # @option options :max_id [Integer]
+      # @option options :since_id [Integer]
+      # @option options :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Status>]
+      def mentions_timeline(options = {})
+        perform_request_with_collection(:get, '/api/v1/statuses/mentions', 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 :limit [Integer]
+      # @return [Mastodon::Collection<Mastodon::Status>]
+      def public_timeline(options = {})
+        perform_request_with_collection(:get, '/api/v1/statuses/public', options, Mastodon::Status)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/utils.rb

@@ -0,0 +1,32 @@
+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
+    end
+  end
+end

data/lib/mastodon/status.rb

@@ -0,0 +1,42 @@
+require 'mastodon/account'
+
+module Mastodon
+  class Status < Mastodon::Base
+    # @!attribute [r] id
+    #   @return [Integer]
+    # @!attribute [r] in_reply_to_id
+    #   @return [Integer]
+    # @!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] account
+    #   @return [Mastodon::Account]
+    # @!attribute [r] reblog
+    #   @return [Mastodon::Status]
+    # @!attribute [r] favourited?
+    #   @return [Boolean]
+    # @!attribute [r] reblogged?
+    #   @return [Boolean]
+
+    normal_attr_reader :id, :content, :in_reply_to_id, :url, :uri, :created_at, :reblogs_count, :favourites_count
+
+    predicate_attr_reader :favourited, :reblogged
+
+    object_attr_reader :account, Mastodon::Account
+    object_attr_reader :reblog, Mastodon::Status
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/version.rb

@@ -0,0 +1,29 @@
+module Mastodon
+  module Version
+    module_function
+
+    def major
+      0
+    end
+
+    def minor
+      0
+    end
+
+    def patch
+      1
+    end
+
+    def pre
+      nil
+    end
+
+    def to_a
+      [major, minor, patch, pre].compact
+    end
+
+    def to_s
+      to_a.join('.')
+    end
+  end
+end

data/mastodon.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mastodon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mastodon-api'
+  spec.description   = 'A ruby interface to the Mastodon API'
+  spec.homepage      = 'https://github.com/Gargron/mastodon-api'
+  spec.email         = 'eugen@zeonfederated.com'
+  spec.authors       = ['Eugen Rochko']
+  spec.summary       = spec.description
+  spec.licenses      = %w(MIT)
+  spec.files         = %w(mastodon.gemspec) + Dir['lib/**/*.rb']
+  spec.require_paths = %w(lib)
+  spec.version       = Mastodon::Version
+
+  spec.add_dependency 'http', '~> 2.0'
+  spec.add_dependency 'addressable', '~> 2.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.0'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: mastodon-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eugen Rochko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A ruby interface to the Mastodon API
+email: eugen@zeonfederated.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mastodon.rb
+- lib/mastodon/account.rb
+- lib/mastodon/app.rb
+- lib/mastodon/base.rb
+- lib/mastodon/client.rb
+- lib/mastodon/collection.rb
+- lib/mastodon/error.rb
+- lib/mastodon/headers.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/media.rb
+- lib/mastodon/rest/relationships.rb
+- lib/mastodon/rest/request.rb
+- lib/mastodon/rest/statuses.rb
+- lib/mastodon/rest/suggestions.rb
+- lib/mastodon/rest/timelines.rb
+- lib/mastodon/rest/utils.rb
+- lib/mastodon/status.rb
+- lib/mastodon/version.rb
+- mastodon.gemspec
+homepage: https://github.com/Gargron/mastodon-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby interface to the Mastodon API
+test_files: []