oauth2_api_client 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54c4982a38d552df8c467fcbd0064eba0d1c35e1dd58fffb07a1d8fbe338c8b1
-  data.tar.gz: 446b18222a7f5bd1259d2482304180ad0a0e73fd811004464a46b265ac946537
+  metadata.gz: 61d5d7602f4fd19918ac64b34d46dbf636d149da28605a296a284d48b9f46506
+  data.tar.gz: 90febed5c60202e3406988c77fdb1ecb103adbf4b0216b4452c10639f0128ffe
 SHA512:
-  metadata.gz: 42adc9e66943d44b12b9c277042dadaa0cc6e17713962cf6feb2ecc623806e1e7ff19e0bc6265191bd33d552175d3490af9855b152ddba5e70e870f27a6ed391
-  data.tar.gz: 4f6beef17b91cac08e5a2c89d4e5e4cc26a91b90217e82c026e84dec99a99f0211902fdff761dbe801b837c9ae019bc01d959f3883537a7440370fabc2f44d3a
+  metadata.gz: a5385487519625a1c65afa4c6c208a779f1373ba76d5695b07338cdcb5bc160ef4141fed85d9ba9364f6c0d5a7f605cc351db4eb7a57bb3d41cbad8cd1343dbd
+  data.tar.gz: b63e215e39f98570b2604dc4352505a359e307355755aa11f8ea823953c6f083060072958895c0d847ff082d7ec460338219236b3f4abcc3829ce918ece1de37

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,18 @@
 
 # CHANGELOG
 
+# v3.2.0
+
+* Allow passing `nil` as token for unprotected APIs
+
+# 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

data/README.md

@@ -1,6 +1,6 @@
 # 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 a small, but powerful client around
@@ -12,10 +12,17 @@ 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)
 # ...
 ```
 
+In case an API is unprotected and you still want to use Oauth2ApiClient, you
+can simply not pass any token:
+
+```ruby
+client = Oauth2ApiClient.new(base_url: "...")
+```
+
 Oauth2ApiClient is capable of generating oauth2 tokens, when a client id,
 client secret and oauth token url is given with automatic token caching and
 renewal on expiry, including retry of the current request.

data/lib/oauth2_api_client/response_error.rb

@@ -65,11 +65,13 @@ class Oauth2ApiClient
     attr_reader :response
 
     def initialize(response)
+      super()
+
       @response = response
     end
 
     def to_s
-      "#{self.class.name} (#{response.code}): #{response.body}"
+      "#{self.class.name} (#{response.code}, #{response.uri}): #{response.body}"
     end
 
     # @api private

data/lib/oauth2_api_client/version.rb

@@ -1,3 +1,3 @@
 class Oauth2ApiClient
-  VERSION = "3.0.0"
+  VERSION = "3.2.0"
 end

data/lib/oauth2_api_client.rb

@@ -1,7 +1,6 @@
 require "ruby2_keywords"
 require "oauth2"
 require "http"
-require "ruby2_keywords"
 require "active_support"
 
 require "oauth2_api_client/version"
@@ -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: nil, base_request: HTTP)
     @base_url = base_url
     @token = token
     @request = base_request
@@ -52,6 +51,8 @@ class Oauth2ApiClient
   # @return [String] The token
 
   def token
+    return if @token.nil?
+
     @token.respond_to?(:to_str) ? @token.to_str : @token.token
   end
 
@@ -75,7 +76,10 @@ class Oauth2ApiClient
 
   def execute(verb, path, options = {})
     with_retry do
-      response = @request.auth("Bearer #{token}").send(verb, "#{@base_url}#{path}", options)
+      request = @request
+      request = request.auth("Bearer #{token}") if token
+
+      response = request.send(verb, "#{@base_url}#{path}", options)
 
       return response if response.status.success?
 

data/oauth2_api_client.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"
@@ -26,6 +25,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

@@ -3,9 +3,9 @@ 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")
+      response = double(code: 401, body: "unauthorized", uri: "http://example.com/")
 
-      expect(described_class.new(response).to_s).to eq("Oauth2ApiClient::ResponseError (401): unauthorized")
+      expect(described_class.new(response).to_s).to eq("Oauth2ApiClient::ResponseError (401, http://example.com/): unauthorized")
     end
   end
 

data/spec/oauth2_api_client_spec.rb

@@ -84,7 +84,7 @@ RSpec.describe Oauth2ApiClient do
       expect(client.get("/path", params: { key: "value" }).to_s).to eq("ok")
     end
 
-    it "passes the token in the authentication header" do
+    it "passes the token in the authorization header" do
       stub_request(:get, "http://localhost/api/path")
         .with(headers: { "Authorization" => "Bearer access_token" })
         .to_return(status: 200, body: "ok", headers: {})
@@ -94,6 +94,16 @@ RSpec.describe Oauth2ApiClient do
       expect(client.get("/path").to_s).to eq("ok")
     end
 
+    it "does not pass any authorization header when no token is provided" do
+      stub_request(:get, "http://localhost/api/path")
+        .with { |request| !request.headers.keys.map(&:to_s).map(&:downcase).include?("authorization") }
+        .to_return(status: 200, body: "ok", headers: {})
+
+      client = described_class.new(base_url: "http://localhost/api")
+
+      expect(client.get("/path").to_s).to eq("ok")
+    end
+
     it "retries the request when an http unauthorized status is returned" do
       stub_request(:get, "http://localhost/api/path")
         .to_return({ status: 401, body: "unauthorized" }, { status: 200, body: "ok" })
@@ -123,7 +133,7 @@ RSpec.describe Oauth2ApiClient do
         )
       )
 
-      expect { client.get("/path") }.to raise_error("Oauth2ApiClient::ResponseError::Unauthorized (401): unauthorized")
+      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: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Benjamin Vetter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2022-08-04 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,9 +144,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -165,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
@@ -180,12 +180,8 @@ 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
+test_files: []

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