my_api_client 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38d80eab152ca28a8dbd5456ed21cbd85c123a8ae5a25183a7a843a97a7a0f9e
-  data.tar.gz: ecf27feccc823ba7c45950b71ee5a8f7459bda3992ab81209c03eca957604e6f
+  metadata.gz: 8a388b02739580f3208f34dc4e56f852f028a6acf2fce08abb3d6689bb3809b3
+  data.tar.gz: cdce875732354336fef4208b48616c9380d8f698865a0fc9a7d893a6f36a2064
 SHA512:
-  metadata.gz: e23a635d8a9342a536202d29dffe54d9bc2973e7e555f0d340a59862aad977bffd2501dad8af159c874cf56ca48b3ae0c6fe258d12584b81e96114d426bd9aa0
-  data.tar.gz: '067183e46ad3421bb6d48c22c89201e2eaa9e490993264afb0a0500f136a0ef2abee5826b39f777902eb11c1c5bb61c93c66291f5c5d18480fd7bdc3289f3a36'
+  metadata.gz: b85475c4e54fe188d7669ad06bbaae159bfef53a89ddbbc6ec3132a8286b8b9e8564d421b7c7e024de2b5f09d888b3ed736c0a98b6f9d12bbaa99e837cd97e8c
+  data.tar.gz: a97decaa49de365e30c9ed0d2a99a9cc290de61f581be5219fd85cbc4931b6267ee5253d000a3c43e664df6e3056e1376708a9e51762ea0b37eb117ef2798be6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## 0.9.1 (July 25, 2019)
+
+### Bugfix
+
+* Fix/forbid nil option ([#97](https://github.com/ryz310/my_api_client/pull/97)) **Breaking Changes**
+
 ## 0.9.0 (July 25, 2019)
 
 ### New Features

data/Gemfile.lock

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

data/README.jp.md

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

data/lib/my_api_client/error_handling.rb

@@ -7,7 +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: 200, json: :forbid_nil
   #   error_handling status_code: 400..499, raise: MyApiClient::ClientError
   #   error_handling status_code: 500..599 do |params, logger|
   #     logger.warn 'Server error occurred.'
@@ -28,10 +28,9 @@ module MyApiClient
       #   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 json [Hash, Symbol]
+      #   Verifies response body as JSON and raises error if matched.
+      #   If specified `:forbid_nil`, it forbid `nil` on response_body.
       # @option with [Symbol]
       #   Calls specified method when error detected
       # @option raise [MyApiClient::Error]
@@ -39,7 +38,6 @@ module MyApiClient
       # @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?
 

data/lib/my_api_client/error_handling/generator.rb

@@ -12,10 +12,9 @@ module MyApiClient
       #   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 json [Hash, Symbol]
+      #   Verifies response body as JSON and raises error if matched.
+      #   If specified `:forbid_nil`, it forbid `nil` on response_body.
       # @option with [Symbol]
       #   Calls specified method when error detected
       # @option raise [MyApiClient::Error]
@@ -32,7 +31,7 @@ module MyApiClient
 
       private
 
-      attr_reader :_response, :_status_code, :_json, :_forbid_nil, :_with, :_raise, :_block
+      attr_reader :_response, :_status_code, :_json, :_with, :_raise, :_block
 
       def initialize(**options)
         options.each { |k, v| instance_variable_set("@_#{k}", v) }
@@ -72,7 +71,7 @@ module MyApiClient
 
       def match_all?(json, response_body)
         return true if json.nil?
-        return true if response_body.nil? && _forbid_nil
+        return response_body.nil? if json == :forbid_nil
         return false if response_body.blank?
 
         json.all? do |path, operator|

data/lib/my_api_client/version.rb

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

metadata

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