checkr-official 1.5.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 11baecc2701fe8183773014e0e0ca9f742927b18
-  data.tar.gz: 37d162612fedee47d704685bd1ffbba10687bc73
+SHA256:
+  metadata.gz: 75c06d4b9b7ca0f7e10ea7dacda6b01391bf5f324f4d32a5824d253b06040b25
+  data.tar.gz: e585ca7f37af58ba98da2e1c4c04af6207d4a32a07130ea0ad06e7e2208bed67
 SHA512:
-  metadata.gz: 719b7d97e082cf7ef6c3c1e5eee60effacd1ccbd4443c315ff5818f8db5d842e419cdec1fc18dd13ef6e5000bf650ee92e79654513b18fd3d4c8e949a91b7363
-  data.tar.gz: f3cb6255a0affca7bd97668a636b138a13ad1327a7711149c49787b00d90e118d1c9bd05a6275209c79d52e2d4a0dc764ece24aa841e71331f8a64bd701c1e68
+  metadata.gz: d8f3a05d1d15e60cbb69f30a6b31335a1540f4d40a468abc8e3a986e11da5ede73bba7496e3c7724c1049d863d3af2bd75e0fd131d9ff987c468c18e31bf3fcf
+  data.tar.gz: aa1c480c462230f8f9b1865ea499ad7cfa460a0b163f6424938794cc56243e7b4faa0cbceef137c0a535e3e33ad6df670025d7e39ca8bce7bd4b907e85756e93

data/Changelog.md

@@ -1,3 +1,7 @@
+## v1.5.4 (2018-12-10)
+
+- Add ability to pass api key to individual API method calls
+
 ## v1.5.3 (2018-11-28)
 
 - Add geos to Report

data/lib/checkr.rb

@@ -61,6 +61,9 @@ module Checkr
   end
 
   def self.request(method, path, params={}, headers={})
+    api_key = params[:api_key] || self.api_key
+    params.delete(:api_key)
+
     verify_api_key(api_key)
 
     url = api_url(path)

data/lib/checkr/version.rb

@@ -1,3 +1,3 @@
 module Checkr
-  VERSION = '1.5.3'.freeze
+  VERSION = '1.5.4'.freeze
 end

data/test/checkr/api_class_test.rb

@@ -48,6 +48,47 @@ module Checkr
           :filter => 'test filter',
         })
       end
+
+      should 'allow passing an api_key as a param when the global api_key is set' do
+        response = test_response(test_mock_resource_list)
+        api_key = '123456'
+
+        @mock.expects(:get).with do |url, headers, params|
+          (url == "#{Checkr.api_base}#{MockResource.path}?page=1&filter=test%20filter" ||
+            url == "#{Checkr.api_base}#{MockResource.path}?filter=test%20filter&page=1") &&
+            params == nil &&
+            Checkr.api_key == 'foo'
+            headers["Authorization"] == "Basic #{Base64.encode64("#{api_key}:")}"
+        end.returns(response)
+
+        list = MockResource.all(
+          :page => 1,
+          :filter => 'test filter',
+          :api_key => api_key
+        )
+      end
+
+      should 'allow passing an api_key as a param when the global api_key is NOT set' do
+        response = test_response(test_mock_resource_list)
+        api_key = '123456'
+        Checkr.api_key = nil
+
+        
+        @mock.expects(:get).with do |url, headers, params|
+          (url == "#{Checkr.api_base}#{MockResource.path}?page=1&filter=test%20filter" ||
+            url == "#{Checkr.api_base}#{MockResource.path}?filter=test%20filter&page=1") &&
+            params == nil &&
+            headers["Authorization"] == "Basic #{Base64.encode64("#{api_key}:")}"
+        end.returns(response)
+
+        assert_equal(Checkr.api_key, nil)
+
+        list = MockResource.all(
+          :page => 1,
+          :filter => 'test filter',
+          :api_key => api_key
+        )
+      end
     end
 
     context 'Making a DELETE request' do
@@ -60,6 +101,19 @@ module Checkr
         end.returns(test_response({}))
         mock_resource.delete(:reason => "delinquent payments")
       end
+
+      should 'allow passing an api_key as a param' do
+        api_key = '123456'
+
+        @mock.expects(:get).once.returns(test_response(test_mock_resource))
+        mock_resource = MockResource.retrieve("fake_id")
+
+        @mock.expects(:delete).once.with do |url, headers, payload|
+          url == "#{Checkr.api_base}#{mock_resource.path}?reason=delinquent%20payments" && payload.nil? &&
+          headers["Authorization"] == "Basic #{Base64.encode64("#{api_key}:")}"
+        end.returns(test_response({}))
+        mock_resource.delete(:reason => "delinquent payments", :api_key => api_key)
+      end
     end
 
     context 'Making a PUT request' do
@@ -73,6 +127,20 @@ module Checkr
         end.returns(test_response(test_mock_resource))
         mock_resource.save
       end
+
+      should 'allow passing an api_key as a param' do
+        api_key = '123456'
+
+        @mock.expects(:get).once.returns(test_response(test_mock_resource))
+        mock_resource = MockResource.retrieve("fake_id")
+        mock_resource.name = "new name"
+
+        @mock.expects(:put).once.with do |url, headers, payload|
+          payload == { :name => "new name"} && 
+          headers["Authorization"] == "Basic #{Base64.encode64("#{api_key}:")}"
+        end.returns(test_response(test_mock_resource))
+        mock_resource.save(:api_key => api_key)
+      end
     end
 
     context 'Making a POST request' do
@@ -82,6 +150,17 @@ module Checkr
 
         MockResource.create(params)
       end
+
+      should 'allow passing an api_key as a param' do
+        api_key = '123456'
+
+        @mock.expects(:post).once.with do |url, headers, payload|
+          url == "#{Checkr.api_base}#{MockResource.path}" && payload == { :name => "some name" } &&
+          headers["Authorization"] == "Basic #{Base64.encode64("#{api_key}:")}"
+        end.returns(test_response(test_mock_resource))
+
+        MockResource.create(:name => "some name", :api_key => api_key)
+      end
     end
 
     context 'APIClass :default_params' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkr-official
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.4
 platform: ruby
 authors:
 - Checkr Engineering Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Checkr API