keycloak-admin 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0b8ec4ab66da0bc2e63c8aa0cf41107da8b7430
-  data.tar.gz: 21e5f3c5b983bf197607f280ff34a743811bc2fb
+  metadata.gz: 70b6714622b54d9fc925675f2a99a78fe0bdab18
+  data.tar.gz: c7afa5ac9282faee2fe4e0d61dd754bf4f842d7a
 SHA512:
-  metadata.gz: 3f7ae98056acef279fac3365b9121dbca089a34a36076d1a31a62cb1a4b6af246c18899ea23418b8668fea59eb88a119b2e5fec9326bf7514a2150fdab560bc5
-  data.tar.gz: 3e44a7ddf4fe78650136b73c73ddeb982e7baf55866674b0c32aadf655423be042eee46722274bf93b80f6cd126924d803a9b8743137576b3156bfd083459883
+  metadata.gz: 1e64662dee5bc2671394248a01f2f89a3feb1497a06089ce5a0ddbc483ba0eb2e9bd8e5630ac9cb5690dfd8472e4d75fd854a7dde53049cee89c14cc994deca2
+  data.tar.gz: e02240453e10ef9f56e5cc27ca60b55355941ef31d4b48e2b80fd10bcb475c7a6ee2107ec1e2f1b908c230fe10b7fc4c35b61cbbcd04193c1a2d15976027063c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keycloak-admin (0.4)
+    keycloak-admin (0.5)
       http-cookie (~> 1.0, >= 1.0.3)
 
 GEM

data/README.md

@@ -12,7 +12,7 @@ This gem *does not* require Rails.
 For example, using `bundle`, add this line to your Gemfile.
 
 ```ruby
-gem "keycloak-admin", "0.4"
+gem "keycloak-admin", "0.5"
 ```
 
 ## Login
@@ -87,6 +87,7 @@ exit
 * Reset credentials
 * Delete a user
 * Impersonate a user
+* Exchange a configurable token
 
 ### Get an access token
 
@@ -150,6 +151,17 @@ user_id = "95985b21-d884-4bbd-b852-cb8cd365afc2"
 KeycloakAdmin.realm("a_realm").users.get_redirect_impersonation(user_id)
 ```
 
+### Exchange a configurable token
+
+*Requires your Keycloak server to have deployed the Custom REST API `configurable-token`* (https://github.com/looorent/keycloak-configurable-token-api)
+Returns an instance of `KeycloakAdmin::TokenRepresentation`.
+
+```ruby
+user_access_token         = "abqsdofnqdsogn"
+token_lifespan_in_seconds = 20
+KeycloakAdmin.realm("a_realm").configurable_token.exchange_with(user_access_token, token_lifespan_in_seconds)
+```
+
 ## How to execute library tests
 
 From the `keycloak-admin-api` directory:

data/lib/keycloak-admin.rb

@@ -5,6 +5,7 @@ require_relative "keycloak-admin/client/client"
 require_relative "keycloak-admin/client/realm_client"
 require_relative "keycloak-admin/client/token_client"
 require_relative "keycloak-admin/client/user_client"
+require_relative "keycloak-admin/client/configurable_token_client"
 require_relative "keycloak-admin/representation/camel_json"
 require_relative "keycloak-admin/representation/representation"
 require_relative "keycloak-admin/representation/token_representation"

data/lib/keycloak-admin/client/configurable_token_client.rb

@@ -0,0 +1,30 @@
+module KeycloakAdmin
+  class ConfigurableTokenClient < Client
+    def initialize(configuration, realm_client)
+      super(configuration)
+      raise ArgumentError.new("realm must be defined") unless realm_client.name_defined?
+      @realm_client = realm_client
+    end
+
+    def token_url
+      "#{realm_url}/configurable-token"
+    end
+
+    def realm_url
+      @realm_client.realm_url
+    end
+
+    def exchange_with(user_access_token, token_lifespan_in_seconds)
+      response = execute_http do
+        RestClient.post(token_url, {
+          tokenLifespanInSeconds: token_lifespan_in_seconds
+        }.to_json, {
+          Authorization: "Bearer #{user_access_token}",
+          content_type:  :json,
+          accept:        :json
+        })
+      end
+      TokenRepresentation.from_json(response.body)
+    end
+  end
+end

data/lib/keycloak-admin/client/realm_client.rb

@@ -25,6 +25,10 @@ module KeycloakAdmin
       TokenClient.new(@configuration, self)
     end
 
+    def configurable_token
+      ConfigurableTokenClient.new(@configuration, self)
+    end
+
     def users
       UserClient.new(@configuration, self)
     end

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "0.4"
+  VERSION = "0.5"
 end

data/spec/client/configurable_token_client_spec.rb

@@ -0,0 +1,34 @@
+RSpec.describe KeycloakAdmin::ConfigurableTokenClient do
+  describe "#initialize" do
+    context "when realm_name is defined" do
+      let(:realm_name) { "master" }
+      it "does not raise any error" do
+        expect {
+          KeycloakAdmin.realm(realm_name).configurable_token
+        }.to_not raise_error
+      end
+    end
+
+    context "when realm_name is not defined" do
+      let(:realm_name) { nil }
+      it "raises any error" do
+        expect {
+          KeycloakAdmin.realm(realm_name).configurable_token
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#token_url" do
+    let(:realm_name) { "valid-realm" }
+    let(:user_id)    { nil }
+
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).configurable_token.token_url
+    end
+
+    it "return a proper url with the realm name" do
+      expect(@built_url).to eq "http://auth.service.io/auth/realms/valid-realm/configurable-token"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Lorent Lempereur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-cookie
@@ -75,6 +75,7 @@ files:
 - keycloak-admin.gemspec
 - lib/keycloak-admin.rb
 - lib/keycloak-admin/client/client.rb
+- lib/keycloak-admin/client/configurable_token_client.rb
 - lib/keycloak-admin/client/realm_client.rb
 - lib/keycloak-admin/client/token_client.rb
 - lib/keycloak-admin/client/user_client.rb
@@ -87,6 +88,7 @@ files:
 - lib/keycloak-admin/representation/token_representation.rb
 - lib/keycloak-admin/representation/user_representation.rb
 - lib/keycloak-admin/version.rb
+- spec/client/configurable_token_client_spec.rb
 - spec/client/realm_client_spec.rb
 - spec/client/token_client_spec.rb
 - spec/client/user_client_spec.rb