moostodon 0.1.0

data/lib/mastodon/list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+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,37 @@
+# frozen_string_literal: true
+
+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,32 @@
+# frozen_string_literal: true
+
+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,38 @@
+# frozen_string_literal: true
+
+module Mastodon
+  # Relationships. Purpose still to be found out (by Maxine Michalski)
+  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]
+
+    normal_attr_reader :id
+
+    predicate_attr_reader :following,
+                          :followed_by,
+                          :blocking,
+                          :muting,
+                          :muting_notifications,
+                          :requested,
+                          :domain_blocking
+
+    def initialize(attributes = {})
+      attributes.fetch('id')
+      super
+    end
+  end
+end

data/lib/mastodon/rest/accounts.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+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
+
+      # Update authenticated account attributes
+      # @param options [Hash]
+      # @option options display_name [String] The name to display in the
+      #   user's profile
+      # @option options note [String] A new biography for the user
+      # @option options avatar [String] A base64 encoded image to display as
+      #   the user's avatar
+      # @option options header [String] A base64 encoded image to display as
+      #   the user's header image
+      # @return [Mastodon::Account]
+      def update_credentials(opts = {})
+        perform_request_with_object(:patch,
+                                    '/api/v1/accounts/update_credentials',
+                                    opts, 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,29 @@
+# frozen_string_literal: true
+
+require 'mastodon/rest/statuses'
+require 'mastodon/rest/accounts'
+require 'mastodon/rest/timelines'
+require 'mastodon/rest/notifications'
+require 'mastodon/rest/search'
+require 'mastodon/rest/relationships'
+require 'mastodon/rest/media'
+require 'mastodon/rest/suggestions'
+require 'mastodon/rest/apps'
+require 'mastodon/rest/instances'
+
+module Mastodon
+  module REST
+    module API
+      include Mastodon::REST::Statuses
+      include Mastodon::REST::Accounts
+      include Mastodon::REST::Timelines
+      include Mastodon::REST::Notifications
+      include Mastodon::REST::Search
+      include Mastodon::REST::Relationships
+      include Mastodon::REST::Media
+      include Mastodon::REST::Suggestions
+      include Mastodon::REST::Apps
+      include Mastodon::REST::Instances
+    end
+  end
+end

data/lib/mastodon/rest/apps.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+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]
+      # @param scopes [String]
+      # @param website [String]
+      # @return [Mastodon::App]
+      def create_app(name, redirect_uri, scopes = 'read', website = nil)
+        perform_request_with_object(:post, '/api/v1/apps',
+                                    {
+                                      client_name: name,
+                                      redirect_uris: redirect_uri,
+                                      scopes: scopes,
+                                      website: website
+                                    }, Mastodon::App)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/client.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'mastodon/client'
+require 'mastodon/rest/api'
+
+module Mastodon
+  module REST
+    # Main interaction class for the REST API.
+    class Client < Mastodon::Client
+      include Mastodon::REST::API
+    end
+  end
+end

data/lib/mastodon/rest/instances.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'mastodon/rest/utils'
+require 'mastodon/instance'
+
+module Mastodon
+  module REST
+    module Instances
+      include Mastodon::REST::Utils
+
+      # Retrieve the current instance. Does not require authentication
+      # @return [Mastodon::Instance]
+      def instance
+        perform_request_with_object(:get, '/api/v1/instance', {},
+                                    Mastodon::Instance)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/media.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'mastodon/rest/utils'
+require 'mastodon/media'
+
+module Mastodon
+  module REST
+    module Media
+      include Mastodon::REST::Utils
+
+      # Upload a media file
+      # @param file [File, StringIO, HTTP::FormData::File] file to
+      #   upload. Will be converted to HTTP::FormData::File before upload
+      # @param description [String] A text description of the image, to be
+      #   along with the image.
+      # @return [Mastodon::Media]
+      def upload_media(file, description = nil)
+        file = if file.is_a?(HTTP::FormData::File)
+                 file
+               else
+                 HTTP::FormData::File.new(file)
+               end
+        payload = { file: file }
+        payload[:description] = description unless description.nil?
+        perform_request_with_object(:post, '/api/v1/media', payload,
+                                    Mastodon::Media)
+      end
+
+      # Update a media description, can only be updated while it's not
+      #   associated to a status
+      # @param media_id [Integer] Id of the media, returned by upload_media
+      # @param description [String] A text description of the image, to be
+      #   along with the image.
+      # @return [Mastodon::Media]
+      def update_media_description(media_id, description)
+        perform_request_with_object(:put, "/api/v1/media/#{media_id}",
+                                    { description: description },
+                                    Mastodon::Media)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/notifications.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'mastodon/rest/utils'
+require 'mastodon/notification'
+
+module Mastodon
+  module REST
+    module Notifications
+      include Mastodon::REST::Utils
+
+      # Get a list of notifications for the authenticated user
+      # @return [Mastodon::Collection<Mastodon::Notification>]
+      def notifications
+        perform_request_with_collection(:get, '/api/v1/notifications', {},
+                                        Mastodon::Notification)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/relationships.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+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',
+                                        array_param(: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
+
+      # Follow a remote user
+      # @param uri [String] username@domain of the person you want to follow
+      # @return [Mastodon::Account]
+      def remote_follow(uri)
+        perform_request_with_object(:post, '/api/v1/follows', { uri: uri },
+                                    Mastodon::Account)
+      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
+
+      # Mute a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def mute(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/mute",
+                                    {}, Mastodon::Relationship)
+      end
+
+      # Unmute a user
+      # @param id [Integer]
+      # @return [Mastodon::Relationship]
+      def unmute(id)
+        perform_request_with_object(:post, "/api/v1/accounts/#{id}/unmute",
+                                    {}, Mastodon::Relationship)
+      end
+    end
+  end
+end

data/lib/mastodon/rest/request.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+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
+        # rubocop:disable GuardClause
+        if @options.is_a?(Hash) && @options[:headers]
+          @headers = @options.delete(:headers).merge @headers
+        end
+        # rubocop:enable GuardClause
+      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'
+
+        r_body = response.body.empty? ? '' : Oj.load(response.to_s, mode: :null)
+        fail_or_return(response.code, r_body)
+      end
+
+      private
+
+      def fail_or_return(code, body)
+        if Mastodon::Error::ERRORS.include?(code)
+          raise Mastodon::Error::ERRORS[code].from_response(body)
+        end
+        body
+      end
+
+      def http_client
+        HTTP.timeout(:per_operation, connect: @client.timeout[:connect],
+                                     read: @client.timeout[:read],
+                                     write: @client.timeout[:write])
+      end
+    end
+  end
+end