mangadex 5.3.2 → 5.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70cb7894526dbcf74e8911b51fa186c5cfdfd2b206ed80e5c52377040a614b7b
-  data.tar.gz: dc1acb66eeec43f0f07a0d0a99d20d762fdac959e0abeb62893c1ec8eeb4266d
+  metadata.gz: 166fb230b0125992e5168515129718a28f7d545c3c1cb07f9bc81e837ad8c2c7
+  data.tar.gz: cf310df080bb7fdce3df2fd885aa478de4ae050272e58d97ce6fdbe0b60459af
 SHA512:
-  metadata.gz: 515629e3df563f6e4ec848fa45c50e184332d062aff08a6097df51c9870f40a8ff88fac09d918aa7647cd286271c47e1f99032768d99eb211053e363b1a4d1bc
-  data.tar.gz: 3aef7d8db275e3aa1337f4c6494a41ce2dfcd30acd1058c5351df86f2e745f478c8175b4aca27655cba8eb4ca3ff2be5b01f7dadd7d61d035d993fbf1b234802
+  metadata.gz: 4babccf80e64908e70f612d5afb152b00fef108c827cbfc75a273478ee2f1230b6b2366318bab5a3fadb3b2025e0e7a64bed88746c04484d18a9c1a62a241e2a
+  data.tar.gz: aebcdeed93c99b1beb9e4723e8371875c21da6629311270cbf2b6ca5c58c55b0dca39e8a222bcd886180ee7b1059e40853948f90a25553da4dea8f1d261b4f44

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mangadex (5.3.1.3)
+    mangadex (5.3.2)
       activesupport (~> 6.1)
       psych (~> 4.0.1)
       rest-client (~> 2.1)
@@ -82,7 +82,7 @@ GEM
     smart_properties (1.16.3)
     sorbet (0.5.9152)
       sorbet-static (= 0.5.9152)
-    sorbet-runtime (0.5.9158)
+    sorbet-runtime (0.5.9161)
     sorbet-static (0.5.9152-universal-darwin-20)
     sorbet-static (0.5.9152-x86_64-linux)
     tilt (2.0.10)

data/lib/mangadex/api/context.rb

@@ -6,6 +6,7 @@ module Mangadex
 
       @@user = nil
       @@version = nil
+      @@force_raw_requests = nil
 
       sig { returns(T.nilable(String)) }
       def self.version
@@ -58,6 +59,32 @@ module Mangadex
           yield
         end
       end
+
+      def self.force_raw_requests(&block)
+        if block_given?
+          temp_force_raw_requests do
+            yield
+          end
+        else
+          !!@@force_raw_requests
+        end
+      end
+
+      def self.force_raw_requests=(value)
+        @@force_raw_requests = value
+      end
+
+      private
+
+      def self.temp_force_raw_requests(&block)
+        current_force_raw_requests = @@force_raw_requests
+        @@force_raw_requests = true
+        response = yield
+        @@force_raw_requests = current_force_raw_requests
+        response
+      ensure
+        @@force_raw_requests = current_force_raw_requests
+      end
     end
   end
 end

data/lib/mangadex/api/response.rb

@@ -7,6 +7,7 @@ module Mangadex
 
       attr_accessor :result, :response, :errors, :data
       attr_accessor :limit, :offset, :total
+      attr_accessor :raw_data
 
       def self.attributes_to_inspect
         %i(result errors limit offset total data)
@@ -44,6 +45,10 @@ module Mangadex
         Array(errors).any?
       end
 
+      def as_json(*)
+        Hash(raw_data)
+      end
+
       private
 
       def self.coerce_errors(data)
@@ -60,6 +65,7 @@ module Mangadex
               )
             end
           ),
+          raw_data: data,
         )
       end
 
@@ -75,6 +81,7 @@ module Mangadex
           result: data['result'],
           response: data['response'],
           data: klass.from_data(data['data'] || data),
+          raw_data: data,
         )
       end
 
@@ -97,6 +104,7 @@ module Mangadex
               end
             )
           ),
+          raw_data: data,
         )
       end
     end

data/lib/mangadex/author.rb

@@ -66,6 +66,8 @@ module Mangadex
     # @return [Mangadex::Api::Response] with a entity of author
     sig { params(id: String, args: T::Api::Arguments).returns(Mangadex::Api::Response[Author]) }
     def self.get(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.get(
         format('/author/%{id}', id: id),
         Mangadex::Internal::Definition.validate(args, {
@@ -81,6 +83,8 @@ module Mangadex
     # @return [Mangadex::Api::Response] with a entity of author
     sig { params(id: String, args: T::Api::Arguments).returns(Mangadex::Api::Response[Author]) }
     def self.update(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.put(
         format('/author/%{id}', id: id),
         payload: Mangadex::Internal::Definition.validate(args, {
@@ -98,6 +102,8 @@ module Mangadex
     # @return [Hash]
     sig { params(id: String).returns(Hash) }
     def self.delete(id)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.delete(
         format('/author/%{id}', id: id)
       )
@@ -107,6 +113,10 @@ module Mangadex
       [:name]
     end
 
+    class << self
+      alias_method :view, :get
+    end
+
     # Indicates if this is an artist
     #
     # @return [Boolean] whether this is an artist or not.

data/lib/mangadex/chapter.rb

@@ -31,6 +31,8 @@ module Mangadex
 
     sig { params(id: String, args: T::Api::Arguments).returns(Mangadex::Api::Response[Chapter]) }
     def self.get(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.get(
         '/chapter/%{id}' % {id: id},
         Mangadex::Internal::Definition.validate(args, {
@@ -41,6 +43,8 @@ module Mangadex
 
     sig { params(id: String, args: T::Api::Arguments).returns(Mangadex::Api::Response[Chapter]) }
     def self.update(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.put(
         '/chapter/%{id}' % {id: id},
         payload: Mangadex::Internal::Definition.validate(args, {
@@ -56,11 +60,17 @@ module Mangadex
 
     sig { params(id: String).returns(Hash) }
     def self.delete(id)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.delete(
         '/chapter/%{id}' % {id: id},
       )
     end
 
+    class << self
+      alias_method :view, :get
+    end
+
     sig { returns(String) }
     def title
       attributes&.title.presence || chapter.presence && "Chapter #{chapter}" || "N/A"

data/lib/mangadex/content_rating.rb

@@ -64,7 +64,7 @@ module Mangadex
 
     private
 
-    sig { params(value: T.any(T::Api::Text, T::Api::ContentRating)).void }
+    sig { params(value: T.any(T::Api::Text, T::Api::ContentRating)).returns(T.any(T::Api::Text, T::Api::ContentRating)) }
     def ensure_value!(value)
       return value if value.is_a?(ContentRating)
       return value if VALUES.include?(value)

data/lib/mangadex/cover_art.rb

@@ -47,6 +47,8 @@ module Mangadex
 
     sig { params(id: String, args: T::Api::Arguments).returns(Mangadex::Api::Response[CoverArt]) }
     def self.get(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.get(
         '/cover/%{id}' % {id: id},
         Mangadex::Internal::Definition.validate(args, {
@@ -57,6 +59,8 @@ module Mangadex
 
     sig { params(id: String, args: T::Api::Arguments).returns(Mangadex::Api::Response[CoverArt]) }
     def self.edit(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.put(
         '/cover/%{id}' % {id: id},
         Mangadex::Internal::Definition.validate(args, {
@@ -69,11 +73,18 @@ module Mangadex
 
     sig { params(id: String).returns(Hash) }
     def self.delete(id)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.delete(
         '/cover/%{id}' % {id: id},
       )
     end
 
+    class << self
+      alias_method :view, :get
+      alias_method :update, :edit
+    end
+
     sig { params(size: T::Api::Text).returns(T.nilable(String)) }
     def image_url(size: :small)
       return unless manga.present?

data/lib/mangadex/custom_list.rb

@@ -24,6 +24,8 @@ module Mangadex
 
     sig { params(id: String).returns(Mangadex::Api::Response[CustomList]) }
     def self.get(id)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.get(
         '/list/%{id}' % {id: id},
       )
@@ -31,6 +33,8 @@ module Mangadex
 
     sig { params(id: String, args: T::Api::Arguments).returns(Mangadex::Api::Response[CustomList]) }
     def self.update(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.put(
         '/list/%{id}' % {id: id},
         payload: Mangadex::Internal::Definition.validate(args, {
@@ -44,6 +48,8 @@ module Mangadex
 
     sig { params(id: String).returns(T::Boolean) }
     def self.delete(id)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.delete(
         '/list/%{id}' % {id: id},
       )
@@ -51,6 +57,8 @@ module Mangadex
 
     sig { params(id: String, args: T::Api::Arguments).returns(Mangadex::Api::Response[Chapter]) }
     def self.feed(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.get(
         '/list/%{id}/feed' % {id: id},
         Mangadex::Internal::Definition.chapter_list(args),
@@ -59,6 +67,8 @@ module Mangadex
 
     sig { params(id: String, list_id: String).returns(T::Boolean) }
     def self.add_manga(id, list_id:)
+      Mangadex::Internal::Definition.must(id)
+
       response = Mangadex::Internal::Request.post(
         '/manga/%{id}/list/%{list_id}' % {id: id, list_id: list_id},
       )
@@ -71,6 +81,8 @@ module Mangadex
 
     sig { params(id: String, list_id: String).returns(T::Boolean) }
     def self.remove_manga(id, list_id:)
+      Mangadex::Internal::Definition.must(id)
+
       response = Mangadex::Internal::Request.delete(
         '/manga/%{id}/list/%{list_id}' % {id: id, list_id: list_id},
       )
@@ -94,6 +106,8 @@ module Mangadex
 
     sig { params(user_id: String, args: T::Api::Arguments).returns(Mangadex::Api::Response[CustomList]) }
     def self.user_list(user_id, **args)
+      Mangadex::Internal::Definition.must(user_id)
+
       Mangadex::Internal::Request.get(
         '/user/%{id}/list' % {id: user_id},
         Mangadex::Internal::Definition.validate(args, {
@@ -103,6 +117,11 @@ module Mangadex
       )
     end
 
+    class << self
+      alias_method :view, :get
+      alias_method :edit, :update
+    end
+
     sig { params(id: String).returns(T::Boolean) }
     def add_manga(id)
       Mangadex::CustomList.add_manga(id, list_id: self.id)

data/lib/mangadex/internal/definition.rb

@@ -120,6 +120,19 @@ module Mangadex
           )
         end
 
+        def must(*args)
+          args = args.each_with_index.map do |arg, index|
+            ["arg_at_position_#{index}".to_sym, arg]
+          end.to_h
+
+          definition = args.keys.map do |key|
+            [key, { required: true }]
+          end.to_h
+
+          validate(args, definition)
+          args.values
+        end
+
         def validate(args, definition)
           args = Hash(args).with_indifferent_access
           definition = Hash(definition).with_indifferent_access
@@ -144,7 +157,7 @@ module Mangadex
           if errors.any?
             error_message = errors.map do |error|
               if error[:extra]
-                "params[:#{error[:extra]}] does not exist and cannot be passed to this request"
+                "paalidate_required!rams[:#{error[:extra]}] does not exist and cannot be passed to this request"
               elsif error[:message]
                 error[:message]
               else

data/lib/mangadex/internal/request.rb

@@ -62,13 +62,15 @@ module Mangadex
         end_time = Time.now
         elapsed_time = ((end_time - start_time) * 1000).to_i
         puts("[#{self.class.name}] took #{elapsed_time} ms")
+        
+        raw_request = raw || Mangadex::Api::Context.force_raw_requests
 
-        if @response.body
-          raw ? @response.body : Mangadex::Api::Response.coerce(JSON.parse(@response.body))
+        if (body = @response.body)
+          raw_request ? try_json(body) : Mangadex::Api::Response.coerce(try_json(body))
         end
       rescue RestClient::Exception => error
-        if error.response.body
-          raw ? error.response.body : Mangadex::Api::Response.coerce(JSON.parse(error.response.body)) rescue raise error
+        if (body = error.response.body)
+          raw_request ? try_json(body) : Mangadex::Api::Response.coerce(JSON.parse(body)) rescue raise error
         else
           raise error
         end
@@ -116,6 +118,12 @@ module Mangadex
 
         raise "Invalid method: #{method}. Must be one of: #{ALLOWED_METHODS}"
       end
+
+      def try_json(body)
+        JSON.parse(body)
+      rescue JSON::ParserError
+        body
+      end
     end
   end
 end

data/lib/mangadex/internal/with_attributes.rb

@@ -11,7 +11,8 @@ module Mangadex
           :id,
           :type,
           :attributes,
-          :relationships
+          :relationships,
+          :related_type
       
       class_methods do
         USING_ATTRIBUTES = {}
@@ -30,7 +31,7 @@ module Mangadex
           self.name.split('::').last.underscore
         end
 
-        def from_data(data)
+        def from_data(data, related_type: nil)
           base_class_name = self.name.gsub('::', '_')
           klass_name = self.name
           target_attributes_class_name = "#{base_class_name}_Attributes"
@@ -65,6 +66,7 @@ module Mangadex
             id: data['id'],
             type: data['type'] || self.type,
             attributes: attributes,
+            related_type: related_type,
           }
 
           initialize_hash.merge!({relationships: relationships}) if relationships.present?
@@ -110,6 +112,13 @@ module Mangadex
             else
               super
             end
+          elsif !related_type.nil?
+            return super unless method_name.end_with?("?")
+
+            looking_for_related = method_name.to_s.split("?").first
+            return super unless Mangadex::Relationship::RELATED_VALUES.include?(looking_for_related)
+
+            related_type == looking_for_related
           else
             super
           end

data/lib/mangadex/manga.rb

@@ -66,6 +66,8 @@ module Mangadex
 
     sig { params(id: String, args: T::Api::Arguments).returns(T::Api::MangaResponse) }
     def self.view(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.get(
         '/manga/%{id}' % {id: id},
         Mangadex::Internal::Definition.validate(args, {
@@ -76,6 +78,8 @@ module Mangadex
 
     sig { params(id: String).returns(T.any(Hash, Mangadex::Api::Response)) }
     def self.unfollow(id)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.delete(
         '/manga/%{id}/follow' % {id: id},
       )
@@ -83,6 +87,8 @@ module Mangadex
 
     sig { params(id: String).returns(T.any(Hash, Mangadex::Api::Response)) }
     def self.follow(id)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.post(
         '/manga/%{id}/follow' % {id: id},
       )
@@ -90,6 +96,8 @@ module Mangadex
 
     sig { params(id: String, args: T::Api::Arguments).returns(T::Api::ChapterResponse) }
     def self.feed(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.get(
         '/manga/%{id}/feed' % {id: id},
         Mangadex::Internal::Definition.chapter_list(args),
@@ -128,6 +136,8 @@ module Mangadex
 
     sig { params(id: String).returns(T::Api::GenericResponse) }
     def self.reading_status(id)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.get(
         '/manga/%{id}/status' % {id: id},
       )
@@ -135,6 +145,8 @@ module Mangadex
 
     sig { params(id: String, status: String).returns(T::Api::GenericResponse) }
     def self.update_reading_status(id, status)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.post(
         '/manga/%{id}/status' % {id: id},
         payload: Mangadex::Internal::Definition.validate({status: status}, {
@@ -149,11 +161,15 @@ module Mangadex
     # Untested API endpoints
     sig { params(id: String, args: T::Api::Arguments).returns(T::Api::MangaResponse) }
     def self.update(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.put('/manga/%{id}' % {id: id}, payload: args)
     end
 
     sig { params(id: String).returns(Hash) }
     def self.delete(id)
+      Mangadex::Internal::Definition.must(id)
+
       Mangadex::Internal::Request.delete(
         '/manga/%{id}' % {id: id},
       )
@@ -169,6 +185,8 @@ module Mangadex
 
     class << self
       alias_method :aggregate, :volumes_and_chapters
+      alias_method :get, :view
+      alias_method :edit, :update
     end
 
     sig { returns(T.nilable(ContentRating)) }

data/lib/mangadex/relationship.rb

@@ -1,33 +1,45 @@
 # typed: false
 module Mangadex
   class Relationship < MangadexObject
-    attr_accessor :id, :type, :attributes
+    attr_accessor :id, :type, :related, :attributes
+
+    RELATED_VALUES = %w(
+      monochrome
+      main_story
+      adapted_from
+      based_on
+      prequel
+      side_story
+      doujinshi
+      same_franchise
+      shared_universe
+      sequel
+      spin_off
+      alternate_story
+      preserialization
+      colored
+      serialization
+    ).freeze
 
     class << self
       def from_data(data)
         data = data.with_indifferent_access
         klass = class_for_relationship_type(data['type'])
 
-        return klass.from_data(data) if klass && data['attributes']&.any?
+        if klass && data['attributes']&.any?
+          return klass.from_data(data, related_type: data['related'])
+        end
 
         new(
           id: data['id'],
           type: data['type'],
           attributes: OpenStruct.new(data['attributes']),
+          related: data['related'],
         )
       end
 
       private
 
-      def build_attributes(data)
-        klass = class_for_relationship_type(data['type'])
-        if klass.present?
-          klass.from_data(data)
-        else
-          OpenStruct.new(data['attributes'])
-        end
-      end
-
       def class_for_relationship_type(type)
         module_parts = self.name.split('::')
         module_name = module_parts.take(module_parts.size - 1).join('::')
@@ -39,8 +51,18 @@ module Mangadex
       end
     end
 
-    def inspect
-      "#<#{self.class} id=#{id.inspect} type=#{type.inspect}>"
+    def self.attributes_to_inspect
+      [:id, :type, :related]
+    end
+
+    
+    def method_missing(value)
+      return super unless value.end_with?("?")
+
+      looking_for_related = value.to_s.split("?").first
+      return super unless RELATED_VALUES.include?(looking_for_related)
+
+      !related.nil? && related == looking_for_related
     end
   end
 end

data/lib/mangadex/scanlation_group.rb

@@ -48,6 +48,8 @@ module Mangadex
       end
 
       def view(id)
+        Mangadex::Internal::Definition.must(id)
+
         Mangadex::Internal::Request.get(
           '/group/%{id}' % {id: id},
           Mangadex::Internal::Definition.validate(args, {
@@ -92,6 +94,11 @@ module Mangadex
       end
     end
 
+    class << self
+      alias_method :get, :view
+      alias_method :edit, :update
+    end
+
     def self.inspect_attributes
       self.attributes - [:version, :created_at, :updated_at]
     end

data/lib/mangadex/sorbet.rb

@@ -17,7 +17,8 @@ module T
     MangaResponse = T.type_alias do
       T.any(
         Mangadex::Api::Response[Mangadex::Manga],
-        Mangadex::Api::Response[T::Array[Mangadex::Manga]]
+        Mangadex::Api::Response[T::Array[Mangadex::Manga]],
+        Hash,
       )
     end
     ChapterResponse = T.type_alias do

data/lib/mangadex/upload.rb

@@ -28,6 +28,8 @@ module Mangadex
       alias_method :begin, :start
 
       def upload_images(upload_session_id)
+        Mangadex::Internal::Definition.must(upload_session_id)
+
         Mangadex::Internal::Request.post(
           '/upload/%{upload_session_id}' % {upload_session_id: upload_session_id},
           payload: Mangadex::Internal::Definition.validate(args, {
@@ -37,6 +39,8 @@ module Mangadex
       end
 
       def abandon(upload_session_id)
+        Mangadex::Internal::Definition.must(upload_session_id)
+
         Mangadex::Internal::Request.delete(
           '/upload/%{upload_session_id}' % {upload_session_id: upload_session_id},
         )
@@ -44,6 +48,8 @@ module Mangadex
       alias_method :stop, :abandon
 
       def commit(upload_session_id, **args)
+        Mangadex::Internal::Definition.must(upload_session_id)
+
         Mangadex::Internal::Request.post(
           '/upload/%{upload_session_id}/commit' % {upload_session_id: upload_session_id},
           payload: Mangadex::Internal::Definition.validate(args, {
@@ -54,6 +60,8 @@ module Mangadex
       end
 
       def delete_uploaded_image(upload_session_id, upload_session_file_id)
+        Mangadex::Internal::Definition.must(upload_session_id)
+
         Mangadex::Internal::Request.delete(
           '/upload/%{upload_session_id}/%{upload_session_file_id}' % {
             upload_session_id: upload_session_id,
@@ -63,6 +71,8 @@ module Mangadex
       end
 
       def delete_uploaded_images(upload_session_id, upload_session_file_ids)
+        Mangadex::Internal::Definition.must(upload_session_id)
+
         Mangadex::Internal::Request.delete(
           '/upload/%{upload_session_id}' % {upload_session_id: upload_session_id},
           payload: Array(upload_session_file_id),

data/lib/mangadex/user.rb

@@ -30,6 +30,8 @@ module Mangadex
 
     sig { params(id: String).returns(T::Boolean) }
     def self.follows_group(id)
+      Mangadex::Internal::Definition.must(id)
+
       data = Mangadex::Internal::Request.get(
         '/user/follows/group/%{id}' % {id: id},
         raw: true,
@@ -55,6 +57,8 @@ module Mangadex
 
     sig { params(id: String).returns(T::Boolean) }
     def self.follows_user(id)
+      Mangadex::Internal::Definition.must(id)
+
       return if Mangadex::Api::Context.user.nil?
 
       data = Mangadex::Internal::Request.get(
@@ -83,6 +87,8 @@ module Mangadex
 
     sig { params(id: String).returns(T::Boolean) }
     def self.follows_manga(id)
+      Mangadex::Internal::Definition.must(id)
+
       return if Mangadex::Api::Context.user.nil?
 
       data = Mangadex::Internal::Request.get(

data/lib/mangadex/version.rb

@@ -3,7 +3,7 @@ module Mangadex
   module Version
     MAJOR = "5"
     MINOR = "3"
-    TINY = "2"
+    TINY = "3"
     PATCH = nil
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mangadex
 version: !ruby/object:Gem::Version
-  version: 5.3.2
+  version: 5.3.3
 platform: ruby
 authors:
 - Akinyele Cafe-Febrissy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-26 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych