mangadex 5.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c4ab078c2f38cc5519044c3b5984fe4061b431632b543766bc5b20b219d4a50
+  data.tar.gz: fe668a1df2fc8704676733ac0017443a5714e3716f0dec97debde112ab7ee3b1
+SHA512:
+  metadata.gz: c34c0b8c9e4f3d09c0f870165c02fe272ebc62af3f4145b0a6744ba9d31323d87ba25367018893b48bc6cc098a6b9315d6e97a1384956429eb3e6615b8055d89
+  data.tar.gz: 2218c590eea3bdff50ba1bd76a6f18737cf57ba327482f316fe2284365a5cee2767866f9510fbf2244bf8f99ca1c196698c5e03692101d2d619ffd45461260a4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@akinyele.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mangadex.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    mangadex (5.3.0)
+      activesupport (~> 6.1)
+      psych (~> 4.0.1)
+      rest-client (~> 2.1)
+      sorbet-runtime
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    minitest (5.14.4)
+    netrc (0.11.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    psych (4.0.1)
+    rake (10.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sorbet (0.5.9152)
+      sorbet-static (= 0.5.9152)
+    sorbet-runtime (0.5.9152)
+    sorbet-static (0.5.9152-universal-darwin-20)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.2.19)
+  mangadex!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sorbet
+
+BUNDLED WITH
+   2.2.19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Akinyele Cafe-Febrissy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# Mangadex
+
+Welcome to `mangadex`, your next favourite Ruby gem for interacting with [Mangadex](https://mangadex.org).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mangadex'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mangadex
+
+## Usage
+
+Please note that I tried my best to follow Mangadex's naming conventions for [their documentation](https://api.mangadex.org).
+To find out how to use the gem, you're welcome to [check this out](lib/mangadex).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thedrummeraki/mangadex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mangadex project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/thedrummeraki/mangadex/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mangadex"
+
+username, password = [
+  ENV['MD_USERNAME'],
+  ENV['MD_PASSWORD'],
+]
+
+if username && password
+  Mangadex::Auth.login(username, password)
+end
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/extensions.rb

@@ -0,0 +1,12 @@
+# typed: true
+require "active_support/hash_with_indifferent_access"
+
+class Hash
+  def with_indifferent_access
+    ActiveSupport::HashWithIndifferentAccess.new(self)
+  end
+
+  def nested_under_indifferent_access
+    ActiveSupport::HashWithIndifferentAccess.new(self)
+  end
+end

data/lib/mangadex/README.md

@@ -0,0 +1,93 @@
+## `Mangadex`
+
+This is documentation for the `Mangadex` module.
+
+### Directory
+#### Sub-modules
+
+- [`Mangadex::Api`](#)
+- [`Mangadex::Internal`](#)
+
+#### Fetchable/Resources
+- [`Mangadex::Artist`](#)
+- [`Mangadex::Auth`](#mangadexauth)
+- [`Mangadex::Author`](#)
+- [`Mangadex::Chapter`](#)
+- [`Mangadex::ContentRating`](#)
+- [`Mangadex::CoverArt`](#)
+- [`Mangadex::CustomList`](#)
+- [`Mangadex::Manga`](#)
+- [`Mangadex::Relationship`](#)
+- [`Mangadex::ReportReason`](#)
+- [`Mangadex::ScanlationGroup`](#)
+- [`Mangadex::Tag`](#)
+- [`Mangadex::Upload`](#)
+- [`Mangadex::User`](#)
+
+#### Other classes
+- [`Mangadex::MangadexObject`](#)
+- [`Mangadex::Types`](#)
+- [`Mangadex::Version`](#)
+
+### Fetchable/Resources
+
+These refer to the resources that live on Mangadex, or general "namespace"-like
+concepts on which one can fetch information.
+
+### `Mangadex::Artist`
+
+> See [`Mangadex::Author`](#)
+
+This is a sub-class of `Mangadex::Author`. It has the same attributes as an author.
+
+### `Mangadex::Auth`
+
+All things authentication.
+
+#### `login`
+
+```ruby
+Mangadex::Auth.login(username, password)
+```
+
+Login with your username and password. Upon successful login, the user will be available in a context from
+`Mangadex::Api::Context.user`. This variable can be used anywhere in your application. More info [here](#).
+
+> - Returns `Mangadex::Api::Response` if request fails.
+> - Returns `true` if user is logged in.
+> - Returns `false` if the user was not successfully logged in.
+
+#### `check_token`
+
+```ruby
+Mangadex::Auth.check_token
+```
+
+Check the status of your token, whether you're authenticated or not.
+
+> - Returns a hash with the token information.
+
+#### `logout`
+
+```ruby
+Mangadex::Auth.logout
+```
+
+Logs out the current user. Sets `Mangadex::Api::Content.user` to `nil`.
+
+> - Returns `Mangadex::Api::Response` if request fails.
+> - Returns `true` if request is considered successful.
+> - Idempotent request.
+
+#### `refresh_token`
+
+```ruby
+Mangadex::Auth.refresh_token
+```
+
+Manually cause a token refresh.
+> Please note that simply calling `Mangadex::Api::Content.user` ensures that the token is valid. More info [here](#).
+
+> - Returns `nil` if user is not logged (ie: `Mangadex::Api::Content.user` is `nil`)
+> - Returns `true` if the refresh is successful
+> - Returns `false` if the refresh is [not successful](#).

data/lib/mangadex/api/context.rb

@@ -0,0 +1,53 @@
+# typed: true
+module Mangadex
+  module Api
+    class Context
+      @@user = nil
+
+      class << self
+        def user
+          @@user&.with_valid_session
+        end
+
+        def user=(user)
+          if user.is_a?(Mangadex::Api::User)
+            @@user = user
+          elsif user.is_a?(Mangadex::User)
+            @@user = Mangadex::Api::User.new(
+              user.id,
+              data: user,
+            )
+          elsif user.is_a?(Hash)
+            user = user.with_indifferent_access
+
+            @@user = Mangadex::Api::User.new(
+              user[:mangadex_user_id],
+              session: user[:session],
+              refresh: user[:refresh],
+            )
+          elsif user.nil?
+            @@user = nil
+          else
+            raise ArgumentError, "Must be an instance of #{Mangadex::Api::User}, #{Mangadex::User} or Hash"
+          end
+        end
+
+        def with_user(user)
+          current_user = @@user
+          @@user = user
+          response = yield
+          @@user = current_user
+          response
+        ensure
+          @@user = current_user
+        end
+
+        def without_user
+          with_user(nil) do
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mangadex/api/response.rb

@@ -0,0 +1,104 @@
+# typed: true
+module Mangadex
+  module Api
+    class Response < Mangadex::MangadexObject
+      extend T::Sig
+      extend T::Generic
+
+      attr_accessor :result, :response, :errors, :data
+      attr_accessor :limit, :offset, :total
+
+      def self.attributes_to_inspect
+        %i(result errors limit offset total data)
+      end
+
+      class Error < Mangadex::MangadexObject
+        attr_accessor :id, :status, :title, :detail
+
+        def self.attributes_to_inspect
+          %i(id status title detail)
+        end
+      end
+
+      class Collection < Array
+        def to_s
+          result_text = count == 0 || count > 1 ? "results" : "result"
+          "[...#{count} #{result_text}]"
+        end
+      end
+
+      sig { params(data: Hash).returns(T.any(Mangadex::Api::Response, Hash)) }
+      def self.coerce(data)
+        if data['errors']
+          coerce_errors(data)
+        elsif data['response'] == 'entity'
+          coerce_entity(data)
+        elsif data['response'] == 'collection'
+          coerce_collection(data)
+        else
+          data
+        end
+      end
+
+      private
+
+      def self.coerce_errors(data)
+        new(
+          result: data['result'],
+          response: data['response'],
+          errors: (
+            data['errors'].map do |error_data|
+              Error.new(
+                id: error_data['id'],
+                status: error_data['status'],
+                title: error_data['title'],
+                detail: error_data['detail'],
+              )
+            end
+          ),
+        )
+      end
+
+      def self.coerce_entity(data)
+        object_type = data['type'] || data.dig('data', 'type')
+
+        # Derive the class name from the type. "Convention over configuration"
+        class_from_data = "Mangadex::#{object_type.split('_').collect(&:capitalize).join}"
+        return unless Object.const_defined?(class_from_data)
+
+        klass = Object.const_get(class_from_data)
+        new(
+          result: data['result'],
+          response: data['response'],
+          data: klass.from_data(data['data'] || data),
+        )
+      end
+
+      def self.coerce_collection(data)
+        new(
+          result: data['result'],
+          response: data['response'],
+          limit: data['limit'],
+          offset: data['offset'],
+          total: data['total'],
+          data: (
+            Collection.new(
+              data['data'].map do |entity_data|
+                object_type = entity_data['type']
+                class_from_data = "Mangadex::#{object_type.split('_').collect(&:capitalize).join}"
+                return unless Object.const_defined?(class_from_data)
+
+                klass = Object.const_get(class_from_data)
+                klass.from_data(entity_data)
+              end
+            )
+          ),
+        )
+      end
+
+      def errored?
+        Array(errors).any?
+      end
+    end
+  end
+end

data/lib/mangadex/api/user.rb

@@ -0,0 +1,48 @@
+# typed: true
+module Mangadex
+  module Api
+    class User
+      attr_accessor :mangadex_user_id, :session, :refresh, :session_valid_until
+      attr_reader :data
+
+      def initialize(mangadex_user_id, session: nil, refresh: nil, data: nil)
+        raise ArgumentError, 'Missing mangadex_user_id' if mangadex_user_id.to_s.empty?
+
+        @mangadex_user_id = mangadex_user_id
+        @session = session
+        @session_valid_until = session ? Time.now + (14 * 60) : nil
+        @refresh = refresh
+        @data = data
+      end
+
+      # nil: Nothing happened, no need to refresh the token
+      # true: The tokens were successfully refreshed
+      # false: Error: refresh token empty or could not refresh the token on the server
+      def refresh!
+        return false if refresh.nil?
+
+        response = Mangadex::Api::Context.without_user do
+          Mangadex::Internal::Request.post('/auth/refresh', payload: { token: refresh })
+        end
+        return false unless response['token']
+
+        @session_valid_until = Time.now + (14 * 60)
+        @refresh = response.dig('token', 'refresh')
+        @session = response.dig('token', 'session')
+
+        true
+      end
+
+      def with_valid_session
+        session_expired? && refresh!
+        self
+      ensure
+        self
+      end
+
+      def session_expired?
+        @session_valid_until.nil? || @session_valid_until <= Time.now
+      end
+    end
+  end
+end

data/lib/mangadex/api/version.rb

@@ -0,0 +1,21 @@
+# typed: true
+require "psych"
+
+module Mangadex
+  module Api
+    VERSION = -> do
+      version = Psych.load(
+        RestClient.get(
+          'https://api.mangadex.org/api.yaml',
+        ).body,
+      ).dig('info', 'version')
+
+      if version != Mangadex::VERSION
+        warn(
+          "[Warning] This gem is compatible with #{Mangadex::VERSION} but it looks like Mangadex is at #{version}",
+          "[Warning] Check out #{Mangadex::Internal::Request::BASE_URI} for more information.",
+        )
+      end
+    end.call
+  end
+end

data/lib/mangadex/api.rb

@@ -0,0 +1,5 @@
+# typed: strict
+require_relative "api/version"
+require_relative "api/context"
+require_relative "api/response"
+require_relative "api/user"

data/lib/mangadex/artist.rb

@@ -0,0 +1,13 @@
+# typed: true
+require_relative "author"
+
+module Mangadex
+  class Artist < Author
+    # Indicates if this is an artist
+    #
+    # @return [Boolean] whether this is an artist or not.
+    def artist?
+      true
+    end
+  end
+end