keycloak-ruby-client 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5fb941053a36de82d660a51be6d041b432c9342
-  data.tar.gz: 5c9ffc4b484fed6cdbff04f937b0a96f603e457e
+  metadata.gz: 64fd5654b140211d2d61816df33711498be7bdc4
+  data.tar.gz: d263f09209a4a4d27d282ed9c5fa673c9116a0ec
 SHA512:
-  metadata.gz: bb526460464780a4be8667ce19e576d3ff790b169d22edf0502f20d9684bab8ca22a65c71c9aeecd7a9e6534729739420d40917208a93c4f791062062adbaf5f
-  data.tar.gz: 50e74f7a50372209f4b011076ecb9ceeda1b4898ed718b6e4fdf01b4a54ab8ca5415ae28cc4b92d73f16a1880bdabc85343de35bf7dbac05e1a784b9337c3acc
+  metadata.gz: 87621811a0e707edfe779468442738f2044943666a7392e719a1c3511130423c52b91549c7a9c8130ae11fc5454037ad2dceb7faea2a3ab3f6f3076f2c5f3731
+  data.tar.gz: 062f6231ea0b325c6cac2d603446c93e0fc9e0a2c0176ce2933a208c82e5759a72875f74549e7db73b37fba8d1899d6411d166b7d79f0bbc0d1145bfa8a84ed2

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`

data/keycloak-ruby-client.gemspec

@@ -44,4 +44,5 @@ Gem::Specification.new do |spec|
   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/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/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,32 @@ 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
     end
   end
 end

data/lib/keycloak/client.rb

@@ -39,7 +39,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/version.rb

@@ -1,3 +1,3 @@
 module Keycloak
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 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.16
 platform: ruby
 authors:
 - Fuxin Hao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,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