oauth2_api_client 3.2.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 538d67c5360a1a6a2e2f9ff40c1b87acdaf6fdfe64ba292fbee47bc52c48047f
-  data.tar.gz: b50a7904af84f243bc73d0aebf89a8b00d50dd6ef5e579805b959b9de8161319
+  metadata.gz: bf92b6840d7440d512d8d0b7586acfe9751c38e6c99e4ab9f83cd9893cf9f13e
+  data.tar.gz: 2e79b922b01af914adef3bacc2f415af62d26e3c8ad95b699daa63147842410a
 SHA512:
-  metadata.gz: b801d4daec062a26567ba686b923a1051a3d024e5a9ed0ddb954edb093d5c26891b4f071657df2c34284be7d3f8cb38f60ceb277d145e3c7628cd45daa58c227
-  data.tar.gz: 4dd5218f1d770194836800702190dba87b943c80c92f65c0a518bc4ca2c9783f24f7d2bc23968705ec52ec067f6d4127439aa9d367f14a80f95cbe828861f722
+  metadata.gz: 0b782f564cde4d121868f274946df14af27ab13d7e1d501367451b571ada534696027c8ae51e8705315ad35a5a43b04d800d3209a6c70a6eaedf0a1a5f077ca1
+  data.tar.gz: f2c3a469a6a189c6a0c986182ab2a53eb268a851882406d1d7de00cc32556f5a7ebb9e9dcc6732fd370ff9ce905a90a714ddea0649e33ada8eeea2dcb7a74be7

data/.github/workflows/test.yml

@@ -7,12 +7,12 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-        - 2.6
-        - 2.7
-        - 3.0
+        - "2.7"
+        - "3.0"
+        - "3.1"
     steps:
     - uses: actions/checkout@v1
-    - uses: actions/setup-ruby@v1
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - run: gem install bundler

data/CHANGELOG.md

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

data/Gemfile

@@ -1,3 +1,9 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "bundler"
+gem "rspec"
+gem "rubocop"
+gem "timecop"
+gem "webmock"

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.4.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|
@@ -66,7 +72,7 @@ class Oauth2ApiClient
     ruby2_keywords method
   end
 
-  [:get, :post, :put, :delete, :head, :options].each do |method|
+  [:get, :post, :put, :patch, :delete, :head, :options].each do |method|
     define_method method do |path, options = {}|
       execute(method, path, options)
     end
@@ -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/oauth2_api_client.gemspec

@@ -17,12 +17,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "timecop"
-  spec.add_development_dependency "webmock"
-
   spec.add_dependency "activesupport"
   spec.add_dependency "http"
   spec.add_dependency "oauth2", ">= 1.4.2"

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,6 +140,19 @@ RSpec.describe Oauth2ApiClient do
       expect(client.get("/path", params: { key: "value" }).to_s).to eq("ok")
     end
 
+    [:get, :post, :put, :patch, :delete, :head, :options].each do |method|
+      describe "##{method}" do
+        it "calls with body" do
+          stub_request(method, "http://localhost/api/path").with(body: { key: "value" }.to_json)
+            .to_return(status: 200, body: "ok")
+
+          client = described_class.new(base_url: "http://localhost/api", token: "token")
+
+          expect(client.send(method, "/path", headers: { "Content-Type" => "application/json" }, body: { key: "value" }.to_json).to_s).to eq("ok")
+        end
+      end
+    end
+
     it "passes the token in the authorization header" do
       stub_request(:get, "http://localhost/api/path")
         .with(headers: { "Authorization" => "Bearer access_token" })

metadata

@@ -1,85 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oauth2_api_client
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement