keycloak_oauth 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b84ab145e8572eebc11e31faff2080a82ec5f157fe5579c7076f32149f4b2b7
-  data.tar.gz: '0308c1a7e95dbd136e1cb1c659d203b355d78faecfefa4bd56d31fc222040245'
+  metadata.gz: cd57edea266446ba41b1247a566ae9919ee9f5d26c8b4f77a915f568a085542d
+  data.tar.gz: 6334660d691bb5aeab2a8a789b7f2d57c4b8ff643ea29fb4a711f968d08bdc62
 SHA512:
-  metadata.gz: a9c847ab0c59e5d6c4d28c51bbc5ad8ae515874cd680b312b31e264edc97748e813a319eb83f51c75ee463edaa02a9eba65ad6a444b82c59bc805b1a6eb1cfbf
-  data.tar.gz: fab61c415c9a09a4cc66a6e9986998dfc1db3c126205698938ef4f76c59a3571d1078f74456ab97201f7fa578b323430767fedd5687315a6233404f3610fb01d
+  metadata.gz: 6b472474aca15f56c3c7bbddbb5c135b11220add4f2cf0e6d52cc8398b5b3b8c755fa4d9517e103a68fe6ce86e676ac12860c077793a3094632e94da4b4a067d
+  data.tar.gz: aa7927e0ec6759a835123ae6d3f10ba59469558fe50081d2143c0274a94bfed11543527cc71b286436242e50588a7a5596b4bdad4152c90e80c385833f8a4f84

data/app/services/keycloak_oauth/authorizable_service.rb

@@ -2,10 +2,12 @@ require 'net/http'
 
 module KeycloakOauth
   class AuthorizableError < StandardError; end
+  class NotFoundError < StandardError; end
 
   class AuthorizableService
     HTTP_SUCCESS_CODES = [Net::HTTPOK, Net::HTTPNoContent, Net::HTTPCreated]
-    DEFAULT_CONTENT_TYPE = 'application/x-www-form-urlencoded'.freeze
+    CONTENT_TYPE_X_WWW_FORM_URLENCODED = 'application/x-www-form-urlencoded'.freeze
+    CONTENT_TYPE_JSON = 'application/json'.freeze
     AUTHORIZATION_HEADER = 'Authorization'.freeze
 
     attr_reader :http_response, :parsed_response_body
@@ -15,6 +17,20 @@ module KeycloakOauth
       @parsed_response_body ||= parse_response_body(http_response)
     end
 
+    def self.uri_with_supported_query_params(url, supported_params, given_params)
+      uri = URI.parse(url)
+
+      query_params = supported_params.inject({}) do |acc, query_param|
+        acc[query_param] = given_params[query_param] if given_params[query_param].present?
+        acc
+      end
+
+      log_unsupported_params(given_params.keys - supported_params)
+
+      uri.query = URI.encode_www_form(query_params) if query_params.values.any?
+      uri
+    end
+
     private
 
     def parse_response_body(http_response)
@@ -39,6 +55,8 @@ module KeycloakOauth
           return response['errorMessage']
         elsif response.has_key?('error_description')
           return response['error_description']
+        elsif response.has_key?('error')
+          return response['error']
         end
       when 'String'
         return response
@@ -46,5 +64,11 @@ module KeycloakOauth
         'Unexpected Keycloak error'
       end
     end
+
+    def self.log_unsupported_params(query_params)
+      query_params.each do |query_param|
+        Rails.logger.warn { "Unsupported query param was passed in: #{query_param}" }
+      end
+    end
   end
 end

data/app/services/keycloak_oauth/get_users_service.rb

@@ -0,0 +1,42 @@
+require 'net/http'
+
+module KeycloakOauth
+  class GetUsersService < KeycloakOauth::AuthorizableService
+    SUPPORTED_QUERY_PARAMS = %i(briefRepresentation email first firstName lastName max search username)
+
+    attr_reader :connection, :options
+
+    def initialize(connection:, access_token:, refresh_token:, options: {})
+      @connection = connection
+      @access_token = access_token
+      @refresh_token = refresh_token
+      @options = options
+    end
+
+    def send_request
+      get_users
+    end
+
+    private
+
+    attr_reader :access_token, :refresh_token
+
+    def get_users
+      uri = build_uri
+
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        request = Net::HTTP::Get.new(uri)
+        request[AUTHORIZATION_HEADER] = "Bearer #{access_token}"
+        http.request(request)
+      end
+    end
+
+    def build_uri
+      self.class.uri_with_supported_query_params(
+        connection.users_endpoint,
+        SUPPORTED_QUERY_PARAMS,
+        options
+      )
+    end
+  end
+end

data/app/services/keycloak_oauth/logout_service.rb

@@ -18,7 +18,7 @@ module KeycloakOauth
       uri = URI.parse(KeycloakOauth.connection.logout_endpoint)
       Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
         request = Net::HTTP::Post.new(uri)
-        request.set_content_type(DEFAULT_CONTENT_TYPE)
+        request.set_content_type(CONTENT_TYPE_X_WWW_FORM_URLENCODED)
         request.set_form_data(logout_request_params)
         request[AUTHORIZATION_HEADER] = "Bearer #{access_token}"
         http.request(request)

data/app/services/keycloak_oauth/post_token_service.rb

@@ -23,7 +23,7 @@ module KeycloakOauth
       uri = URI.parse(connection.authentication_endpoint)
       Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
         request = Net::HTTP::Post.new(uri)
-        request.set_content_type(DEFAULT_CONTENT_TYPE)
+        request.set_content_type(CONTENT_TYPE_X_WWW_FORM_URLENCODED)
         request.set_form_data(token_request_params)
         http.request(request)
       end

data/app/services/keycloak_oauth/post_users_service.rb

@@ -4,8 +4,6 @@ module KeycloakOauth
   class DuplicationError < StandardError; end
 
   class PostUsersService < KeycloakOauth::AuthorizableService
-    CONTENT_TYPE = 'application/json'.freeze
-
     attr_reader :request_params, :connection, :user_params
 
     def initialize(connection:, access_token:, refresh_token:, user_params:)
@@ -24,10 +22,10 @@ module KeycloakOauth
     attr_accessor :access_token, :refresh_token
 
     def post_users
-      uri = URI.parse(connection.post_users_endpoint)
+      uri = URI.parse(connection.users_endpoint)
       Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
         request = Net::HTTP::Post.new(uri)
-        request.set_content_type(CONTENT_TYPE)
+        request.set_content_type(CONTENT_TYPE_JSON)
         request[AUTHORIZATION_HEADER] = "Bearer #{access_token}"
         request.body = user_params.to_json
         http.request(request)

data/app/services/keycloak_oauth/put_execute_actions_email_service.rb

@@ -0,0 +1,57 @@
+require 'net/http'
+
+module KeycloakOauth
+  class PutExecuteActionsEmailService < KeycloakOauth::AuthorizableService
+    SUPPORTED_QUERY_PARAMS = %i(client_id lifespan redirect_uri)
+
+    attr_reader :connection, :user_id, :actions, :options
+
+    def initialize(connection: KeycloakOauth.connection, access_token:, refresh_token:, user_id:, actions:, options: {})
+      @connection = connection
+      @access_token = access_token
+      @refresh_token = refresh_token
+      @user_id = user_id
+      @actions = actions
+      @options = options
+    end
+
+    def send_request
+      put_execute_actions_email
+    end
+
+    private
+
+    attr_accessor :access_token, :refresh_token
+
+    def put_execute_actions_email
+      uri = build_uri
+
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        request = Net::HTTP::Put.new(uri)
+        request.set_content_type(CONTENT_TYPE_JSON)
+        request[AUTHORIZATION_HEADER] = "Bearer #{access_token}"
+        request.body = actions.to_json
+        http.request(request)
+      end
+    end
+
+    def build_uri
+      self.class.uri_with_supported_query_params(
+        connection.put_execute_actions_email_endpoint(user_id),
+        SUPPORTED_QUERY_PARAMS,
+        options
+      )
+    end
+
+    def parse_response_body(http_response)
+      super
+    rescue KeycloakOauth::AuthorizableError => exception
+      raise exception unless not_found_error?(exception)
+      raise KeycloakOauth::NotFoundError.new(exception)
+    end
+
+    def not_found_error?(exception)
+      exception.message == "User not found"
+    end
+  end
+end

data/app/services/keycloak_oauth/user_info_retrieval_service.rb

@@ -21,7 +21,7 @@ module KeycloakOauth
       uri = URI.parse(KeycloakOauth.connection.user_info_endpoint)
       Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
         request = Net::HTTP::Get.new(uri)
-        request.set_content_type(DEFAULT_CONTENT_TYPE)
+        request.set_content_type(CONTENT_TYPE_X_WWW_FORM_URLENCODED)
         request[AUTHORIZATION_HEADER] = "Bearer #{access_token}"
         http.request(request)
       end

data/lib/keycloak_oauth/endpoints.rb

@@ -21,8 +21,12 @@ module KeycloakOauth
       "#{auth_url}/realms/#{realm}/protocol/openid-connect/logout"
     end
 
-    def post_users_endpoint
+    def users_endpoint
       "#{auth_url}/admin/realms/#{realm}/users"
     end
+
+    def put_execute_actions_email_endpoint(user_id)
+      "#{auth_url}/admin/realms/#{realm}/users/#{user_id}/execute-actions-email"
+    end
   end
 end

data/lib/keycloak_oauth/version.rb

@@ -1,3 +1,3 @@
 module KeycloakOauth
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak_oauth
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - simplificator
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -70,9 +70,11 @@ files:
 - app/controllers/keycloak_oauth/callbacks_controller.rb
 - app/services/keycloak_oauth/authentication_service.rb
 - app/services/keycloak_oauth/authorizable_service.rb
+- app/services/keycloak_oauth/get_users_service.rb
 - app/services/keycloak_oauth/logout_service.rb
 - app/services/keycloak_oauth/post_token_service.rb
 - app/services/keycloak_oauth/post_users_service.rb
+- app/services/keycloak_oauth/put_execute_actions_email_service.rb
 - app/services/keycloak_oauth/user_info_retrieval_service.rb
 - config/routes.rb
 - lib/keycloak_oauth.rb