oauth2_api_client 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb758d909c7cbeae49beef096ef7b8b0eedb5e038c8a403fac15388d6fc71884
-  data.tar.gz: 86186e7192b22b2fddb16e6bd03c005efbe58d3f159585ef8ad2ec1cd9a79d4b
+  metadata.gz: '09a8c7819bfff19e85236301e161cf9481d4f53357bc9952084e5582d509337c'
+  data.tar.gz: d047883ee8e1fd35ff7ffce55f0983653dc862050e1aea786ee410259fbc44d1
 SHA512:
-  metadata.gz: 5cbb79317198bd5c8bf2e3139ee5646be1d035ef7a95950ed05e0b35aad4b8bde1556b80294e73ee2c3823e6ce863fbc09ce26989fb6677b81fed0157c04aae6
-  data.tar.gz: ce5ef6661c8226f38770f2abc8cae7f33bc6b5efb6eaac11819fd8848ab084cc236374797d92c5d505a4d2142a6e677b0d17f1e2c0d0d910fb44b201bdf0537c
+  metadata.gz: e52fed4a4c43fa3cc4db0ddc9d0cd6fc0e628b65a0aeaa1b50b9761c7774e8f72d8b08e0eba8ccce6cb69032da9ef92eedb5edb3fb5aa988b6ab5f9ce5527584
+  data.tar.gz: 1ebf22539000c9fb75ca536bc71f59e0476d4ce99c5236c1752d793e6a25fd428f996aae6d9b8cc544f1852f213f7481020d9ff6a8c582369ae26b75aa2dfa7b

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 
 # CHANGELOG
 
+# v2.1.0
+
+* Include the response code and body in `HttpError#to_s`
+
 # v2.0.0
 
 * `TokenProvider` added

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://secure.travis-ci.org/mrkamel/oauth2_api_client.svg?branch=master)](http://travis-ci.org/mrkamel/oauth2_api_client)
 [![Gem Version](https://badge.fury.io/rb/oauth2_api_client.svg)](http://badge.fury.io/rb/oauth2_api_client)
 
-Oauth2ApiClient is small, but powerful client around
+Oauth2ApiClient is a small, but powerful client around
 [oauth2](https://github.com/oauth-xx/oauth2) and
 [http-rb](https://github.com/httprb/http) to interact with APIs which use
 oauth2 for authentication.
@@ -33,6 +33,9 @@ client = Oauth2ApiClient.new(
 )
 ```
 
+Please note, `get`, `post`, `put`, etc. will raise `Oauth2ApiClient::HttpError`
+unless the response code is 2xx.
+
 ## Install
 
 Add this line to your application's Gemfile:

data/lib/oauth2_api_client.rb

@@ -79,7 +79,7 @@ class Oauth2ApiClient
 
       return response if response.status.success?
 
-      raise HttpError.new(response.status.to_s, response)
+      raise HttpError, response
     end
   end
 

data/lib/oauth2_api_client/http_error.rb

@@ -1,10 +1,24 @@
 class Oauth2ApiClient
+  # The HttpError class is the main exception class of Oauth2ApiClient and is
+  # raised when a request fails with some status code other than 2xx. Using
+  # the exception object, you still have access to the response.
+  #
+  # @example
+  #   begin
+  #     client.post("/orders", json: { address: "..." })
+  #   rescue Oauth2ApiClient::HttpError => e
+  #     e.response # => HTTP::Response
+  #   end
+
   class HttpError < StandardError
-    attr_reader :message, :response
+    attr_reader :response
 
-    def initialize(message, response)
-      @message = message
+    def initialize(response)
       @response = response
     end
+
+    def to_s
+      "#{self.class.name} (#{response.code}): #{response.body}"
+    end
   end
 end

data/lib/oauth2_api_client/version.rb

@@ -1,3 +1,3 @@
 class Oauth2ApiClient
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/oauth2_api_client/http_error_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe Oauth2ApiClient::HttpError do
+  describe "#to_s" do
+    it "returns the message" do
+      response = double(code: 401, body: "unauthorized")
+
+      expect(described_class.new(response).to_s).to eq("Oauth2ApiClient::HttpError (401): unauthorized")
+    end
+  end
+end

data/spec/oauth2_api_client_spec.rb

@@ -123,7 +123,7 @@ RSpec.describe Oauth2ApiClient do
         )
       )
 
-      expect { client.get("/path") }.to raise_error(described_class::HttpError)
+      expect { client.get("/path") }.to raise_error("Oauth2ApiClient::HttpError (401): unauthorized")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth2_api_client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-21 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,6 +157,7 @@ files:
 - lib/oauth2_api_client/token_provider.rb
 - lib/oauth2_api_client/version.rb
 - oauth2_api_client.gemspec
+- spec/oauth2_api_client/http_error_spec.rb
 - spec/oauth2_api_client/token_provider_spec.rb
 - spec/oauth2_api_client_spec.rb
 - spec/spec_helper.rb
@@ -184,6 +185,7 @@ signing_key:
 specification_version: 4
 summary: Small but powerful client around oauth2 and http-rb to interact with APIs
 test_files:
+- spec/oauth2_api_client/http_error_spec.rb
 - spec/oauth2_api_client/token_provider_spec.rb
 - spec/oauth2_api_client_spec.rb
 - spec/spec_helper.rb