mangadex 5.3.1.1 → 5.3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c3906abcda03214729faefa84f1f28cf7685a56bb31d2759a75728c2dfe8633
-  data.tar.gz: 8ad9182042f2e00bd2d796d1278fbdd6ba3413ef66cd8c2c9946d2e79f5c9dc4
+  metadata.gz: 7f849f066bfd4117f3a62b0712201ee6cafe769a7c2e6d6ef9d75789200accb9
+  data.tar.gz: 74deaae68ac7efe1b3634495689350a34b0b2479508518a11ae8162207c41b55
 SHA512:
-  metadata.gz: d5e8f6bb17f8b565fd5b9068089282370c5f6b88d2707331ceeabbd35a7372f937c9a8e71ee41fe6c32b249950ed8908a429456d65369610ee1976b50329122a
-  data.tar.gz: d4e78fc2cae3bdc612b2cf739d989a5590e2a95fe6256dfc2cc5c9120dd07a727d2557dc9ae9461b16e080c0bb8950e8562333679c0cef7f569e4c6d5c917b9e
+  metadata.gz: daae07877b80764aa77d3aa3ed5e4332f93c60cd72a70c5aaba48d5de4a12c5f6259b19fae0dcbf9f11a7cfc24f4d4d7fd9c761a2ecacd0172bc968bde69670c
+  data.tar.gz: 39515e57425a001d787a2bab769694e25c6da7aea8cbf7ffb1a3ee1d263cc7143576fbe916889180437d7c416ffaea392430d1a86080d135f40c2f4bd54d9df8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mangadex (5.3.1)
+    mangadex (5.3.1.1)
       activesupport (~> 6.1)
       psych (~> 4.0.1)
       rest-client (~> 2.1)

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/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/version.rb

@@ -1,4 +1,12 @@
-# typed: strict
+# typed: false
 module Mangadex
-  VERSION = "5.3.1.1"
+  module Version
+    MAJOR = "5"
+    MINOR = "3"
+    TINY = "1"
+    PATCH = "2"
+
+    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"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mangadex
 version: !ruby/object:Gem::Version
-  version: 5.3.1.1
+  version: 5.3.1.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-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - me@akinyele.ca
 executables: []
@@ -162,7 +162,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 +221,7 @@ homepage: https://github.com/thedrummeraki/mangadex
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -237,7 +237,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,23 +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
-
-      version
-    end.call
-  end
-end