my_api_client 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a9f9115532dc935f506308465aa7d0fcab38b347aeb3694501a39136e54b339
-  data.tar.gz: fd05661eccd1e5d970de6ad0323845580d0929919c528ddcc7f1cc4fdaf2212a
+  metadata.gz: ad19788202ac1ee6711537e81d0ab8d459918a9660d85bced28ae051dbf06d23
+  data.tar.gz: f36355f04e35e09473a3d4fdc6be1bb46bbd3b39d99d18b942d41891d581808a
 SHA512:
-  metadata.gz: 8d346886c4ff7ae526b1ddf2f8d0212edb8db32f0e09fb0d54068e39dc9435b85a347d585c2abfb2c301c3908a050b3fd392237df96858858c30b6fba73c1587
-  data.tar.gz: 887e47f816f9657d0f3ace557a35530fbf3f2be4eef1162f39dd614114cb55023a43e6882435a36fc6b552b3e186e71ac2938dcca8e5c395c0077e9831e0dc55
+  metadata.gz: 856baa51b7ee09c7178b6e3c3145ff313908b1790f4f051a19a987e645f9f9b4c4de8a2e2e0cd76d1cb9dac9dbabf210b90ff7dd8d78f4f1a1225cedb9f22628
+  data.tar.gz: 984dc3fb7a188b11e454eff1c92086e58d7346498aa9f8333aa7c429896c695d708e19b34f3b96a98311e1e9539c5d4e0975d0b71d2d52bd673a5eb01c9b3ca7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.5.3)
+    my_api_client (0.6.0)
       activesupport (>= 4.2.0)
       jsonpath
       sawyer
@@ -72,7 +72,7 @@ GEM
     rspec-support (3.8.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.71.0)
+    rubocop (0.72.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)

data/lib/my_api_client/rspec/stub.rb

@@ -3,6 +3,55 @@
 module MyApiClient
   # Test helper module for RSpec
   module Stub
+    # Stubs all instance of arbitrary MyApiClient class.
+    # And returns a stubbed arbitrary MyApiClient instance.
+    #
+    # @param klass [Class]
+    #   Stubbing target class.
+    # @param actions_and_options [Hash]
+    #   Stubbing target method and options
+    # @example
+    #   stub_api_client_all(
+    #     ExampleApiClient,
+    #     get_user: { response: { id: 1 } },               # Returns an arbitrary response.
+    #     post_users: { status: 'created' },               # 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.
+    #   )
+    #   response = ExampleApiClient.new.get_user(id: 123)
+    #   response.id # => 1
+    # @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)
+      allow(klass).to receive(:new).and_return(instance)
+      instance
+    end
+
+    # Returns a stubbed arbitrary MyApiClient instance.
+    #
+    # @param klass [Class]
+    #   Stubbing target class.
+    # @param actions_and_options [Hash]
+    #   Stubbing target method and options
+    # @example
+    #   api_client = stub_api_client(
+    #     ExampleApiClient,
+    #     get_user: { response: { id: 1 } },               # Returns an arbitrary response.
+    #     post_users: { status: 'created' },               # 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.
+    #   )
+    #   response = api_client.get_user(id: 123)
+    #   response.id # => 1
+    # @return [InstanceDouble]
+    #   Returns a spy object of the stubbed ApiClient.
+    def stub_api_client(klass, **actions_and_options)
+      instance = instance_double(klass)
+      actions_and_options.each { |action, options| stubbing(instance, action, options) }
+      instance
+    end
+
     # Provides stubbing feature for `MyApiClient`.
     #
     # @param klass [Class]
@@ -20,6 +69,10 @@ module MyApiClient
     #   Returns a spy object for the ApiClient.
     # rubocop:disable Metrics/AbcSize
     def my_api_client_stub(klass, action, response: nil, raise: nil)
+      ActiveSupport::Deprecation.warn(<<~MSG)
+        `my_api_client_stub` is deprecated. Please use `stub_api_client` or `stub_api_client_all`.
+      MSG
+
       instance = instance_double(klass)
       allow(klass).to receive(:new).and_return(instance)
       if raise.present?
@@ -35,6 +88,25 @@ module MyApiClient
 
     private
 
+    # rubocop:disable Metrics/AbcSize
+    def stubbing(instance, action, options)
+      case options
+      when Proc
+        allow(instance).to receive(action) { |*request| stub_as_sawyer(options.call(*request)) }
+      when Hash
+        if options[:raise].present?
+          allow(instance).to receive(action).and_raise(process_raise_option(options[:raise]))
+        elsif options[:response]
+          allow(instance).to receive(action).and_return(stub_as_sawyer(options[:response]))
+        else
+          allow(instance).to receive(action).and_return(stub_as_sawyer(options))
+        end
+      else
+        allow(instance).to receive(action).and_return(stub_as_sawyer(options))
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+
     # Provides a shorthand for `raise` option.
     # `MyApiClient::Error` requires `MyApiClient::Params::Params` instance on
     # initialize, but it makes trubolesome. `MyApiClient::NetworkError` is more.
@@ -62,7 +134,7 @@ module MyApiClient
     def stub_as_sawyer(params)
       case params
       when Hash  then Sawyer::Resource.new(agent, params)
-      when Array then params.map { |hash| sawyer_resource(hash) }
+      when Array then params.map { |hash| stub_as_sawyer(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.5.3'
+  VERSION = '0.6.0'
 end

metadata

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