oauth2_api_client 2.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb758d909c7cbeae49beef096ef7b8b0eedb5e038c8a403fac15388d6fc71884
-  data.tar.gz: 86186e7192b22b2fddb16e6bd03c005efbe58d3f159585ef8ad2ec1cd9a79d4b
+  metadata.gz: 33e0e15f43fe027760355c1a403da0d02b30412b064984102234744fc8da65b7
+  data.tar.gz: bf10a1428e0a797daa31f32b7712d2525eddab710c2ba12d244e95b968489314
 SHA512:
-  metadata.gz: 5cbb79317198bd5c8bf2e3139ee5646be1d035ef7a95950ed05e0b35aad4b8bde1556b80294e73ee2c3823e6ce863fbc09ce26989fb6677b81fed0157c04aae6
-  data.tar.gz: ce5ef6661c8226f38770f2abc8cae7f33bc6b5efb6eaac11819fd8848ab084cc236374797d92c5d505a4d2142a6e677b0d17f1e2c0d0d910fb44b201bdf0537c
+  metadata.gz: 46dbbbd595379cc1217f272247149d0ce8084651704c2264301e28dcc8ece22b2c8cc2b9b108d38140eaf1f46145cfde1fb600e24a5434f00a013948e79b22c3
+  data.tar.gz: d3b38d88ac90e9550971f5320b5cca814be87ade495a8bd999047faebd310f41beecbe45ac16e35fd2ba1e54bbea7b443f13f670e1c119e3a08931b6ea7476ef

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+on: push
+name: test
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+        - 2.6
+        - 2.7
+        - 3.0
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: gem install bundler
+    - run: bundle
+    - run: bundle exec rspec
+    - run: bundle exec rubocop

data/.rubocop.yml

@@ -1,6 +1,12 @@
 AllCops:
   NewCops: enable
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
 Metrics/ParameterLists:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 
 # CHANGELOG
 
+# v3.1.1
+
+* Added oauth2 version constraint
+
+# v3.1.0
+
+* Added uri to `Oauth2ApiClient::ReponseError` exception message
+
+# v3.0.0
+
+* [BREAKING] Renamed `Oauth2ApiClient::HttpError` to
+  `Oauth2ApiClient::ResponseError`
+* Added http error exception classes like e.g.
+  `Oauth2ApiClient::ResponseError::NotFound`,
+  `Oauth2ApiClient::ResponseError::InternalServerError`, etc.
+
+# v2.1.0
+
+* Include the response code and body in `HttpError#to_s`
+
 # v2.0.0
 
 * `TokenProvider` added

data/README.md

@@ -1,9 +1,9 @@
 # oauth2_api_client
 
-[![Build Status](https://secure.travis-ci.org/mrkamel/oauth2_api_client.svg?branch=master)](http://travis-ci.org/mrkamel/oauth2_api_client)
+[![Build](https://github.com/mrkamel/oauth2_api_client/workflows/test/badge.svg)](https://github.com/mrkamel/oauth2_api_client/actions?query=workflow%3Atest+branch%3Amaster)
 [![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.
@@ -12,7 +12,7 @@ oauth2 for authentication.
 client = Oauth2ApiClient.new(base_url: "https://api.example.com", token "oauth2 token")
 
 client.post("/orders", json: { address: "..." }).status.success?
-client.headers("User-Agent" => "API Client").timeout(read: 5, write: 5).get("/orders").parse
+client.headers("User-Agent" => "API Client").timeout(read: 5, write: 5).get("/orders").parse(:json)
 # ...
 ```
 
@@ -33,6 +33,12 @@ client = Oauth2ApiClient.new(
 )
 ```
 
+Please note, `get`, `post`, `put`, etc. will raise
+`Oauth2ApiClient::ResponseError` unless the response code is 2xx. More
+specifically, it will e.g. raise `Oauth2ApiClient::ResponseError::NotFound` for
+a 404 status code, `Oauth2ApiClient::ResponseError::InternalServerError` for a
+500 status code, etc.
+
 ## Install
 
 Add this line to your application's Gemfile:

data/lib/oauth2_api_client/response_error.rb

@@ -0,0 +1,100 @@
+class Oauth2ApiClient
+  # The ResponseError 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. Moreover,
+  # there are exception classes for all 4xx and 5xx errors.
+  #
+  # @example
+  #   begin
+  #     client.post("/orders", json: { address: "..." })
+  #   rescue Oauth2ApiClient::ResponseError::NotFound => e
+  #     e.response # => HTTP::Response
+  #   rescue Oauth2ApiClient::ResponseError::BadRequest => e
+  #     # ...
+  #   rescue Oauth2ApiClient::ResponseError => e
+  #     # ...
+  #   end
+
+  class ResponseError < StandardError
+    STATUSES = {
+      400 => "Bad Request",
+      401 => "Unauthorized",
+      402 => "Payment Required",
+      403 => "Forbidden",
+      404 => "Not Found",
+      405 => "Method Not Allowed",
+      406 => "Not Acceptable",
+      407 => "Proxy Authentication Required",
+      408 => "Request Timeout",
+      409 => "Conflict",
+      410 => "Gone",
+      411 => "Length Required",
+      412 => "Precondition Failed",
+      413 => "Payload Too Large",
+      414 => "URI Too Long",
+      415 => "Unsupported Media Type",
+      416 => "Range Not Satisfiable",
+      417 => "Expectation Failed",
+      418 => "I'm A Teapot",
+      421 => "Too Many Connections From This IP",
+      422 => "Unprocessable Entity",
+      423 => "Locked",
+      424 => "Failed Dependency",
+      425 => "Unordered Collection",
+      426 => "Upgrade Required",
+      428 => "Precondition Required",
+      429 => "Too Many Requests",
+      431 => "Request Header Fields Too Large",
+      449 => "Retry With",
+      450 => "Blocked By Windows Parental Controls",
+
+      500 => "Internal Server Error",
+      501 => "Not Implemented",
+      502 => "Bad Gateway",
+      503 => "Service Unavailable",
+      504 => "Gateway Timeout",
+      505 => "HTTP Version Not Supported",
+      506 => "Variant Also Negotiates",
+      507 => "Insufficient Storage",
+      508 => "Loop Detected",
+      509 => "Bandwidth Limit Exceeded",
+      510 => "Not Extended",
+      511 => "Network Authentication Required"
+    }
+
+    attr_reader :response
+
+    def initialize(response)
+      super()
+
+      @response = response
+    end
+
+    def to_s
+      "#{self.class.name} (#{response.code}, #{response.uri}): #{response.body}"
+    end
+
+    # @api private
+    #
+    # Returns the exception class for a status code of the given response.
+
+    def self.for(response)
+      return const_get(const_name(STATUSES[response.code])).new(response) if STATUSES.key?(response.code)
+
+      new(response)
+    end
+
+    # @api private
+    #
+    # Returns a sanitized version to be used as a constant name for a given
+    # http error message.
+
+    def self.const_name(message)
+      message.gsub(/[^a-zA-Z0-9]/, "")
+    end
+
+    STATUSES.each do |_code, message|
+      const_set(const_name(message), Class.new(self))
+    end
+  end
+end

data/lib/oauth2_api_client/version.rb

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

data/lib/oauth2_api_client.rb

@@ -1,11 +1,10 @@
 require "ruby2_keywords"
 require "oauth2"
 require "http"
-require "ruby2_keywords"
 require "active_support"
 
 require "oauth2_api_client/version"
-require "oauth2_api_client/http_error"
+require "oauth2_api_client/response_error"
 require "oauth2_api_client/token_provider"
 
 # The Oauth2ApiClient class is a client wrapped around the oauth2 and http-rb
@@ -28,7 +27,7 @@ class Oauth2ApiClient
   #   )
   #
   #   client.post("/orders", json: { address: "..." }).status.success?
-  #   client.headers("User-Agent" => "API Client").timeout(read: 5, write: 5).get("/orders").parse
+  #   client.headers("User-Agent" => "API Client").timeout(read: 5, write: 5).get("/orders").parse(:json)
   #
   # @example
   #   client = Oauth2ApiClient.new(
@@ -41,7 +40,7 @@ class Oauth2ApiClient
   #     )
   #   )
 
-  def initialize(base_url:, base_request: HTTP, token:)
+  def initialize(base_url:, token:, base_request: HTTP)
     @base_url = base_url
     @token = token
     @request = base_request
@@ -79,7 +78,7 @@ class Oauth2ApiClient
 
       return response if response.status.success?
 
-      raise HttpError.new(response.status.to_s, response)
+      raise ResponseError.for(response)
     end
   end
 
@@ -88,7 +87,7 @@ class Oauth2ApiClient
 
     begin
       yield
-    rescue HttpError => e
+    rescue ResponseError => e
       if !retried && e.response.status.unauthorized? && @token.respond_to?(:invalidate_token)
         @token.invalidate_token
 

data/oauth2_api_client.gemspec

@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport"
   spec.add_dependency "http"
-  spec.add_dependency "oauth2"
+  spec.add_dependency "oauth2", ">= 1.4.2"
   spec.add_dependency "ruby2_keywords"
 end

data/spec/oauth2_api_client/response_error_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe Oauth2ApiClient::ResponseError do
+  describe "#to_s" do
+    it "returns the message" do
+      response = double(code: 401, body: "unauthorized", uri: "http://example.com/")
+
+      expect(described_class.new(response).to_s).to eq("Oauth2ApiClient::ResponseError (401, http://example.com/): unauthorized")
+    end
+  end
+
+  describe ".for" do
+    it "returns the exception class for the status code of the given response" do
+      expect(described_class.for(double(code: 400, body: "body"))).to be_instance_of(Oauth2ApiClient::ResponseError::BadRequest)
+      expect(described_class.for(double(code: 404, body: "body"))).to be_instance_of(Oauth2ApiClient::ResponseError::NotFound)
+      expect(described_class.for(double(code: 500, body: "body"))).to be_instance_of(Oauth2ApiClient::ResponseError::InternalServerError)
+      expect(described_class.for(double(code: 503, body: "body"))).to be_instance_of(Oauth2ApiClient::ResponseError::ServiceUnavailable)
+    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::ResponseError::Unauthorized (401, http://localhost/api/path): 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: 3.1.1
 platform: ruby
 authors:
 - Benjamin Vetter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-21 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
   requirement: !ruby/object:Gem::Requirement
@@ -144,19 +144,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/oauth2_api_client.rb
-- lib/oauth2_api_client/http_error.rb
+- lib/oauth2_api_client/response_error.rb
 - lib/oauth2_api_client/token_provider.rb
 - lib/oauth2_api_client/version.rb
 - oauth2_api_client.gemspec
+- spec/oauth2_api_client/response_error_spec.rb
 - spec/oauth2_api_client/token_provider_spec.rb
 - spec/oauth2_api_client_spec.rb
 - spec/spec_helper.rb
@@ -164,7 +165,7 @@ homepage: https://github.com/mrkamel/oauth2_api_client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,11 +180,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+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/response_error_spec.rb
 - spec/oauth2_api_client/token_provider_spec.rb
 - spec/oauth2_api_client_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,10 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - ruby-2.6.2
-  - ruby-2.7.1
-install:
-  - travis_retry bundle install
-script:
- - bundle exec rspec
- - bundle exec rubocop

data/lib/oauth2_api_client/http_error.rb

@@ -1,10 +0,0 @@
-class Oauth2ApiClient
-  class HttpError < StandardError
-    attr_reader :message, :response
-
-    def initialize(message, response)
-      @message = message
-      @response = response
-    end
-  end
-end