shikimori-api 1.0.0

data/lib/shikimori/api/v1/messages.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Messages API
+      #
+      # @see https://shikimori.one/api/doc/1.0/messages Shikimori's API documentation
+      module Messages
+        # Get a message by id.
+        #
+        # Requires `messages` oauth scope
+        # @param id [#to_s] message id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing message
+        #
+        # @see https://shikimori.one/api/doc/1.0/messages/show Shikimori's API documentation
+        # @example Get a message with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.message(1) #=> { id: 1, ... }
+        def message(id, headers: nil, **query)
+          rest.get base_url.join('messages', id.to_s).url, headers: headers, query: query
+        end
+
+        # Create a message
+        # Requires `messages` oauth scope
+        #
+        # @param message [Hash] Message data for creating
+        # @option message [String] :body message text
+        # @option message [Integer] :from_id user id, that sending a message
+        # @option message [Integer] :to_id user id, that receiving a message
+        # @option message ['Private'] :kind message type
+        # @param frontend ['false', 'true', 1, 0] Used by shikimori frontend code. Ignore it.
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created message
+        #
+        # @see https://shikimori.one/api/doc/1.0/messages/create Shikimori's API documentation
+        # @example Send message by user with id 1 to user with 2
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.create_message({ body: 'Hello, kitty! :)', from_id: 1, to_id: 2, kind: 'Private' })
+        def create_message(message, frontend: nil, headers: nil, **query)
+          rest.post(
+            base_url.join('messages').url,
+            { message: message, frontend: frontend }.compact,
+            headers: headers, query: query
+          )
+        end
+
+        # Update message.
+        # Requires `messages` oauth scope
+        #
+        # @param id [#to_s] message id
+        # @param message [Hash] message data for updating
+        # @option message [String] :body message text
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        # @option query ['false', 'true', 1, 0] :frontend Used by shikimori frontend code. Ignore it.
+        #
+        # @return [Hash] Hash representing updated message
+        #
+        # @see https://shikimori.one/api/doc/1.0/messages/update Shikimori's API documentation
+        # @example Update a message's text with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.update_message(1, { body: "new text!" })
+        def update_message(id, message, headers: nil, **query)
+          rest.put(
+            base_url.join('messages', id.to_s).url,
+            { message: message, frontend: query.delete(:frontend) }.compact,
+            headers: headers, query: query
+          )
+        end
+
+        # Delete message.
+        # Requires `messages` oauth scope
+        #
+        # @param id [String, Integer] message 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/1.0/messages/destroy Shikimori's API documentation
+        # @example Delete a message with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.delete_message(1)
+        def delete_message(id, headers: nil, **query)
+          rest.delete base_url.join('messages', id.to_s).url, headers: headers, query: query
+        end
+
+        # Mark all messages as read by type
+        # Requires `messages` oauth scope
+        #
+        # @param type ['news', 'notifications'] Type of messages to read
+        # @param frontend ['false', 'true', 1, 0] Used by shikimori frontend code. Ignore it.
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing of readed messages
+        #
+        # @see https://shikimori.one/api/doc/1.0/messages/read_all Shikimori's API documentation
+        # @example Read all notifications
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.read_all_messages(type: 'notifications')
+        def read_all_messages(type:, frontend: nil, headers: nil, **query)
+          rest.post(
+            base_url.join('messages', 'read_all').url,
+            { type: type, frontend: frontend }.compact,
+            headers: headers, query: query
+          )
+
+          true
+        end
+
+        # Delete all messages by type
+        # Requires `messages` oauth scope
+        #
+        # @param type ['news', 'notifications'] Type of messages to delete
+        # @param frontend ['false', 'true', 1, 0] Used by shikimori frontend code. Ignore it.
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing of deleted messages
+        #
+        # @see https://shikimori.one/api/doc/1.0/messages/delete_all Shikimori's API documentation
+        # @example Delete all notifications
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.delete_all_messages(type: 'notifications')
+        def delete_all_messages(type:, frontend: nil, headers: nil, **query)
+          rest.post(
+            base_url.join('messages', 'delete_all').url,
+            { type: type, frontend: frontend }.compact,
+            headers: headers, query: query
+          )
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/people.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the People API
+      #
+      # @see https://shikimori.one/api/doc/1.0/people Shikimori's API documentation
+      module People
+        # Get list of People
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        # @option query [String] :search Filter by person name
+        # @option query ['seyu', 'mangaka', 'producer'] :kind Filter by person type
+        #
+        # @return [Array<Hash>] Array of hashes representing people
+        #
+        # @see https://shikimori.one/api/doc/1.0/people/index Shikimori's API documentation
+        # @example Search a Hayao Miyazaki at mangakas list
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.people(search: 'Hayao Miyazaki', kind: 'mangaka')
+        def people(headers: nil, **query)
+          rest.get base_url.join('people', 'search').url, headers: headers, query: query
+        end
+
+        # Get an person by id
+        #
+        # @param id [String, Integer] Person id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing person
+        #
+        # @see https://shikimori.one/api/doc/1.0/people/show Shikimori's API documentation
+        # @example Get a person with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.person(1)
+        def person(id, headers: nil, **query)
+          rest.get base_url.join('people', id.to_s).url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/publishers.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Publishers API
+      #
+      # @see https://shikimori.one/api/doc/1.0/publishers Shikimori's API documentation
+      module Publishers
+        # Get list of publishers
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Array of hashes representing publishers
+        #
+        # @see https://shikimori.one/api/doc/1.0/publishers/index Shikimori's API documentation
+        # @example Get list of publishers
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.publishers #=> [{ id: 1, ... }, ...]
+        def publishers(headers: nil, **query)
+          rest.get base_url.join('publishers').url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/ranobe.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Ranobes API
+      #
+      # @see https://shikimori.one/api/doc/1.0/ranobe Shikimori's API documentation
+      module Ranobe
+        # Get list of ranobe titles
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Filters and pagination for ranobes
+        # @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 ["id", "id_desc", "ranked", "chapters",
+        #  "kind", "popularity", "name",
+        #  "aired_on", "volumes", "status",
+        #  "random", "ranked_random",
+        #  "ranked_shiki", "created_at", "created_at_desc"] :order Sorting type.
+        # @option query ["anons", "ongoing", "released", "paused", "discontinued"] :status Ranobe title status
+        # @option query [String] :season Ranobe season. Examples: "summer_2017", "2016", "2014_2016", "199x"
+        # @option query [Integer] :score Minimal ranobe score
+        # @option query [String] :genre List of genre ids separated by comma
+        # @option query [String] :publisher List of publisher ids separated by comma
+        # @option query [String] :franchise List of franchises separated by comma
+        # @option query [TrueClass, FalseClass] :censored Set to false to allow hentai, yaoi and yuri
+        # @option query ["planned", "watching", "rewatching",
+        #   "completed", "on_hold", "dropped"] :mylist Status of anime in current user list
+        # @option query [String] :ids List of anime ids separated by comma
+        # @option query [String] :exclude_ids List of anime ids separated by comma
+        # @option query [String] :search Search phrase to filter ranobes by name
+        #
+        # @return [Array<Hash>] Array of hashes representing ranobes
+        #
+        # @see https://shikimori.one/api/doc/1.0/ranobe/index Shikimori's API documentation
+        # @example Get 20 ranobe titles on second page
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobes(page: 2, limit: 20) #=> [{ id: 1, ... }, { id: 2, ... }, ...]
+        # @example Get top 50 ongoing ranobe titles
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobes(limit: 50, status: 'ongoing', order: 'ranked') #=> [{ id: 1, ... }, { id: 2, ... }, ...]
+        # @example Get 10 random ranobe titles released in the 90s
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobes(limit: 10, order: 'random', season: '199x') #=> [{ id: 1, ... }, { id: 2, ... }, ...]
+        def ranobes(headers: nil, **query)
+          rest.get base_url.join('ranobe').url, headers: headers, query: query
+        end
+
+        # Get an ranobe by id
+        #
+        # @param id [#to_s] ranobe id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing ranobe
+        #
+        # @see https://shikimori.one/api/doc/1.0/ranobe/show Shikimori's API documentation
+        # @example Get ranobe with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobe(1) #=> { id: 1, ... }
+        def ranobe(id, headers: nil, **query)
+          rest.get base_url.join('ranobe', id.to_s).url, headers: headers, query: query
+        end
+
+        # Get an ranobe roles
+        #
+        # @param id [#to_s] ranobe id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing ranobe roles
+        #
+        # @see https://shikimori.one/api/doc/1.0/ranobe/roles Shikimori's API documentation
+        # @example Get a first ranobe roles
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobe_roles(1) #=> { roles: [...], roles_russian: [...], character: {...}, person: {...} }
+        def ranobe_roles(id, headers: nil, **query)
+          rest.get base_url.join('ranobe', id.to_s, 'roles').url, headers: headers, query: query
+        end
+
+        # Get an ranobe similar
+        #
+        # @param id [#to_s] ranobe id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Array<Hash>] Array of hashes representing similar ranobes
+        #
+        # @see https://shikimori.one/api/doc/1.0/ranobe/similar Shikimori's API documentation
+        # @example Get a similar ranobe titles for ranobe with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobe_similar(1) #=> { id: 2, ... }
+        def ranobe_similar(id, headers: nil, **query)
+          rest.get base_url.join('ranobe', id.to_s, 'similar').url, headers: headers, query: query
+        end
+
+        # Get an related ranobes
+        #
+        # @param id [#to_s] ranobe id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Array<Hash>] Array of hashes representing related ranobes
+        #
+        # @see https://shikimori.one/api/doc/1.0/ranobe/related Shikimori's API documentation
+        # @example Get a related anime, manga and ranobe titles for anime with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobe_related(1)
+        #   #=> [{ relation: "...", relation_russian: "...", anime: { id: 3, ... }, ranobe: { id: 1, ... } }]
+        def ranobe_related(id, headers: nil, **query)
+          rest.get base_url.join('ranobe', id.to_s, 'related').url, headers: headers, query: query
+        end
+
+        # Get an ranobe franchise
+        #
+        # @param id [#to_s] ranobe id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing of ranobe's franchise tree
+        #
+        # @see https://shikimori.one/api/doc/1.0/ranobe/franchise Shikimori's API documentation
+        # @example Get ranobe franchise tree for ranobe with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobe_franchise(1) #=> { links: [{ id: 1, ... }], nodes: [{ id: 1, ... }], current_id: 1 }
+        def ranobe_franchise(id, headers: nil, **query)
+          rest.get base_url.join('ranobe', id.to_s, 'franchise').url, headers: headers, query: query
+        end
+
+        # Get an ranobe external links
+        #
+        # @param id [#to_s] ranobe id
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Array<Hash>] Array of hashes representing ranobe's extenal links
+        #
+        # @see https://shikimori.one/api/doc/1.0/ranobe/external_links Shikimori's API documentation
+        # @example Get related external links for ranobe with id equal 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobe_external_links(1) #=> [{ id: 1, ... }, { id: nil, ... }]
+        def ranobe_external_links(id, headers: nil, **query)
+          rest.get base_url.join('ranobe', id.to_s, 'external_links').url, headers: headers, query: query
+        end
+
+        # Get an ranobe topics
+        #
+        # @param id [#to_s] ranobe id
+        # @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
+        # @return [Array<Hash>] Array of hashes representing ranobe's topics
+        #
+        # @see https://shikimori.one/api/doc/1.0/ranobe/topics Shikimori's API documentation
+        # @example Get topics for ranobe with id equal 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.ranobe_topics(1) #=> [{ id: 1, ... }]
+        def ranobe_topics(id, headers: nil, **query)
+          rest.get base_url.join('ranobe', id.to_s, 'topics').url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/reviews.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Reviews API
+      #
+      # @see https://shikimori.one/api/doc/1.0/reviews Shikimori's API documentation
+      module Reviews
+        # Create a anime's review
+        #
+        # @param review [Hash] Review data for creating
+        # @option review [String] :body Review text
+        # @option review [Integer] :anime_id Anime's ID
+        # @option review ['positive', 'neutral', 'negative'] :opinion Review's opinion
+        # @param frontend ['false', 'true', 1, 0] Used by shikimori frontend code. Ignore it.
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing created comment
+        #
+        # @see https://shikimori.one/api/doc/1.0/reviews/create Shikimori's API documentation
+        # @example Create a comment for topic with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.create_review({ body: 'Good!', anime_id: 1, opinion: 'positive' })
+        def create_review(review, frontend: nil, headers: nil, **query)
+          rest.post(
+            base_url.join('reviews').url,
+            { review: review, frontend: frontend }.compact,
+            headers: headers, query: query
+          )
+        end
+
+        # Update anime's review by id
+        #
+        # @param id [Hash] Review's id
+        # @param review [Hash] Review data for updating
+        # @option review [String] :body Review text
+        # @option review ['positive', 'neutral', 'negative'] :opinion Review's opinion
+        # @param frontend ['false', 'true', 1, 0] Used by shikimori frontend code. Ignore it.
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Hash] Hash representing updated review
+        #
+        # @see https://shikimori.one/api/doc/1.0/reviews/update Shikimori's API documentation
+        # @example Change review opinion
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #
+        #   client.v1.update_review(1, { opinion: 'negative' })
+        def update_review(id, review, frontend: nil, headers: nil, **query)
+          rest.put(
+            base_url.join('reviews', id.to_s).url,
+            { review: review, frontend: frontend }.compact,
+            headers: headers, query: query
+          )
+        end
+
+        # Delete anime's review
+        #
+        # @param id [String, Integer] Review 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/1.0/reviews/destroy
+        # @example Delete review with id equal to 1
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.delete_review(1)
+        def delete_review(id, headers: nil, **query)
+          rest.delete base_url.join('reviews', id.to_s).url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/stats.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Stats API
+      #
+      # @see https://shikimori.one/api/doc/1.0/stats Shikimori's API documentation
+      module Stats
+        # Get list of active users
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Array<Integer>] Array of ids of active users
+        #
+        # @see https://shikimori.one/api/doc/1.0/stats/active_users Shikimori's API documentation
+        # @example Get list of active users
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.active_users #=> [1, 2, 3, ...]
+        def active_users(headers: nil, **query)
+          rest.get base_url.join('stats', 'active_users').url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end

data/lib/shikimori/api/v1/studios.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module API
+    class V1
+      # Methods for the Studios API
+      #
+      # @see https://shikimori.one/api/doc/1.0/studios Shikimori's API documentation
+      module Studios
+        # Get list of studios
+        #
+        # @param headers [Hash] Request headers
+        # @param query [Hash] Query string parameters for request
+        #
+        # @return [Array<Hash>] Array of hashes representing studios
+        #
+        # @see https://shikimori.one/api/doc/1.0/studios/index Shikimori's API documentation
+        # @example Get list of studios
+        #   client = Shikimori::API::Client.new(
+        #     app_name: 'Api Test',
+        #     aceess_token: '****',
+        #     refresh_token: '****'
+        #   )
+        #   client.v1.studios #=> [{ id: 1, ... }, ...]
+        def studios(headers: nil, **query)
+          rest.get base_url.join('studios').url, headers: headers, query: query
+        end
+      end
+    end
+  end
+end