my_api_client 0.26.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04b65801b00f389260d1c5e565c9bf62141dca015f7d63a1f2f55a9432202971
-  data.tar.gz: 0cb50201bdc0877a6bff65300907be74910c62ee29112c782ac513f6e153c243
+  metadata.gz: 9a7c0e59912fcb57831b996cda5b2d18d6488e33609eac9c1cc227b8d2699177
+  data.tar.gz: 6cf555c678a2537db8fe85dfe2c6a98385c61d00b92bc4d931c3bfdfdf04442b
 SHA512:
-  metadata.gz: f2404378034857782c548971e5812a791ebe7902b5a73b63a56eb85a52e5d29aef6eee64c654377a4564ee33ac30f11e3d0c2e60dca391a658d7786cddb4ea50
-  data.tar.gz: 5daea5828a938350e909238b2c3d217e5dc49f792626689791b033648650ffc6b8f99eaa4edbe4a100d41212d811732d2072d40d4f79252752e034a4cbc413bd
+  metadata.gz: 289f20431d12e8c625e15da365c85607da2324cb4990f8ad100ef8fd31b1c1acd5dae6e964b20191ef4be3b98518b77c792e5a5616d4e506cf01407f5038f822
+  data.tar.gz: 61b0c21d3b43b5492d84bd6eb5107efcf4b7f6b8573685c9f85097276ae86c97ca27beb988d7482b864b17f18a8655a1e43251bb827de36e23a1aa46e314365f

data/.circleci/config.yml

@@ -12,12 +12,12 @@ references:
   - &ruby_version
     ruby_version:
       type: enum
-      enum: &ruby_version_enum ["2.7", "3.0", "3.1", "3.2"]
+      enum: &ruby_version_enum ["3.0", "3.1", "3.2"]
       default: "3.2"
   - &rails_version
     rails_version:
       type: enum
-      enum: &rails_version_enum ["6.0", "6.1", "7.0"]
+      enum: &rails_version_enum ["6.1", "7.0"]
       default: "7.0"
   - &bundler_options
     bundler_options:
@@ -153,7 +153,7 @@ commands:
           name: Install Bundler 2.x
           command: gem install bundler -v '~> 2.0'
       - ruby-orbs/bundle-install:
-          cache_key_prefix: v2-dependencies-<< parameters.ruby_version >>
+          cache_key_prefix: v3-dependencies-<< parameters.ruby_version >>
           bundle_extra_args: << parameters.bundler_options >>
           restore_bundled_with: false
   test_and_deploy_for_api:
@@ -252,7 +252,7 @@ jobs:
       - code-climate/install
       - code-climate/sum-coverage:
           input: codeclimate.*.json
-          parts: 24
+          parts: 12
       - code-climate/upload-coverage
   rubocop:
     executor: gem_executor
@@ -294,7 +294,7 @@ workflows:
               ruby_version: *ruby_version_enum
               rails_version: *rails_version_enum
       - test_api:
-          ruby_version: "2.7" # Jets supports only Ruby 2.x
+          ruby_version: "3.2"
       - rubocop
       - yardoc
       - upload-coverage:

data/.rubocop.yml

@@ -6,7 +6,7 @@ require:
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   NewCops: enable
   Exclude:
     - rails_app/**/*

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-02-06 23:31:23 UTC using RuboCop version 1.41.1.
+# on 2023-11-13 01:22:13 UTC using RuboCop version 1.57.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,7 +14,8 @@ Lint/EmptyBlock:
     - 'spec/support/complete_about.rb'
     - 'spec/support/complete_within.rb'
 
-# Offense count: 5
+# Offense count: 6
+# Configuration parameters: AllowedParentClasses.
 Lint/MissingSuper:
   Exclude:
     - 'lib/my_api_client/error_handling/generator.rb'
@@ -27,17 +28,27 @@ Lint/MissingSuper:
 # Offense count: 6
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
 # SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
 Naming/VariableNumber:
   Exclude:
     - 'spec/lib/my_api_client/error_handling_spec.rb'
     - 'spec/lib/my_api_client/request/executor_spec.rb'
 
-# Offense count: 101
+# Offense count: 103
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 15
 
+# Offense count: 3
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/lib/my_api_client/errors/error_spec.rb'
+    - 'spec/lib/my_api_client/errors/network_error_spec.rb'
+    - 'spec/lib/my_api_client/rspec/stub_spec.rb'
+
 # Offense count: 3
 Style/DocumentDynamicEvalDefinition:
   Exclude:

data/CHANGELOG.md

@@ -1,5 +1,60 @@
 # Change log
 
+## v1.0.0 (Dec 07, 2023)
+
+### Feature
+
+- [#955](https://github.com/ryz310/my_api_client/pull/955) Enable Dynamic URL Generation for `#pageable_get` via `Proc` Objects ([@ryz310](https://github.com/ryz310))
+
+```ruby
+# Example of using a Proc with pageable_get
+pget 'api/example', headers:, query:, paging: ->(response) {
+  # Custom logic to generate the next URL
+}
+```
+
+### Dependabot
+
+- [#950](https://github.com/ryz310/my_api_client/pull/950) Bump faraday from 2.7.11 to 2.7.12 ([@ryz310](https://github.com/ryz310))
+
+## v0.27.0 (Nov 13, 2023)
+
+### Feature
+
+- [#944](https://github.com/ryz310/my_api_client/pull/944) Add block to retrieve sawyer response ([@okumud](https://github.com/okumud))
+
+```rb
+api_clinet = ExampleApiClient.new(access_token: 'access_token')
+
+# You can retrieve sawyer response with return value
+api_clinet.get_users #=> #<Sawyer::Resource>
+
+# You can retrieve sawyer response with block
+api_clinet.get_users do |response|
+  response #=> #<Sawyer::Response>
+  response.headers #=> #<Hash>
+  response.data #=> #<Sawyer::Resource>
+end
+```
+
+### Breaking Change
+
+- [#931](https://github.com/ryz310/my_api_client/pull/931) End of support for ruby 2.7 and rails 6.0 ([@ryz310](https://github.com/ryz310))
+
+### Dependabot
+
+- [#919](https://github.com/ryz310/my_api_client/pull/919) Bump bugsnag from 6.25.2 to 6.26.0 ([@ryz310](https://github.com/ryz310))
+- [#929](https://github.com/ryz310/my_api_client/pull/929) Bump webmock from 3.19.0 to 3.19.1 ([@ryz310](https://github.com/ryz310))
+- [#934](https://github.com/ryz310/my_api_client/pull/934) Bump rubocop-performance from 1.19.0 to 1.19.1 ([@ryz310](https://github.com/ryz310))
+- [#933](https://github.com/ryz310/my_api_client/pull/933) Bump faraday from 2.7.10 to 2.7.11 ([@ryz310](https://github.com/ryz310))
+- [#939](https://github.com/ryz310/my_api_client/pull/939) Bump jsonpath from 1.1.4 to 1.1.5 ([@ryz310](https://github.com/ryz310))
+- [#942](https://github.com/ryz310/my_api_client/pull/942) Bump rake from 13.0.6 to 13.1.0 ([@ryz310](https://github.com/ryz310))
+- [#945](https://github.com/ryz310/my_api_client/pull/945) Bump activesupport from 7.1.1 to 7.1.2 ([@ryz310](https://github.com/ryz310))
+
+### Misc
+
+- [#946](https://github.com/ryz310/my_api_client/pull/946) Fix a broken spec ([@ryz310](https://github.com/ryz310))
+
 ## v0.26.0 (Jul 04, 2023)
 
 ### Bugfix

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.26.0)
-      activesupport (>= 6.0.0)
+    my_api_client (1.0.0)
+      activesupport (>= 6.1.0)
       faraday (>= 0.17.1)
       jsonpath
       sawyer (>= 0.8.2)
@@ -10,39 +10,51 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.6)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.4)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    bugsnag (6.25.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
+    bugsnag (6.26.0)
       concurrent-ruby (~> 1.0)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.7.9)
+    drb (2.2.0)
+      ruby2_keywords
+    faraday (2.7.12)
+      base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
     hashdiff (1.0.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    jsonpath (1.1.3)
+    json (2.7.1)
+    jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    minitest (5.18.1)
+    minitest (5.20.0)
     multi_json (1.15.0)
+    mutex_m (0.2.0)
     parallel (1.23.0)
-    parser (3.2.2.3)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -51,12 +63,12 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    public_suffix (5.0.1)
-    racc (1.7.1)
+    public_suffix (5.0.4)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
-    rexml (3.2.5)
+    rake (13.1.0)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -66,36 +78,36 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.54.0)
+    rubocop (1.58.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.23.1)
+    rubocop-factory_bot (2.24.0)
       rubocop (~> 1.33)
-    rubocop-performance (1.18.0)
+    rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.22.0)
-      rubocop (~> 1.33)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
@@ -111,8 +123,8 @@ GEM
     simplecov_json_formatter (0.1.4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-    webmock (3.18.1)
+    unicode-display_width (2.5.0)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.jp.md

@@ -12,8 +12,8 @@ MyApiClient は API リクエストクラスを作成するための汎用的な
 
 ## Supported Versions
 
-- Ruby 2.7, 3.0, 3.1, 3.2
-- Rails 6.0, 6.1, 7.0
+- Ruby 3.0, 3.1, 3.2
+- Rails 6.1, 7.0
 
 ## Installation
 
@@ -52,7 +52,7 @@ class ExampleApiClient < MyApiClient::Base
 
   # GET https://example.com/v1/users
   #
-  # @return [Sawyer::Response] HTTP response parameter
+  # @return [Sawyer::Resource] HTTP resource parameter
   def get_users
     get 'users', headers: headers, query: { key: 'value' }
   end
@@ -60,7 +60,7 @@ class ExampleApiClient < MyApiClient::Base
   # POST https://example.com/v1/users
   #
   # @param name [String] Username which want to create
-  # @return [Sawyer::Response] HTTP response parameter
+  # @return [Sawyer::Resource] HTTP resource parameter
   def post_user(name:)
     post 'users', headers: headers, body: { name: name }
   end
@@ -76,7 +76,7 @@ class ExampleApiClient < MyApiClient::Base
 end
 
 api_clinet = ExampleApiClient.new(access_token: 'access_token')
-api_clinet.get_users #=> #<Sawyer::Response>
+api_clinet.get_users #=> #<Sawyer::Resource>
 ```
 
 クラス定義の最初に記述される `endpoint` にはリクエスト URL の共通部分を定義します。後述の各メソッドで後続の path を定義しますが、上記の例だと `get 'users'` と定義すると、 `GET https://example.com/v1/users` というリクエストが実行されます。
@@ -416,7 +416,7 @@ class GetUsersApiClient < ExampleApiClient
 
   # GET https://example.com/users
   #
-  # @return [Sawyer::Response] HTTP response parameter
+  # @return [Sawyer::Resource] HTTP resource parameter
   def request
     get 'users', query: { key: 'value' }, headers: headers
   end
@@ -428,7 +428,7 @@ class PostUserApiClient < ExampleApiClient
   # POST https://example.com/users
   #
   # @param name [String] Username which want to create
-  # @return [Sawyer::Response] HTTP response parameter
+  # @return [Sawyer::Resource] HTTP resource parameter
   def request(name:)
     post 'users', headers: headers, body: { name: name }
   end

data/README.md

@@ -16,8 +16,8 @@ It is supposed to be used in Ruby on Rails, but it is made to work in other envi
 
 ## Supported Versions
 
-- Ruby 2.7, 3.0, 3.1, 3.2
-- Rails 6.0, 6.1, 7.0
+- Ruby 3.0, 3.1, 3.2
+- Rails 6.1, 7.0
 
 ## Installation
 
@@ -56,7 +56,7 @@ class ExampleApiClient < MyApiClient::Base
 
   # GET https://example.com/v1/users
   #
-  # @return [Sawyer::Response] HTTP response parameter
+  # @return [Sawyer::Resource] HTTP resource parameter
   def get_users
     get 'users', headers: headers, query: { key: 'value' }
   end
@@ -64,7 +64,7 @@ class ExampleApiClient < MyApiClient::Base
   # POST https://example.com/v1/users
   #
   # @param name [String] Username which want to create
-  # @return [Sawyer::Response] HTTP response parameter
+  # @return [Sawyer::Resource] HTTP resource parameter
   def post_user(name:)
     post 'users', headers: headers, body: { name: name }
   end
@@ -80,7 +80,7 @@ class ExampleApiClient < MyApiClient::Base
 end
 
 api_clinet = ExampleApiClient.new(access_token: 'access_token')
-api_clinet.get_users #=> #<Sawyer::Response>
+api_clinet.get_users #=> #<Sawyer::Resource>
 ```
 
 The `endpoint` defines the intersection of the request URL. Each method described below defines a subsequent path. In the above example, `get 'users'` will request to `GET https://example.com/v1/users`.

data/example/api_clients/my_pagination_api_client.rb

@@ -5,9 +5,18 @@ require_relative 'application_api_client'
 # An usage example of the `my_api_client`.
 # See also: my_api/app/controllers/pagination_controller.rb
 class MyPaginationApiClient < ApplicationApiClient
+  # Paging with JSONPath
   # GET pagination?page=1
-  def pagination
-    pget 'pagination', paging: '$.links.next', headers: headers, query: { page: 1 }
+  def paging_with_jsonpath
+    pget 'pagination', headers: headers, query: { page: 1 }, paging: '$.links.next'
+  end
+
+  # Paging with Proc
+  # GET pagination?page=1
+  def paging_with_proc
+    pget 'pagination', headers: headers, query: { page: 1 }, paging: lambda { |response|
+      response.data.links.next
+    }
   end
 
   private

data/lib/my_api_client/errors/network_error.rb

@@ -23,7 +23,7 @@ module MyApiClient
     #   Some network error
     def initialize(params = nil, original_error = nil)
       @original_error = original_error
-      super params, original_error&.message
+      super(params, original_error&.message)
     end
 
     # Returns contents as string for to be readable for human

data/lib/my_api_client/errors.rb

@@ -16,7 +16,7 @@ module MyApiClient
     #   The error description
     def initialize(params = nil, error_message = nil)
       @params = params
-      super error_message
+      super(error_message)
     end
 
     # Returns contents as string for to be readable for human

data/lib/my_api_client/request/basic.rb

@@ -20,10 +20,18 @@ module MyApiClient
           # @param body [Hash, nil]
           #   Request body. You should not specify it when use GET method.
           # @return [Sawyer::Resource]
-          #   Response body instance.
+          #   Response body instance if the block is not given.
+          # @yield
+          #   Process the response body with the given block.
+          # @yieldparam response [Sawyer::Response]
+          #   Response instance.
+          # @yieldreturn [Object]
+          #   The block result.
+          # @return [Object]
+          #   Whatever the block returns if the block is given.
           def #{http_method}(pathname, headers: nil, query: nil, body: nil)
             response = call(:_request_with_relative_uri, :#{http_method}, pathname, headers, query, body)
-            response.data
+            block_given? ? yield(response) : response.data
           end
         METHOD
       end

data/lib/my_api_client/request/pagination.rb

@@ -9,7 +9,7 @@ module MyApiClient
       #
       # @param pathname [String]
       #   Pathname of the request target URL. It's joined with the defined by `endpoint`.
-      # @param paging [String]
+      # @param paging [String, Proc]
       #   Specify the pagination link path included in the response body as JsonPath expression
       # @param headers [Hash, nil]
       #   Request headers.
@@ -25,7 +25,7 @@ module MyApiClient
           loop do
             y << response.data
 
-            next_uri = JsonPath.new(paging).first(response.body)
+            next_uri = get_next_url(paging, response)
             break if next_uri.blank?
 
             response = call(:_request_with_absolute_uri, :get, next_uri, headers, nil)
@@ -34,6 +34,27 @@ module MyApiClient
       end
 
       alias pget pageable_get
+
+      private
+
+      # Returns the next URL for pagination
+      #
+      # @param paging [String, Proc]
+      #   Specify the pagination link path included in the response body as JsonPath expression
+      # @param response [MyApiClient::Response]
+      #   The response object
+      # @return [String, nil]
+      #   The next URL for pagination
+      def get_next_url(paging, response)
+        case paging
+        when String
+          JsonPath.new(paging).first(response.body)
+        when Proc
+          paging.call(response)
+        else
+          raise ArgumentError, "Invalid paging argument: #{paging}"
+        end
+      end
     end
   end
 end

data/lib/my_api_client/rspec/stub.rb

@@ -144,6 +144,7 @@ module MyApiClient
         status: status_code.presence || 400,
         headers: {},
         data: stub_as_resource(params),
+        body: params.to_json,
         timing: 0.123
       )
     end

data/lib/my_api_client/service_abstract.rb

@@ -5,8 +5,8 @@ module MyApiClient
   class ServiceAbstract
     private_class_method :new
 
-    def self.call(**args, &block)
-      new(**args, &block).send(:call)
+    def self.call(...)
+      new(...).send(:call)
     end
 
     # private

data/lib/my_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyApiClient
-  VERSION = '0.26.0'
+  VERSION = '1.0.0'
 end

data/my_api/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.0.6

data/my_api/Gemfile

@@ -2,12 +2,12 @@
 
 source 'https://rubygems.org'
 
-gem 'jets', '~> 4.0.1'
+gem 'jets', '~> 4.0.10'
 
 gem 'dynomite'
 
 # See: https://github.com/boltops-tools/jets/issues/523
-gem 'nokogiri', '~> 1.15.2'
+gem 'nokogiri', '~> 1.15.5'
 
 # development and test groups are not bundled as part of the deployment
 group :development, :test do