mangadex 5.5.8 → 5.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '038676da7b94f64da0e1ba27d2a0f2563153bf785fc027830132330fcaa6db41'
-  data.tar.gz: 219bc69785823ce34145b10103149d3f397803a7a8a77732a5ee98983162e211
+  metadata.gz: 16387ee156618cba16f7f1a730c94a8e6856dd379886cf7ef0124826efe010c5
+  data.tar.gz: f5edff601db0ccef8580a3b108a0a79b123e427c64607317b05cdcba6cc460fc
 SHA512:
-  metadata.gz: fab8f18bd656d148f42513e316389b6505aa63c24fc9be2722f8ac4752f9dfb2bfde8749769af69acdf2d90714aa64e87f82ad40a0405cc3bd7158240bb998cc
-  data.tar.gz: 4f539c62ada95b984cf96f04b2450385b3bf348d8efcbbb501ab67ac9f21f70c38fb082763b68a3c3851fb572047a07650ab4f80a975987aadea9fb5f4ae505a
+  metadata.gz: 10affdcc160415a2a38187ef0518011d2982364d1df79a02e0253df05a4aacefc1b489895cf0b81b39d1c172ce0632b9432869f65103962308cc080c70693166
+  data.tar.gz: e2eaa50eaed120768286a3c76f55f27ee43d258b7d445891c0ff941c5bf5364f468b3e171607d04542840b28ef729fdfbca7a823865cff95ea8d6cbf61f3cd72

data/.github/workflows/docker-image.yml

@@ -0,0 +1,19 @@
+name: Docker Image CI
+
+on:
+  push:
+    branches: ["culture"]
+  pull_request:
+    branches: ["culture"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build the Docker image
+        run: docker build . --file Dockerfile --tag mangadex
+
+      - name: Run tests
+        run: docker run --rm -t mangadex:latest bundle exec rspec

data/.gitignore

@@ -15,3 +15,7 @@
 
 # Misc
 .DS_Store
+.env*
+
+# Docker
+.devcontainer/

data/Dockerfile

@@ -5,3 +5,10 @@ WORKDIR /app
 COPY . /app
 
 RUN bundle install --jobs 4 --retry 5 --quiet
+
+COPY entrypoint.sh /usr/bin/
+RUN chmod +x /usr/bin/entrypoint.sh
+
+ENTRYPOINT [ "entrypoint.sh" ]
+
+CMD [ "bin/console" ]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mangadex (5.5.8)
+    mangadex (5.6.0.1)
       psych (~> 4.0.1)
       rest-client (~> 2.1)
       sorbet-runtime
@@ -9,91 +9,50 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    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.5.0)
     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.5)
       domain_name (~> 0.5)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
-    minitest (5.15.0)
-    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.4)
+    psych (4.0.6)
       stringio
-    public_suffix (4.0.6)
-    rack (2.2.3)
-    rack-protection (2.2.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.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    ruby2_keywords (0.0.5)
-    sinatra (2.2.0)
-      mustermann (~> 1.0)
-      rack (~> 2.2)
-      rack-protection (= 2.2.0)
-      tilt (~> 2.0)
-    smart_properties (1.17.0)
-    sorbet (0.5.9742)
-      sorbet-static (= 0.5.9742)
-    sorbet-runtime (0.5.10030)
-    sorbet-static (0.5.9742-x86_64-linux)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    sorbet (0.5.10526)
+      sorbet-static (= 0.5.10526)
+    sorbet-runtime (0.5.10520)
+    sorbet-static (0.5.10526-x86_64-linux)
     stringio (3.0.2)
-    tilt (2.0.10)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
-    webmock (3.14.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   x86_64-linux
@@ -103,7 +62,6 @@ DEPENDENCIES
   mangadex!
   pry
   rake (~> 13.0)
-  request_interceptor (~> 1.0.0)
   rspec (~> 3.0)
   sorbet
 

data/README.md

@@ -1,4 +1,4 @@
-[![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>
+[![Docker Image CI](https://github.com/thedrummeraki/mangadex/actions/workflows/docker-image.yml/badge.svg)](https://github.com/thedrummeraki/mangadex/actions/workflows/docker-image.yml)<a href="https://rubygems.org/gems/mangadex"><img src="https://badgen.net/rubygems/v/mangadex" /></a>
 
 # Mangadex
 
@@ -7,6 +7,7 @@ Welcome to `mangadex`, your next favourite Ruby gem for interacting with [Mangad
 ## Important information
 
 **By using this gem you accept**:
+
 - To **credit [Mangadex](https://mangadex.org)**. This gem is your friendly neighbourhood wrapper on _their_ API.
 - To **credit scanlation groups**, especially if you offer the ability to read chapters.
 - **Not to run any ads** on the service that will use this gem. Please do not make money off of Mangadex's services.
@@ -196,6 +197,7 @@ end
 ```
 
 Already created your `User` class? Make sure it has all of the following:
+
 - `mangade_user_id`: ID used to identify your user on Mangadex
 - `username`: Your username
 - `session`: The session token (valid for 15 minutes)
@@ -282,7 +284,7 @@ class SessionController < ApplicationController
   rescue Mangadex::Errors::AuthenticationError => error
     # See https://api.mangadex.org/docs.html to learn more about errors
     Rails.logger.error(error.response.errors)
-    
+
     # Handle authentication errors here
   end
 
@@ -325,7 +327,7 @@ class ProtectedController < ApplicationController
 end
 ```
 
-We're going with managing (list, create, show, edit, delete) MDLists (ie: custom lists). __We're not using strong params below to keep things simple, but you should, especially when mutating data (ie: creating and editing)__.
+We're going with managing (list, create, show, edit, delete) MDLists (ie: custom lists). **We're not using strong params below to keep things simple, but you should, especially when mutating data (ie: creating and editing)**.
 
 ```ruby
 class CustomListsController < ProtectedController
@@ -384,10 +386,34 @@ end
 
 ## Development
 
+### Docker
+
+You can use Docker to get started with dev work on the repo. After installing Dcoker, you can build the image:
+
+```
+docker build -t mangadex .
+```
+
+Then run the ruby console with the gem loaded
+
+```
+docker run --rm -it mangadex:latest
+```
+
+You can also log in directly when setting the `MD_USERNAME` and `MD_PASSWORD` (or `MD_EMAIL`) environment variables:
+
+```
+docker run --rm -e MD_USERNAME=username -e MD_PASSWORD=password -it mangadex:latest
+```
+
+### Locally
+
 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).
 
+You can also
+
 ## 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.

data/entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -e
+
+# Then exec the container's main process (what's set as CMD in the Dockerfile).
+exec "$@"

data/lib/mangadex/auth.rb

@@ -48,7 +48,7 @@ module Mangadex
       Mangadex.context.user = user
 
       if block_given?
-        return yield(user)        
+        return yield(user)
       end
 
       user

data/lib/mangadex/chapter_read_marker.rb

@@ -0,0 +1,47 @@
+module Mangadex
+  class ChapterReadMarker
+    extend T::Sig
+
+    sig { params(id: String).returns(T::Api::GenericResponse) }
+    def self.get(id)
+      Mangadex::Internal::Definition.must(id)
+
+      Mangadex::Internal::Request.get(
+        '/manga/{id}/read' % {id: id}
+      )
+    end
+
+    sig { params(id: String, args: T::Api::Arguments).returns(T::Api::GenericResponse) }
+    def self.create(id, **args)
+      Mangadex::Internal::Definition.must(id)
+
+      Mangadex::Internal::Request.post(
+        '/manga/{id}/read' % {id: id},
+        payload: Mangadex::Internal::Definition.validate(args, {
+          update_history: { accepts: [true, false] }
+        })
+      )
+    end
+
+    sig { sig(args: T::Api::Arguments).returns(T::Api::GenericResponse) }
+    def self.list(**args)
+      to_a = Mangadex::Internal::Definition.converts(:to_a)
+
+      Mangadex::Internal::Request.get(
+        '/manga/list',
+        Mangadex::Internal::Definition.validate(args, {
+          ids: { accepts: [String], converts: to_a, required: true },
+          grouped: { accepts: [true, false] },
+        })
+      )
+    end
+
+    sig { returns(T::Api::GenericResponse) }
+    def self.user_list
+      Mangadex::Internal::Request.get(
+        '/user/history',
+        auth: true,
+      )
+    end
+  end
+end

data/lib/mangadex/internal/definition.rb

@@ -1,4 +1,10 @@
 # typed: true
+
+require_relative "definitions/accepts"
+
+require_relative "definitions/base"
+require_relative "definitions/content_rating"
+
 module Mangadex
   module Internal
     class Definition
@@ -94,7 +100,10 @@ module Mangadex
 
       class << self
         def converts(key=nil)
-          procs = { to_a: -> ( x ) { Array(x) } }
+          procs = {
+            to_a: -> ( x ) { Array(x) },
+            to_i: -> ( x ) { Integer(x.to_s, 10) if x },
+          }
           return procs if key.nil?
 
           procs[key]
@@ -115,13 +124,16 @@ module Mangadex
               translated_language: { accepts: [String], converts: converts(:to_a) },
               original_language: { accepts: [String] },
               excluded_original_language: { accepts: [String] },
-              content_rating: { accepts: %w(safe suggestive erotica pornographic), converts: converts(:to_a) },
+              content_rating: Definitions::ContentRating,
               include_future_updates: { accepts: %w(0 1) },
               created_at_since: { accepts: %r{^\d{4}-[0-1]\d-([0-2]\d|3[0-1])T([0-1]\d|2[0-3]):[0-5]\d:[0-5]\d$} },
               updated_at_since: { accepts: %r{^\d{4}-[0-1]\d-([0-2]\d|3[0-1])T([0-1]\d|2[0-3]):[0-5]\d:[0-5]\d$} },
               publish_at_since: { accepts: %r{^\d{4}-[0-1]\d-([0-2]\d|3[0-1])T([0-1]\d|2[0-3]):[0-5]\d:[0-5]\d$} },
               order: { accepts: Hash },
               includes: { accepts: [String], converts: converts(:to_a) },
+              include_empty_pages: { accepts: [0, 1], converts: converts(:to_i) },
+              include_future_publish_at: { accepts: [0, 1], converts: converts(:to_i) },
+              include_external_url: { accepts: [0, 1], converts: converts(:to_i) },
             },
           )
         end
@@ -151,8 +163,17 @@ module Mangadex
           end
 
           definition.each do |key, definition|
-            validator = Definition.new(key, args[key], **definition.symbolize_keys)
-            validation_error = validator.error
+            validation_error = if definition.is_a?(Class) && definition < Definitions::Base
+              validator = definition.new(args[key])
+              validator.validate
+              validator.error_message
+            elsif !definition.is_a?(Class)
+              validator = Definition.new(key, args[key], **definition.symbolize_keys)
+              validator.error
+            else
+              raise "Invalid definition class: #{definition}"
+            end
+
             if validation_error
               errors << { message: validation_error }
             elsif !validator.empty?

data/lib/mangadex/internal/definitions/accepts.rb

@@ -0,0 +1,72 @@
+# typed: false
+
+module Mangadex
+  module Internal
+    module Definitions
+      class Accepts
+        VALID_CONDITIONS = [:and, :or]
+
+        class Possibility
+          def initialize(accepted:)
+            @accepted = accepted
+          end
+
+          def inspect
+            "{#{@accepted.class.name}: #{@accepted}}"
+          end
+        end
+
+        def initialize(array: nil, class: nil, value: nil, condition: :and)
+          @array = array
+          @class = binding.local_variable_get(:class)
+          @value = value
+          @condition = ensure_valid_condition!(condition.to_s.to_sym)
+        end
+
+        def validate!(value)
+          valid = if @condition == :or
+            validate_or!(value)
+          else
+            validate_and!(value)
+          end
+
+          raise ArgumentError, "Value `#{value}` must be #{nature}: #{possibilities}" unless valid
+        end
+
+        private
+
+        def ensure_valid_condition!(condition)
+          return condition if VALID_CONDITIONS.include?(condition)
+
+          raise "Condition `#{condition}` must be one of #{VALID_CONDITIONS}"
+        end
+
+        def nature
+          @condition == :or ? "one of" : "all of"
+        end
+
+        def validate_and!(value)
+          possibilities.all? { potentially_valid?(value) }
+        end
+
+        def validate_or!(value)
+          possibilities.any? { potentially_valid?(value) }
+        end
+
+        def possibilities
+          @possibilities ||= [
+            @array,
+            @class,
+            @value,
+          ].compact.map { |pos| Possibility.new(accepted: pos) }
+        end
+
+        def potentially_valid?(value)
+          @array.include?(value) || \
+            value.is_a?(@class) || \
+            value == @value
+        end
+      end
+    end
+  end
+end

data/lib/mangadex/internal/definitions/base.rb

@@ -0,0 +1,94 @@
+# typed: false
+
+module Mangadex
+  module Internal
+    module Definitions
+      class Base
+        attr_reader :key, :accepts, :converts, :errors
+
+        def initialize(value, key:, accepts:, required: false, converts: nil)
+          @value = value
+          @key = key
+          @accepts = accepts
+          @required = required
+          @converts = converts
+          @errors = Array.new
+        end
+
+        def validate
+          validate_required
+          return if !@required && empty?
+
+          validate_accepts
+
+          nil
+        end
+
+        def validate!
+          validate
+
+          raise_if_any_errors!
+        end
+
+        def valid?
+          validate!
+          true
+        rescue ArgumentError
+          false
+        end
+
+        def error_message
+          return unless errors.any?
+
+          compile_error_message
+        end
+
+        def empty?
+          converted_value.respond_to?(:empty?) ? converted_value.empty? : converted_value.to_s.strip.empty?
+        end
+
+        def value
+          converted_value
+        end
+
+        protected
+
+        def validate_required
+          return unless @required
+
+          add_error("Missing :#{key}") if empty?
+          false
+        end
+
+        def validate_accepts
+          raise NotImplementedError
+        end
+
+        def converted_value
+          @converted_value ||= if converts.is_a?(Proc)
+            converts.call(@value)
+          elsif converts.is_a?(String) || converts.is_a?(Symbol)
+            @value.send(converts)
+          else
+            @value
+          end
+        end
+
+        def add_error(message)
+          @errors << message
+          @errors.uniq!
+        end
+
+        def compile_error_message
+          errors.join(', ')
+        end
+
+        private
+
+        def raise_if_any_errors!
+          raise ArgumentError, "Validation error: #{compile_error_message}" if errors.any?
+        end
+      end
+    end
+  end
+end

data/lib/mangadex/internal/definitions/content_rating.rb

@@ -0,0 +1,33 @@
+# typed: false
+
+module Mangadex
+  module Internal
+    module Definitions
+      class ContentRating < Base
+        def initialize(value)
+          super(
+            value,
+            key: :content_rating,
+            accepts: Accepts.new(
+              array: Mangadex::ContentRating::VALUES,
+              class: Mangadex::ContentRating,
+              condition: :or,
+            ),
+            converts: :to_s,
+            required: false,
+          )
+        end
+
+        def validate_accepts
+          @accepts.validate!(converted_value)
+        rescue ArgumentError => error
+          add_error(error.message)
+        end
+
+        def validate_condition
+
+        end
+      end
+    end
+  end
+end

data/lib/mangadex/internal/request.rb

@@ -6,6 +6,7 @@ module Mangadex
   module Internal
     class Request
       ALLOWED_METHODS = %i(get post put delete).freeze
+      SENSITIVE_FIELDS = %w(password token oldPassword newPassword)
 
       attr_accessor :path, :headers, :payload, :method, :raw
       attr_reader :response
@@ -16,19 +17,19 @@ module Mangadex
           method: :get,
           headers: headers,
           payload: nil,
-        ).run!(raw: raw, auth: auth)
+        ).run_with_info!(raw: raw, auth: auth)
       end
 
       def self.post(path, headers: nil, auth: false, payload: nil, raw: false)
-        new(path, method: :post, headers: headers, payload: payload).run!(raw: raw, auth: auth)
+        new(path, method: :post, headers: headers, payload: payload).run_with_info!(raw: raw, auth: auth)
       end
 
       def self.put(path, headers: nil, auth: false, payload: nil, raw: false)
-        new(path, method: :put, headers: headers, payload: payload).run!(raw: raw, auth: auth)
+        new(path, method: :put, headers: headers, payload: payload).run_with_info!(raw: raw, auth: auth)
       end
 
       def self.delete(path, headers: nil, auth: false, payload: nil, raw: false)
-        new(path, method: :delete, headers: headers, payload: payload).run!(raw: raw, auth: auth)
+        new(path, method: :delete, headers: headers, payload: payload).run_with_info!(raw: raw, auth: auth)
       end
 
       def initialize(path, method:, headers: nil, payload: nil)
@@ -47,19 +48,16 @@ module Mangadex
         )
       end
 
-      def run!(raw: false, auth: false)
-        payload_details = request_payload ? "Payload: #{sensitive_request_payload}" : "{no-payload}"
-        puts("[#{self.class.name}] #{method.to_s.upcase} #{request_url} #{payload_details}")
+      def run_with_info!(*args, **kwargs)
+        measure_time_taken do
+          run!(*args, **kwargs)
+        end
+      end
 
+      def run!(raw: false, auth: false)
         raise Mangadex::Errors::UserNotLoggedIn.new if auth && Mangadex.context.user.nil?
 
-        start_time = Time.now
-
         @response = request.execute
-        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.context.force_raw_requests
 
         if (body = @response.body)
@@ -95,6 +93,18 @@ module Mangadex
         data
       end
 
+      def measure_time_taken(&block)
+        payload_details = request_payload ? "Payload: #{sensitive_request_payload}" : "{no-payload}"
+        puts("[#{self.class.name}] #{method.to_s.upcase} #{request_url} #{payload_details}")
+        start_time = Time.now
+        result = yield
+
+        result
+      ensure
+        elapsed_time = ((Time.now - start_time) * 1000).to_i
+        puts("[#{self.class.name}] took #{elapsed_time} ms")
+      end
+
       def request_url
         request_path = path.start_with?('/') ? path : "/#{path}"
         "#{Mangadex.configuration.mangadex_url}#{request_path}"
@@ -106,7 +116,7 @@ module Mangadex
         JSON.generate(payload)
       end
       
-      def sensitive_request_payload(sensitive_fields: %w(password token))
+      def sensitive_request_payload(sensitive_fields: SENSITIVE_FIELDS)
         payload = JSON.parse(request_payload)
         sensitive_fields.map(&:to_s).each do |field|
           payload[field] = '[REDACTED]' if payload.key?(field)

data/lib/mangadex/manga.rb

@@ -21,6 +21,7 @@ module Mangadex
       :version,
       :chapter_numbers_reset_on_new_volume,
       :available_translated_languages,
+      :latest_uploaded_chapter,
       :created_at,
       :updated_at
 
@@ -34,13 +35,14 @@ module Mangadex
           limit: { accepts: Integer },
           offset: { accepts: Integer },
           title: { accepts: String },
+          author_or_artist: { accepts: String },
           authors: { accepts: [String] },
           artists: { accepts: [String] },
           year: { accepts: Integer },
           included_tags: { accepts: [String] },
-          included_tags_mode: { accepts: %w(OR AND), converts: to_a },
+          included_tags_mode: { accepts: %w(OR AND) },
           excluded_tags: { accepts: [String] },
-          excluded_tags_mode: { accepts: %w(OR AND), converts: to_a },
+          excluded_tags_mode: { accepts: %w(OR AND) },
           status: { accepts: %w(ongoing completed hiatus cancelled), converts: to_a },
           original_language: { accepts: [String] },
           excluded_original_language: { accepts: [String] },
@@ -114,11 +116,17 @@ module Mangadex
 
     sig { params(args: T::Api::Arguments).returns(T::Api::MangaResponse) }
     def self.random(**args)
+      to_a = Mangadex::Internal::Definition.converts(:to_a)
+
       Mangadex::Internal::Request.get(
         '/manga/random',
         Mangadex::Internal::Definition.validate(args, {
           includes: { accepts: Array },
           content_rating: { accepts: %w(safe suggestive erotica pornographic), converts: to_a },
+          included_tags: { accepts: [String] },
+          included_tags_mode: { accepts: %w(OR AND) },
+          excluded_tags: { accepts: [String] },
+          excluded_tags_mode: { accepts: %w(OR AND) },
         })
       )
     end

data/lib/mangadex/rating.rb

@@ -0,0 +1,19 @@
+# typed: false
+
+module Mangadex
+  class Rating < MangadexObject
+    has_attributes \
+      :rating,
+      :created_at
+
+    def self.list(**args)
+      Mangadex::Internal::Request.get(
+        '/rating',
+        Mangadex::Internal::Definition.validate(args, {
+          manga: { accepts: Array[String] },
+        }),
+        auth: true,
+      )
+    end
+  end
+end

data/lib/mangadex/report.rb

@@ -0,0 +1,42 @@
+module Mangadex
+  class Report < MangadexObject
+    has_attributes \
+      :details,
+      :object_id,
+      :status,
+      :created_at
+
+    sig { params(args: T::Api::Arguments).returns(Mangadex::Api::Response[Report]) }
+    def self.list(**args)
+      to_a = Mangadex::Internal::Definition.converts(:to_a)
+
+      Mangadex::Internal::Request.get(
+        '/report',
+        Mangadex::Internal::Definition.validate(args, {
+          limit: { accepts: Integer },
+          offset: { accepts: Integer },
+          category: { accepts: %w(manga chapter scanlation_group user author) },
+          reason_id: { accepts: String },
+          object_id: { accepts: String },
+          status: { accepts: %w(waiting accepted refused autoresolved) },
+          order: { accepts: Hash },
+          includes: { accepts: Array, converts: to_a },
+        }),
+        auth: true,
+      )
+    end
+
+    sig { params(args: T::Api::Arguments).returns(T::Api::GenericResponse) }
+    def create(**args)
+      Mangadex::Internal::Request.post(
+        '/report',
+        payload: Mangadex::Internal::Definition.validate(args, {
+          category: { accepts: %w(manga chapter scanlation_group user), required: true },
+          reason: { accepts: String, required: true },
+          object_id: { accepts: String, required: true },
+          details: { accepts: String },
+        }),
+      )
+    end
+  end
+end

data/lib/mangadex/report_reason.rb

@@ -10,7 +10,7 @@ module Mangadex
     class << self
       def list(category)
         args = Mangadex::Internal::Definition.validate({category: category}, {
-          category: { accepts: %w(manga chapter scanlation_group user), required: true },
+          category: { accepts: %w(manga chapter scanlation_group user author), required: true },
         })
 
         Mangadex::Internal::Request.get(
@@ -19,6 +19,9 @@ module Mangadex
       end
 
       def create(**args)
+        # TODO: create a "deprecated" log function
+        puts("[DEPRECATED] Use Mangadex::Report.create(...) instead.")
+
         Mangadex::Internal::Request.post(
           '/report',
           payload: Mangadex::Internal::Definition.validate(args, {

data/lib/mangadex/sorbet.rb

@@ -12,6 +12,7 @@ module T
         T::Array[Text],
         Integer,
         T::Hash[Text, Text],
+        Mangadex::ContentRating,
       )
     end
     MangaResponse = T.type_alias do
@@ -26,6 +27,12 @@ module T
         Mangadex::Api::Response[T::Array[Mangadex::Chapter]]
       )
     end
+    UserResponse = T.type_alias do
+      T.any(
+        Mangadex::Api::Response[Mangadex::User],
+        Mangadex::Api::Response[T::Array[Mangadex::User]]
+      )
+    end
     GenericResponse = T.type_alias do
       T.any(
         ::Hash,

data/lib/mangadex/statistic.rb

@@ -0,0 +1,33 @@
+# typed: false
+
+module Mangadex
+  class Statistic < MangadexObject
+    has_attributes \
+      :rating,
+      :average,
+      :bayesian,
+      :distribution,
+      :follows
+
+    sig { params(uuid: String).returns(T::Api::GenericResponse) }
+    def self.get(uuid)
+      Mangadex::Internal::Definition.must(uuid)
+
+      Mangadex::Internal::Request.get(
+        '/statistics/manga/%{uuid}' % {uuid: uuid},
+      )
+    end
+
+    sig { params(args: T::Api::Arguments).returns(T::Api::GenericResponse) }
+    def self.list(**args)
+      to_a = Mangadex::Internal::Definition.converts(:to_a)
+
+      Mangadex::Internal::Request.get(
+        '/statistics/manga',
+        Mangadex::Internal::Definition.validate(args, {
+          manga: { accepts: [String], converts: to_a },
+        })
+      )
+    end
+  end
+end

data/lib/mangadex/types.rb

@@ -19,6 +19,9 @@ require_relative "user"
 require_relative "tag"
 require_relative "scanlation_group"
 require_relative "report_reason"
+require_relative "report"
+require_relative "rating"
+require_relative "statistic"
 
 # Relationship
 require_relative "relationship"

data/lib/mangadex/user.rb

@@ -6,6 +6,74 @@ module Mangadex
       :roles,
       :version
 
+    sig { params(args: T::Api::Arguments).returns(T::Api::UserResponse) }
+    def self.list(**args)
+      Mangadex::Internal::Request.get(
+        '/user',
+        Mangadex::Internal::Definition.validate(args, {
+          limit: { accepts: Integer },
+          offset: { accepts: Integer },
+          ids: { accepts: Array },
+          username: { accepts: String },
+          order: { accepts: Hash },
+        }),
+        auth: true,
+      )
+    end
+
+    sig { params(id: String).returns(T::Api::UserResponse) }
+    def self.get(id)
+      Mangadex::Internal::Request.get(
+        "/user/#{id}",
+      )
+    end
+
+    sig { params(id: String).returns(T::Api::GenericResponse) }
+    def self.delete(id)
+      Mangadex::Internal::Request.delete(
+        "/user/#{id}",
+        auth: true,
+      )
+    end
+
+    sig { params(code: String).returns(T::Api::GenericResponse) }
+    def self.delete_code(code)
+      Mangadex::Internal::Request.post(
+        "/user/delete/#{code}",
+      )
+    end
+
+    sig { params(old_password: String, new_password: String).returns(T::Api::GenericResponse) }
+    def self.update_password(old_password:, new_password:)
+      payload = {
+        oldPassword: old_password,
+        newPassword: new_password,
+      }
+
+      Mangadex::Internal::Request.post(
+        '/user/password',
+        payload: payload,
+        auth: true,
+      )
+    end
+
+    sig { params(email: String).returns(T::Api::GenericResponse) }
+    def self.update_email(email:)
+      Mangadex::Internal::Request.post(
+        '/user/email',
+        payload: { email: email },
+        auth: true,
+      )
+    end
+
+    sig { returns(T::Api::UserResponse) }
+    def self.current
+      Mangadex::Internal::Request.get(
+        '/user/me',
+        auth: true,
+      )
+    end
+
     sig { params(args: T::Api::Arguments).returns(Mangadex::Api::Response[Mangadex::Chapter]) }
     def self.feed(**args)
       Mangadex::Internal::Request.get(

data/lib/mangadex/version.rb

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

data/mangadex.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.2.19"
   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.5.8
+  version: 5.7.5
 platform: ruby
 authors:
 - Akinyele Cafe-Febrissy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -94,20 +94,6 @@ 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
@@ -144,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/docker-image.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -161,6 +148,7 @@ files:
 - docker-compose.yml
 - docs/authentication.md
 - docs/context.md
+- entrypoint.sh
 - lib/config.rb
 - lib/errors.rb
 - lib/extensions.rb
@@ -175,20 +163,27 @@ files:
 - lib/mangadex/auth.rb
 - lib/mangadex/author.rb
 - lib/mangadex/chapter.rb
+- lib/mangadex/chapter_read_marker.rb
 - lib/mangadex/content_rating.rb
 - 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/definitions/accepts.rb
+- lib/mangadex/internal/definitions/base.rb
+- lib/mangadex/internal/definitions/content_rating.rb
 - lib/mangadex/internal/request.rb
 - lib/mangadex/internal/with_attributes.rb
 - lib/mangadex/manga.rb
 - lib/mangadex/mangadex_object.rb
+- lib/mangadex/rating.rb
 - lib/mangadex/relationship.rb
+- lib/mangadex/report.rb
 - lib/mangadex/report_reason.rb
 - lib/mangadex/scanlation_group.rb
 - lib/mangadex/sorbet.rb
+- lib/mangadex/statistic.rb
 - lib/mangadex/storage.rb
 - lib/mangadex/storage/basic.rb
 - lib/mangadex/storage/memory.rb
@@ -250,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Your next favourite Ruby gem for interacting with Mangadex.org