mangadex 5.3.1.3 → 5.3.3.2

data/lib/mangadex/manga.rb

@@ -50,6 +50,7 @@ module Mangadex
           order: { accepts: Hash },
           includes: { accepts: Array, converts: to_a },
         }),
+        content_rating: true,
       )
     end
 
@@ -66,6 +67,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 +79,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 +88,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,9 +97,12 @@ 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),
+        content_rating: true,
       )
     end
 
@@ -113,14 +123,16 @@ module Mangadex
       )
     end
 
-    sig { params(args: T::Api::Arguments).returns(T::Api::GenericResponse) }
-    def self.all_reading_status(**args)
+    sig { params(status: String).returns(T::Api::GenericResponse) }
+    def self.all_reading_status(status)
+      args = { status: status }
+
       Mangadex::Internal::Request.get(
         '/manga/status',
         Mangadex::Internal::Definition.validate(args, {
           status: {
             accepts: %w(reading on_hold dropped plan_to_read re_reading completed),
-            converts: Mangadex::Internal::Definition.converts(:to_a),
+            converts: :to_s,
           },
         })
       )
@@ -128,6 +140,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 +149,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 +165,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 +189,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

@@ -3,6 +3,7 @@ module Mangadex
   class ScanlationGroup < MangadexObject
     has_attributes \
       :name,
+      :alt_names,
       :website,
       :irc_channel,
       :irc_server,
@@ -47,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, {
@@ -91,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,7 @@ 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]],
       )
     end
     ChapterResponse = T.type_alias do

data/lib/mangadex/storage/basic.rb

@@ -0,0 +1,18 @@
+module Mangadex
+  module Storage
+    class Basic
+      def get(_scope, _key)
+        raise NotImplementedError
+      end
+
+      def set(_scope, _key, _value)
+        raise NotImplementedError
+      end
+
+      def clear(_scope)
+        warn("Don't know how to clear #{self.class} storage strategy! Skipping...")
+        nil
+      end
+    end
+  end
+end

data/lib/mangadex/storage/memory.rb

@@ -0,0 +1,23 @@
+module Mangadex
+  module Storage
+    class Memory < BasicObject
+      def initialize
+        @storage = {}
+      end
+
+      def get(scope, key)
+        @storage.dig(scope.to_s, key.to_s)
+      end
+
+      def set(scope, key, value)
+        key = key.to_s
+        @storage[scope] = {} unless @storage.has_key?(scope)
+        @storage[scope][key] = value
+      end
+
+      def clear(scope)
+        @storage.delete(scope)
+      end
+    end
+  end
+end

data/lib/mangadex/storage/none.rb

@@ -0,0 +1,9 @@
+module Mangadex
+  module Storage
+    class None < Basic
+      def get(_scope, _key); end
+      def set(_scope, _key, _value); end
+      def clear(_scope); end
+    end
+  end
+end

data/lib/mangadex/storage.rb

@@ -0,0 +1,3 @@
+require_relative "storage/basic"
+require_relative "storage/none"
+require_relative "storage/memory"

data/lib/mangadex/tag.rb

@@ -3,6 +3,11 @@ module Mangadex
   class Tag < MangadexObject
     has_attributes :name, :description, :group, :version
 
+    sig { returns(Mangadex::Api::Response[Mangadex::Tag]) }
+    def self.list
+      Mangadex::Manga.tag_list
+    end
+
     def self.attributes_to_inspect
       %i(name)
     end

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

@@ -11,6 +11,7 @@ module Mangadex
       Mangadex::Internal::Request.get(
         '/user/follows/manga/feed',
         Mangadex::Internal::Definition.chapter_list(args),
+        content_rating: true,
         auth: true,
       )
     end
@@ -30,6 +31,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,7 +58,9 @@ module Mangadex
 
     sig { params(id: String).returns(T::Boolean) }
     def self.follows_user(id)
-      return if Mangadex::Api::Context.user.nil?
+      Mangadex::Internal::Definition.must(id)
+
+      return if Mangadex.context.user.nil?
 
       data = Mangadex::Internal::Request.get(
         '/user/follows/user/%{id}' % {id: id},
@@ -83,7 +88,9 @@ module Mangadex
 
     sig { params(id: String).returns(T::Boolean) }
     def self.follows_manga(id)
-      return if Mangadex::Api::Context.user.nil?
+      Mangadex::Internal::Definition.must(id)
+
+      return if Mangadex.context.user.nil?
 
       data = Mangadex::Internal::Request.get(
         '/user/follows/manga/%{id}' % {id: id},

data/lib/mangadex/version.rb

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

data/lib/mangadex.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: true
 require 'sorbet-runtime'
 
 require 'active_support'
@@ -14,22 +14,35 @@ require "mangadex/types"
 # API, to interact with Mangadex
 require "mangadex/api"
 
+# Persist strategies
+require "mangadex/storage"
+
+require_relative "config"
+require_relative "errors"
+
 # Namespace for classes and modules for this gem.
 # @since 5.3.0
 
 module Mangadex
-  # Standard error class for this gem.
-  # 
-  # @author thedrummeraki
-  # @since 0.6.0
-  class Error < StandardError
-    extend T::Sig
-  end
+  class << self
+    def configuration
+      @configuration ||= Config.new
+    end
+
+    def context
+      @context ||= Internal::Context.new
+    end
+
+    def configure(&block)
+      yield(configuration)
+    end
+
+    def storage
+      configuration.storage
+    end
 
-  class UserNotLoggedIn < Error
-    sig { returns(String) }
-    def message
-      "You are not logged in. Use [Mangadex::Auth.login] to log in."
+    def api_version
+      context.version
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mangadex
 version: !ruby/object:Gem::Version
-  version: 5.3.1.3
+  version: 5.3.3.2
 platform: ruby
 authors:
 - Akinyele Cafe-Febrissy
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2021-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - me@akinyele.ca
 executables: []
@@ -170,11 +170,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/authentication.md
+- docs/context.md
+- lib/config.rb
+- lib/errors.rb
 - lib/extensions.rb
 - lib/mangadex.rb
 - lib/mangadex/README.md
 - lib/mangadex/api.rb
-- lib/mangadex/api/context.rb
 - lib/mangadex/api/response.rb
 - lib/mangadex/api/user.rb
 - lib/mangadex/api/version_checker.rb
@@ -186,6 +189,7 @@ files:
 - lib/mangadex/cover_art.rb
 - lib/mangadex/custom_list.rb
 - lib/mangadex/internal.rb
+- lib/mangadex/internal/context.rb
 - lib/mangadex/internal/definition.rb
 - lib/mangadex/internal/request.rb
 - lib/mangadex/internal/with_attributes.rb
@@ -195,6 +199,10 @@ files:
 - lib/mangadex/report_reason.rb
 - lib/mangadex/scanlation_group.rb
 - lib/mangadex/sorbet.rb
+- lib/mangadex/storage.rb
+- lib/mangadex/storage/basic.rb
+- lib/mangadex/storage/memory.rb
+- lib/mangadex/storage/none.rb
 - lib/mangadex/tag.rb
 - lib/mangadex/types.rb
 - lib/mangadex/upload.rb
@@ -236,7 +244,7 @@ homepage: https://github.com/thedrummeraki/mangadex
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -252,7 +260,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/context.rb

@@ -1,63 +0,0 @@
-# typed: true
-module Mangadex
-  module Api
-    class Context
-      extend T::Sig
-
-      @@user = nil
-      @@version = nil
-
-      sig { returns(T.nilable(String)) }
-      def self.version
-        return @@version unless @@version.nil?
-
-        @@version = Mangadex::Api::Version.check_mangadex_version
-      end
-
-      sig { returns(T.nilable(Mangadex::Api::User)) }
-      def self.user
-        @@user&.with_valid_session
-      end
-
-      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
-        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
-
-      sig { params(block: T.proc.returns(T.untyped)).returns(T.untyped) }
-      def self.without_user(&block)
-        with_user(nil) do
-          yield
-        end
-      end
-    end
-  end
-end