my_api_client 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cd0cadf555eff5fcc7b6ce43f2af6437c89243fa371b8c17eb6db893948c256
-  data.tar.gz: 9c69a2495c109a11c601bbe770f4f063fa4783f72d567d5b3b4f1a3ded514c99
+  metadata.gz: b184fa1b59269203a189c396d43f1b9f63e91c38c6402c22ed77ce30c60f78e6
+  data.tar.gz: 05befe929b0d318c2668dfeb3627602c9985e4da4baf8b5a234469d772da4d78
 SHA512:
-  metadata.gz: 3b697f923d27cde7834774fc321f39a965f375619c591cb157f7e2743cdc54be44a41d160371e8c85f386159edbf6aeff269123d904c24eba0e6929ef540ec08
-  data.tar.gz: 8868f50cf3f9b1358b070d5a0261bc9db268ccf90bc2715a478b0a1b82bb6d9d210fd7b022caaafa6c0ee3afa63b1a0efd3566dee4a9e91e4b3541b748cd35c8
+  metadata.gz: b788bb9d4ac50f1c0c31f6d24df04e164fe325173f4ece5a01effb2b5b696ea68c7630b56a4e0f6a1b6e001da2ce46b1e4a568e9110729f75c5b7a5d086a20c0
+  data.tar.gz: a8d5a2aa67ce54336961ce0a1a79b2461cf38cfa82546f6b9ddbe1f33e09c8bc002aa2cefe2f1f093321d9a6bbaad4003ea5e63c29b4e8858eeb882178cdf7cd

data/.rubocop.yml

@@ -14,6 +14,7 @@ Metrics/BlockLength:
   Max: 50
   Exclude:
     - 'my_api_client.gemspec'
+    - 'lib/my_api_client/rspec/matchers/**/*'
     - 'spec/**/*'
 
 Metrics/MethodLength:

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## 0.10.1 (Oct 23, 2019)
+
+### Feature
+
+* Support `retry_on` testing at shoulda matcher ([#127](git@github.com:ryz310/my_api_client/pull/127))
+
 ## 0.10.0 (Oct 23, 2019)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.10.0)
+    my_api_client (0.10.1)
       activesupport (>= 4.2.0)
       jsonpath
       sawyer (>= 0.8.2)

data/README.jp.md

@@ -406,6 +406,30 @@ it do
 end
 ```
 
+##### `retry_on` を定義している場合
+
+以下のように `retry_on` を API Client に定義している場合:
+
+```ruby
+class ExampleApiClient < MyApiClient::Base
+  endpoint 'https://example.com'
+
+  error_handling json: { '$.errors.code': 20 }, raise: MyApiClient::ApiLimitError
+  retry_on MyApiClient::ApiLimitError, wait: 30.seconds, attempts: 3
+end
+```
+
+`after_retry` と `times` という Custom Matcher を利用することが出来ます。
+
+```ruby
+it do
+  expect { api_client.get_users(condition: 'condition') }
+    .to be_handled_as_an_error(MyApiClient::ApiLimitError)
+    .after_retry(3).times
+    .when_receive(status_code: 200, body: { errors: { code: 20 } }.to_json)
+end
+```
+
 ### Stubbing
 
 以下のような `ApiClient` を定義しているとします。

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

@@ -7,6 +7,7 @@ RSpec::Matchers.define :be_handled_as_an_error do |expected_error_class|
 
   match do |api_request|
     init
+    set_validation_for_retry_count
     handle_error(api_request).is_a? expected_error_class
   end
 
@@ -15,8 +16,16 @@ 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
 
+  description do
+    message = "be handled as #{expected_error_class}"
+    message += " after retry #{retry_count} times" unless retry_count.nil?
+    message
+  end
+
   failure_message do |api_request|
     actual_error = handle_error(api_request)
     if actual_error.nil?
@@ -34,6 +43,8 @@ RSpec::Matchers.define :be_handled_as_an_error do |expected_error_class|
     "but it was handled as #{actual_error.class.name}"
   end
 
+  attr_reader :sawyer
+
   def init
     disable_logging
     response = dummy_response(
@@ -41,10 +52,16 @@ RSpec::Matchers.define :be_handled_as_an_error do |expected_error_class|
       headers: expected_response[:headers] || {},
       body: expected_response[:body] || nil
     )
-    sawyer = instance_double(Sawyer::Agent, call: response)
+    @sawyer = instance_double(Sawyer::Agent, call: response, sleep: nil)
     allow(Sawyer::Agent).to receive(:new).and_return(sawyer)
   end
 
+  def set_validation_for_retry_count
+    return if retry_count.nil?
+
+    expect(sawyer).to receive(:call).exactly(retry_count + 1).times
+  end
+
   def handle_error(api_request)
     api_request.call
   rescue MyApiClient::Error => e

data/lib/my_api_client/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_api_client
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - ryz310