keycloak-ruby-client 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d9e6755953b3b7c1e98116ebeeb55107b54f058
+  data.tar.gz: 21ab42c066be34c26e4077a7d10a9884e3f387a5
+SHA512:
+  metadata.gz: b5192d922842967e6586dfee0b88a24d5c99e09dcb7d2a75e76136ac5c39ab90479cf23fc6a71acb9938c58d893a05a7b028c6f7b473ab5469f3e58d6296a4ad
+  data.tar.gz: c21b0568ce50e660a36b3f7bf905707523f4bb784bafcaba7bfd01ae1e41a0f23c30f9030da1ea700713b020913b6ac4ce3b6d2a5fdf555b6d075bcb9daa2478

data/.gitignore

@@ -0,0 +1,25 @@
+.ruby-version
+doc/
+.yardoc/
+guides/yardoc/
+pkg/
+Gemfile.lock
+gemfiles/*.lock
+# Test database
+*.db
+.bundle/
+vendor/
+.idea/
+
+_site
+.sass-cache
+.jekyll-metadata
+gh-pages/
+tmp/*
+__*.db
+node_modules/
+yarn.lock
+OperationStoreClient.js
+spec/integration/tmp
+.vscode/
+*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at haofxpro@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in keycloak-ruby-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Fuxin Hao
+
+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,160 @@
+# Keycloak::Ruby::Client
+
+[![Gem Version](https://badge.fury.io/rb/keycloak-ruby-client.svg)](https://badge.fury.io/rb/keycloak-ruby-client)
+
+This is a keycloak client implementation in ruby. I mainly use this in a rails project, so this is 
+written with some methods that derive from rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keycloak-ruby-client', require: 'keycloak'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keycloak-ruby-client
+
+## Usage
+
+Firstly, you need to register your keycloak config:
+
+```ruby
+Keycloak::Realm.register do |config|
+  config.installation_file = Rails.root.join("config/keycloak.json")
+end
+```
+
+or 
+
+```ruby
+Keycloak::Realm.register do |config|
+  config.auth_server_url = "http://127.0.0.1:8081/auth"
+  
+  config.realm = "shundao-admin"
+end
+```
+
+Then you can authenticate your keycloak JWT token:
+
+```ruby
+token = "your_bearer_token"
+keycloak_token =                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           .parse_access_token(token) # an instance of Keycloak::AccessToken
+raise CanCan::AccessDenied if keycloak_token.expired? || !keycloak_token.has_role?("admin")
+
+# authentication succeeded 
+```
+
+Or you may need asking if permissions are granted from keycloak server, it's also worth noting that 
+this is much expensive than decoding JWT cuz this asks from keycloak server every time. 
+Always use JWT unless there is a compelling reason to use this.
+
+```ruby
+token = "your_bearer_token"
+keycloak_token = Keycloak::Realm.shundao_admin.parse_access_token(token)
+raise Cancan::AccessDenied unless Keycloak::Realm.shundao_admin.client.granted_by_server("Admin Resources#view", keycloak_token)
+
+# authentication succeeded
+```
+
+Some examples demonstrate how to interact with Keycloak admin REST API:
+
+```ruby
+admin_username = ENV['KEYCLOAK_USERNAME'] || 'admin'
+admin_password = ENV['KEYCLOAK_PASSWORD'] || 'admin'
+auth_server_url = ENV['KEYCLOAK_SERVER_URL'] || 'http://127.0.0.1:8081/auth'
+realm = 'shundao-admin'
+
+# authenticate
+client = Keycloak::Client.new(auth_server_url, realm)
+client.authenticate(admin_username, admin_password, "password", "admin-cli", "master")
+
+# create the roles
+role_store = {}
+roles = ['user', 'premium', 'admin']
+roles.each do |role|
+  role_rep = Keycloak::Model::RoleRepresentation.new({
+    name: role
+  })
+  role_store[role] = client.create_or_find_role(role_rep)
+end
+
+# create a user with the roles created above
+user_rep = Keycloak::Model::UserRepresentation.new({
+  username: "alice",
+  credentials: [
+    Keycloak::Model::CredentialRepresentation.new({
+      type: "password",
+      temporary: false,
+      value: '123456'
+    })
+  ],
+  enabled: true,
+  requiredActions: ['UPDATE_PASSWORD']
+})
+mapping_roles = role_store.map { |entry| {id: entry[1].id , name: entry[1].name} }
+client.create_user(user_rep, mapping_roles)
+```
+
+### Connect your rails user model with keycloak user entity:
+
+Firstly, we create a user model with `bundle exec rails g model user`
+
+In you migration file:
+```Ruby
+class CreateUsers < ActiveRecord::Migration[5.1]
+  def change
+    create_table :users, id: :string do |t|
+      t.string :username
+    end
+  end
+end
+```
+
+Authenticate your client in `config/initializers/keycloak.rb`:
+
+```ruby
+Keycloak::Realm.shundao_admin.client.authenticate(admin_username, admin_password, "password", "admin-cli", "master", auto: true)
+```
+
+Your model file `User.rb` as the following:
+
+```ruby
+class User < ApplicationRecord
+  include Keycloak::UserEntity
+  
+  use_keycloak_client Keycloak::Realm.shundao_admin.client
+end
+```
+
+Finally, you can get user info with `User` model:
+
+```ruby
+user = User.take
+puts user.user_info
+puts user.realm_roles
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FX-HAO/keycloak-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Keycloak::Ruby::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/FX-HAO/keycloak-ruby-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+gem 'rails'
+gem 'rest-client'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keycloak/ruby/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/keycloak-ruby-client.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "keycloak/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "keycloak-ruby-client"
+  spec.version       = Keycloak::VERSION
+  spec.authors       = ["Fuxin Hao"]
+  spec.email         = ["haofxpro@gmail.com"]
+
+  spec.summary       = %q{Keycloak ruby client}
+  spec.description   = %q{Keycloak ruby client}
+  spec.homepage      = "https://github.com/FX-HAO/keycloak-ruby-client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/FX-HAO/keycloak-ruby-client"
+    spec.metadata["changelog_uri"] = "https://github.com/FX-HAO/keycloak-ruby-client/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 4.0"
+  spec.add_dependency "rest-client", "~> 2.0"
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/keycloak/access_token.rb

@@ -0,0 +1,59 @@
+module Keycloak
+  class AccessToken
+    attr_reader :metadata, :jti, :exp, :sub, :azp, :roles, :scope,
+                :phone_number, :username, :access_token, :client_roles
+
+    def initialize(realm, access_token, decoded_token)
+      @realm = realm
+      @access_token = access_token
+      @metadata = decoded_token[0]
+      @jti = @metadata["jti"]
+      @exp = Time.at(@metadata["exp"]).to_datetime
+      @sub = @metadata["sub"]
+      @azp = @metadata["azp"]
+      if realm_access = @metadata["realm_access"]
+        @roles = realm_access["roles"] || []
+      end
+      if resource_access = @metadata["resource_access"]
+        @client_roles = resource_access.dig(realm.name, "roles") || []
+      end
+      @scope = @metadata["scope"]
+      @phone_number = @metadata["phone_number"]
+      @username = @metadata["username"] || @metadata["preferred_username"]
+    end
+
+    def authorization
+      "Bearer #{@access_token}"
+    end
+
+    def expired?
+      exp < DateTime.now
+    end
+
+    def has_role?(role, include_client_role = true)
+      roles.include?(role.to_s) || (include_client_role && has_client_role?(role))
+    end
+
+    def has_client_role?(role)
+      client_roles.include? role.to_s
+    end
+
+    def method_missing(name, *args, &block)
+      regex = /^has_(.*?)_role\?$/
+      if name.match?(regex)
+        return name.match(regex)[1]
+      end
+
+      super
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      regex = /^has_(.*?)_role\?$/
+      if name.match?(regex)
+        return true
+      end
+
+      super
+    end
+  end
+end

data/lib/keycloak/api/client_resources.rb

@@ -0,0 +1,27 @@
+module Keycloak
+  module API
+    module ClientResources
+      extend ActiveSupport::Concern
+      include Concerns::APIUtil
+
+      # @param client_id [String] client-id (not id of client)
+      # @return [Keycloak::Model::ClientRepresentation] client representation
+      def find_client_by_client_id(client_id)
+        url = admin_realm_url + "/clients"
+        data = JSON.parse(get(url, params: { clientId: client_id }).body)
+        data[0] && Model::ClientRepresentation.new(data[0])
+      rescue RestClient::NotFound
+        nil
+      end
+
+      # @param id [String] id of client (not client-id)
+      # @return [Keycloak::Model::ClientRepresentation] client representation
+      def find_client_by_id(id)
+        url = admin_realm_url + "/clients/#{id}"
+        Model::ClientRepresentation.new JSON.parse(get(url).body)
+      rescue RestClient::NotFound
+        nil
+      end
+    end
+  end
+end

data/lib/keycloak/api/client_role_resources.rb

@@ -0,0 +1,55 @@
+module Keycloak
+  module API
+    module ClientRoleResources
+      extend ActiveSupport::Concern
+      include Concerns::APIUtil
+
+      # @param id [String] id of client (not client-id)
+      # @param role_rep [Keycloak::Model::RoleRepresentation] role representation
+      def create_client_role(id, role_rep)
+        url = admin_realm_url + "/clients/#{id}/roles"
+        post(url, role_rep.to_json, headers: {content_type: :json})
+      end
+
+      # @param id [String] id of client (not client-id)
+      # @return [Array<Keycloak::Model::ClientRepresentation>] an array of client representations
+      def find_client_roles(id)
+        url = admin_realm_url + "/clients/#{id}/roles"
+        JSON.parse(get(url)).map { |role| Model::RoleRepresentation.new role }
+      end
+
+      # @param id [String] id of client (not client-id)
+      # @param name [String] name of role
+      # @return [Keycloak::Model::RoleRepresentation] role representation
+      def find_client_role_by_name(id, name)
+        url = admin_realm_url + "/clients/#{id}/roles/#{name}"
+        Model::RoleRepresentation.new JSON.parse(get(url))
+      rescue RestClient::NotFound
+        nil
+      end
+
+      # @param user_id [String] user id
+      # @param id_of_client [String] id of client (not client-id)
+      # @return [Array<Keycloak::Model::RoleRepresentation>] role representations
+      def find_client_roles_for_user(user_id, id_of_client)
+        url = admin_realm_url + "/users/#{user_id}/role-mappings/clients/#{id_of_client}"
+        JSON.parse(get(url)).map { |role| Model::RoleRepresentation.new role }
+      end
+
+      # Only role id and role name are required in role_mappings
+      #
+      # @param user_id [String] user id
+      # @param id_of_client [String] id of client (not client-id)
+      # @param role_mappings [Array<Keycloak::Model::RoleRepresentation>] an array of roles
+      def add_client_role_mapping(user_id, id_of_client, role_mappings)
+        url = admin_realm_url + "/users/#{user_id}/role-mappings/clients/#{id_of_client}"
+        post(url, role_mappings.to_json, headers: {content_type: :json})
+      end
+
+      def remove_client_role_mapping(user_id, id_of_client, role_mappings)
+        url = admin_realm_url + "/users/#{user_id}/role-mappings/clients/#{id_of_client}"
+        delete(url, payload: role_mappings.to_json, headers: {content_type: :json})
+      end
+    end
+  end
+end

data/lib/keycloak/api/protection_resources.rb

@@ -0,0 +1,37 @@
+module Keycloak
+  module API
+    module ProtectionResources
+      extend ActiveSupport::Concern
+      include Concerns::APIUtil
+
+      # use this when you are mainly interested in either the overall decision
+      # or the permissions granted by the server, this is much expensive than
+      # decoding JWT cuz this asks from keycloak server every time. Always use
+      # JWT unless there is a compelling reason to use this.
+      #
+      # @param permissions [String] A string representing a set of one or more
+      #   resources and scopes the client is seeking access. The format of the
+      #   string must be: RESOURCE_ID#SCOPE_ID. For instance:
+      #   Resource A#Scope A, Resource A#Scope A, Scope B, Scope C, Resource A,
+      #   #Scope A. See https://www.keycloak.org/docs/latest/authorization_services/#_service_obtaining_permissions
+      #   for more details.
+      # @param access_token [Keycloak::AccessToken] access token
+      # @return [Boolean] true if the permissions granted or false when forbidden
+      def granted_by_server(permissions, access_token)
+        url = admin_realm_url + "/protocol/openid-connect/token"
+        res = JSON.parse post(url, {
+            grant_type: "urn:ietf:params:oauth:grant-type:uma-ticket",
+            audience: @realm,
+            permission: permissions,
+            response_mode: "decision"
+          },
+          headers: {content_type: :json, authorization: access_token.authorization},
+          try_refresh_token: false
+        )
+        res['result']
+      rescue RestClient::Forbidden, RestClient::Unauthorized
+        false
+      end
+    end
+  end
+end

data/lib/keycloak/api/role_resources.rb

@@ -0,0 +1,63 @@
+module Keycloak
+  module API
+    module RoleResources
+      extend ActiveSupport::Concern
+      include Concerns::APIUtil
+
+      # @param role_rep [Keycloak::Model::RoleRepresentation] role representation
+      def create_role(role_rep)
+        url = admin_realm_url + "/roles"
+        post(url, role_rep.to_json, headers: {content_type: :json})
+      end
+
+      # @return [Array<Keycloak::Model::RoleRepresentation>] role representations
+      def realm_roles
+        url = admin_realm_url + "/roles"
+        JSON.parse(get(url)).map { |role| Model::RoleRepresentation.new role }
+      end
+
+      # @param name [String] name of role
+      # @return [Keycloak::Model::RoleRepresentation] role representation
+      def find_role_by_name(name)
+        url = admin_realm_url + "/roles/#{name}"
+        Model::RoleRepresentation.new JSON.parse(get(url).body)
+      rescue RestClient::NotFound
+        nil
+      end
+
+      # @param role_rep [Keycloak::Model::RoleRepresentation] role representation
+      # @return [Keycloak::Model::RoleRepresentation] role representation
+      def create_or_find_role(role_rep)
+        create_role(role_rep) && find_role_by_name(role_rep.name)
+      rescue RestClient::Conflict
+        find_role_by_name(role_rep.name)
+      end
+
+      # @param user_id [String] user id
+      # @return [Array<Keycloak::Model::RoleRepresentation>] an array of role representations
+      def find_user_realm_roles(user_id)
+        JSON.parse(get("#{user_resources_url}/#{user_id}/role-mappings/realm")).map do |role|
+          Model::RoleRepresentation.new role
+        end
+      end
+
+      # Only role id and role name are required in role_mappings
+      #
+      # @param user_id [String] user id
+      # @param role_mappings [Array<Keycloak::Model::RoleRepresentation>] an array of roles
+      def add_role_mapping(user_id, role_mappings)
+        url = admin_realm_url + "/users/#{user_id}/role-mappings/realm"
+        post(url, role_mappings.to_json, headers: {content_type: :json})
+      end
+
+      # Only role id and role name are required in role_mappings
+      #
+      # @param user_id [String] user id
+      # @param role_mappings [Array<Keycloak::Model::RoleRepresentation>] an array of roles
+      def remove_role_mapping(user_id, role_mappings)
+        url = admin_realm_url + "/users/#{user_id}/role-mappings/realm"
+        delete(url, payload: role_mappings.to_json, headers: {content_type: :json})
+      end
+    end
+  end
+end

data/lib/keycloak/api/user_resources.rb

@@ -0,0 +1,42 @@
+module Keycloak
+  module API
+    # see https://www.keycloak.org/docs-api/6.0/rest-api/index.html#_users_resource for params details
+    module UserResources
+      extend ActiveSupport::Concern
+      include Concerns::APIUtil
+
+      def user_resources_url
+        admin_realm_url + "/users"
+      end
+
+      # Keycloak server doesn't support assign roles at creating user,
+      # so we actually implement this in 2 steps.
+      #
+      # @param user_rep [Keycloak::Model::UserRepresentation] user representation
+      # @param roles [Array] an array of roles
+      def create_user(user_rep, roles = [])
+        res = post(user_resources_url, user_rep.to_json, headers: {content_type: :json})
+        id = res.headers[:location].split("/")[-1]
+        return if roles.empty?
+        add_role_mapping(id, roles)
+      end
+
+      # @param id [String] user id
+      # @return [Keycloak::Model::UserRepresentation] user representation
+      def find_user(id)
+        Model::UserRepresentation.new JSON.parse(get("#{user_resources_url}/#{id}"))
+      end
+
+      # see https://www.keycloak.org/docs-api/6.0/rest-api/index.html#_users_resource for params details
+      def find_users(params = {})
+        res = JSON.parse(get(user_resources_url, params: params))
+        res.map { |user| Model::UserRepresentation.new user }
+      end
+
+      def find_user_by_username(username)
+        find_users({username: username})[0]
+      end
+
+    end
+  end
+end

data/lib/keycloak/api.rb

@@ -0,0 +1,5 @@
+require 'keycloak/api/protection_resources'
+require 'keycloak/api/role_resources'
+require 'keycloak/api/user_resources'
+require 'keycloak/api/client_resources'
+require 'keycloak/api/client_role_resources'

data/lib/keycloak/client.rb

@@ -0,0 +1,112 @@
+module Keycloak
+  class Client
+    include API::UserResources
+    include API::RoleResources
+    include API::ProtectionResources
+    include API::ClientResources
+    include API::ClientRoleResources
+
+    attr_reader :auth_server_url, :realm
+
+    def initialize(auth_server_url, realm)
+      @auth_server_url = auth_server_url
+      @realm = realm
+    end
+
+    def realm_url
+      "#{@auth_server_url}/realms/#{@realm}"
+    end
+
+    def admin_realm_url
+      "#{@auth_server_url}/admin/realms/#{@realm}"
+    end
+
+    def authenticate(username, password, grant_type, client_id, realm = @realm, auto: true)
+      @authenticate_realm = realm
+      @authenticate_client_id = client_id
+      if auto
+        @authenticate_username = username
+        @authenticate_password = password
+        @authenticate_grant_type = grant_type
+      end
+
+      url = "#{@auth_server_url}/realms/#{realm}/protocol/openid-connect/token"
+      res = JSON.parse post(url, {
+        username: username,
+        password: password,
+        grant_type: grant_type,
+        client_id: client_id
+      }, try_refresh_token: false).body
+      @access_token = res["access_token"]
+      @refresh_token = res["refresh_token"]
+      @refresh_expires_in = DateTime.now + res["refresh_expires_in"].seconds
+      @expires_in = DateTime.now + res["expires_in"].seconds
+      true
+    end
+
+    def refresh_token!
+      raise "need to call `authenticate` first" unless @refresh_token
+
+      url = "#{@auth_server_url}/realms/#{@authenticate_realm}/protocol/openid-connect/token"
+      res = JSON.parse post(url, {
+        grant_type: "refresh_token",
+        client_id: @authenticate_client_id,
+        refresh_token: @refresh_token
+      }, try_refresh_token: false)
+      @access_token = res["access_token"]
+      @refresh_token = res["refresh_token"]
+      @refresh_expires_in = DateTime.now + res["refresh_expires_in"].seconds
+      @expires_in = DateTime.now + res["expires_in"].seconds
+    end
+
+    def access_token_expired?
+      @expires_in && @expires_in < DateTime.now
+    end
+
+    def refresh_token_expired?
+      @refresh_expires_in && @refresh_expires_in < DateTime.now
+    end
+
+    def try_refresh_token!
+      return unless access_token_expired?
+
+      if !refresh_token_expired?
+        refresh_token!
+      elsif @authenticate_username && @authenticate_password
+        authenticate(@authenticate_username, @authenticate_password, @authenticate_grant_type, @authenticate_client_id, @authenticate_realm, auto: false)
+      else
+        raise("Refresh token expired, you should re-authenticate to obtain an access token or enable auto authentication")
+      end
+    end
+
+    def post(url, payload, headers: {}, try_refresh_token: true)
+      try_refresh_token! if try_refresh_token
+
+      RestClient.post(url, payload, {
+        authorization: "Bearer #{@access_token}",
+        accept: "application/json"
+      }.merge(headers))
+    end
+
+    def get(url, headers: {}, params: {}, try_refresh_token: true)
+      try_refresh_token! if try_refresh_token
+
+      RestClient.get(url, {
+        authorization: "Bearer #{@access_token}",
+        accept: "application/json",
+        params: params
+      }.merge(headers))
+    end
+
+    def delete(url, headers: {}, payload: nil, try_refresh_token: true)
+      try_refresh_token! if try_refresh_token
+
+      RestClient::Request.execute(
+        method: :delete, url: url, payload: payload,
+        headers: {
+          authorization: "Bearer #{@access_token}",
+          accept: "application/json"
+        }.merge(headers))
+    end
+  end
+end

data/lib/keycloak/concerns/api_util.rb

@@ -0,0 +1,27 @@
+module Keycloak
+  module Concerns
+    module APIUtil
+      extend ActiveSupport::Concern
+
+      def realm_url
+        raise NotImplementedError
+      end
+
+      def admin_realm_url
+        raise NotImplementedError
+      end
+
+      def post(url, payload, headers: {}, try_refresh_token: true)
+        raise NotImplementedError
+      end
+
+      def get(url, headers: {}, params: {}, try_refresh_token: true)
+        raise NotImplementedError
+      end
+
+      def delete(url, headers: {}, payload: nil, try_refresh_token: true)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/keycloak/concerns.rb

@@ -0,0 +1 @@
+require 'keycloak/concerns/api_util'

data/lib/keycloak/model/base_representation.rb

@@ -0,0 +1,78 @@
+module Keycloak
+  module Model
+    class BaseRepresentation
+      class << self
+        def fields(*names)
+          names.each do |name|
+            field name
+          end
+        end
+
+        def field(name, type = :any)
+          define_reader name, type
+          define_writer name, type
+
+          name_sym = name.to_sym
+          attributes << name_sym
+          registry[name_sym] = type
+        end
+
+        def type_resolve(value, type)
+          case
+          when type == :any
+            value
+          when type == Integer
+            value.to_i
+          when type == String
+            value.to_s
+          when type == Float
+            value.to_f
+          when type.is_a?(Scalar::ArrayType)
+            value.map { |e| type_resolve(e, type.type) }
+          when type < BaseRepresentation
+            value.is_a?(type) ? value : type.new(value)
+          else
+            type.new value
+          end
+        end
+
+        def define_reader(name, type)
+          attr_reader name
+        end
+
+        def define_writer(name, type)
+          define_method "#{name}=" do |value|
+            instance_variable_set("@#{name}", self.class.type_resolve(value, type))
+          end
+        end
+
+        def attributes
+          @attributes ||= Concurrent::Array.new
+        end
+
+        def registry
+          @registry ||= Concurrent::Hash.new
+        end
+      end
+
+      def initialize(payload = {})
+        payload.each do |key, value|
+          send("#{key}=", value) if self.class.attributes.include?(key.to_sym)
+        end
+      end
+
+      def as_json(*options)
+        h = {}
+        self.class.attributes.each do |attr|
+          v = instance_variable_get("@#{attr}")
+          h[attr] = v unless v.nil?
+        end
+        h
+      end
+
+      def to_json
+        as_json.to_json
+      end
+    end
+  end
+end

data/lib/keycloak/model/client_representation.rb

@@ -0,0 +1,12 @@
+module Keycloak
+  module Model
+    class ClientRepresentation < BaseRepresentation
+      fields :id, :clientId, :name, :baseUrl, :surrogateAuthRequired, :enabled,
+             :clientAuthenticatorType, :redirectUris, :webOrigins, :notBefore, :bearerOnly,
+             :consentRequired, :standardFlowEnabled, :implicitFlowEnabled, :directAccessGrantsEnabled,
+             :serviceAccountsEnabled, :publicClient, :frontchannelLogout, :protocol, :attributes,
+             :authenticationFlowBindingOverrides, :fullScopeAllowed, :nodeReRegistrationTimeout,
+             :protocolMappers, :defaultClientScopes, :optionalClientScopes, :access
+    end
+  end
+end

data/lib/keycloak/model/credential_representation.rb

@@ -0,0 +1,9 @@
+module Keycloak
+  module Model
+    class CredentialRepresentation < BaseRepresentation
+      fields :algorithm, :config, :counter, :createdDate, :device, :digits,
+             :hashIterations, :hashedSaltedValue, :period, :salt, :temporary,
+             :type, :value
+    end
+  end
+end

data/lib/keycloak/model/role_representation.rb

@@ -0,0 +1,7 @@
+module Keycloak
+  module Model
+    class RoleRepresentation < BaseRepresentation
+      fields :clientRole, :composite, :containerId, :description, :id, :name
+    end
+  end
+end

data/lib/keycloak/model/user_representation.rb

@@ -0,0 +1,13 @@
+module Keycloak
+  module Model
+    class UserRepresentation < BaseRepresentation
+      fields :id, :createdTimestamp, :username, :enabled, :totp, :emailVerified,
+             :disableableCredentialTypes, :requiredActions, :notBefore, :access,
+             :attributes, :clientConsents, :clientRoles, :credentials, :email,
+             :federatedIdentities, :federationLink, :firstName, :groups, :lastName,
+             :origin, :realmRoles, :self, :serviceAccountClientId
+
+      field :credentials, Scalar::ArrayType.new(CredentialRepresentation)
+    end
+  end
+end

data/lib/keycloak/model.rb

@@ -0,0 +1,5 @@
+require 'keycloak/model/base_representation'
+require 'keycloak/model/credential_representation'
+require 'keycloak/model/role_representation'
+require 'keycloak/model/user_representation'
+require 'keycloak/model/client_representation'

data/lib/keycloak/realm.rb

@@ -0,0 +1,58 @@
+module Keycloak
+  class Realm
+    @realms = Concurrent::Map.new
+
+    class Configuration
+      attr_accessor :auth_server_url, :realm, :installation_file
+    end
+
+    class << self
+      def register(&block)
+        return unless block_given?
+
+        cfg = Configuration.new
+        block.call(cfg)
+        if file = cfg.installation_file
+          file_cfg = JSON.parse(File.read(file))
+          realm_key = file_cfg['realm'].underscore.to_sym
+          @realms[realm_key] = Realm.new(file_cfg['auth-server-url'], file_cfg['realm'])
+        else
+          realm_key = cfg.realm.underscore.to_sym
+          @realms[realm_key] = Realm.new(cfg.auth_server_url, cfg.realm)
+        end
+
+        define_singleton_method(realm_key) { @realms[realm_key] }
+      end
+    end
+
+    attr_accessor :auth_server_url, :realm
+
+    def initialize(auth_server_url, realm)
+      @auth_server_url = auth_server_url
+      @realm = realm
+    end
+
+    def name
+      realm
+    end
+
+    def parse_access_token(access_token)
+      decoded_token = JWT.decode access_token, public_key, false, { :algorithm => 'RS256' }
+      AccessToken.new self, access_token, decoded_token
+    end
+
+    def client
+      @client ||= Client.new(auth_server_url, realm)
+    end
+
+    private
+
+    def public_key
+      return @public_key if @public_key
+
+      keys = JSON.parse(RestClient.get("#{auth_server_url}/realms/#{realm}/protocol/openid-connect/certs").body)['keys']
+      jwk = JSON::JWK.new(keys[0])
+      @public_key = jwk.to_key
+    end
+  end
+end

data/lib/keycloak/scalar/array_type.rb

@@ -0,0 +1,11 @@
+module Keycloak
+  module Scalar
+    class ArrayType
+      attr_accessor :type
+
+      def initialize(type)
+        @type = type
+      end
+    end
+  end
+end

data/lib/keycloak/scalar.rb

@@ -0,0 +1 @@
+require 'keycloak/scalar/array_type'

data/lib/keycloak/user_entity.rb

@@ -0,0 +1,36 @@
+module Keycloak
+  module UserEntity
+    extend ActiveSupport::Concern
+
+    class_methods do
+      cattr_reader :keycloak_client
+
+      # @param client [Keycloak::Client] keycloak client
+      def use_keycloak_client(client)
+        @keycloak_client = client
+      end
+    end
+
+    included do
+      def keycloak_identify
+        id
+      end
+
+      def user_info(reload = false)
+        _set_or_get_keycloak_data(:user_info, reload) { keycloak_client.find_user(keycloak_identify) }
+      end
+
+      def realm_roles(reload = false)
+        _set_or_get_keycloak_data(:realm_roles, reload) { keycloak_client.find_user_realm_roles(keycloak_identify) }
+      end
+
+      def has_role?(role)
+        realm_roles.include?(role)
+      end
+
+      def _set_or_get_keycloak_data(attr_name, reload)
+        reload ? instance_variable_set(yield) : instance_variable_get(attr_name) || instance_variable_set(yield)
+      end
+    end
+  end
+end

data/lib/keycloak/version.rb

@@ -0,0 +1,3 @@
+module Keycloak
+  VERSION = "0.0.5"
+end

data/lib/keycloak.rb

@@ -0,0 +1,10 @@
+require_relative 'keycloak/version'
+require_relative 'keycloak/concerns'
+require_relative 'keycloak/access_token'
+require_relative 'keycloak/realm' # require 'keycloak/realm' not working, weird
+# require 'keycloak/realm'
+require_relative 'keycloak/user_entity'
+require_relative 'keycloak/scalar'
+require_relative 'keycloak/api'
+require_relative 'keycloak/client'
+require_relative 'keycloak/model'

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: keycloak-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Fuxin Hao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Keycloak ruby client
+email:
+- haofxpro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keycloak-ruby-client.gemspec
+- lib/keycloak.rb
+- lib/keycloak/access_token.rb
+- lib/keycloak/api.rb
+- lib/keycloak/api/client_resources.rb
+- lib/keycloak/api/client_role_resources.rb
+- lib/keycloak/api/protection_resources.rb
+- lib/keycloak/api/role_resources.rb
+- lib/keycloak/api/user_resources.rb
+- lib/keycloak/client.rb
+- lib/keycloak/concerns.rb
+- lib/keycloak/concerns/api_util.rb
+- lib/keycloak/model.rb
+- lib/keycloak/model/base_representation.rb
+- lib/keycloak/model/client_representation.rb
+- lib/keycloak/model/credential_representation.rb
+- lib/keycloak/model/role_representation.rb
+- lib/keycloak/model/user_representation.rb
+- lib/keycloak/realm.rb
+- lib/keycloak/scalar.rb
+- lib/keycloak/scalar/array_type.rb
+- lib/keycloak/user_entity.rb
+- lib/keycloak/version.rb
+homepage: https://github.com/FX-HAO/keycloak-ruby-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/FX-HAO/keycloak-ruby-client
+  source_code_uri: https://github.com/FX-HAO/keycloak-ruby-client
+  changelog_uri: https://github.com/FX-HAO/keycloak-ruby-client/blob/master/CHANGELOG.md
+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.11
+signing_key: 
+specification_version: 4
+summary: Keycloak ruby client
+test_files: []