keycloak-admin 0.7.8 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7d17b8a5f55e87b615da11c9554bfeec127629207e81bd4e4950fb85971010c
-  data.tar.gz: '097affd8e18b7e778557fe4ecc787e93127bcef133a4dd9e6db590fc7ad65982'
+  metadata.gz: ddc2a67d3273ab4353daeb48dce261f5ba27a310fa91e9947e751da86d55a124
+  data.tar.gz: 5850f80b6f5c1f76ade40a92bba444559fcc1f637bee0eaf1cb4b917cbfd7f4c
 SHA512:
-  metadata.gz: ffc55b0f6c7719ce1fa38b93838fe2d137fe3cd6395fe1717ac4ef352484bdfedab0363811f88bf9e82815d1ae6f94ec008ab1fb4db5038f638cc816d66362fd
-  data.tar.gz: b8053bb57699928d793523b9d0274a284ebafbedd8e05d8294fbcdebcca967d69531dddf2048fd890b8e51dc3bb9bea2c83a9aee19e34bac13fccbed95a547b7
+  metadata.gz: 210d92708eb39e0f221cd54f7c5d1fec917f8a1cab5bafb6ec1b1f706b60e634acf55bd38396bf5017ac95eef4aaed2d3892700ec9cbcc84757128ed02f2d46f
+  data.tar.gz: 45e19fa08576cb1f468f0fc9dd6841da93e0bafe91002361ad78610637a41e438bfc7e7a04f5741eab87bc161cab4982b7d9fd88a482862ede548c03b2e3c287

data/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.9] - 2020-10-22
+
+* Extend `search` function to use complex queries (thanks to @hobbypunk90)
+
 ## [0.7.8] - 2020-10-15
 
 * Bug: `rest_client_options` default value does not match the documentation (was `nil` by default, should be `{}`)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keycloak-admin (0.7.8)
+    keycloak-admin (0.7.9)
       http-cookie (~> 1.0, >= 1.0.3)
       rest-client (~> 2.0)
 

data/README.md

@@ -12,7 +12,7 @@ This gem *does not* require Rails.
 For example, using `bundle`, add this line to your Gemfile.
 
 ```ruby
-gem "keycloak-admin", "0.7.8"
+gem "keycloak-admin", "0.7.9"
 ```
 
 ## Login
@@ -91,7 +91,8 @@ All options have a default value. However, all of them can be changed in your in
 
 | Option | Default Value | Type | Required? | Description  | Example |
 | ---- | ----- | ------ | ----- | ------ | ----- |
-| `server_url` | `nil`| String | Required | The base url where your Keycloak server is located. This value can be retrieved in your Keycloak client configuration. | `server_domain` | `nil`| String | Required | Public domain that identify your authentication cookies. | `auth.service.io` |
+| `server_url` | `nil` | String | Required | The base url where your Keycloak server is located (a URL that starts with `http` and that ends with `/auth`). This value can be retrieved in your Keycloak client configuration. | `http://auth:8080/auth`
+| `server_domain` | `nil`| String | Required | Public domain that identify your authentication cookies. | `auth.service.io` |
 | `client_realm_name` | `""`| String | Required | Name of the realm that contains the admin client. | `master` |
 | `client_id` | `admin-cli`| String | Required | Client that should be used to access admin capabilities. | `api-cli` |
 | `client_secret` | `nil`| String | Optional | If your client is `confidential`, this parameter must be specified. | `4e3c481c-f823-4a6a-b8a7-bf8c86e3eac3` |
@@ -144,10 +145,18 @@ KeycloakAdmin.realm("a_realm").users.get(user_id)
 
 Returns an array of `KeycloakAdmin::UserRepresentation`.
 
+According to [the documentation](https://www.keycloak.org/docs-api/11.0/rest-api/index.html#_users_resource):
+* When providing a `String` parameter, this produces an arbitrary search string
+* When providing a `Hash`, you can search for specific field (_e.g_ an email)
+
 ```ruby
 KeycloakAdmin.realm("a_realm").users.search("a_username_or_an_email")
 ```
 
+```ruby
+KeycloakAdmin.realm("a_realm").users.search({ email: "john@doe.com" })
+```
+
 ### List all users in a realm
 
 Returns an array of `KeycloakAdmin::UserRepresentation`.

data/lib/keycloak-admin/client/user_client.rb

@@ -38,8 +38,22 @@ module KeycloakAdmin
       UserRepresentation.from_hash(JSON.parse(response))
     end
 
+    ##
+    # Query can be a string or a hash.
+    # * String: It's used as search query
+    # * Hash: Used for complex search queries.
+    #   For its documentation see: https://www.keycloak.org/docs-api/11.0/rest-api/index.html#_users_resource
+    ##
     def search(query)
-      derived_headers = query ? headers.merge({params: { search: query }}) : headers
+      derived_headers = case query
+                        when String
+                          headers.merge({params: { search: query }})
+                        when Hash
+                          headers.merge({params: query })
+                        else
+                          headers
+                        end
+
       response = execute_http do
         RestClient::Resource.new(users_url, @configuration.rest_client_options).get(derived_headers)
       end

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "0.7.8"
+  VERSION = "0.7.9"
 end

data/spec/client/user_client_spec.rb

@@ -192,12 +192,24 @@ RSpec.describe KeycloakAdmin::TokenClient do
       allow_any_instance_of(RestClient::Resource).to receive(:get).and_return '[{"username":"test_username","createdTimestamp":1559347200}]'
     end
 
-    it "finds a user" do
+    it "finds a user using a string" do
       users = @user_client.search("test_username")
       expect(users.length).to eq 1
       expect(users[0].username).to eq "test_username"
     end
 
+    it "finds a user using nil does not fail" do
+      users = @user_client.search(nil)
+      expect(users.length).to eq 1
+      expect(users[0].username).to eq "test_username"
+    end
+
+    it "finds a user using a hash" do
+      users = @user_client.search({ search: "test_username"})
+      expect(users.length).to eq 1
+      expect(users[0].username).to eq "test_username"
+    end
+
     it "passes rest client options" do
       rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
       allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
 platform: ruby
 authors:
 - Lorent Lempereur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2020-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-cookie