oauth2_api_client 3.1.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33e0e15f43fe027760355c1a403da0d02b30412b064984102234744fc8da65b7
-  data.tar.gz: bf10a1428e0a797daa31f32b7712d2525eddab710c2ba12d244e95b968489314
+  metadata.gz: b846fd82d5e91d799c60adb483691d92a8ee508e3d602c624f9dea0f7d924af5
+  data.tar.gz: 983f980480afb33623d5733ab5cafc019d6e9e2b93048cd5f6a3e9536acd7dc8
 SHA512:
-  metadata.gz: 46dbbbd595379cc1217f272247149d0ce8084651704c2264301e28dcc8ece22b2c8cc2b9b108d38140eaf1f46145cfde1fb600e24a5434f00a013948e79b22c3
-  data.tar.gz: d3b38d88ac90e9550971f5320b5cca814be87ade495a8bd999047faebd310f41beecbe45ac16e35fd2ba1e54bbea7b443f13f670e1c119e3a08931b6ea7476ef
+  metadata.gz: 457d37f335df145f62464d7d380fbf2506bd8003ef38e2f471073513a38851dbe8ef5ad78d9763065e4bb0fa48f83fff832686705c50005b49f26a92c0c41e41
+  data.tar.gz: 4b8f9a70d1afc7de2890196d34bef86e1006dae031ea60b7cef075442281bad8f3a3156bbb33fece19de67fcff404fbfdd834518388ac37f315daba4e7ea4b27

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 
 # CHANGELOG
 
+# v3.3.0
+
+* Add Oauth2ApiClient#params to set default query params
+
+# v3.2.1
+
+* Fix thread safety issue of http-rb
+
+# v3.2.0
+
+* Allow passing `nil` as token for unprotected APIs
+
 # v3.1.1
 
 * Added oauth2 version constraint

data/README.md

@@ -16,6 +16,13 @@ client.headers("User-Agent" => "API Client").timeout(read: 5, write: 5).get("/or
 # ...
 ```
 
+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.
@@ -39,6 +46,17 @@ specifically, it will e.g. raise `Oauth2ApiClient::ResponseError::NotFound` for
 a 404 status code, `Oauth2ApiClient::ResponseError::InternalServerError` for a
 500 status code, etc.
 
+## Default query params
+
+In addition to the DSL of http-rb Oauth2ApiClient allows to set default query
+params, which can be useful for some APIs:
+
+```ruby
+client = Oauth2ApiClient.new(base_url: "https://api.example.com").params(key1: "value1")
+client.get("/path", params: { key2: "value" })
+#=> GET https://api.example.com/path?key1=value1&key2=value2
+```
+
 ## Install
 
 Add this line to your application's Gemfile:

data/lib/oauth2_api_client/version.rb

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

data/lib/oauth2_api_client.rb

@@ -40,7 +40,7 @@ class Oauth2ApiClient
   #     )
   #   )
 
-  def initialize(base_url:, token:, base_request: HTTP)
+  def initialize(base_url:, token: nil, base_request: HTTP)
     @base_url = base_url
     @token = token
     @request = base_request
@@ -51,9 +51,17 @@ class Oauth2ApiClient
   # @return [String] The token
 
   def token
+    return if @token.nil?
+
     @token.respond_to?(:to_str) ? @token.to_str : @token.token
   end
 
+  def params(parms = {})
+    dup.tap do |client|
+      client.instance_variable_set(:@params, (@params || {}).merge(parms))
+    end
+  end
+
   [:timeout, :headers, :cookies, :via, :encoding, :accept, :auth, :basic_auth].each do |method|
     define_method method do |*args|
       dup.tap do |client|
@@ -74,7 +82,14 @@ 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.headers({}) # Prevent thread-safety issue of http-rb: https://github.com/httprb/http/issues/558
+      request = request.auth("Bearer #{token}") if token
+
+      opts = options.dup
+      opts[:params] = @params.merge(opts.fetch(:params, {})) if @params
+
+      response = request.send(verb, "#{@base_url}#{path}", opts)
 
       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"

data/spec/oauth2_api_client_spec.rb

@@ -51,6 +51,62 @@ RSpec.describe Oauth2ApiClient do
     end
   end
 
+  describe "#params" do
+    it "creates a dupped instance" do
+      client = described_class.new(base_url: "http://localhost")
+
+      client1 = client.params(key1: "value1")
+      client2 = client1.params(key2: "value2")
+
+      expect(client1.object_id).not_to eq(client2.object_id)
+    end
+
+    it "merges the params" do
+      client = described_class.new(base_url: "http://localhost")
+
+      client1 = client.params(key1: "value1")
+      client2 = client1.params(key2: "value2")
+
+      expect(client2.instance_variable_get(:@params)).to eq(key1: "value1", key2: "value2")
+    end
+
+    it "merges the params with passed params in requests" do
+      stub_request(:get, "http://localhost/api/path?key1=value1&key2=value2")
+        .to_return(status: 200, body: "ok")
+
+      client = described_class.new(base_url: "http://localhost/api", token: "token").params(key1: "value1")
+
+      expect(client.get("/path", params: { key2: "value2" }).to_s).to eq("ok")
+    end
+
+    it "overwrites the default params when neccessary" do
+      stub_request(:get, "http://localhost/api/path?key=value2")
+        .to_return(status: 200, body: "ok")
+
+      client = described_class.new(base_url: "http://localhost/api", token: "token").params(key: "value1")
+
+      expect(client.get("/path", params: { key: "value2" }).to_s).to eq("ok")
+    end
+
+    it "passes the default params only when no params are given" do
+      stub_request(:get, "http://localhost/api/path?key=value")
+        .to_return(status: 200, body: "ok")
+
+      client = described_class.new(base_url: "http://localhost/api", token: "token").params(key: "value")
+
+      expect(client.get("/path").to_s).to eq("ok")
+    end
+
+    it "passes the params only when no default params are given" do
+      stub_request(:get, "http://localhost/api/path?key=value")
+        .to_return(status: 200, body: "ok")
+
+      client = described_class.new(base_url: "http://localhost/api", token: "token")
+
+      expect(client.get("/path", params: { key: "value" }).to_s).to eq("ok")
+    end
+  end
+
   [:timeout, :headers, :cookies, :via, :encoding, :accept, :auth, :basic_auth].each do |method|
     describe "##{method}" do
       it "creates a dupped instance" do
@@ -84,7 +140,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 +150,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" })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth2_api_client
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,8 +184,4 @@ 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: []