my_api_client 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2bc661b02a6845ae92ba2548be624861c3438fd094ab9644ae8fe340cf4adf7
-  data.tar.gz: 99b85fe9d44cf89095318ebfcff92996d688d0aacf5ef86c65943aab13086c43
+  metadata.gz: 9e5581dc65458d9130b465c89479fa8fc877c78f67d1cf701c225d64cbef9577
+  data.tar.gz: 86cae4eade33446a4ef2a5e54f44600e72ee868add6e3cfa5690fe8f1336df01
 SHA512:
-  metadata.gz: ac1dcb549f29b4c5abfecf3ec38b87c17758fe4ac2d442b9d6ff873c0ca6a140bafe6d9c5d84ee3a0fde54f098c439ebde7d072a87c883aec138681d8bbb7b4a
-  data.tar.gz: 0e18aadcfa83643371ea029552240b8d67826f5c65ffd7ff1a4c9e8c26e0af71839ffccf19a9426fc57182e23601865615ed4d06f060e61c8a5e797f6298ec5d
+  metadata.gz: fce2d580f7c2622b2c2b1acc506e585434c29946ac81b6311e255cb53ac8e98276f30b79171e87610076376711f024b08b86724dcc5413328ba7488c9b52e983
+  data.tar.gz: 9475d69090e5748e511e7000df1db586da11ee5f62fc5f35fad30fce203a6ca2beabcafcf28e8eaf505e4a58d45cd4f771da86dea74bdcc70cee7e072267751e

data/.rubocop.yml

@@ -23,6 +23,9 @@ Metrics/MethodLength:
 Metrics/LineLength:
   Max: 100
 
+Naming/AccessorMethodName:
+  Enabled: false
+
 Style/ClassAndModuleChildren:
   Exclude:
     - 'spec/**/*'
@@ -33,6 +36,10 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/lib/my_api_client/rspec/matchers/**/*'
+
 RSpec/ExampleLength:
   Max: 10
 
@@ -43,7 +50,7 @@ RSpec/FilePath:
     - 'spec/lib/my_api_client/rspec/**/*'
 
 RSpec/NestedGroups:
-  Max: 4
+  Max: 5
 
 RSpec/MultipleExpectations:
   Max: 4

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change log
 
+## v0.12.0 (Jan 19, 2020)
+
+### Feature
+
+* [#173](https://github.com/ryz310/my_api_client/pull/173) Avoid sleep on testing ([@ryz310](https://github.com/ryz310))
+* [#175](https://github.com/ryz310/my_api_client/pull/175) Verify arguments on error handling definition ([@ryz310](https://github.com/ryz310))
+* [#176](https://github.com/ryz310/my_api_client/pull/176) Provides a syntax sugar of `retry_on` on `error_handling` ([@ryz310](https://github.com/ryz310))
+
+### Bugfix
+
+* [#174](https://github.com/ryz310/my_api_client/pull/174) Fix warning on ruby 2.7 ([@ryz310](https://github.com/ryz310))
+
 ## v0.11.0 (Jan 16, 2020)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.11.0)
+    my_api_client (0.12.0)
       activesupport (>= 4.2.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -93,7 +93,7 @@ GEM
     to_regexp (0.2.1)
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.6.1)
     webmock (3.8.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)

data/README.jp.md

@@ -228,6 +228,36 @@ API リクエストを何度も実行していると回線の不調などによ
 
 ちなみに一応 `discard_on` も実装していますが、作者自身が有効な用途を見出せていないので、詳細は割愛します。良い利用方法があれば教えてください。
 
+#### 便利な使い方
+
+`error_handling` に `retry` オプションを付与する事で `retry_on` の定義を省略できます。
+例えば以下の 2 つのコードは同じ意味になります。
+
+```ruby
+retry_on MyApiClient::ApiLimitError, wait: 30.seconds, attempts: 3
+error_handling json: { '$.errors.code': 20 },
+               raise: MyApiClient::ApiLimitError
+```
+
+```ruby
+error_handling json: { '$.errors.code': 20 },
+               raise: MyApiClient::ApiLimitError,
+               retry: { wait: 30.seconds, attempts: 3 }
+```
+
+`retry_on` で `wait` や `attempts` を指定する必要がない場合は `retry: true` という記述で動作します。
+
+```ruby
+error_handling json: { '$.errors.code': 20 },
+               raise: MyApiClient::ApiLimitError,
+               retry: true
+```
+
+`retry` オプションを使用する際は以下の点に注意が必要です。
+
+* `error_handling` に `raise` オプションの指定が必須となります。
+* Block を使った `error_handling` の定義は禁止されます。
+
 #### MyApiClient::NetworkError
 
 前述の通りですが、 `MyApiClient` ではネットワーク系の例外はまとめて `MyApiClient::NetworkError` として `raise` されます。他の例外と同じく `MyApiClient::Error` を親クラスとしています。 `MyApiClient::NetworkError` として扱われる例外クラスの一覧は `MyApiClient::NETWORK_ERRORS` で参照できます。また、元となった例外は `#original_error` で参照できます。

data/lib/my_api_client.rb

@@ -7,9 +7,11 @@ require 'jsonpath'
 require 'active_support'
 require 'active_support/core_ext'
 require 'sawyer'
+require 'my_api_client/service_abstract'
 require 'my_api_client/version'
 require 'my_api_client/config'
 require 'my_api_client/error_handling/generator'
+require 'my_api_client/error_handling/process_retry_option'
 require 'my_api_client/error_handling'
 require 'my_api_client/exceptions'
 require 'my_api_client/logger'
@@ -18,6 +20,7 @@ require 'my_api_client/params/params'
 require 'my_api_client/params/request'
 require 'my_api_client/request'
 require 'my_api_client/base'
+require 'my_api_client/sleeper'
 
 # Loads gems for feature of integrations
 begin

data/lib/my_api_client/base.rb

@@ -26,7 +26,7 @@ module MyApiClient
 
     HTTP_METHODS.each do |http_method|
       class_eval <<~METHOD, __FILE__, __LINE__ + 1
-        # Description of #undefined
+        # Description of ##{http_method}
         #
         # @param pathname [String]
         # @param headers [Hash, nil]

data/lib/my_api_client/error_handling.rb

@@ -34,15 +34,22 @@ module MyApiClient
       # @option with [Symbol]
       #   Calls specified method when error detected
       # @option raise [MyApiClient::Error]
-      #   Raises specified error when error detected. default: MyApiClient::Error
+      #   Raises specified error when an invalid response detected.
+      #   Should be inherited `MyApiClient::Error` class.
+      #   default: MyApiClient::Error
+      # @option retry [TrueClass, Hash]
+      #   If the error detected, retries the API request. Requires `raise` option.
+      #   You can set `true` or `retry_on` options (`wait` and `attempts`).
       # @yield [MyApiClient::Params::Params, MyApiClient::Logger]
-      #   Executes the block when error detected
+      #   Executes the block when error detected.
+      #   Forbid to be used with the` retry` option.
       def error_handling(**options, &block)
-        options[:raise] ||= MyApiClient::Error
-        options[:block] = block if block_given?
+        options[:block] = block
+        retry_options = ProcessRetryOption.call(error_handling_options: options)
+        retry_on(options[:raise], **retry_options) if retry_options
 
         temp = error_handlers.dup
-        temp << ->(response) { Generator.call(options.merge(response: response)) }
+        temp << ->(response) { Generator.call(**options.merge(response: response)) }
         self.error_handlers = temp
       end
     end

data/lib/my_api_client/error_handling/generator.rb

@@ -3,8 +3,8 @@
 module MyApiClient
   module ErrorHandling
     # Generates an error handler proc (or symbol)
-    class Generator
-      private_class_method :new
+    class Generator < ServiceAbstract
+      ARGUMENTS = %i[response status_code json with raise block].freeze
 
       # @param options [Hash]
       #   Options for this generator
@@ -25,17 +25,14 @@ module MyApiClient
       #   Returns value as `Proc` if given `raise` or `block` option
       # @return [Symbol]
       #   Returns value as `Symbol` if given `with` option
-      def self.call(**options)
-        new(options).send(:call)
+      def initialize(**options)
+        options[:raise] ||= MyApiClient::Error
+        verify_and_set_arguments(**options)
       end
 
       private
 
-      attr_reader :_response, :_status_code, :_json, :_with, :_raise, :_block
-
-      def initialize(**options)
-        options.each { |k, v| instance_variable_set("@_#{k}", v) }
-      end
+      attr_reader(*ARGUMENTS.map { |argument| :"_#{argument}" })
 
       def call
         return unless match?(_status_code, _response.status)
@@ -46,7 +43,23 @@ module MyApiClient
         elsif _with
           _with
         else
-          ->(params, _logger) { raise _raise, params }
+          ->(params, _) { raise _raise, params }
+        end
+      end
+
+      # Verify given options and raise error if they are incorrect.
+      # If not, set them to instance variables.
+      #
+      # @param options [Hash]
+      # @raise [RuntimeError]
+      def verify_and_set_arguments(**options)
+        options.each do |k, v|
+          if ARGUMENTS.exclude? k
+            raise "Specified an incorrect option: `#{k}`\n" \
+                  "You can use options that: #{ARGUMENTS}"
+          end
+
+          instance_variable_set("@_#{k}", v)
         end
       end
 

data/lib/my_api_client/error_handling/process_retry_option.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  module ErrorHandling
+    # Processes the `retry` option.
+    class ProcessRetryOption < ServiceAbstract
+      # @param error_handling_options [Hash]
+      #   Options for the retry.
+      # @option raise [MyApiClient::Error]
+      #   Raises specified error when an invalid response detected.
+      #   Should be inherited `MyApiClient::Error` class.
+      # @option retry [TrueClass, Hash]
+      #   If the error detected, retries the API request. Requires `raise` option.
+      #   You can set `true` or `retry_on` options (`wait` and `attempts`).
+      # @option block [Proc, nil]
+      #   Executes the block when error detected.
+      #   The `block` option is forbidden to be used with the` retry` option.
+      # @return [Hash]
+      #   Options for `retry_on`.
+      # @return [nil]
+      #   If `retry` is not specified.
+      def initialize(error_handling_options:)
+        @error_handling_options = error_handling_options
+      end
+
+      private
+
+      attr_reader :error_handling_options
+
+      def call
+        retry_options = error_handling_options.delete(:retry)
+        return unless retry_options
+
+        verify_error_handling_options
+        retry_options = {} unless retry_options.is_a? Hash
+        retry_options
+      end
+
+      # Requires `retry` option and forbid `block` option.
+      def verify_error_handling_options
+        if !error_handling_options[:raise]
+          raise 'The `retry` option requires `raise` option. ' \
+                'Please set any `raise` option, which inherits `MyApiClient::Error` class.'
+        elsif error_handling_options[:block]
+          raise 'The `block` option is forbidden to be used with the` retry` option.'
+        end
+      end
+    end
+  end
+end

data/lib/my_api_client/exceptions.rb

@@ -51,7 +51,7 @@ module MyApiClient
     end
 
     def retry_calling(wait)
-      sleep(wait)
+      Sleeper.call(wait: wait)
       @retry_count += 1
       @retry_result = call(*args)
     end

data/lib/my_api_client/rspec/matchers/be_handled_as_an_error.rb

@@ -16,9 +16,9 @@ RSpec::Matchers.define :be_handled_as_an_error do |expected_error_class|
     handle_error(api_request).nil?
   end
 
-  chain :after_retry, :retry_count
-  chain(:times) { nil }
-  chain :when_receive, :expected_response
+  chain(:after_retry, :retry_count)
+  chain(:times) {}
+  chain(:when_receive, :expected_response)
 
   description do
     message = "be handled as #{expected_error_class || 'an error'}"
@@ -54,6 +54,7 @@ RSpec::Matchers.define :be_handled_as_an_error do |expected_error_class|
     )
     @sawyer = instance_double(Sawyer::Agent, call: response)
     allow(Sawyer::Agent).to receive(:new).and_return(sawyer)
+    allow(MyApiClient::Sleeper).to receive(:call)
   end
 
   def set_validation_for_retry_count

data/lib/my_api_client/rspec/stub.rb

@@ -23,7 +23,7 @@ module MyApiClient
     # @return [InstanceDouble]
     #   Returns a spy object of the stubbed ApiClient.
     def stub_api_client_all(klass, **actions_and_options)
-      instance = stub_api_client(klass, actions_and_options)
+      instance = stub_api_client(klass, **actions_and_options)
       allow(klass).to receive(:new).and_return(instance)
       instance
     end

data/lib/my_api_client/service_abstract.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  # The abstract class for service classes
+  class ServiceAbstract
+    private_class_method :new
+
+    def self.call(**args, &block)
+      new(**args, &block).send(:call)
+    end
+
+    # private
+
+    # def initialize(**_args)
+    #   raise "You must implement #{self.class}##{__method__}"
+    # end
+
+    # def call
+    #   raise "You must implement #{self.class}##{__method__}"
+    # end
+  end
+end

data/lib/my_api_client/sleeper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  # Sleep arbitrary time
+  class Sleeper < ServiceAbstract
+    # @param wait [Integer, Float] Sleep time
+    def initialize(wait:)
+      @wait = wait
+    end
+
+    private
+
+    attr_reader :wait
+
+    def call
+      sleep(wait)
+    end
+  end
+end

data/lib/my_api_client/version.rb

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

data/my_api_client.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.4.0'
+
   spec.add_dependency 'activesupport', '>= 4.2.0'
   spec.add_dependency 'faraday', '>= 0.17.1'
   spec.add_dependency 'jsonpath'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_api_client
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -262,6 +262,7 @@ files:
 - lib/my_api_client/config.rb
 - lib/my_api_client/error_handling.rb
 - lib/my_api_client/error_handling/generator.rb
+- lib/my_api_client/error_handling/process_retry_option.rb
 - lib/my_api_client/errors.rb
 - lib/my_api_client/exceptions.rb
 - lib/my_api_client/integrations/bugsnag.rb
@@ -274,6 +275,8 @@ files:
 - lib/my_api_client/rspec/matchers/be_handled_as_an_error.rb
 - lib/my_api_client/rspec/matchers/request_to.rb
 - lib/my_api_client/rspec/stub.rb
+- lib/my_api_client/service_abstract.rb
+- lib/my_api_client/sleeper.rb
 - lib/my_api_client/version.rb
 - my_api_client.gemspec
 - renovate.json
@@ -289,7 +292,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="