oauth2_api_client 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09a8c7819bfff19e85236301e161cf9481d4f53357bc9952084e5582d509337c'
-  data.tar.gz: d047883ee8e1fd35ff7ffce55f0983653dc862050e1aea786ee410259fbc44d1
+  metadata.gz: 54c4982a38d552df8c467fcbd0064eba0d1c35e1dd58fffb07a1d8fbe338c8b1
+  data.tar.gz: 446b18222a7f5bd1259d2482304180ad0a0e73fd811004464a46b265ac946537
 SHA512:
-  metadata.gz: e52fed4a4c43fa3cc4db0ddc9d0cd6fc0e628b65a0aeaa1b50b9761c7774e8f72d8b08e0eba8ccce6cb69032da9ef92eedb5edb3fb5aa988b6ab5f9ce5527584
-  data.tar.gz: 1ebf22539000c9fb75ca536bc71f59e0476d4ce99c5236c1752d793e6a25fd428f996aae6d9b8cc544f1852f213f7481020d9ff6a8c582369ae26b75aa2dfa7b
+  metadata.gz: 42adc9e66943d44b12b9c277042dadaa0cc6e17713962cf6feb2ecc623806e1e7ff19e0bc6265191bd33d552175d3490af9855b152ddba5e70e870f27a6ed391
+  data.tar.gz: 4f6beef17b91cac08e5a2c89d4e5e4cc26a91b90217e82c026e84dec99a99f0211902fdff761dbe801b837c9ae019bc01d959f3883537a7440370fabc2f44d3a

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 
 # CHANGELOG
 
+# 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`

data/README.md

@@ -33,8 +33,11 @@ client = Oauth2ApiClient.new(
 )
 ```
 
-Please note, `get`, `post`, `put`, etc. will raise `Oauth2ApiClient::HttpError`
-unless the response code is 2xx.
+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
 

data/lib/oauth2_api_client.rb

@@ -5,7 +5,7 @@ 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
@@ -79,7 +79,7 @@ class Oauth2ApiClient
 
       return response if response.status.success?
 
-      raise HttpError, response
+      raise ResponseError.for(response)
     end
   end
 
@@ -88,7 +88,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/lib/oauth2_api_client/response_error.rb

@@ -0,0 +1,98 @@
+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)
+      @response = response
+    end
+
+    def to_s
+      "#{self.class.name} (#{response.code}): #{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.1.0"
+  VERSION = "3.0.0"
 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")
+
+      expect(described_class.new(response).to_s).to eq("Oauth2ApiClient::ResponseError (401): 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("Oauth2ApiClient::HttpError (401): unauthorized")
+      expect { client.get("/path") }.to raise_error("Oauth2ApiClient::ResponseError::Unauthorized (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.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,11 +153,11 @@ files:
 - 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/http_error_spec.rb
+- 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
@@ -185,7 +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/response_error_spec.rb
 - spec/oauth2_api_client/token_provider_spec.rb
 - spec/oauth2_api_client_spec.rb
 - spec/spec_helper.rb

data/lib/oauth2_api_client/http_error.rb

@@ -1,24 +0,0 @@
-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 :response
-
-    def initialize(response)
-      @response = response
-    end
-
-    def to_s
-      "#{self.class.name} (#{response.code}): #{response.body}"
-    end
-  end
-end

data/spec/oauth2_api_client/http_error_spec.rb

@@ -1,11 +0,0 @@
-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