keycloak-admin 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 107fe1a9772c1ca9f9014e1e089d5eb4a9c66a6a
+  data.tar.gz: f4c5918e8e3f3654bb6f8e8f63d0480b2f7b5d98
+SHA512:
+  metadata.gz: c5be1ffcad5a514578de150dae7a6b55d1ca7af1466fe3f45ec007c17da164ea877b190357fa50227f1e68ac3861a3daea793389cd2044b31ef9c5c0f1e30aa9
+  data.tar.gz: 40932b69af9e0ba619a3d267cd50bbf0146f4a5573aee005e9d362c57e2536f39c4ba77320cbb0b0323cb37b9a07e1a347a05919da040cead84022368f1daf4c

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM ruby:2.3
+RUN mkdir -p /usr/src/app/lib/keycloak-admin
+WORKDIR /usr/src/app
+
+COPY Gemfile /usr/src/app/
+COPY Gemfile.lock /usr/src/app/
+COPY keycloak-admin.gemspec /usr/src/app/
+COPY lib/keycloak-admin/version.rb /usr/src/app/lib/keycloak-admin/
+RUN bundle install
+COPY . /usr/src/app
+RUN bundle install

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    keycloak-admin (0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.4)
+      actionpack (= 5.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.4)
+      activesupport (= 5.1.4)
+      globalid (>= 0.3.6)
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    byebug (9.1.0)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.1)
+    nio4r (2.2.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.3)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails (5.1.4)
+      actioncable (= 5.1.4)
+      actionmailer (= 5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      activemodel (= 5.1.4)
+      activerecord (= 5.1.4)
+      activesupport (= 5.1.4)
+      bundler (>= 1.3.0)
+      railties (= 5.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (= 9.1.0)
+  keycloak-admin!
+  rspec (= 3.7.0)
+
+BUNDLED WITH
+   1.16.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+
+# Keycloak Admin Ruby
+
+Ruby client that acts as a client for the Keycloak REST API.
+This gem basically acts as an url builder using `http-client` to get responses and serialize them into _representation_ objects.
+
+_Warning: This beta gem is currently used for personal used. Most Keycloak Admin features are not implemented yet._
+
+## Install
+
+This gem *does not* require Rails.
+
+```ruby
+gem "keycloak-admin"
+```
+
+## Configuration
+
+To configure this gem, call `KeycloakAdmin.configure`. 
+For instance, to configure this gem based on environment variables, write (and load if required) a `keycloak_admin.rb`:
+```ruby
+KeycloakAdmin.configure do |config|
+  config.server_url       = ENV["KEYCLOAK_SERVER_URL"]
+  config.client_id        = ENV["KEYCLOAK_ADMIN_CLIENT_ID"]
+  config.user_realm_name  = ENV["KEYCLOAK_REALM_ID"]
+  config.username         = ENV["KEYCLOAK_ADMIN_USER"]
+  config.password         = ENV["KEYCLOAK_ADMIN_PASSWORD"]
+  config.logger           = Rails.logger
+end
+```
+This example is autoloaded in a Rails environment.
+
+### Overall configuration options
+
+All options have a default value. However, all of them can be changed in your initializer file.
+
+| Option | Default Value | Type | Required? | Description  | Example |
+| ---- | ----- | ------ | ----- | ------ | ----- |
+| `server_url` | `nil`| String | Required | The base url where your Keycloak server is located. This value can be retrieved in your Keycloak client configuration. | `auth:8080/auth` |
+| `user_realm_name` | `""`| String | Required | Name of the realm that contain the admin client and user. | `master` |
+| `client_id` | `admin-cli`| String | Required | Client that should be used to access admin capabilities. | `api-cli` |
+| `username` | `nil`| String | Required | Username that access to the Admin REST API | `mummy` |
+| `password` | `nil`| String | Required | Clear password that access to the Admin REST API | `bobby` |
+| `logger` | `Logger.new(STDOUT)`| Logger | Optional | The logger used by `keycloak-admin` | `Rails.logger` | 
+
+
+## Use Case
+exit
+### Supported features
+
+* Get an access token
+* Create a user
+* Reset credentials
+* Delete a user
+
+### Get an access token
+
+Returns an instance of `KeycloakAdmin::TokenRepresentation`.
+
+```ruby
+KeycloakAdmin.realm("a_realm").token.get
+```
+
+### Search for users
+
+Returns an array of `KeycloakAdmin::UserRepresentation`.
+
+```ruby
+KeycloakAdmin.realm("a_realm").users.search("a_username_or_an_email")
+```
+
+### Save a user
+
+Returns the provided `user`, which must be of type `KeycloakAdmin::UserRepresentation`.
+
+```ruby
+KeycloakAdmin.realm("a_realm").users.save(user)
+```
+
+### Create and save a user with password
+
+Returns the created user of type `KeycloakAdmin::UserRepresentation`.
+
+```ruby
+username       = "pioupioux"
+email          = "pioupioux@email.com"
+password       = "acme0"
+email_verified = true
+KeycloakAdmin.realm("a_realm").users.create!(username, email, password, email_verified)
+```
+
+### Reset a password
+
+```ruby
+user_id      = "95985b21-d884-4bbd-b852-cb8cd365afc2"
+new_password = "coco"
+KeycloakAdmin.realm("commuty").users.update_password(user_id, new_password)
+```
+
+## How to execute library tests
+
+From the `keycloak-admin-api` directory:
+
+```
+  $ docker build . -t keycloak-admin:test
+  $ docker run -v `pwd`:/usr/src/app/ keycloak-admin:test bundle exec rspec spec
+```

data/keycloak-admin.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "keycloak-admin/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "keycloak-admin"
+  spec.version     = KeycloakAdmin::VERSION
+  spec.authors     = ["Lorent Lempereur"]
+  spec.email       = ["lorent.lempereur.dev@gmail.com"]
+  spec.homepage    = "https://github.com/looorent/keycloak-admin-ruby"
+  spec.summary     = "Keycloak Admin REST API client written in Ruby"
+  spec.description = "Keycloak Admin REST API client written in Ruby"
+  spec.license     = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+  
+  spec.add_development_dependency "rspec",   "3.7.0"
+  spec.add_development_dependency "byebug", "9.1.0"
+end

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

@@ -0,0 +1,30 @@
+module KeycloakAdmin
+  class Client
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def server_url
+      @configuration.server_url
+    end
+
+    def token
+      @token ||= KeycloakAdmin.realm(@configuration.user_realm_name).token.get
+    end
+
+    def headers
+      {
+        Authorization: "Bearer #{token.access_token}",
+        content_type: :json,
+        accept:       :json
+      }
+    end
+
+    private
+
+    def error(response)
+      raise "Keycloak: The request failed with response code #{response.code} and message: #{response.body}"
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module KeycloakAdmin
+  class RealmClient < Client
+    def initialize(configuration, realm_name=nil)
+      super(configuration)
+      @realm_name = realm_name
+    end
+
+    def realm_url
+      if @realm_name
+        "#{server_url}/realms/#{@realm_name}"
+      else
+        "#{server_url}/realms"
+      end
+    end
+
+    def realm_admin_url
+      if @realm_name
+        "#{server_url}/admin/realms/#{@realm_name}"
+      else
+        "#{server_url}/admin/realms"
+      end
+    end
+
+    def token
+      TokenClient.new(@configuration, self)
+    end
+
+    def users
+      UserClient.new(@configuration, self)
+    end
+
+    def name_defined?
+      !@realm_name.nil?
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module KeycloakAdmin
+  class TokenClient < 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}/protocol/openid-connect/token"
+    end
+
+    def realm_url
+      @realm_client.realm_url
+    end
+
+    def get
+      response = RestClient.post(token_url,
+        username: @configuration.username,
+        password: @configuration.password,
+        grant_type: "password",
+        client_id: @configuration.client_id
+      )
+      if response.code == 200
+        TokenRepresentation.from_json(response.body)
+      else
+        error(response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module KeycloakAdmin
+  class UserClient < 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 create!(username, email, password, email_verified)
+      user = save(build(username, email, password, email_verified))
+      search(user.email)&.first
+    end
+
+    def save(user_representation)
+      response = RestClient.post(users_url, user_representation.to_json, headers)
+      if response.code == 201
+        user_representation
+      else
+        error(response)
+      end
+    end
+
+    def search(query)
+      response = RestClient.get(users_url, headers.merge({params: { search: query }}))
+      if response.code == 200
+        JSON.parse(response).map { |user_as_hash| UserRepresentation.from_hash(user_as_hash) }
+      else
+        error(response)
+      end
+    end
+
+    def delete(user_id)
+      response = RestClient.delete(users_url(user_id), headers)
+      response.code == 204 || error(response)
+    end
+
+    def update_password(user_id, new_password)
+      response = RestClient.put(reset_password_url(user_id), {
+        type: "password",
+        value: new_password,
+        temporary: false
+      }.to_json, headers)
+      if response.code == 204
+        user_id
+      else
+        error(response)
+      end
+    end
+
+    def users_url(id=nil)
+      if id
+        "#{@realm_client.realm_admin_url}/users/#{id}"
+      else
+        "#{@realm_client.realm_admin_url}/users"
+      end
+    end
+
+    def reset_password_url(user_id)
+      raise ArgumentError.new("user_id must be defined") if user_id.nil?
+      "#{users_url(user_id)}/reset-password"
+    end
+
+    private
+
+    def build(username, email, password, email_verified)
+      user                = UserRepresentation.new
+      user.email          = email
+      user.username       = username
+      user.email_verified = email_verified
+      user.enabled        = true
+      user.add_credential(CredentialRepresentation.from_password(password))
+      user
+    end
+  end
+end

data/lib/keycloak-admin/configuration.rb

@@ -0,0 +1,5 @@
+module KeycloakAdmin
+  class Configuration
+    attr_accessor :server_url, :client_id, :user_realm_name, :username, :password, :logger
+  end
+end

data/lib/keycloak-admin/representation/camel_json.rb

@@ -0,0 +1,12 @@
+module KeycloakAdmin
+  module CamelJson
+
+    def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+      if first_letter_in_uppercase
+        lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+      else
+        lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
+      end
+    end
+  end
+end

data/lib/keycloak-admin/representation/credential_representation.rb

@@ -0,0 +1,39 @@
+module KeycloakAdmin
+  class CredentialRepresentation < Representation
+    attr_accessor :type,
+      :device,
+      :value,
+      :hashedSaltedValue,
+      :salt,
+      :hashIterations,
+      :counter,
+      :algorithm,
+      :digits,
+      :period,
+      :created_date,
+      :config,
+      :temporary
+
+    def self.from_password(password, temporary=false)
+      credential = new
+      credential.value     = password
+      credential.type      = "password"
+      credential.temporary = temporary
+      credential
+    end
+
+    def self.from_json(json)
+      attributes = JSON.parse(json)
+      from_hash(attributes)
+    end
+
+    def self.from_hash(hash)
+      credential = new
+      hash.each do |key, value|
+        property = "@#{key}".to_sym
+        credential.instance_variable_set(property, value)
+      end
+      credential
+    end
+  end
+end

data/lib/keycloak-admin/representation/representation.rb

@@ -0,0 +1,18 @@
+require_relative "camel_json"
+
+class Representation
+  include ::KeycloakAdmin::CamelJson
+
+  def to_json(options=nil)
+    snaked_hash = as_json
+    snaked_hash.keys.reduce({}) do |camelized_hash, key|
+      camelized_hash[camelize(key, false)] = snaked_hash[key]
+      camelized_hash
+    end.to_json(options)
+  end
+
+  def self.from_json(json)
+    hash = JSON.parse(json)
+    from_hash(hash)
+  end
+end

data/lib/keycloak-admin/representation/token_representation.rb

@@ -0,0 +1,14 @@
+
+module KeycloakAdmin
+  class TokenRepresentation < Representation
+    attr_accessor :access_token
+
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    def self.from_hash(hash)
+      new(hash["access_token"])
+    end
+  end
+end

data/lib/keycloak-admin/representation/user_representation.rb

@@ -0,0 +1,36 @@
+module KeycloakAdmin
+  class UserRepresentation < Representation
+    attr_accessor :id,
+      :created_at,
+      :attributes,
+      :origin,
+      :username,
+      :email,
+      :enabled,
+      :email_verified,
+      :first_name,
+      :last_name,
+      :credentials
+
+    def self.from_hash(hash)
+      user                = new
+      user.id             = hash["id"]
+      user.created_at     = Time.at(hash["createdTimestamp"] / 1000).to_datetime
+      user.origin         = hash["origin"]
+      user.username       = hash["username"]
+      user.email          = hash["email"]
+      user.enabled        = hash["enabled"]
+      user.email_verified = hash["emailVerified"]
+      user.first_name     = hash["firstName"]
+      user.last_name      = hash["lastName"]
+      user.attributes     = hash["attributes"]
+      user.credentials    = hash["credentials"]&.map{ |hash| CredentialRepresentation.from_hash(hash) } || []
+      user
+    end
+
+    def add_credential(credential_representation)
+      @credentials ||= []
+      @credentials.push(credential_representation)
+    end
+  end
+end

data/lib/keycloak-admin/version.rb

@@ -0,0 +1,3 @@
+module KeycloakAdmin
+  VERSION = "0.1"
+end

data/lib/keycloak-admin.rb

@@ -0,0 +1,44 @@
+require "logger"
+
+require_relative "keycloak-admin/configuration"
+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/representation/camel_json"
+require_relative "keycloak-admin/representation/representation"
+require_relative "keycloak-admin/representation/token_representation"
+require_relative "keycloak-admin/representation/credential_representation"
+require_relative "keycloak-admin/representation/user_representation"
+
+module KeycloakAdmin
+
+  def self.configure
+    yield @configuration ||= KeycloakAdmin::Configuration.new
+  end
+
+  def self.config
+    @configuration
+  end
+
+  def self.realm(realm_name)
+    RealmClient.new(@configuration, realm_name)
+  end
+
+  def self.logger
+    config.logger
+  end
+
+  def self.load_configuration
+    configure do |config|
+      config.server_url      = nil
+      config.user_realm_name = ""
+      config.client_id       = "admin-cli"
+      config.logger          = ::Logger.new(STDOUT)
+      config.username        = nil
+      config.password        = nil
+    end
+  end
+
+  load_configuration
+end

data/spec/client/realm_client_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe KeycloakAdmin::RealmClient do
+  describe "#realm_url" do
+
+    let(:realm_name) { nil }
+
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).realm_url
+    end
+
+    context "when realm_name is defined" do
+      let(:realm_name) { "master2" }
+      it "return a proper url with realm_name" do
+        expect(@built_url).to eq "http://auth.service.io/auth/realms/master2"
+      end
+    end
+
+    context "when realm_name is not defined" do
+      let(:realm_name) { nil }
+      it "return a proper url without realm_name" do
+        expect(@built_url).to eq "http://auth.service.io/auth/realms"
+      end
+    end
+  end
+
+  describe "#admin_realm_url" do
+
+    let(:realm_name) { nil }
+
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).realm_admin_url
+    end
+
+    context "when realm_name is defined" do
+      let(:realm_name) { "master2" }
+      it "return a proper url with realm_name" do
+        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/master2"
+      end
+    end
+
+    context "when realm_name is not defined" do
+      let(:realm_name) { nil }
+      it "return a proper url without realm_name" do
+        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms"
+      end
+    end
+  end
+end

data/spec/client/token_client_spec.rb

@@ -0,0 +1,37 @@
+RSpec.describe KeycloakAdmin::TokenClient do
+  describe "#initialize" do
+    let(:realm_name) { nil }
+    before(:each) do
+      @realm = KeycloakAdmin.realm(realm_name)
+    end
+
+    context "when realm_name is defined" do
+      let(:realm_name) { "master" }
+      it "does not raise any error" do
+        expect {
+          @realm.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 {
+          @realm.token
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#token_url" do
+    let(:realm_name) { "valid-realm" }
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).token.token_url
+    end
+
+    it "return a proper url" do
+      expect(@built_url).to eq "http://auth.service.io/auth/realms/valid-realm/protocol/openid-connect/token"
+    end
+  end
+end

data/spec/client/user_client_spec.rb

@@ -0,0 +1,74 @@
+RSpec.describe KeycloakAdmin::TokenClient do
+  describe "#initialize" do
+    let(:realm_name) { nil }
+    before(:each) do
+      @realm = KeycloakAdmin.realm(realm_name)
+    end
+
+    context "when realm_name is defined" do
+      let(:realm_name) { "master" }
+      it "does not raise any error" do
+        expect {
+          @realm.users
+        }.to_not raise_error
+      end
+    end
+
+    context "when realm_name is not defined" do
+      let(:realm_name) { nil }
+      it "raises any error" do
+        expect {
+          @realm.users
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#users_url" do
+    let(:realm_name) { "valid-realm" }
+    let(:user_id)    { nil }
+
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).users.users_url(user_id)
+    end
+
+    context "when user_id is not defined" do
+      let(:user_id) { nil }
+      it "return a proper url without user id" do
+        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users"
+      end
+    end
+
+    context "when user_id is defined" do
+      let(:user_id) { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
+      it "return a proper url with the user id" do
+        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users/95985b21-d884-4bbd-b852-cb8cd365afc2"
+      end
+    end
+  end
+
+  describe "#reset_password_url" do
+    let(:realm_name) { "valid-realm" }
+    let(:user_id)    { nil }
+
+    before(:each) do
+      @client = KeycloakAdmin.realm(realm_name).users
+    end
+
+    context "when user_id is not defined" do
+      let(:user_id) { nil }
+      it "raises an error" do
+        expect {
+          @client.reset_password_url(user_id)
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when user_id is defined" do
+      let(:user_id) { 42 }
+      it "return a proper url" do
+        expect(@client.reset_password_url(user_id)).to eq "http://auth.service.io/auth/admin/realms/valid-realm/users/42/reset-password"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require_relative "../lib/keycloak-admin"
+
+require "byebug"
+
+def configure
+  KeycloakAdmin.configure do |config|
+    config.server_url       = "http://auth.service.io/auth"
+    config.client_id        = "admin-cli"
+    config.user_realm_name  = "master2"
+    config.username         = "bobby"
+    config.password         = "coucou"
+  end 
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  configure
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: keycloak-admin
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Lorent Lempereur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.1.0
+description: Keycloak Admin REST API client written in Ruby
+email:
+- lorent.lempereur.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- keycloak-admin.gemspec
+- lib/keycloak-admin.rb
+- lib/keycloak-admin/client/client.rb
+- lib/keycloak-admin/client/realm_client.rb
+- lib/keycloak-admin/client/token_client.rb
+- lib/keycloak-admin/client/user_client.rb
+- lib/keycloak-admin/configuration.rb
+- lib/keycloak-admin/representation/camel_json.rb
+- lib/keycloak-admin/representation/credential_representation.rb
+- lib/keycloak-admin/representation/representation.rb
+- lib/keycloak-admin/representation/token_representation.rb
+- lib/keycloak-admin/representation/user_representation.rb
+- lib/keycloak-admin/version.rb
+- spec/client/realm_client_spec.rb
+- spec/client/token_client_spec.rb
+- spec/client/user_client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/looorent/keycloak-admin-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Keycloak Admin REST API client written in Ruby
+test_files: []