keycloak-ruby-client 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad0512b14993b6c29da87aacc53c064c926152bf
-  data.tar.gz: 683cc0dcd8ddf7f33744fb19398fdef2247ad4d6
+  metadata.gz: a21f53bd4b432715baed464f6a40ac5133c9b272
+  data.tar.gz: 473bcc4c2965d6cd0c4355fc74a8c336c7d48457
 SHA512:
-  metadata.gz: a60226b5ec10dd7cf6d33e6954d5e69851b713407ae71e4b7fbadd0fb31fa8920d4cd8a958d126e3552f388ef3ed679e90a4bfa91cffa1ed52dfef68cb82831b
-  data.tar.gz: a7918aec954a71d228d7c369d64f358631ea81bab2a7aa79ea090e2f66f017360fb0e3f2b9d6cac36dc62fbfa4a70964716182872ff8a031baf7079b69c98f91
+  metadata.gz: 10f49dc6b19beb1f516963252159e7250f5d3362bb4e4613646e8e57f9a753d288ef2f303535cb28bd7d3d3dec756988f7669b82db1dafd25fc131ae65daa72f
+  data.tar.gz: a2e7c8b5ec06e0564f0ef59cd7cd53d18ca0cad799a8ed624c733cb1b6e17f4ab294904eaa69561497e69db6c3f2d16751bc32dc512b231fe33e2cd51340f1b6

data/README.md

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

@@ -1,3 +1,3 @@
 module Keycloak
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Fuxin Hao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -151,6 +151,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