keycloak-ruby-client 0.0.15 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5fb941053a36de82d660a51be6d041b432c9342
-  data.tar.gz: 5c9ffc4b484fed6cdbff04f937b0a96f603e457e
+  metadata.gz: '086dfbaf42ef3339dd5860e717be6490f625baa3'
+  data.tar.gz: c32725910ba174a2722839bf913b4c2d69f9785d
 SHA512:
-  metadata.gz: bb526460464780a4be8667ce19e576d3ff790b169d22edf0502f20d9684bab8ca22a65c71c9aeecd7a9e6534729739420d40917208a93c4f791062062adbaf5f
-  data.tar.gz: 50e74f7a50372209f4b011076ecb9ceeda1b4898ed718b6e4fdf01b4a54ab8ca5415ae28cc4b92d73f16a1880bdabc85343de35bf7dbac05e1a784b9337c3acc
+  metadata.gz: ff0f354f26cbfce2d3ef617abe6d56e0a62c5acc99d5a254a52a95cd70ad72e64de0c34fd82fc236863bb1c0ea3732ed979d9cd8b4a2ab7e690cc6c12c5cfe06
+  data.tar.gz: 373f5165819f01ae672d30e87e378f3dacdc98bdfe2db63c814885b3f6ede60d6778ecfd3dad75405fe648de1dbde94e360912780914b4da2b39a0cf92c43e4d

data/README.md

@@ -109,6 +109,8 @@ client.find_users.each { |user| puts user.to_json } # no risk of out of memory
 
 ```
 
+For more examples, please take a look at [spec/api/](./spec/api/)
+
 ### Connect your rails user model with keycloak user entity:
 
 Firstly, we create a user model with `bundle exec rails g model user`
@@ -150,6 +152,31 @@ puts user.user_info
 puts user.realm_roles
 ```
 
+### GraphQL (optional)
+
+Integrate `RepresentationIterator` into `graphql` to support GraphQL Connections
+
+```ruby
+require 'keycloak/graphql'
+```
+
+Now you can implement a GraphQL API to find users as the following:
+
+```ruby
+field :users, Types::KeycloakUserRepresentationType.connection_type, null: true, max_page_size: 30 do
+  argument :briefRepresentation, Boolean, required: false
+  argument :email, String, required: false
+  argument :firstName, String, required: false
+  argument :lastName, String, required: false
+  argument :search, String, required: false
+  argument :username, String, required: false
+end
+
+def users(**kwargs)
+  Keycloak::Realm.your_realm.client.find_users(**kwargs)
+end
+```
+
 ## 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.

data/keycloak-ruby-client.gemspec

@@ -39,9 +39,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rails", ">= 4.0"
   spec.add_dependency "rest-client", "~> 2.0"
   spec.add_dependency "concurrent-ruby", "~> 1.0"
+  spec.add_dependency "jwt"
+  spec.add_dependency "json-jwt"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "faker"
+  spec.add_development_dependency "factory_bot"
 end

data/lib/keycloak/api.rb

@@ -4,3 +4,4 @@ require 'keycloak/api/user_resources'
 require 'keycloak/api/client_resources'
 require 'keycloak/api/client_role_resources'
 require 'keycloak/api/realm_resources'
+require 'keycloak/api/keycloak_api_extension_resources'

data/lib/keycloak/api/client_resources.rb

@@ -4,11 +4,14 @@ module Keycloak
       extend ActiveSupport::Concern
       include Concerns::APIUtil
 
+      def client_resources_url
+        "#{admin_realm_url}/clients"
+      end
+
       # @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 = JSON.parse(get(client_resources_url, params: { clientId: client_id }).body)
         data[0] && Model::ClientRepresentation.new(data[0])
       rescue RestClient::NotFound
         nil
@@ -17,11 +20,25 @@ module Keycloak
       # @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}"
+        url = client_resources_url + "/#{id}"
         Model::ClientRepresentation.new JSON.parse(get(url).body)
       rescue RestClient::NotFound
         nil
       end
+
+      # @param client_rep [Keycloak::Model::UserRepresentation] client representation
+      # @return [String] id of client
+      def create_client(client_rep)
+        res = post(client_resources_url, client_rep.to_json, headers: {content_type: :json})
+        res.headers[:location].split("/")[-1]
+      end
+
+      # @param id [String] id of client (not client-id)
+      # @param client_rep [Keycloak::Model::UserRepresentation] client representation
+      def update_client(id, client_rep)
+        url = client_resources_url + "/#{id}"
+        put(url, client_rep.to_json, headers: {content_type: :json})
+      end
     end
   end
 end

data/lib/keycloak/api/keycloak_api_extension_resources.rb

@@ -0,0 +1,28 @@
+# Keycloak API extension resource from https://github.com/FX-HAO/keycloak-api-extension
+module Keycloak
+  module API
+    module KeycloakAPIExtensionResources
+      extend ActiveSupport::Concern
+      include Concerns::APIUtil
+
+      def api_extension_resources_url
+        realm_url + "/keycloak-api-extension/"
+      end
+
+      # @param user_id [String] user id
+      # @return Boolean
+      def if_otp_exists(user_id)
+        url = api_extension_resources_url + "users/#{user_id}/if-otp-exists"
+        JSON.parse(get(url))["status"]
+      end
+
+      # @param user_id [String] user id
+      # @param otp [String] otp
+      # @return Boolean
+      def validate_otp(user_id, otp)
+        url = api_extension_resources_url + "users/#{user_id}/validate-otp"
+        JSON.parse(post(url, otp: otp))["status"]
+      end
+    end
+  end
+end

data/lib/keycloak/api/realm_resources.rb

@@ -5,8 +5,10 @@ module Keycloak
       include Concerns::APIUtil
 
       # @param realm_rep [Keycloak::Model::RealmRepresentation] realm representation
+      # @return [String] realm id
       def create_realm(realm_rep)
-        post("#{@auth_server_url}/admin/realms/", realm_rep.to_json, headers: {content_type: :json})
+        res = post("#{@auth_server_url}/admin/realms/", realm_rep.to_json, headers: {content_type: :json})
+        res.headers[:location].split("/")[-1]
       end
 
       # @param realm [String] realm name

data/lib/keycloak/api/user_resources.rb

@@ -43,11 +43,37 @@ module Keycloak
         end
       end
 
+      # @param username [String] username
       # @return [Keycloak::Model::UserRepresentation] user representation
       def find_user_by_username(username)
         find_users({username: username}).to_a[0]
       end
 
+      # @param role [String] role name
+      # @param params [Hash] extra params
+      # @return [Keycloak::Model::UserRepresentation] user representation
+      def find_user_by_role(role, params = {})
+        url = "#{admin_realm_url}/roles/#{role}/users"
+        Utils::RepresentationIterator.new(self, params) do
+          JSON.parse(get(url, params: params)).map { |user| Model::UserRepresentation.new(user) }
+        end
+      end
+
+      # @param id_of_client [String] id of client (not client-id)
+      # @param role [String] role name
+      # @param params [Hash] extra params
+      # @return [Keycloak::Model::UserRepresentation] user representation
+      def find_user_by_client_role(id_of_client, role, params = {})
+        url = "#{admin_realm_url}/clients/#{id_of_client}/roles/#{role}/users"
+        Utils::RepresentationIterator.new(self, params) do
+          JSON.parse(get(url, params: params)).map { |user| Model::UserRepresentation.new(user) }
+        end
+      end
+
+      # @param id [String] user id
+      def delete_user(id)
+        delete("#{user_resources_url}/#{id}", headers: {content_type: :json})
+      end
     end
   end
 end

data/lib/keycloak/client.rb

@@ -8,6 +8,7 @@ module Keycloak
     include API::ClientResources
     include API::ClientRoleResources
     include API::RealmResources
+    include API::KeycloakAPIExtensionResources
 
     attr_reader :auth_server_url, :realm
 
@@ -39,7 +40,8 @@ module Keycloak
         username: username,
         password: password,
         grant_type: grant_type,
-        client_id: client_id
+        client_id: client_id,
+        scope: "offline_access"
       }, try_refresh_token: false).body
       @access_token = res["access_token"]
       @refresh_token = res["refresh_token"]

data/lib/keycloak/graphql.rb

@@ -0,0 +1,3 @@
+require 'graphql'
+
+require_relative 'graphql/keycloak_representation_iterator_connection'

data/lib/keycloak/graphql/keycloak_representation_iterator_connection.rb

@@ -0,0 +1,101 @@
+module GraphQL
+  module Relay
+    class KeycloakRepresentationIteratorConnection < BaseConnection
+      def cursor_from_node(item)
+        item_index = paged_nodes.index(item)
+        if item_index.nil?
+          raise("Can't generate cursor, item not found in connection: #{item}")
+        else
+          offset = item_index + (paged_nodes_offset || 0)
+
+          encode(offset.to_s)
+        end
+      end
+
+      # TODO: support `before`
+      def has_next_page
+        sliced_nodes_count >= (first || max_page_size)
+      end
+
+      # TODO: support `before`
+      def has_previous_page
+        false
+      end
+
+      def first
+        return @first if defined? @first
+
+        @first = get_limited_arg(:first)
+        @first = max_page_size if @first && max_page_size && @first > max_page_size
+        @first
+      end
+
+      def last
+        return @last if defined? @last
+
+        @last = get_limited_arg(:last)
+        @last = max_page_size if @last && max_page_size && @last > max_page_size
+        @last
+      end
+
+      private
+
+      # apply first / last limit results
+      # @return [Array]
+      def paged_nodes
+        return @paged_nodes if defined? @paged_nodes
+
+        items = sliced_nodes
+
+        if first
+          items.till = items.first + first
+        end
+
+        if max_page_size && !first && !last
+          items.till = items.first + max_page_size
+        end
+
+        @paged_nodes_offset = items.first
+
+        @paged_nodes = items.to_a
+      end
+
+      def paged_nodes_offset
+        paged_nodes && @paged_nodes_offset
+      end
+
+      def relation_offset(iterator)
+        iterator.first
+      end
+
+      def relation_limit(iterator)
+        iterator.till
+      end
+
+      # Apply cursors to edges
+      def sliced_nodes
+        return @sliced_nodes if defined? @sliced_nodes
+
+        @sliced_nodes = nodes
+
+        if after
+          @sliced_nodes.first = offset_from_cursor(after) + 1
+        end
+
+        @sliced_nodes
+      end
+
+      def sliced_nodes_count
+        return @sliced_nodes_count if defined? @sliced_nodes_count
+
+        @sliced_nodes_count = paged_nodes.size
+      end
+
+      def offset_from_cursor(cursor)
+        decode(cursor).to_i
+      end
+    end
+
+    BaseConnection.register_connection_implementation(Keycloak::Utils::RepresentationIterator, KeycloakRepresentationIteratorConnection)
+  end
+end

data/lib/keycloak/realm.rb

@@ -1,3 +1,6 @@
+require 'jwt'
+require 'json-jwt'
+
 module Keycloak
   class Realm
     @realms = Concurrent::Map.new

data/lib/keycloak/user_entity.rb

@@ -2,6 +2,8 @@ module Keycloak
   module UserEntity
     extend ActiveSupport::Concern
 
+    attr_accessor :keycloak_token
+
     included do
       def keycloak_client
         raise NotImplementedError
@@ -20,7 +22,9 @@ module Keycloak
       end
 
       def has_role?(role)
-        realm_roles.map(&:name).include?(role)
+        keycloak_token ?
+          keycloak_token.has_role?(role) :
+          realm_roles.map(&:name).include?(role)
       end
 
       def _set_or_get_keycloak_data(attr_name, reload)

data/lib/keycloak/version.rb

@@ -1,3 +1,3 @@
 module Keycloak
-  VERSION = "0.0.15"
+  VERSION = "0.0.20"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.20
 platform: ruby
 authors:
 - Fuxin Hao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Keycloak ruby client
 email:
 - haofxpro@gmail.com
@@ -129,6 +171,7 @@ files:
 - lib/keycloak/api.rb
 - lib/keycloak/api/client_resources.rb
 - lib/keycloak/api/client_role_resources.rb
+- lib/keycloak/api/keycloak_api_extension_resources.rb
 - lib/keycloak/api/protection_resources.rb
 - lib/keycloak/api/realm_resources.rb
 - lib/keycloak/api/role_resources.rb
@@ -136,6 +179,8 @@ files:
 - lib/keycloak/client.rb
 - lib/keycloak/concerns.rb
 - lib/keycloak/concerns/api_util.rb
+- lib/keycloak/graphql.rb
+- lib/keycloak/graphql/keycloak_representation_iterator_connection.rb
 - lib/keycloak/model.rb
 - lib/keycloak/model/base_representation.rb
 - lib/keycloak/model/client_representation.rb
@@ -174,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: Keycloak ruby client