shikimori-api 1.0.0

data/lib/shikimori/api/v2/user_ignore.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V2
+      # Methods for the User ignores API
+      #
+      # @see https://shikimori.one/api/doc/2.0/User%20Ignore Shikimori's API documentation
+      module UserIgnore
+        # Add user to ignore by id.
+        # Requires `ignores` oauth scope
+        #
+        # @param user_id [#to_s] User id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created user ignore
+        #
+        # @see https://shikimori.one/api/doc/2.0/User%20Ignore/create Shikimori's API documentation
+        # @example Add to ignore a user with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v2.create_user_ignore(1)
+        def create_user_ignore(user_id, headers: nil, **query)
+          rest.post base_url.join('users', user_id.to_s, 'ignore').url, {}, headers: headers, query: query
+        end
+
+        # Delete a user ignore by id.
+        # Requires `ignores` oauth scope
+        #
+        # @param user_id [#to_s] User id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if deletion successful, false otherwise.
+        #
+        # @see https://shikimori.one/api/doc/2.0/User%20Ignore/destroy Shikimori's API documentation
+        # @example Delete a user ignore
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v2.delete_user_ignore(1)
+        def delete_user_ignore(user_id, headers: nil, **query)
+          rest.delete base_url.join('users', user_id.to_s, 'ignore').url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v2/user_rates.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V2
+      # Methods for the User rates API
+      #
+      # @see https://shikimori.one/api/doc/2.0/user_rates
+      module UserRates
+        # Get list of user rates
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        # @option query [Integer] :page Number of page. Must be between 1 and 100000
+        # @option query [Integer] :limit Number of titles per page. Must be a lower or equal that 50
+        # @option query [Integer] :user_id User ID
+        # @option query [Integer] :target_id Target ID
+        # @option query ['Anime', 'Manga'] :target_type Target ID
+        # @option query ['planned', 'watching', 'rewatching',
+        #   'completed', 'on_hold', 'dropped'] :status Watching/Reading status
+        #
+        # @return [Array<Hash>] Array of hashes representing user rates
+        #
+        # @see https://shikimori.one/api/doc/2.0/user_rates/index Shikimori's API documentation
+        # @example List of user rates
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v2.user_rates(status: 'planned')
+        def user_rates(headers: nil, **query)
+          rest.get base_url.join('user_rates').url, headers: headers, query: query
+        end
+
+        # Get an user rate by id
+        #
+        # @param id [#to_s] user rate id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing user rate
+        #
+        # @see https://shikimori.one/api/doc/2.0/user_rates/show Shikimori's API documentation
+        # @example Get user rate with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v2.user_rate(1) #=> { id: 1, ... }
+        def user_rate(id, headers: nil, **query)
+          rest.get base_url.join('user_rates', id.to_s).url, headers: headers, query: query
+        end
+
+        # Create a user rate.
+        # Requires `user_rates` oauth scope
+        #
+        # @param user_rate [Hash] User rate data for creating
+        # @option user_rate [Integer] :user_id User id
+        # @option user_rate [Integer] :target_id Target id
+        # @option user_rate ['Anime', 'Manga'] :target_type Target type
+        # @option user_rate ["planned", "watching", "rewatching",
+        #   "completed", "on_hold", "dropped"] :status Watching status
+        # @option user_rate [Numeric] :score Score
+        # @option user_rate [Numeric] :chapters Current chapter number
+        # @option user_rate [Numeric] :episodes Current episode number
+        # @option user_rate [Numeric] :volumes Current volume number
+        # @option user_rate [Numeric] :rewatches Count of rewatching
+        # @option user_rate [String] :text Rate text
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created user rate
+        #
+        # @see https://shikimori.one/api/doc/2.0/user_rates/create Shikimori's API documentation
+        # @example Create a user rate
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   user_rate = {
+        #     text: "text",
+        #     user_id: 1,
+        #     target_id: "41",
+        #     target_type: "Anime"
+        #   }
+        #   client.v2.create_user_rate(user_rate)
+        def create_user_rate(user_rate, headers: nil, **query)
+          rest.post base_url.join('user_rates').url, { user_rate: user_rate }, headers: headers, query: query
+        end
+
+        # Update a user rate.
+        # Requires `user_rates` oauth scope
+        #
+        # @param id [#to_s] User rate id
+        # @param user_rate [Hash] User rate data for creating
+        # @option user_rate ["planned", "watching", "rewatching",
+        #   "completed", "on_hold", "dropped"] :status Watching status
+        # @option user_rate [Numeric] :score Score
+        # @option user_rate [Numeric] :chapters Current chapter number
+        # @option user_rate [Numeric] :episodes Current episode number
+        # @option user_rate [Numeric] :volumes Current volume number
+        # @option user_rate [Numeric] :rewatches Count of rewatching
+        # @option user_rate [String] :text Rate text
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing updated user rate
+        #
+        # @see https://shikimori.one/api/doc/2.0/user_rates/update Shikimori's API documentation
+        # @example Update a user rate text
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   user_rate = {
+        #     text: "text"
+        #   }
+        #   client.v2.update_user_rate(1, user_rate)
+        def update_user_rate(id, user_rate, headers: nil, **query)
+          rest.put base_url.join('user_rates', id.to_s).url, { user_rate: user_rate }, headers: headers, query: query
+        end
+
+        # Delete user rate.
+        # Requires `user_rates` oauth scope
+        #
+        # @param id [#to_s] User rate id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Boolean] True if deletion successful, false otherwise.
+        #
+        # @see https://shikimori.one/api/doc/2.0/user_rates/destroy Shikimori's API documentation
+        # @example Delete user rate
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v2.delete_user_rate(1)
+        def delete_user_rate(id, headers: nil, **query)
+          rest.delete base_url.join('user_rates', id.to_s).url, headers: headers, query: query
+        end
+
+        # Increment episodes/chapters by 1
+        # Requires `user_rates` oauth scope
+        #
+        # @param id [#to_s] User rate ID
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created user rate
+        #
+        # @see https://shikimori.one/api/doc/2.0/user_rates/increment Shikimori's API documentation
+        # @example Increment episodes/chapters by 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v2.increment_user_rate(1)
+        def increment_user_rate(id, headers: nil, **query)
+          rest.post base_url.join('user_rates', id.to_s, 'increment').url, {}, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v2.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'v2/abuse_requests'
+require_relative 'v2/episode_notifications'
+require_relative 'v2/topic_ignore'
+require_relative 'v2/user_ignore'
+require_relative 'v2/user_rates'
+
+module Shikimori
+  module API
+    # Methods for second version of shikimori's API
+    class V2
+      include AbuseRequests
+      include EpisodeNotifications
+      include TopicIgnore
+      include UserIgnore
+      include UserRates
+
+      attr_reader :rest, :base_url
+
+      def initialize(base_url:, rest:)
+        @rest = rest
+        @base_url = base_url
+      end
+    end
+  end
+end

data/lib/shikimori/api/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    # @return [String] Semantic version of library
+    VERSION = '1.0.0'
+  end
+end

data/lib/shikimori/api.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+require_relative 'api/version'
+require_relative 'api/errors'
+require_relative 'api/client'
+
+module Shikimori
+  # Ruby toolkit for the Shikimori API
+  module API
+  end
+end

data/lib/shikimori-api.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'shikimori/api'

data/shikimori-api.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/shikimori/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'shikimori-api'
+  spec.version = Shikimori::API::VERSION
+  spec.authors = ['Ivan Naumov']
+  spec.email = ['ivannaymov@gmail.com']
+
+  spec.summary = 'Simple wrapper for the Shikimori API'
+  spec.description = 'Ruby toolkit for working with the Shikimori API'
+  spec.homepage = 'https://github.com/iwdt/shikikit'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['source_code_uri'] = 'https://github.com/iwdt/shikikit'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/iwdt/shikikit/issues'
+  spec.metadata['changelog_uri'] = 'https://github.com/iwdt/shikikit/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir[
+    # Common files
+    'LICENSE',
+    'README.md',
+    'shikimori-api.gemspec',
+    # Code
+    'lib/shikimori-api.rb',
+    'lib/shikimori/api.rb',
+    'lib/shikimori/api/**/*',
+    # Signtures
+    'sig/shikimori/api.rbs',
+    'sig/shikimori/api/**/*'
+  ]
+  spec.bindir = 'bin'
+  spec.executables = []
+  spec.require_paths = ['lib']
+end

data/sig/shikimori/api/client.rbs

@@ -0,0 +1,12 @@
+module Shikimori
+  module API
+    class Client
+      DEFAULT_SITE_URL: String
+
+      attr_reader v1: V1
+      attr_reader v2: V2
+
+      def initialize: (?String site, app_name: String, access_token: String, refresh_token: String) -> void
+    end
+  end
+end

data/sig/shikimori/api/rest.rbs

@@ -0,0 +1,30 @@
+module Shikimori
+  module API
+    class REST
+      type request_method = :delete | :get | :post | :put
+      type request = Net::HTTP::Delete | Net::HTTP::Get | Net::HTTP::Post | Net::HTTP::Put
+      type body = Hash[_ToS, Object] | nil
+
+      @app_name: String
+      @access_token: String
+      @refresh_token: String
+
+      def initialize: (app_name: String, access_token: String, refresh_token: String) -> void
+
+      def get: (::URI::Generic, **untyped) -> untyped
+      def post: (::URI::Generic, Hash[_ToS, untyped] data, **untyped) -> untyped
+      def put: (::URI::Generic, Hash[_ToS, Object] data, **untyped) -> untyped
+      def delete: (::URI::Generic, **untyped) -> bool
+
+      private
+
+      def request: (request_method, ::URI::Generic, ?body, **untyped) -> [Net::HTTPResponse, (::Hash[_ToS, Object] | nil)]
+      def build_request: (request_method, ::URI::Generic, **untyped) -> request
+      def start_request: (::URI::Generic, request, ?body, **untyped) -> Net::HTTPResponse
+      def parse_response: (Net::HTTPResponse response) -> (::Hash[_ToS, untyped] | nil)
+      def json_parse_response_body: (String) -> (::Hash[_ToS, untyped] | nil)
+      def headers_from: (Hash[untyped, untyped]) -> Hash[String, String]
+      def query_params_from: (::URI::Generic, Hash[untyped, untyped]) -> untyped
+    end
+  end
+end

data/sig/shikimori/api/uri.rbs

@@ -0,0 +1,10 @@
+module Shikimori
+  module API
+    class URI < URI::Generic
+      attr_reader url: ::URI::Generic
+
+      def initialize: (_ToS) -> void
+      def join: (*(::_ToStr | ::URI::Generic)) -> URI
+    end
+  end
+end

data/sig/shikimori/api/v1/achievements.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module Achievements
+        attr_reader rest: REST
+
+        def achievements: (user_id: Integer, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/animes.rbs

@@ -0,0 +1,23 @@
+module Shikimori
+  module API
+    class V1
+      module Animes
+        attr_reader rest: REST
+
+        def animes: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def anime: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def anime_roles: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def anime_similar: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def anime_related: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def anime_screenshots: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def anime_franchise: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def anime_external_links: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def anime_topics: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/appear.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module Appear
+        attr_reader rest: REST
+
+        def create_appear: (?comment_ids: Array[_ToS], ?topic_ids: Array[_ToS], ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/bans.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module Bans
+        attr_reader rest: REST
+
+        def bans: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/calendars.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module Calendars
+        attr_reader rest: REST
+
+        def calendar: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/characters.rbs

@@ -0,0 +1,16 @@
+module Shikimori
+  module API
+    class V1
+      module Characters
+        attr_reader rest: REST
+
+        def characters: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def character: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/clubs.rbs

@@ -0,0 +1,29 @@
+module Shikimori
+  module API
+    class V1
+      module Clubs
+        attr_reader rest: REST
+
+        type club_model = { name: String, description: String, display_images: bool | 1 | 0, comment_policy: 'free' | 'members' | 'admins', topic_policy: 'members' | 'admins', image_upload_policy: 'members' | 'admins' }
+
+        def clubs: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def update_club: (_ToS, club_model, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_animes: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_mangas: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_ranobe: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_characters: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_collections: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_clubs: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_members: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_images: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_join: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+        def club_leave: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/comments.rbs

@@ -0,0 +1,19 @@
+module Shikimori
+  module API
+    class V1
+      module Comments
+        attr_reader rest: REST
+
+        def comments: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def comment: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def create_comment: (Hash[_ToS, Object], ?broadcast: ('false' | 'true' | 1 | 0 | nil), ?frontend: ('false' | 'true' | 1 | 0 | nil), ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def update_comment: (_ToS, Hash[_ToS, untyped], ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_comment: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/constants.rbs

@@ -0,0 +1,19 @@
+module Shikimori
+  module API
+    class V1
+      module Constants
+        attr_reader rest: REST
+
+        def anime_constants: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def manga_constants: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def user_rate_constants: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def club_constants: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def smileys_constants: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/dialogs.rbs

@@ -0,0 +1,17 @@
+module Shikimori
+  module API
+    class V1
+      module Dialogs
+        attr_reader rest: REST
+
+        def dialogs: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def dialog: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_dialog: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/favorites.rbs

@@ -0,0 +1,23 @@
+module Shikimori
+  module API
+    class V1
+      module Favorites
+        attr_reader rest: REST
+
+        type favoritable_type = 'person' | 'anime' | 'manga' | 'ranobe' | 'character'
+        type person_type = 'common' | 'seyu' | 'mangaka' | 'producer' | 'person'
+
+        def create_favorite: (_ToS, type: favoritable_type, ?person_type: person_type, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_favorite: (_ToS, type: favoritable_type, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def reorder_favorite: (_ToS, position: Integer, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def creation_favorite_path_by: (String, String, ?String person_type) -> Array[String]
+        def deletion_favorite_path_by: (String, String) -> Array[String]
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/forums.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module Forums
+        attr_reader rest: REST
+
+        def forums: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/friends.rbs

@@ -0,0 +1,16 @@
+module Shikimori
+  module API
+    class V1
+      module Friends
+        attr_reader rest: REST
+
+        def create_friend: (Hash[_ToS, Object], ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_friend: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/genres.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module API
+    class V1
+      module Genres
+        attr_reader rest: REST
+
+        def genres: (?headers: Hash[String, String] | nil, **untyped) -> untyped
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end

data/sig/shikimori/api/v1/ignores.rbs

@@ -0,0 +1,16 @@
+module Shikimori
+  module API
+    class V1
+      module Ignores
+        attr_reader rest: REST
+
+        def create_ignore: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> untyped
+        def delete_ignore: (_ToS, ?headers: Hash[String, String] | nil, **untyped) -> bool
+
+        private
+
+        def base_url: -> ::Shikimori::API::URI
+      end
+    end
+  end
+end