my_api_client 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e548093a65be2816e7e86939b5570ce245af19b2422180cba0d9cff7f2f15ed
-  data.tar.gz: 0cbafd89253c574bc85cba334a6e90349b51af033aec2b8bcc5076cef22824d7
+  metadata.gz: 38d80eab152ca28a8dbd5456ed21cbd85c123a8ae5a25183a7a843a97a7a0f9e
+  data.tar.gz: ecf27feccc823ba7c45950b71ee5a8f7459bda3992ab81209c03eca957604e6f
 SHA512:
-  metadata.gz: b370c044f12d7d9862bbe3cb1d038a0f7a949acbf2390a442880d59db33f5f5d42ff73e8f205f4696ed2713b3102b86b6cc2a473e218ee2269ea385c6d80c890
-  data.tar.gz: e32efde0fd72efc444dbac9f5435cf9682fc5c18e4d0a8dc09571de9c4d29b8a36b375cee239a39cb05f4af65f2075cd245e6f985d01d11e4166ed0cc46b936f
+  metadata.gz: e23a635d8a9342a536202d29dffe54d9bc2973e7e555f0d340a59862aad977bffd2501dad8af159c874cf56ca48b3ae0c6fe258d12584b81e96114d426bd9aa0
+  data.tar.gz: '067183e46ad3421bb6d48c22c89201e2eaa9e490993264afb0a0500f136a0ef2abee5826b39f777902eb11c1c5bb61c93c66291f5c5d18480fd7bdc3289f3a36'

data/.rubocop_todo.yml

@@ -1,7 +1,17 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-07-16 23:31:21 +0000 using RuboCop version 0.73.0.
+# on 2019-07-23 23:30:32 +0000 using RuboCop version 0.73.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
 # versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 18
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/lib/my_api_client/base_spec.rb'
+    - 'spec/lib/my_api_client/config_spec.rb'
+    - 'spec/lib/my_api_client/error_handling_spec.rb'
+    - 'spec/lib/my_api_client/exceptions_spec.rb'
+    - 'spec/lib/my_api_client/request_spec.rb'
+    - 'spec/lib/my_api_client/rspec/stub_spec.rb'

data/CHANGELOG.md

@@ -1,50 +1,60 @@
 # Change log
 
+## 0.9.0 (July 25, 2019)
+
+### New Features
+
+* Forbid nil response ([#93](https://github.com/ryz310/my_api_client/pull/93))
+
+### Misc
+
+* RSpec/DescribedClass-20190723233015 ([#92](https://github.com/ryz310/my_api_client/pull/92))
+
 ## 0.8.0 (July 23, 2019)
 
 ### New Features
 
-* Allow method calling on error handling (#89)
+* Allow method calling on error handling ([#89](https://github.com/ryz310/my_api_client/pull/89))
 
 ### Breaking Changes
 
-* Require sawyer gem v0.8.2 over (#88)
+* Require sawyer gem v0.8.2 over ([#88](https://github.com/ryz310/my_api_client/pull/88))
 
 ## 0.7.0 (July 17, 2019)
 
 ### Features
 
-* Add request duration to metadata (#80)
-* Support boolean on error handling (#81)
+* Add request duration to metadata ([#80](https://github.com/ryz310/my_api_client/pull/80))
+* Support boolean on error handling ([#81](https://github.com/ryz310/my_api_client/pull/81))
 
 ### Breaking Changes
 
-* Modify the generator to be simple (#82)
+* Modify the generator to be simple ([#82](https://github.com/ryz310/my_api_client/pull/82))
 
 ### Misc
 
-* Re-generate .rubocop_todo.yml with RuboCop v0.73.0 (#79)
-* Introduce gem comet (#85)
+* Re-generate .rubocop_todo.yml with RuboCop v0.73.0 ([#79](https://github.com/ryz310/my_api_client/pull/79))
+* Introduce gem comet ([#85](https://github.com/ryz310/my_api_client/pull/85))
 
 ## 0.6.2 (July 03, 2019)
 
 ### Bug fixes
 
-* Fix logger setter on the template (#76)
+* Fix logger setter on the template ([#76](https://github.com/ryz310/my_api_client/pull/76))
     * Fix #54
 
 ## 0.6.1 (July 03, 2019)
 
 ### Misc
 
-* Bump yard from `0.9.19` to `0.9.20` (#72)
+* Bump yard from `0.9.19` to `0.9.20` ([#72](https://github.com/ryz310/my_api_client/pull/72))
     * Fix a security risk
 
 ## 0.6.0 (June 25, 2019)
 
 ### New Features
 
-* New stubbing helper (#65)
+* New stubbing helper ([#65](https://github.com/ryz310/my_api_client/pull/65))
 
 ```rb
 stub_api_client_all(
@@ -74,85 +84,85 @@ response.id # => 1
 
 ### Bug Fixes
 
-* Initialize sawyer agent before logger initialization (#60)
-    * Fixes: The URL included in the logger is incomplete (#53)
-* Fix parsing error if given text/html response (#61)
+* Initialize sawyer agent before logger initialization ([#60](https://github.com/ryz310/my_api_client/pull/60))
+    * Fixes: The URL included in the logger is incomplete ([#53](https://github.com/ryz310/my_api_client/pull/53))
+* Fix parsing error if given text/html response ([#61](https://github.com/ryz310/my_api_client/pull/61))
 
 ## 0.5.2 (June 23, 2019)
 
 ### Bug Fixes
 
-* Fix the result of the retry (#57)
-    * Issue: Return values are nil after retrying (#56)
+* Fix the result of the retry ([#57](https://github.com/ryz310/my_api_client/pull/57))
+    * Issue: Return values are nil after retrying ([#56](https://github.com/ryz310/my_api_client/pull/56))
 
 ### Misc
 
-* Improvement test coverage (#55)
+* Improvement test coverage ([#55](https://github.com/ryz310/my_api_client/pull/55))
 
 ## 0.5.1 (June 19, 2019)
 
 ### Bug Fixes
 
-* Fix unsupported data for the Bugsnag breadcrumbs (#50)
+* Fix unsupported data for the Bugsnag breadcrumbs ([#50](https://github.com/ryz310/my_api_client/pull/50))
 
 ## 0.5.0 (June 16, 2019)
 
 ### New Features
 
-* Support bugsnag breadcrumb (#41)
+* Support bugsnag breadcrumb ([#41](https://github.com/ryz310/my_api_client/pull/41))
 
 ### Misc
 
-* Use CircleCI Orbs (#43)
+* Use CircleCI Orbs ([#43](https://github.com/ryz310/my_api_client/pull/43))
 
 ## 0.4.0 (June 03, 2019)
 
 ### Feature
 
-* Improvement for endpoint (#35)
+* Improvement for endpoint ([#35](https://github.com/ryz310/my_api_client/pull/35))
 
 ### Bug Fix
 
-* Add requirements for `$ bin/console` (#31)
+* Add requirements for `$ bin/console` ([#31](https://github.com/ryz310/my_api_client/pull/31))
 
 ### Misc
 
-* Update RuboCop v0.70.0 -> v0.71.0 (#34)
+* Update RuboCop v0.70.0 -> v0.71.0 ([#34](https://github.com/ryz310/my_api_client/pull/34))
 
 ## 0.3.0 (May 29, 2019)
 
 ### New Features
 
-* Provide test helper for RSpec (#28)
+* Provide test helper for RSpec ([#28](https://github.com/ryz310/my_api_client/pull/28))
 
 ## 0.2.0 (May 29, 2019)
 
 ### New Features
 
-* Support Bugsnag metadata (#22)
+* Support Bugsnag metadata ([#22](https://github.com/ryz310/my_api_client/pull/22))
 
 ### Misc
 
-* Improve test coverage (#24)
-* Fix problem on the release job (#25)
+* Improve test coverage ([#24](https://github.com/ryz310/my_api_client/pull/24))
+* Fix problem on the release job ([#25](https://github.com/ryz310/my_api_client/pull/25))
 
 ## 0.1.4 (May 28, 2019)
 
 ### Bugfix
 
-* Support activesupport before v5.2.0 (#17)
+* Support activesupport before v5.2.0 ([#17](https://github.com/ryz310/my_api_client/pull/17))
 
 ## 0.1.3 (May 27, 2019)
 
-* Fix wrong variable name (#13)
+* Fix wrong variable name ([#13](https://github.com/ryz310/my_api_client/pull/13))
 
 ## 0.1.2 (May 27, 2019)
 
-* Fix wrong method name (#10)
+* Fix wrong method name ([#10](https://github.com/ryz310/my_api_client/pull/10))
 
 ## 0.1.1 (May 27, 2019)
 
-* Fix typo (#6)
+* Fix typo ([#6](https://github.com/ryz310/my_api_client/pull/6))
 
 ## 0.1.0 (May 27, 2019)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.8.0)
+    my_api_client (0.9.0)
       activesupport (>= 4.2.0)
       jsonpath
       sawyer (>= 0.8.2)
@@ -76,7 +76,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     rubocop-performance (1.4.0)
       rubocop (>= 0.71.0)
-    rubocop-rspec (1.33.0)
+    rubocop-rspec (1.34.0)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)

data/README.jp.md

@@ -187,6 +187,14 @@ error_handling json: { '$.errors.code': :negative? }
 }
 ```
 
+#### forbid_nil
+
+```ruby
+error_handling status_code: 200, forbid_nil: true
+```
+
+一部のサービスではサーバーから何らかの Response Body が返ってくる事を期待しているにも関わらず、空の結果が結果が返ってくるというケースがあるようです。こちらも実験的な機能ですが、そういったケースを検出するために `forbid_nil` オプションを用意しました。通常の場合、Response Body が空の場合はエラー判定をしませんが、このオプションに `true` を指定するとエラーとして検知する様になります。正常応答が空となる API も存在するので、誤検知にご注意下さい。
+
 #### MyApiClient::Params::Params
 
 WIP

data/lib/my_api_client/error_handling/generator.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  module ErrorHandling
+    # Generates an error handler proc (or symbol)
+    class Generator
+      private_class_method :new
+
+      # @param options [Hash]
+      #   Options for this generator
+      # @option response [Sawyer::Response]
+      #   The target of verifying
+      # @option status_code [String, Range, Integer, Regexp]
+      #   Verifies response HTTP status code and raises error if matched
+      # @option json [Hash]
+      #   Verifies response body as JSON and raises error if matched
+      # @option forbid_nil [Boolean]
+      #   Verifies response_body and raises error if it is `nil`
+      # @option with [Symbol]
+      #   Calls specified method when error detected
+      # @option raise [MyApiClient::Error]
+      #   Raises specified error when error detected. default: MyApiClient::Error
+      # @option block [Proc]
+      #   Executes the block when error detected
+      # @return [Proc]
+      #   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)
+      end
+
+      private
+
+      attr_reader :_response, :_status_code, :_json, :_forbid_nil, :_with, :_raise, :_block
+
+      def initialize(**options)
+        options.each { |k, v| instance_variable_set("@_#{k}", v) }
+      end
+
+      def call
+        return unless match?(_status_code, _response.status)
+        return unless match_all?(_json, _response.body)
+
+        if _block
+          ->(params, logger) { _block.call(params, logger) }
+        elsif _with
+          _with
+        else
+          ->(params, _logger) { raise _raise, params }
+        end
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def match?(operator, target)
+        case operator
+        when nil
+          true
+        when String, Integer, TrueClass, FalseClass
+          operator == target
+        when Range
+          operator.include?(target)
+        when Regexp
+          operator =~ target.to_s
+        when Symbol
+          target.respond_to?(operator) && target.public_send(operator)
+        else
+          raise "Unexpected operator type was given: #{operator.inspect}"
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def match_all?(json, response_body)
+        return true if json.nil?
+        return true if response_body.nil? && _forbid_nil
+        return false if response_body.blank?
+
+        json.all? do |path, operator|
+          target = JsonPath.new(path.to_s).first(response_body)
+          match?(operator, target)
+        end
+      rescue MultiJson::ParseError
+        false
+      end
+    end
+  end
+end

data/lib/my_api_client/error_handling.rb

@@ -7,6 +7,7 @@ module MyApiClient
   #   You need to define `class_attribute: error_handler, default: []` for the
   #   included class.
   # @example
+  #   error_handling status_code: 200, forbid_nil: true
   #   error_handling status_code: 400..499, raise: MyApiClient::ClientError
   #   error_handling status_code: 500..599 do |params, logger|
   #     logger.warn 'Server error occurred.'
@@ -16,65 +17,36 @@ module MyApiClient
   #   error_handling json: { '$.errors.code': 10..19 }, with: :my_error_handling
   #   error_handling json: { '$.errors.code': 20 }, raise: MyApiClient::ApiLimitError
   #   error_handling json: { '$.errors.message': /Sorry/ }, raise: MyApiClient::ServerError
+  #   error_handling json: { '$.errors.code': :negative? }
   module ErrorHandling
     extend ActiveSupport::Concern
 
     class_methods do
-      # Description of .error_handling
+      # Definition of an error handling
       #
-      # @param status_code [String, Range, Integer, Regexp] default: nil
-      # @param json [Hash] default: nil
-      # @param with [Symbol] default: nil
-      # @param raise [MyApiClient::Error] default: MyApiClient::Error
-      # @param block [Proc] describe_block_here
-      def error_handling(status_code: nil, json: nil, with: nil, raise: MyApiClient::Error)
+      # @param options [Hash]
+      #   Options for this generator
+      # @option status_code [String, Range, Integer, Regexp]
+      #   Verifies response HTTP status code and raises error if matched
+      # @option json [Hash]
+      #   Verifies response body as JSON and raises error if matched
+      # @option forbid_nil [Boolean]
+      #   Verifies response_body and raises error if it is `nil`. default: false.
+      # @option with [Symbol]
+      #   Calls specified method when error detected
+      # @option raise [MyApiClient::Error]
+      #   Raises specified error when error detected. default: MyApiClient::Error
+      # @yield [MyApiClient::Params::Params, MyApiClient::Logger]
+      #   Executes the block when error detected
+      def error_handling(**options, &block)
+        options[:forbid_nil] ||= false
+        options[:raise] ||= MyApiClient::Error
+        options[:block] = block if block_given?
+
         temp = error_handlers.dup
-        temp << lambda { |response|
-          if match?(status_code, response.status) && match_all?(json, response.body)
-            if block_given?
-              ->(params, logger) { yield params, logger }
-            elsif with
-              with
-            else
-              ->(params, _logger) { raise raise, params }
-            end
-          end
-        }
+        temp << ->(response) { Generator.call(options.merge(response: response)) }
         self.error_handlers = temp
       end
-
-      private
-
-      # rubocop:disable Metrics/CyclomaticComplexity
-      def match?(operator, target)
-        case operator
-        when nil
-          true
-        when String, Integer, TrueClass, FalseClass
-          operator == target
-        when Range
-          operator.include?(target)
-        when Regexp
-          operator =~ target.to_s
-        when Symbol
-          target.respond_to?(operator) && target.public_send(operator)
-        else
-          raise "Unexpected operator type was given: #{operator.inspect}"
-        end
-      end
-      # rubocop:enable Metrics/CyclomaticComplexity
-
-      def match_all?(json, response_body)
-        return true if json.nil?
-        return false if response_body.blank?
-
-        json.all? do |path, operator|
-          target = JsonPath.new(path.to_s).first(response_body)
-          match?(operator, target)
-        end
-      rescue MultiJson::ParseError
-        false
-      end
     end
 
     # The error handlers defined later takes precedence

data/lib/my_api_client/version.rb

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

data/lib/my_api_client.rb

@@ -9,6 +9,7 @@ require 'active_support/core_ext'
 require 'sawyer'
 require 'my_api_client/version'
 require 'my_api_client/config'
+require 'my_api_client/error_handling/generator'
 require 'my_api_client/error_handling'
 require 'my_api_client/exceptions'
 require 'my_api_client/logger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_api_client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-23 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -246,6 +246,7 @@ files:
 - lib/my_api_client/base.rb
 - 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/errors.rb
 - lib/my_api_client/exceptions.rb
 - lib/my_api_client/integrations/bugsnag.rb