keycloak-ruby-client 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d9e6755953b3b7c1e98116ebeeb55107b54f058
-  data.tar.gz: 21ab42c066be34c26e4077a7d10a9884e3f387a5
+  metadata.gz: 3cb38b642619a3555b01fb376a6339a3d549c243
+  data.tar.gz: 925ca9ad46a8632213681fdc822ed0c029773df5
 SHA512:
-  metadata.gz: b5192d922842967e6586dfee0b88a24d5c99e09dcb7d2a75e76136ac5c39ab90479cf23fc6a71acb9938c58d893a05a7b028c6f7b473ab5469f3e58d6296a4ad
-  data.tar.gz: c21b0568ce50e660a36b3f7bf905707523f4bb784bafcaba7bfd01ae1e41a0f23c30f9030da1ea700713b020913b6ac4ce3b6d2a5fdf555b6d075bcb9daa2478
+  metadata.gz: 7741aceb16860d9931dbebc11d5e2ce10c688c362a5574232bf9a4b141020f72f20f53bc9c33ab617e5d1c24b81ba87e9d2074c5a4a653aea8eb1980b1ad9f4a
+  data.tar.gz: 68a48f33549ff151c059acdf768233c6246d23ac4087a14bed8084b3a4fb269cf88a81b5ac2329d8f69d6b8386af66102b3c4be033e5210ad13817139b8f7f52

data/README.md

@@ -45,7 +45,7 @@ Then you can authenticate your keycloak JWT token:
 
 ```ruby
 token = "your_bearer_token"
-keycloak_token =                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           .parse_access_token(token) # an instance of Keycloak::AccessToken
+keycloak_token = Keycloak::Realm.shundao_admin.parse_access_token(token) # an instance of Keycloak::AccessToken
 raise CanCan::AccessDenied if keycloak_token.expired? || !keycloak_token.has_role?("admin")
 
 # authentication succeeded 
@@ -100,6 +100,13 @@ user_rep = Keycloak::Model::UserRepresentation.new({
 })
 mapping_roles = role_store.map { |entry| {id: entry[1].id , name: entry[1].name} }
 client.create_user(user_rep, mapping_roles)
+
+# NOTE: It's worth noting that `to_a` may be costly if you have a large dataset of users, 
+# which could cause out-of-memory, but using `each` instead of `to_a` could save you if 
+# you really want traverse all users.
+client.find_users.to_a.each { |user| puts user.to_json } # possibly out of memory 
+client.find_users.each { |user| puts user.to_json } # no risk of out of memory
+
 ```
 
 ### Connect your rails user model with keycloak user entity:

data/lib/keycloak.rb

@@ -8,3 +8,4 @@ require_relative 'keycloak/scalar'
 require_relative 'keycloak/api'
 require_relative 'keycloak/client'
 require_relative 'keycloak/model'
+require_relative 'keycloak/utils'

data/lib/keycloak/api/user_resources.rb

@@ -28,13 +28,18 @@ module Keycloak
       end
 
       # see https://www.keycloak.org/docs-api/6.0/rest-api/index.html#_users_resource for params details
+      #
+      # @return [Keycloak::Utils::RepresentationIterator] iterator of users
       def find_users(params = {})
-        res = JSON.parse(get(user_resources_url, params: params))
-        res.map { |user| Model::UserRepresentation.new user }
+        Utils::RepresentationIterator.new(self, params) do
+          res = JSON.parse(get(user_resources_url, params: params))
+          res.map { |user| Model::UserRepresentation.new user }
+        end
       end
 
+      # @return [Keycloak::Model::UserRepresentation] user representation
       def find_user_by_username(username)
-        find_users({username: username})[0]
+        find_users({username: username}).to_a[0]
       end
 
     end

data/lib/keycloak/utils.rb

@@ -0,0 +1 @@
+require 'keycloak/utils/representation_iterator'

data/lib/keycloak/utils/representation_iterator.rb

@@ -0,0 +1,62 @@
+module Keycloak
+  module Utils
+    # RepresentationIterator provides ability to enable lazy loading if necessary.
+    #
+    # NOTE: It's worth noting that `to_a` may be costly if you have a large dataset of users,
+    # which could cause out-of-memory, but using `each` instead of `to_a` could save you if
+    # you really want traverse all users.
+    class RepresentationIterator
+      DEFAULT_PER_PAGE = 30
+
+      include Enumerable
+
+      attr_accessor :first, :per_page, :till
+      attr_reader :cursor
+
+      def initialize(client, params, per_page: DEFAULT_PER_PAGE, till: nil, &block)
+        @client = client
+        @params = params
+        @params[:first] ||= 0
+        @first = @params[:first]
+        @till = @params[:max] || till
+        @per_page = per_page
+        @block = block
+
+        @data = []
+        @cursor = 0
+      end
+
+      def first=(num)
+        @first = num
+        @cursor = 0
+        @data = []
+      end
+
+      def each
+        while true
+          return if at_end?
+          _fetch_next if @data.empty? || @cursor >= @data.size
+          return if @data.empty?
+
+          yield @data[@cursor]
+          @cursor += 1
+        end
+      end
+
+      private
+
+      def _fetch_next
+        @params[:first] = @first
+        @params[:max] = @per_page
+        @data = @client.instance_eval(&@block)
+
+        @first += @per_page
+        @cursor = 0
+      end
+
+      def at_end?
+        @till && @till <= @params[:first] + @cursor
+      end
+    end
+  end
+end

data/lib/keycloak/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Fuxin Hao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,6 +117,8 @@ files:
 - lib/keycloak/scalar.rb
 - lib/keycloak/scalar/array_type.rb
 - lib/keycloak/user_entity.rb
+- lib/keycloak/utils.rb
+- lib/keycloak/utils/representation_iterator.rb
 - lib/keycloak/version.rb
 homepage: https://github.com/FX-HAO/keycloak-ruby-client
 licenses: