my_api_client 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad19788202ac1ee6711537e81d0ab8d459918a9660d85bced28ae051dbf06d23
-  data.tar.gz: f36355f04e35e09473a3d4fdc6be1bb46bbd3b39d99d18b942d41891d581808a
+  metadata.gz: 93698a943856cab100913566c3dd718662d6c25a3f332add330d28d9071107db
+  data.tar.gz: 2c642b721e322c51a34c7fcb90accdb58ab6e73587a9b61b9b34cfd9041087ae
 SHA512:
-  metadata.gz: 856baa51b7ee09c7178b6e3c3145ff313908b1790f4f051a19a987e645f9f9b4c4de8a2e2e0cd76d1cb9dac9dbabf210b90ff7dd8d78f4f1a1225cedb9f22628
-  data.tar.gz: 984dc3fb7a188b11e454eff1c92086e58d7346498aa9f8333aa7c429896c695d708e19b34f3b96a98311e1e9539c5d4e0975d0b71d2d52bd673a5eb01c9b3ca7
+  metadata.gz: 4a884a59d5a3cc8b697d709f556b95152431958d51d0445803891dd0b0515eb142a2082f516bca321d9ada72b84b7c9f8924e37f813b1be01fa30a0e797b4e20
+  data.tar.gz: 752f41008a25167523950b3d4056e747755fa0d147f0981f2ac871d958c8dd03ad36295c9240d6cc6958a7266140c6447723398ec5aeb6f4401a969c329a68d1

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-05-30 23:31:07 +0000 using RuboCop version 0.71.0.
+# on 2019-06-25 23:31:06 +0000 using RuboCop version 0.72.0.
 # 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.6.0)
+    my_api_client (0.6.1)
       activesupport (>= 4.2.0)
       jsonpath
       sawyer
@@ -54,14 +54,14 @@ GEM
     pry-byebug (3.7.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    public_suffix (3.1.0)
+    public_suffix (3.1.1)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
     rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -88,7 +88,7 @@ GEM
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    simplecov (0.16.1)
+    simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -102,7 +102,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.19)
+    yard (0.9.20)
 
 PLATFORMS
   ruby

data/README.jp.md

@@ -299,34 +299,51 @@ class ExampleApiClient < MyApiClient::Base
 end
 ```
 
-`my_api_client_stub` を使うことで、 `ExampleApiClient#request` をスタブ化することができます。これで `#request` を実行してもリアルな HTTP リクエストが実行されなくなります。
+`stub_api_client_all` や `stub_api_client` を使うことで、 `ExampleApiClient#request` をスタブ化することができます。これで `#request` を実行してもリアルな HTTP リクエストが実行されなくなります。
 
 ```ruby
-my_api_client_stub(ExampleApiClient, :request, response: { id: 12345 })
+stub_api_client_all(
+  ExampleApiClient,
+  request: { response: { id: 12345 } }
+)
 
 response = ExampleApiClient.new.request(user_id: 1)
 response.id # => 12345
 ```
 
-リクスエストパラメータを使ったレスポンスを返すようにスタブ化したい場合は、 `block` を利用することで実現できます。
+`response` は省略することも可能です。
 
 ```ruby
-my_api_client_stub(ExampleApiClient, :request) do |params|
-  { id: params[:user_id] }
-end
+stub_api_client_all(
+  ExampleApiClient,
+  request: { id: 12345 }
+)
+
+response = ExampleApiClient.new.request(user_id: 1)
+response.id # => 12345
+```
+
+
+リクスエストパラメータを使ったレスポンスを返すようにスタブ化したい場合は、 `Proc` を利用することで実現できます。
+
+```ruby
+stub_api_client_all(
+  ExampleApiClient,
+  request: ->(params) { { id: params[:user_id] } }
+)
 
 response = ExampleApiClient.new.request(user_id: 1)
 response.id # => 1
 ```
 
-`receive` や `have_received` を使ったテストを書きたい場合は、 `my_api_client_stub` の戻り値を利用すると良いでしょう。
+`receive` や `have_received` を使ったテストを書きたい場合は、 `stub_api_client_all` や `stub_api_client` の戻り値を利用すると良いでしょう。
 
 ```ruby
 def execute_api_request
   ExampleApiClient.new.request(user_id: 1)
 end
 
-api_clinet = my_api_client_stub(ExampleApiClient, :request)
+api_clinet = stub_api_client_all(ExampleApiClient, request: nil)
 execute_api_request
 expect(api_client).to have_received(:request).with(user_id: 1)
 ```
@@ -338,7 +355,7 @@ def execute_api_request
   ExampleApiClient.new.request(user_id: 1)
 end
 
-my_api_client_stub(ExampleApiClient, :request, raise: MyApiClient::Error)
+stub_api_client_all(ExampleApiClient, request: { raise: MyApiClient::Error })
 expect { execute_api_request }.to raise_error(MyApiClient::Error)
 ```
 

data/lib/my_api_client/rspec/stub.rb

@@ -14,7 +14,7 @@ module MyApiClient
     #   stub_api_client_all(
     #     ExampleApiClient,
     #     get_user: { response: { id: 1 } },               # Returns an arbitrary response.
-    #     post_users: { status: 'created' },               # You can ommit `response` keyword.
+    #     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.
     #   )
@@ -38,7 +38,7 @@ module MyApiClient
     #   api_client = stub_api_client(
     #     ExampleApiClient,
     #     get_user: { response: { id: 1 } },               # Returns an arbitrary response.
-    #     post_users: { status: 'created' },               # You can ommit `response` keyword.
+    #     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.
     #   )

data/lib/my_api_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_api_client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport