oauth2_api_client 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 538d67c5360a1a6a2e2f9ff40c1b87acdaf6fdfe64ba292fbee47bc52c48047f
-  data.tar.gz: b50a7904af84f243bc73d0aebf89a8b00d50dd6ef5e579805b959b9de8161319
+  metadata.gz: b846fd82d5e91d799c60adb483691d92a8ee508e3d602c624f9dea0f7d924af5
+  data.tar.gz: 983f980480afb33623d5733ab5cafc019d6e9e2b93048cd5f6a3e9536acd7dc8
 SHA512:
-  metadata.gz: b801d4daec062a26567ba686b923a1051a3d024e5a9ed0ddb954edb093d5c26891b4f071657df2c34284be7d3f8cb38f60ceb277d145e3c7628cd45daa58c227
-  data.tar.gz: 4dd5218f1d770194836800702190dba87b943c80c92f65c0a518bc4ca2c9783f24f7d2bc23968705ec52ec067f6d4127439aa9d367f14a80f95cbe828861f722
+  metadata.gz: 457d37f335df145f62464d7d380fbf2506bd8003ef38e2f471073513a38851dbe8ef5ad78d9763065e4bb0fa48f83fff832686705c50005b49f26a92c0c41e41
+  data.tar.gz: 4b8f9a70d1afc7de2890196d34bef86e1006dae031ea60b7cef075442281bad8f3a3156bbb33fece19de67fcff404fbfdd834518388ac37f315daba4e7ea4b27

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 
 # CHANGELOG
 
+# v3.3.0
+
+* Add Oauth2ApiClient#params to set default query params
+
 # v3.2.1
 
 * Fix thread safety issue of http-rb

data/README.md

@@ -46,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.2.1"
+  VERSION = "3.3.0"
 end

data/lib/oauth2_api_client.rb

@@ -56,6 +56,12 @@ class Oauth2ApiClient
     @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|
@@ -80,7 +86,10 @@ class Oauth2ApiClient
       request = request.headers({}) # Prevent thread-safety issue of http-rb: https://github.com/httprb/http/issues/558
       request = request.auth("Bearer #{token}") if token
 
-      response = request.send(verb, "#{@base_url}#{path}", options)
+      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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oauth2_api_client
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler