killbill-client 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3be1314e1b773cf9f381995047bd08907957bd18
-  data.tar.gz: 2b16aa7aa39dd1239b548b393aff5c4f8de30f32
+  metadata.gz: 03e77573407a78aef2165e380bc7e1d0f672b53d
+  data.tar.gz: 27e12ebd3c57f128cdd181c16e77e19d4be9daa5
 SHA512:
-  metadata.gz: b1bc847df0c8987f35e0fe54ee3fb2707f3084945f00866b681189940eefd2b0d0d58afa9405d2a42cccf1170e023fc9666094c4a58db52fc256be86134e19e5
-  data.tar.gz: 73c08847cb57745d1a762bd174a5e747f2aa082e7b65f445f504236b2934b1ac7fdd83323c831a773ffd19fc7ac4816bd4bff458d0f04e832c7d1aee6cda6ec0
+  metadata.gz: 88715661ffaa19c983d3c0ba9a091cbd4c8cd9a242675de0e44a43c8d9cbf6aad172620a1902d545c6d6ec0964cf161bcb5793b7f69f7a2cb50cc8315db2994b
+  data.tar.gz: 5d199dffd09feffc3a02c83b9e886c29ba84c6d8317603146eff9e931d708cb69aed72c763b9ac5c38de46ac6632ad697c9c4ce94ceee83128fe2cfbdddf3ad1

data/README.md

@@ -28,6 +28,37 @@ Alternatively, add the dependency in your Gemfile:
 gem 'killbill-client', '~> 1.0'
 ```
 
+Authentication
+--------------
+
+A username and password can be set directly in the `options` hash (accepted by each API method):
+```ruby
+options = {
+  :username => 'admin',
+  :password => 'password'
+}
+```
+These credentials are validated by Kill Bill either directly (users managed by Kill Bill) or via a third-party (LDAP, Okta, Auth0, etc.).
+
+Alternatively, a bearer token can be passed as such:
+```ruby
+options = {
+  :bearer => 'token'
+}
+```
+The security token would be validated by Kill bill via a third-party (e.g. Auth0).
+
+By default, Kill Bill won't maintain sessions, except when calling the API `/1.0/kb/security/permissions` (`JSESSIONID`, present in the `Set-Cookie` response header).
+This session id can be passed instead:
+```ruby
+options = {
+  :session_id => 'JSESSIONID'
+}
+```
+Using this session mechanism is recommend for user interfaces or to minimize the runtime dependency with a third-party provider.
+
+Note: if a timed out session is re-used (`last_access_time` older than 60 minutes by default), a `HTTP/1.1 401 Unauthorized` is returned with `Set-Cookie: JSESSIONID=deleteMe`, and the session is deleted from the database (and cache) on the server side.
+
 Examples
 --------
 

data/lib/killbill_client/api/net_http_adapter.rb

@@ -118,8 +118,11 @@ module KillBillClient
           # Configure RBAC, if enabled
           username = options[:username] || KillBillClient.username
           password = options[:password] || KillBillClient.password
+          bearer = options[:bearer]
           if username and password
             request.basic_auth(*[username, password].flatten[0, 2])
+          elsif bearer
+            request['authorization'] = 'Bearer ' + bearer
           end
           session_id = options[:session_id]
           if session_id

data/lib/killbill_client/version.rb

@@ -1,3 +1,3 @@
 module KillBillClient
-  VERSION = '3.3.0'
+  VERSION = '3.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-client
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Killbill core team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem-release