oauth2_api_client 3.4.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9361c724e72de0bbebb82eb1d3a70d62bf9c12488d665eea40ad25c090ab2ed0
-  data.tar.gz: a025968d9268a17b2fce69056575e48b3133f2621042f0e682d711d9dc4319ad
+  metadata.gz: 71751084c3e42bbdea2ccd3aae3e33716c4cea4d175ef709474de146c94dc7b8
+  data.tar.gz: 78c01d8725a63ad148f3ffa9570f9524a5496bd35c901212cefcbd02f18b4cb7
 SHA512:
-  metadata.gz: df519ea81f617078eb44f734de18e3543f1d44fcc0db2be030436401c3e504f11b8ed54b5eb5bf0a57af744bec36678bf52f9daa055b51b9ee48e27bc7d340db
-  data.tar.gz: a2eec2a4d5ad53fcda9386e890d5cf7067410a6e5452a5263206ae6bfe62c8b122c829bee140090e742ba5d151e8a2ce11bae5df0515ca6449605033b248f6d8
+  metadata.gz: 48c6453955a713e5d144e7788c4c970dc3405801410525b9d561c2bc7ede63556dfaf737221f27b38edf37c0342c029c6c17f8c03b2d87ac334d1fa88d125d19
+  data.tar.gz: a62a3aa0814ed3dd096a37ea6ad7ebc7ef304445bbfd7e70fe282e85c060c77607923a08bdbc6f4074bae62e34be56a3731d7e3024f908a61c1f3d14cbff6aba

data/.github/workflows/test.yml

@@ -15,7 +15,6 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - run: gem install bundler
     - run: bundle
     - run: bundle exec rspec
     - run: bundle exec rubocop

data/CHANGELOG.md

@@ -1,6 +1,32 @@
 
 # CHANGELOG
 
+# v4.0.0
+
+* [BREAKING] Rescue `HTTP::Error` and raise `Oauth2ApiClient::Error` instead
+
+In case you currently use:
+
+```ruby
+begin
+  client = Oauth2ApiClient.new(base_url: "...")
+  client.get("...")
+rescue HTTP::Error # or HTTP::ConnectionError, etc.
+  # ...
+end
+```
+
+please change it to:
+
+```ruby
+begin
+  client = Oauth2ApiClient.new(base_url: "...")
+  client.get("...")
+rescue Oauth2ApiClient::Error
+  # ...
+end
+```
+
 # v3.4.1
 
 * fix duplicate auth calls if NullStore is used

data/lib/oauth2_api_client/{response_error.rb → errors.rb}

@@ -15,7 +15,9 @@ class Oauth2ApiClient
   #     # ...
   #   end
 
-  class ResponseError < StandardError
+  class Error < StandardError; end
+
+  class ResponseError < Error
     STATUSES = {
       400 => "Bad Request",
       401 => "Unauthorized",
@@ -93,7 +95,7 @@ class Oauth2ApiClient
       message.gsub(/[^a-zA-Z0-9]/, "")
     end
 
-    STATUSES.each do |_code, message|
+    STATUSES.each_value do |message|
       const_set(const_name(message), Class.new(self))
     end
   end

data/lib/oauth2_api_client/version.rb

@@ -1,3 +1,3 @@
 class Oauth2ApiClient
-  VERSION = "3.4.1"
+  VERSION = "4.0.0"
 end

data/lib/oauth2_api_client.rb

@@ -4,7 +4,7 @@ require "http"
 require "active_support"
 
 require "oauth2_api_client/version"
-require "oauth2_api_client/response_error"
+require "oauth2_api_client/errors"
 require "oauth2_api_client/token_provider"
 
 # The Oauth2ApiClient class is a client wrapped around the oauth2 and http-rb
@@ -91,7 +91,12 @@ class Oauth2ApiClient
       opts = options.dup
       opts[:params] = @params.merge(opts.fetch(:params, {})) if @params
 
-      response = request.send(verb, "#{@base_url}#{path}", opts)
+      response =
+        begin
+          request.send(verb, "#{@base_url}#{path}", opts)
+        rescue HTTP::Error => e
+          raise Error, e.message
+        end
 
       return response if response.status.success?
 

data/spec/oauth2_api_client_spec.rb

@@ -222,5 +222,13 @@ RSpec.describe Oauth2ApiClient do
 
       expect { client.get("/path") }.to raise_error("Oauth2ApiClient::ResponseError::Unauthorized (401, http://localhost/api/path): unauthorized")
     end
+
+    it "rescues HTTP::Error and raises a Oauth2ApiClient::Error instead" do
+      stub_request(:get, "http://localhost/api/path").to_raise(HTTP::Error.new("error"))
+
+      client = described_class.new(base_url: "http://localhost/api", token: "token")
+
+      expect { client.get("/path") }.to raise_error(Oauth2ApiClient::Error, "error")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth2_api_client
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -83,7 +83,7 @@ files:
 - README.md
 - Rakefile
 - lib/oauth2_api_client.rb
-- lib/oauth2_api_client/response_error.rb
+- lib/oauth2_api_client/errors.rb
 - lib/oauth2_api_client/token_provider.rb
 - lib/oauth2_api_client/version.rb
 - oauth2_api_client.gemspec