my_api_client 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e5581dc65458d9130b465c89479fa8fc877c78f67d1cf701c225d64cbef9577
-  data.tar.gz: 86cae4eade33446a4ef2a5e54f44600e72ee868add6e3cfa5690fe8f1336df01
+  metadata.gz: 5e287e051f0699595e499150dd4e4c303e00a82f951ffc86b13afde142a3720e
+  data.tar.gz: 7725d581e64d01683a636f56e86d217010d536f827023d691faca3b5cbbe2264
 SHA512:
-  metadata.gz: fce2d580f7c2622b2c2b1acc506e585434c29946ac81b6311e255cb53ac8e98276f30b79171e87610076376711f024b08b86724dcc5413328ba7488c9b52e983
-  data.tar.gz: 9475d69090e5748e511e7000df1db586da11ee5f62fc5f35fad30fce203a6ca2beabcafcf28e8eaf505e4a58d45cd4f771da86dea74bdcc70cee7e072267751e
+  metadata.gz: c37ce83c7a27302b8e890087251c67b955e8398b95d08a78b47447401cf0b3332b9bcd66c0e46e4e578a5a51e80f0a4a5fcea576c69fd8d29be8fa5c1c670720
+  data.tar.gz: 9a42a194c50def52f2aca6f9c54aac80dd7e4191114aa24fef543f81fab235417b3ec1f86ff2f960cd77cd1ff17188df5c073a4574df80fed9963375060058ce

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## v0.13.0 (Jan 21, 2020)
+
+### Feature
+
+* [#180](https://github.com/ryz310/my_api_client/pull/180) Stub response on raising error ([@ryz310](https://github.com/ryz310))
+
 ## v0.12.0 (Jan 19, 2020)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.12.0)
+    my_api_client (0.13.0)
       activesupport (>= 4.2.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -20,7 +20,7 @@ GEM
     ast (2.4.0)
     bugsnag (6.12.2)
       concurrent-ruby (~> 1.0)
-    byebug (11.0.1)
+    byebug (11.1.0)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
     crack (0.4.3)

data/README.jp.md

@@ -201,7 +201,21 @@ WIP
 
 #### MyApiClient::Error
 
-WIP
+API リクエストのレスポンスが `error_handling` で定義した matcher に合致した場合、 `raise` で指定した例外処理が発生します。この例外クラスは `MyApiClient::Error` を継承している必要があります。
+
+この例外クラスには `#params` というメソッドが存在し、リクエストやレスポンスのパラメータを参照することが出来ます。
+
+```ruby
+begin
+  api_client.request
+rescue MyApiClient::Error => e
+  e.params.inspect
+  # => {
+  #      :request=>"#<MyApiClient::Params::Request#inspect>",
+  #      :response=>"#<Sawyer::Response#inspect>",
+  #    }
+end
+```
 
 #### Bugsnag breadcrumbs
 
@@ -534,6 +548,25 @@ stub_api_client_all(ExampleApiClient, request: { raise: MyApiClient::Error })
 expect { execute_api_request }.to raise_error(MyApiClient::Error)
 ```
 
+なお、発生した例外に含まれるレスポンスパラメータもスタブ化したい場合は、 `response` オプションと同時に指定することが可能です。
+
+```ruby
+stub_api_client_all(
+  ExampleApiClient,
+  request: {
+    raise: MyApiClient::Error,
+    response: { message: 'error' }
+  }
+)
+
+begin
+  ExampleApiClient.new.request(user_id: 1)
+rescue MyApiClient::Error => e
+  response_body = e.params.response.data.to_h
+  expect(response_body).to eq(message: 'error')
+end
+```
+
 ## Contributing
 
 不具合の報告や Pull Request を歓迎しています。OSS という事で自分はなるべく頑張って英語を使うようにしていますが、日本語での報告でも大丈夫です :+1:

data/lib/my_api_client/rspec/stub.rb

@@ -3,6 +3,11 @@
 module MyApiClient
   # Test helper module for RSpec
   module Stub
+    ERROR_MESSAGE =
+      'If you use the `raise` option as an error instance, the `response` option ' \
+      'is ignored. If you want to use both options, you need to specify the ' \
+      '`raise` option as an error class.'
+
     # Stubs all instance of arbitrary MyApiClient class.
     # And returns a stubbed arbitrary MyApiClient instance.
     #
@@ -16,7 +21,11 @@ module MyApiClient
     #     get_user: { response: { id: 1 } },               # Returns an arbitrary response.
     #     post_users: { id: 1 },                           # You can ommit `response` keyword.
     #     patch_user: ->(params) { { id: params[:id] } },  # Returns calculated result as response.
-    #     delete_user: { raise: MyApiClient::ClientError } # Raises an arbitrary error.
+    #     put_user: { raise: MyApiClient::ClientError }    # Raises an arbitrary error.
+    #     delete_user: {
+    #       raise: MyApiClient::ClientError,
+    #       response: { errors: [{ code: 10 }] },          # You can stub response with exception.
+    #     }
     #   )
     #   response = ExampleApiClient.new.get_user(id: 123)
     #   response.id # => 1
@@ -40,7 +49,11 @@ module MyApiClient
     #     get_user: { response: { id: 1 } },               # Returns an arbitrary response.
     #     post_users: { id: 1 },                           # You can ommit `response` keyword.
     #     patch_user: ->(params) { { id: params[:id] } },  # Returns calculated result as response.
-    #     delete_user: { raise: MyApiClient::ClientError } # Raises an arbitrary error.
+    #     put_user: { raise: MyApiClient::ClientError }    # Raises an arbitrary error.
+    #     delete_user: {
+    #       raise: MyApiClient::ClientError,
+    #       response: { errors: [{ code: 10 }] },          # You can stub response with exception.
+    #     }
     #   )
     #   response = api_client.get_user(id: 123)
     #   response.id # => 1
@@ -58,17 +71,18 @@ module MyApiClient
     def stubbing(instance, action, options)
       case options
       when Proc
-        allow(instance).to receive(action) { |*request| stub_as_sawyer(options.call(*request)) }
+        allow(instance).to receive(action) { |*request| stub_as_resource(options.call(*request)) }
       when Hash
         if options[:raise].present?
-          allow(instance).to receive(action).and_raise(process_raise_option(options[:raise]))
+          exception = process_raise_option(options[:raise], options[:response])
+          allow(instance).to receive(action).and_raise(exception)
         elsif options[:response]
-          allow(instance).to receive(action).and_return(stub_as_sawyer(options[:response]))
+          allow(instance).to receive(action).and_return(stub_as_resource(options[:response]))
         else
-          allow(instance).to receive(action).and_return(stub_as_sawyer(options))
+          allow(instance).to receive(action).and_return(stub_as_resource(options))
         end
       else
-        allow(instance).to receive(action).and_return(stub_as_sawyer(options))
+        allow(instance).to receive(action).and_return(stub_as_resource(options))
       end
     end
     # rubocop:enable Metrics/AbcSize
@@ -81,26 +95,38 @@ module MyApiClient
     # @param exception [Clsas, MyApiClient::Error] Processing target.
     # @return [MyApiClient::Error] Processed exception.
     # @raise [RuntimeError] Unsupported error class was set.
-    def process_raise_option(exception)
+    def process_raise_option(exception, response = {})
       case exception
       when Class
-        params = instance_double(MyApiClient::Params::Params, metadata: {})
+        params = MyApiClient::Params::Params.new(nil, stub_as_response(response))
         if exception == MyApiClient::NetworkError
           exception.new(params, Net::OpenTimeout.new)
         else
           exception.new(params)
         end
       when MyApiClient::Error
+        raise ERROR_MESSAGE if response.present?
+
         exception
       else
         raise "Unsupported error class was set: #{exception.inspect}"
       end
     end
 
-    def stub_as_sawyer(params)
+    def stub_as_response(params)
+      instance_double(
+        Sawyer::Response,
+        status: 400,
+        headers: {},
+        data: stub_as_resource(params),
+        timing: 0.123
+      )
+    end
+
+    def stub_as_resource(params)
       case params
       when Hash  then Sawyer::Resource.new(agent, params)
-      when Array then params.map { |hash| stub_as_sawyer(hash) }
+      when Array then params.map { |hash| stub_as_resource(hash) }
       when nil   then nil
       else params
       end

data/lib/my_api_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_api_client
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport