mangadex 5.3.1 → 5.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c44ce27fcd41e7b08e02892e8f8dae3ca3c47beb3af218fcf5043676bafeb0d4
-  data.tar.gz: cb15886c9ba01b2534d5b49eb226791c8219255e7a26c8dea1856ff1d3a30999
+  metadata.gz: 70cb7894526dbcf74e8911b51fa186c5cfdfd2b206ed80e5c52377040a614b7b
+  data.tar.gz: dc1acb66eeec43f0f07a0d0a99d20d762fdac959e0abeb62893c1ec8eeb4266d
 SHA512:
-  metadata.gz: c07c3433681344d6d2f1a2f85e99f36e691eac96e3774001fff1c3dc58aed8e0e82c62f640c6d453dce45b2827cd4d1d0347c4f0a515acd57dd258cbf9799c13
-  data.tar.gz: 63caf26a2274fc5496bb0c62e3d7d3d8f7f179dfeee5ac8749d6cde29afaf24e9a9cbea228c5db3603fc590056252bd7ccb22e3e4b26542a37be737a41910618
+  metadata.gz: 515629e3df563f6e4ec848fa45c50e184332d062aff08a6097df51c9870f40a8ff88fac09d918aa7647cd286271c47e1f99032768d99eb211053e363b1a4d1bc
+  data.tar.gz: 3aef7d8db275e3aa1337f4c6494a41ce2dfcd30acd1058c5351df86f2e745f478c8175b4aca27655cba8eb4ca3ff2be5b01f7dadd7d61d035d993fbf1b234802

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [culture]
+  pull_request:
+    branches: [culture]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.7", "3.0"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rspec
+      - name: Run sorbet typecheck
+        run: bundle exec srb tc

data/.gitignore

@@ -9,4 +9,9 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Build
+*.gem
+
+# Misc
 .DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mangadex (5.3.1)
+    mangadex (5.3.1.3)
       activesupport (~> 6.1)
       psych (~> 4.0.1)
       rest-client (~> 2.1)
@@ -16,11 +16,16 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
     http-accept (1.7.0)
     http-cookie (1.0.4)
       domain_name (~> 0.5)
@@ -31,17 +36,30 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2021.0901)
     minitest (5.14.4)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     netrc (0.11.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     psych (4.0.1)
-    rake (10.5.0)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rake (13.0.6)
+    request_interceptor (1.0.0)
+      activesupport (>= 4.0)
+      rack
+      sinatra
+      smart_properties (~> 1.0)
+      webmock (~> 3.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)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -55,25 +73,40 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    smart_properties (1.16.3)
     sorbet (0.5.9152)
       sorbet-static (= 0.5.9152)
-    sorbet-runtime (0.5.9152)
+    sorbet-runtime (0.5.9158)
     sorbet-static (0.5.9152-universal-darwin-20)
+    sorbet-static (0.5.9152-x86_64-linux)
+    tilt (2.0.10)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.2.19)
   mangadex!
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
+  request_interceptor (~> 1.0.0)
   rspec (~> 3.0)
   sorbet
 

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby](https://github.com/thedrummeraki/mangadex/actions/workflows/ruby.yml/badge.svg)](https://github.com/thedrummeraki/mangadex/actions/workflows/ruby.yml)<a href="https://rubygems.org/gems/mangadex"><img src="https://badgen.net/rubygems/v/mangadex" /></a>
+
 # Mangadex
 
 Welcome to `mangadex`, your next favourite Ruby gem for interacting with [Mangadex](https://mangadex.org).
@@ -20,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-Please note that I tried my best to follow Mangadex's naming conventions for [their documentation](https://api.mangadex.org).
+Please note that I tried my best to follow Mangadex's naming conventions for [their documentation](https://api.mangadex.org). Track the progress [here in an issue](https://github.com/thedrummeraki/mangadex/issues/5).
 To find out how to use the gem, you're welcome to [check this out](lib/mangadex).
 
 ## Development

data/lib/mangadex/api/context.rb

@@ -2,50 +2,60 @@
 module Mangadex
   module Api
     class Context
+      extend T::Sig
+
       @@user = nil
+      @@version = nil
 
-      class << self
-        def user
-          @@user&.with_valid_session
-        end
+      sig { returns(T.nilable(String)) }
+      def self.version
+        return @@version unless @@version.nil?
 
-        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
+        @@version = Mangadex::Api::Version.check_mangadex_version
+      end
+
+      sig { returns(T.nilable(Mangadex::Api::User)) }
+      def self.user
+        @@user&.with_valid_session
+      end
 
-        def with_user(user)
-          current_user = @@user
+      sig { params(user: T.nilable(T.any(Hash, Mangadex::Api::User, Mangadex::User))).void }
+      def self.user=(user)
+        if user.is_a?(Mangadex::Api::User)
           @@user = user
-          response = yield
-          @@user = current_user
-          response
-        ensure
-          @@user = current_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
         end
+      end
+
+      sig { params(user: T.nilable(T.any(Hash, Mangadex::Api::User, Mangadex::User)), block: T.proc.returns(T.untyped)).returns(T.untyped) }
+      def self.with_user(user, &block)
+        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
+      sig { params(block: T.proc.returns(T.untyped)).returns(T.untyped) }
+      def self.without_user(&block)
+        with_user(nil) do
+          yield
         end
       end
     end

data/lib/mangadex/api/response.rb

@@ -40,6 +40,10 @@ module Mangadex
         end
       end
 
+      def errored?
+        Array(errors).any?
+      end
+
       private
 
       def self.coerce_errors(data)
@@ -95,10 +99,6 @@ module Mangadex
           ),
         )
       end
-
-      def errored?
-        Array(errors).any?
-      end
     end
   end
 end

data/lib/mangadex/api/user.rb

@@ -2,9 +2,12 @@
 module Mangadex
   module Api
     class User
+      extend T::Sig
+
       attr_accessor :mangadex_user_id, :session, :refresh, :session_valid_until
       attr_reader :data
 
+      sig { params(mangadex_user_id: String, session: T.nilable(String), refresh: T.nilable(String), data: T.untyped).void }
       def initialize(mangadex_user_id, session: nil, refresh: nil, data: nil)
         raise ArgumentError, 'Missing mangadex_user_id' if mangadex_user_id.to_s.empty?
 
@@ -15,9 +18,9 @@ module Mangadex
         @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
+      sig { returns(T::Boolean) }
       def refresh!
         return false if refresh.nil?
 
@@ -33,6 +36,7 @@ module Mangadex
         true
       end
 
+      sig { returns(Mangadex::Api::User) }
       def with_valid_session
         session_expired? && refresh!
         self
@@ -40,6 +44,7 @@ module Mangadex
         self
       end
 
+      sig { returns(T::Boolean) }
       def session_expired?
         @session_valid_until.nil? || @session_valid_until <= Time.now
       end

data/lib/mangadex/api/version_checker.rb

@@ -0,0 +1,31 @@
+# typed: true
+require "psych"
+
+module Mangadex
+  module Api
+    class Version
+      extend T::Sig
+
+      sig { returns(T.nilable(String)) }
+      def self.check_mangadex_version
+        puts("Checking Mangadex's latest API version...")
+        version = Psych.load(
+          RestClient.get(
+            'https://api.mangadex.org/api.yaml',
+          ).body,
+        ).dig('info', 'version')
+
+        if version != Mangadex::Version::STRING
+          warn(
+            "[Warning] This gem is compatible with #{Mangadex::Version::STRING} but it looks like Mangadex is at #{version}",
+            "[Warning] Check out #{Mangadex::Internal::Request::BASE_URI} for more information.",
+          )
+        end
+
+        version
+      rescue => error
+        nil
+      end
+    end
+  end
+end

data/lib/mangadex/api.rb

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

data/lib/mangadex/auth.rb

@@ -1,56 +1,60 @@
 # typed: false
 module Mangadex
   class Auth
-    class << self
-      def login(username, password)
-        response = Mangadex::Internal::Request.post(
-          '/auth/login',
-          payload: {
-            username: username,
-            password: password,
-          },
-        )
-        return response if response.is_a?(Mangadex::Api::Response) && response.errored?
-
-        session = response.dig('token', 'session')
-        refresh = response.dig('token', 'refresh')
-
-        mangadex_user = Mangadex::Internal::Request.get('/user/me', headers: { Authorization: session })
+    extend T::Sig
+
+    sig { params(username: String, password: String).returns(T.any(T::Boolean, Mangadex::Api::Response)) }
+    def self.login(username, password)
+      response = Mangadex::Internal::Request.post(
+        '/auth/login',
+        payload: {
+          username: username,
+          password: password,
+        },
+      )
+      return response if response.is_a?(Mangadex::Api::Response) && response.errored?
+
+      session = response.dig('token', 'session')
+      refresh = response.dig('token', 'refresh')
+
+      mangadex_user = Mangadex::Internal::Request.get('/user/me', headers: { Authorization: session })
+
+      user = Mangadex::Api::User.new(
+        mangadex_user.data.id,
+        session: session,
+        refresh: refresh,
+        data: mangadex_user.data,
+      )
+      Mangadex::Api::Context.user = user
+      !user.session_expired?
+    end
 
-        user = Mangadex::Api::User.new(
-          mangadex_user.data.id,
-          session: session,
-          refresh: refresh,
-          data: mangadex_user.data,
+    sig { returns(Hash) }
+    def self.check_token
+      JSON.parse(
+        Mangadex::Internal::Request.get(
+          '/auth/check',
+          raw: true,
         )
-        Mangadex::Api::Context.user = user
-        !user.session_expired?
-      end
-
-      def check_token
-        JSON.parse(
-          Mangadex::Internal::Request.get(
-            '/auth/check',
-            raw: true,
-          )
-        )
-      end
+      )
+    end
 
-      def logout
-        return true if Mangadex::Api::Context.user.nil?
+    sig { returns(T.any(T::Boolean, Mangadex::Api::Response)) }
+    def self.logout
+      return true if Mangadex::Api::Context.user.nil?
 
-        response = Mangadex::Internal::Request.post(
-          '/auth/logout',
-        )
-        return reponse if response.is_a?(Mangadex::Api::Response) && response.errored?
+      response = Mangadex::Internal::Request.post(
+        '/auth/logout',
+      )
+      return reponse if response.is_a?(Mangadex::Api::Response) && response.errored?
 
-        Mangadex::Api::Context.user = nil
-        true
-      end
+      Mangadex::Api::Context.user = nil
+      true
+    end
 
-      def refresh_token
-        !(Mangadex::Api::Context.user&.refresh!).nil?
-      end
+    sig { returns(T::Boolean) }
+    def self.refresh_token
+      !(Mangadex::Api::Context.user&.refresh!).nil?
     end
   end
 end

data/lib/mangadex/author.rb

@@ -4,7 +4,24 @@ require_relative 'mangadex_object'
 
 module Mangadex
   class Author < MangadexObject
-    has_attributes :name, :image_url, :biography, :version, :created_at, :updated_at
+    has_attributes \
+      :name,
+      :image_url,
+      :biography,
+      :twitter,
+      :pixiv,
+      :melon_book,
+      :fan_box,
+      :booth,
+      :nicovideo,
+      :skeb,
+      :fantia,
+      :tumblr,
+      :youtube,
+      :website,
+      :version,
+      :created_at,
+      :updated_at
 
     # List all authors.
     # Path: +GET /author+

data/lib/mangadex/internal/request.rb

@@ -68,7 +68,7 @@ module Mangadex
         end
       rescue RestClient::Exception => error
         if error.response.body
-          raw ? error.response.body : Mangadex::Api::Response.coerce(JSON.parse(error.response.body))
+          raw ? error.response.body : Mangadex::Api::Response.coerce(JSON.parse(error.response.body)) rescue raise error
         else
           raise error
         end

data/lib/mangadex/manga.rb

@@ -114,7 +114,7 @@ module Mangadex
     end
 
     sig { params(args: T::Api::Arguments).returns(T::Api::GenericResponse) }
-    def self.reading_status(**args)
+    def self.all_reading_status(**args)
       Mangadex::Internal::Request.get(
         '/manga/status',
         Mangadex::Internal::Definition.validate(args, {
@@ -133,13 +133,6 @@ module Mangadex
       )
     end
 
-    sig { returns(T::Api::GenericResponse) }
-    def self.all_reading_status
-      Mangadex::Internal::Request.get(
-        '/manga/status',
-      )
-    end
-
     sig { params(id: String, status: String).returns(T::Api::GenericResponse) }
     def self.update_reading_status(id, status)
       Mangadex::Internal::Request.post(

data/lib/mangadex/scanlation_group.rb

@@ -3,6 +3,7 @@ module Mangadex
   class ScanlationGroup < MangadexObject
     has_attributes \
       :name,
+      :alt_names,
       :website,
       :irc_channel,
       :irc_server,

data/lib/mangadex/version.rb

@@ -1,4 +1,12 @@
-# typed: strict
+# typed: false
 module Mangadex
-  VERSION = "5.3.1"
+  module Version
+    MAJOR = "5"
+    MINOR = "3"
+    TINY = "2"
+    PATCH = nil
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+    FULL = [MAJOR, MINOR, TINY, PATCH].compact.join('.')
+  end
 end

data/mangadex.gemspec

@@ -5,7 +5,7 @@ require "mangadex/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "mangadex"
-  spec.version       = Mangadex::VERSION
+  spec.version       = Mangadex::Version::FULL
   spec.authors       = ["Akinyele Cafe-Febrissy"]
   spec.email         = ["me@akinyele.ca"]
 
@@ -28,8 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sorbet-runtime"
 
   spec.add_development_dependency "bundler", "~> 2.2.19"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "request_interceptor", "~> 1.0.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "sorbet"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mangadex
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 5.3.2
 platform: ruby
 authors:
 - Akinyele Cafe-Febrissy
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-22 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: request_interceptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -136,13 +150,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - me@akinyele.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -162,7 +177,7 @@ files:
 - lib/mangadex/api/context.rb
 - lib/mangadex/api/response.rb
 - lib/mangadex/api/user.rb
-- lib/mangadex/api/version.rb
+- lib/mangadex/api/version_checker.rb
 - lib/mangadex/artist.rb
 - lib/mangadex/auth.rb
 - lib/mangadex/author.rb
@@ -221,7 +236,7 @@ homepage: https://github.com/thedrummeraki/mangadex
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -237,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.15
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Your next favourite Ruby gem for interacting with Mangadex.org
 test_files: []

data/lib/mangadex/api/version.rb

@@ -1,21 +0,0 @@
-# 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