soar-registry-identity 4.0.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a84bab4718cef4c398bc0006cf5d726999aa4f67
-  data.tar.gz: 270e3edf5048e84fe90ac88a4f9024cf9e0ef5fb
+  metadata.gz: 821dd803bad9432b1c2206c11c46708bed15d4e0
+  data.tar.gz: baea63429adf243703b68e74f9b3d0d46aac8d41
 SHA512:
-  metadata.gz: 4dd8a44902cf4dd770f973fd48a2b49af45c1833ddc7bf251e3fc09f92f042c9626f98226be0ce68f8a513a6ad8c856f962a525f5c6a968464cc9892b93e69ad
-  data.tar.gz: 83ab95c63f1410be7a7a6756b543b6c4e7dd7c72a2bc5f5e842ce3ff31741ebf1a85ee659e5e04a5fdab2b48ac22b2a0bd23e30714589fc1e06ee00663483440
+  metadata.gz: bf1e42b3b28c05e5f01c0b72a77fc82c287c9cfd2d8334b25dae439b3cae1663a06b6710acebb500d69659f3cf9669ed8f9fa13706324f31d2db21218ce0c09e
+  data.tar.gz: b577f82ccedd6db4a7b8d4a5b5f8f5798d4001623a67ad006defac2de9af286f71333f244e543684b731392e9832b13b60139820093c3027bc86766ee0b028c0

data/README.md

@@ -3,6 +3,7 @@
 ## Quickstart
 
 ### Example data
+
 ```javascript
 identities = [{
     "uuid": "62936e70-1815-439b-bf89-8492855a7e6b",
@@ -23,6 +24,7 @@ Create a directory provider
 ```
 
 Create a directory
+
 ```ruby
 > directory = Soar::Registry::Directory.new(directory_provider)
 ```
@@ -32,7 +34,7 @@ Create a directory
 #### Manual instantiation
 
 ##### Staff Email IDR
-Search for identifiers by email address. Used by [soar-authentication-identity](https://github.com/hetznerZA/soar-authentication-identity) to translate an authenticated identifier to an UUID.
+Search for identifiers by email address. Used by [soar-authentication-identity_uuid_translator](https://github.com/hetznerZA/soar-authentication-identity_uuid_translator) to translate an authenticated identifier to an UUID.
 ```ruby
 require 'soar/registry/identity'
 identity_provider = Soar::Registry::Identity::Provider::Staff::Email.new({
@@ -48,7 +50,8 @@ identity_provider = Soar::Registry::Identity::Provider::Staff::Email.new({
 
 #### Factory instantiation
 
-##### Create a selector
+Create a selector
+
 ```ruby
 > require 'object_selector'
 > selector = ObjectSelector.new(
@@ -83,7 +86,8 @@ identity_provider = Soar::Registry::Identity::Provider::Staff::Email.new({
 )
 ```
 
-##### Get an IDR
+Get an IDR
+
 ```ruby
 > selector_value = 'your-string-here'
 idr = Soar::Registry::Identity::Factory.create({
@@ -94,14 +98,16 @@ idr = Soar::Registry::Identity::Factory.create({
 
 ### Use your IDR
 
-##### Getting a list of identifiers
+Getting a list of identifiers
+
 ```ruby
 > identifiers = @email_idr.get_identifiers("admin@hetzner.co.za") 
 > puts identifiers.inspect
 ["admin@hetzner.co.za", "identity-820d5660-2204-4f7d-8c04-746313439b81"]
 ```
 
-### Getting a list of roles
+Getting a list of roles
+
 ```ruby
 > roles = @uuid_idr.get_roles("identity-820d5660-2204-4f7d-8c04-746313439b81")
 > # get_roles is not applicable to staff email idr
@@ -109,7 +115,8 @@ idr = Soar::Registry::Identity::Factory.create({
 ["staff", "configuration_publisher", "configuration_consumer"]
 ```
 
-### Getting a hash of attributes for a role 
+Getting a hash of attributes for a role 
+
 ```ruby
 > role = 'staff'
 > attributes = @uuid_idr.get_attributes("identity-820d5660-2204-4f7d-8c04-746313439b81", role)
@@ -123,7 +130,8 @@ idr = Soar::Registry::Identity::Factory.create({
 
 ```
 
-### Getting a hash of all attributes
+Getting a hash of all attributes
+
 ```ruby
 > attributes = @uuid_idr.get_attributes("identity-820d5660-2204-4f7d-8c04-746313439b81")
 > # get_attributes is not applicate to staff email idr
@@ -154,15 +162,102 @@ idr = Soar::Registry::Identity::Factory.create({
 ## Tests
 
 ### Local
+
+Start container dependencies
+
+```bash
+$ docker-compose up --build --remove-orphans --force-recreate
+```
+
+Soar::Registry::Identity::Provider::Customer::Uuid
+
 ```bash
-$ bundle exec rspec 
+$ CUSTOMER_DIRECTORY_CONFIG_FILE=config.mysql.yml ROLES_DIRECTORY_CONFIG_FILE=config.dynamo_db.yml TEST_ORCHESTRATION_PROVIDER=Customer::Uuid bundle exec cucumber
+```
+
+Soar::Registry::Identity::Provider::Staff::Uuid
+
+```bash
+$ STAFF_DIRECTORY_CONFIG_FILE=config.ldap.yml ROLES_DIRECTORY_CONFIG_FILE=config.dynamo_db.yml TEST_ORCHESTRATION_PROVIDER=Staff::Uuid bundle exec cucumber
+```
+
+Soar::Registry::Identity::Provider::Staff::Email
+
+```bash
+$ bundle exec rspec spec/staff/email_spec.rb
+```
+
+Soar::Registry::Identity::Provider::Customer::Email
+
+```bash
+$ bundle exec rspec spec/customer/email_spec.rb
+```
+
+Soar::Registry::Identity::Provider::Customer::ClientNumber
+
+```bash
+$ bundle exec rspec spec/customer/client_number_spec.rb
+```
+
+Soar::Registry::Identity::Factory 
+
+```bash
+$ bundle exec rspec spec/authenticated_identity_factory_spec.rb spec/identity_uuid_factory_spec.rb
 ```
 
 ### CI
+
+Soar::Registry::Identity::Provider::Staff::Email
+
+```bash
+docker-compose --file docker-compose.ci.staff-email.yml --project-name soar-registry-identity-provider-staff-email up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistryidentityproviderstaffemail_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
+docker-compose --file docker-compose.ci.staff-email.yml --project-name soar-registry-identity-provider-staff-email down --rmi local
+exit $EXIT_CODE;
+```
+
+Soar::Registry::Identity::Provider::Customer::Email
+
+```bash
+docker-compose --file docker-compose.ci.customer-email.yml --project-name soar-registry-identity-provider-customer-email up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistryidentityprovidercustomeremail_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
+docker-compose --file docker-compose.ci.customer-email.yml --project-name soar-registry-identity-provider-customer-email down --rmi local
+exit $EXIT_CODE;
+```
+
+Soar::Registry::Identity::Provider::Customer::ClientNumber
+
+```bash
+docker-compose --file docker-compose.ci.customer-client_number.yml --project-name soar-registry-identity-provider-customer-client_number up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistryidentityprovidercustomerclientnumber_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
+docker-compose --file docker-compose.ci.customer-client_number.yml --project-name soar-registry-identity-provider-customer-client_number down --rmi local
+exit $EXIT_CODE;
+```
+
+Soar::Registry::Identity::Factory 
+
+```bash
+docker-compose --file docker-compose.ci.factory.yml --project-name soar-registry-identity-factory up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistryidentityfactory_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
+docker-compose --file docker-compose.ci.factory.yml --project-name soar-registry-identity-factory down --rmi local
+exit $EXIT_CODE;
+```
+
+Soar::Registry::Identity::Provider::Staff::Uuid
+
+```bash
+docker-compose --file docker-compose.ci.staff-uuid.yml --project-name soar-registry-identity-provider-staff-uuid up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistryidentityproviderstaffuuid_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
+docker-compose --file docker-compose.ci.staff-uuid.yml --project-name soar-registry-identity-provider-staff-uuid down --rmi local
+exit $EXIT_CODE;
+```
+
+Soar::Registry::Identity::Provider::Customer::Uuid
+
 ```bash
-docker-compose --file docker-compose.ci.yml --project-name soar-registry-identity up --abort-on-container-exit --remove-orphans --build --force-recreate
-EXIT_CODE=$(docker ps -a -f "name=soarregistryidentity_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
-docker-compose --file docker-compose.ci.yml --project-name soar-registry-identity down --rmi local
+docker-compose --file docker-compose.ci.customer-uuid.yml --project-name soar-registry-identity-provider-customer-uuid up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistryidentityprovidercustomeruuid_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
+docker-compose --file docker-compose.ci.customer-uuid.yml --project-name soar-registry-identity-provider-customer-uuid down --rmi local
 exit $EXIT_CODE;
 ```
 

data/lib/soar/registry/identity/factory.rb

@@ -6,7 +6,7 @@ module Soar
       class Factory
 
         ##
-        # @param [String] value
+        # @param [String,Array] value
         # @param [ObjectSelector] selector
         # @raise [ObjectSelector::Error::NoMatchError]
         # @return [Soar::Registry::Identity]

data/lib/soar/registry/identity/model.rb

@@ -2,6 +2,7 @@ require 'soar/registry/identity/provider/staff/email'
 require 'soar/registry/identity/provider/staff/uuid'
 require 'soar/registry/identity/provider/customer/client_number'
 require 'soar/registry/identity/provider/customer/email'
+require 'soar/registry/identity/provider/customer/uuid'
 
 module Soar
   module Registry
@@ -15,7 +16,7 @@ module Soar
         end
 
         ##
-        # @param [String] identifier
+        # @param [String] identifier 
         # @return [Array<String>] list of roles
         ##
         def get_roles(identifier)
@@ -25,7 +26,8 @@ module Soar
         ##
         # @param [String] identifier
         # @param [String] role
-        # @return [Hash] if a role is specified the returned hash is keyed by role
+        # @return [Hash{String => String, Hash, Number}] 
+        #   if a role is specified the returned hash is keyed by role
         #   else it's keyed by attribute name
         ##
         def get_attributes(identifier, role = nil)
@@ -34,7 +36,8 @@ module Soar
 
         ##
         # @param [String] identifier
-        # @return [Array<String>] list of identifiers
+        # @return [Array<String>] 
+        #   array of identity identifiers
         ##
         def get_identifiers(identifier)
           @provider.get_identifiers(identifier)

data/lib/soar/registry/identity/provider/customer/client_number.rb

@@ -9,6 +9,8 @@ module Soar
 
             ##
             # @param [Soar::Registry::Directory] directory
+            # @param [String] fetch_index
+            # @param [String] search_index
             ##
             def initialize(directory:, fetch_index: , search_index: )
               @directory = directory
@@ -17,12 +19,15 @@ module Soar
             end
 
             ##
-            # @param [String] identifier, an email address that uniquely identifies an identity
+            # @param [String] identity_identifier
+            #   a client_number that uniquely identifies an identity
             # @return [Hash] an identity
             ##
             def calculate_identities(identity_identifier)
+              return @identities if not @identities.nil?
               entries = @directory.search(@search_index, identity_identifier)
-              return entries.empty? ? [] : [entries[0]]
+              @identities = entries.empty? ? [] : [entries[0]]
+              return @identities
             end
 
             ##

data/lib/soar/registry/identity/provider/customer/email.rb

@@ -17,12 +17,15 @@ module Soar
             end
 
             ##
-            # @param [String] identifier, an email address that uniquely identifies an identity
+            # @param [String] identity_identifier 
+            #   an email address that uniquely identifies an identity
             # @return [Hash] an identity
             ##
             def calculate_identities(identity_identifier)
+              return @identities if not @identities.nil?
               entries = @directory.search(@search_index, identity_identifier)
-              return entries.empty? ? [] : [entries[0]]
+              @identities = entries.empty? ? [] : [entries[0]]
+              return @identities
             end
 
             ##

data/lib/soar/registry/identity/provider/customer/uuid.rb

@@ -12,11 +12,124 @@ module Soar
           class Uuid < SoarIdm::IdmApi
 
             ##
-            # @param [String] identifier, a primary key that uniquely identifies an identity
-            # @return [Hash] an identity
+            # @param [Hash] identity
+            # @option identity [Soar::Registry::Directory] :directory
+            # @option identity [String] :fetch_index
+            # @option identity [String] :search_index
+            #
+            # @param [Hash] roles
+            # @option roles [Soar::Registry::Directory] :directory
+            # @option roles [String] :fetch_index
+            # @option roles [String] :search_index
+            #
+            # @raise [ArgumentError]
+            ##
+            def initialize(identity:, roles:)
+              raise ArgumentError if not identity.key?(:directory) or not identity.key?(:fetch_index) or not identity.key?(:search_index)
+              raise ArgumentError if not roles.key?(:directory) or not roles.key?(:fetch_index) or not roles.key?(:search_index)
+              @identity = identity
+              @roles = roles
+            end
+
+            ##
+            # @param [Hash{String => String,Number}] identity
+            # @return [Array<String>] list of roles
+            ##
+            def calculate_roles(identity)
+              entries = @roles[:directory].search(@roles[:search_index], identity[@roles[:search_index]])
+              roles = []
+              entries.each do |entry|
+                roles << entry[@roles[:fetch_index][1]]
+              end
+              return roles
+            end
+
+            ##
+            # @param [Hash{String => String, Number}] identity
+            # @return [Array<String,Number>] list of identifiers
+            ##
+            def calculate_identifiers(identity)
+              indexes = @identity[:directory].index
+              #indexes.delete(@identity[:directory])
+              identifiers = []
+              indexes.each { |index| 
+                identifiers << identity[index.to_s]
+              }
+              identifiers << identity[@roles[:fetch_index][0]]
+              return identifiers.reverse
+            end
+
+            ## 
+            # @param [Hash{String => String, Number}] identity
+            # @param [String] role
+            # @return [Hash{String => String, Number, Hash, Array}] A hash of attributes 
+            ##
+            def calculate_attributes(identity, role)
+              primary_key = {
+                @roles[:fetch_index][0] => identity[@roles[:fetch_index][0]],
+                @roles[:fetch_index][1] => role
+              }
+              result = @roles[:directory].fetch(primary_key)
+              attributes = {
+                role => result.key?('identity_role_attributes') ? result['identity_role_attributes'] : {}
+              }
+              return attributes
+            end 
+
+            ##
+            # @param [Hash{String => String, Number}] identity
+            # @return [Hash{String => String, Number, Hash, Array}] A hash of attributes 
+            def calculate_all_attributes(identity)
+              identity = Marshal.load(Marshal.dump(identity))
+              identity_uuid = identity[@roles[:search_index]]
+              role_entries = @roles[:directory].search(@roles[:search_index], identity_uuid)
+              roles = {}
+              role_entries.each do |role_entry|
+                roles[role_entry['identity_role']] = role_entry.key?('identity_role_attributes') ? role_entry['identity_role_attributes'] : {}
+              end
+              identity[:roles] = roles
+              attributes = Hashie.stringify_keys(identity)
+              return attributes
+            end
+
+            ##
+            # @param [String] identifier a string that uniquely identifies an identity
+            # @return [Array<Hash{String => String, Number }>] identities
             ##
             def calculate_identities(identifier)
-              return [@translator.get_identity(@directory.fetch(identifier))]
+              return @identities if not @identities.nil?
+              identities = @roles[:directory].search(@roles[:search_index], identifier)
+              identity = { @roles[:search_index] => identifier } 
+              return [identity] if identities.length == 0
+              identity_source = get_identity_source(identities) 
+              identity_id = get_identity_id(identity_source) if not identity_source.nil?
+              #raise SoarIdm::IdentityError if identity_id.nil?
+              begin 
+                identity = @identity[:directory].fetch(identity_id)
+                identity = {
+                  "email" => identity[:Notifyemail_Invoice],
+                  "firstname" => identity[:First_Name],
+                  "lastname" =>identity[:Surname]
+                }
+              rescue Soar::Registry::Directory::Error::NoEntriesFoundError
+              end
+              identity[@roles[:search_index]] = identifier
+              @identities = [identity]
+              return @identities
+            end
+
+            private 
+
+            def get_identity_id(identity_source)
+              result = identity_source.split(":")
+              return result.last.to_i if result[0] === "mysql" and result[1] === "genie" and result[2] === "client" and result[3] === "id"
+            end
+
+            def get_identity_source(identities)
+              identity_source = identities.each { |identity| 
+                break identity["identity_source"] if identity.key?("identity_source") 
+              }
+              return identity_source if identity_source.is_a?(String)
             end
 
           end

data/lib/soar/registry/identity/provider/staff/email.rb

@@ -17,12 +17,15 @@ module Soar
             end
 
             ##
-            # @param [String] identifier, an email address that uniquely identifies an identity
+            # @param [String] identity_identifier
+            #   an email address that uniquely identifies an identity
             # @return [Hash] an identity
             ##
             def calculate_identities(identity_identifier)
+              return @identities if not @identities.nil?
               entries = @directory.search(@search_index, identity_identifier)
-              return entries.empty? ? [] : [entries[0]]
+              @identities = entries.empty? ? [] : [entries[0]]
+              return @identities
             end
 
             ##

data/lib/soar/registry/identity/provider/staff/uuid.rb

@@ -1,4 +1,5 @@
 require 'soar_idm/soar_idm'
+require 'hashie'
 
 module Soar
   module Registry
@@ -6,71 +7,107 @@ module Soar
       module Provider
         module Staff
 
-          ##
-          # Work in progress. Do not use.
-          ##
           class Uuid < SoarIdm::IdmApi
 
             ##
-            # @param [Hash] directories
-            # @option directories [Object] :identity
-            # @option directories [Object] :role 
+            # @param [Hash] identity
+            # @option identity [Soar::Registry::Directory] :directory
+            # @option identity [String] :fetch_index
+            # @option identity [String] :search_index
+            #
+            # @param [Hash] roles
+            # @option roles [Soar::Registry::Directory] :directory
+            # @option roles [String] :fetch_index
+            # @option roles [String] :search_index
+            #
+            # @raise [ArgumentError]
             ##
-            def initialize(directories:, fetch_index: "entryuuid")
-              raise Soar::Registry::Identity::Error::MissingRequiredDirectoryError, ':identity key is required' if not directories.key?(:identity)
-              @identity_directory = directories[:identity]
-              @roles_directory = directories.key?(:roles) ? directories[:roles] : directories[:identity]
+            def initialize(identity:, roles:)
+              raise ArgumentError if not identity.key?(:directory) or not identity.key?(:fetch_index) or not identity.key?(:search_index)
+              raise ArgumentError if not roles.key?(:directory) or not roles.key?(:fetch_index) or not roles.key?(:search_index)
+              @identity = identity
+              @roles = roles
             end
 
             ##
-            # @param [Hash] identity
-            # @return [Array] list of roles
+            # @param [Hash{String => String}] identity
+            # @return [Array<String>] list of roles
+            ##
             def calculate_roles(identity)
-              entry = @roles_directory.fetch(identity[@roles_directory.index[0]])
-              return nil if not entry
+              entries = @roles[:directory].search(@roles[:search_index], identity[@identity[:fetch_index]])
               roles = []
-              entry['roles'].each do |role, attributes|
-                roles << role
+              entries.each do |entry|
+                roles << entry[@roles[:fetch_index][1]]
               end
-              roles
+              #raise SoarIdm::IdentityError if identity.nil? and roles.length == 0
+              return roles
             end
 
             ##
-            # @param [Hash] identity
-            # @return [Array] list of identifiers
+            # @param [Hash{String => String, Number}] identity
+            # @return [Array<String,Number>] list of identifiers
             ##
             def calculate_identifiers(identity)
-              indexes = @identity_directory.index
+              indexes = @identity[:directory].index
               identifiers = []
               indexes.each { |index| 
-                identifiers << identity[index]
+                identifiers << identity[index.to_s]
               }
               identifiers
             end
 
             ## 
-            # @param [Hash] identity
+            # @param [Hash{String => String, Number}] identity
             # @param [String] role
-            # @return [Hash] A hash of attributes 
+            # @return [Hash{String => String, Number, Hash, Array}] A hash of attributes 
+            ##
             def calculate_attributes(identity, role)
-              entry = @roles_directory.fetch(identity[@roles_directory.index[0]])
-              return nil if not entry
-              { role => entry['roles'][role] }
+              primary_key = {
+                @roles[:fetch_index][0] => identity[@identity[:fetch_index]],
+                @roles[:fetch_index][1] => role
+              }
+              result = @roles[:directory].fetch(primary_key)
+              attributes = {
+                role => result.key?('identity_role_attributes') ? result['identity_role_attributes'] : {}
+              }
+              return attributes
             end 
 
+            ## 
+            # @param [Hash{String => String, Number}] identity
+            # @return [Hash{String => String, Number, Hash, Array}] A hash of attributes 
             ##
-            # @param [Hash] identity
-            # @return [Hash] Hash of attributes keyed by role
             def calculate_all_attributes(identity)
-              @directory.fetch(identity[@roles_directory.index[0]])
+              identity_uuid = identity[@identity[:fetch_index]]
+              role_entries = @roles[:directory].search(@roles[:search_index], identity_uuid)
+              roles = {}
+              role_entries.each do |role_entry|
+                roles[role_entry['identity_role']] = role_entry.key?('identity_role_attributes') ? role_entry['identity_role_attributes'] : {}
+              end
+              attributes = {
+                identity_uuid: identity_uuid,
+                firstname: identity['givenName'],
+                lastname: identity['sn'],
+                email: identity[@identity[:search_index]],
+                roles: roles
+              }
+              return attributes.stringify_keys
             end
 
             ##
-            # @param [String] identifier, a primary key that uniquely identifies an identity
-            # @return [Hash] an identity
+            # @param [String] identifier a string that uniquely identifies an identity
+            # @return [Array<Hash{String => String}>] identities
+            # @raise [Soar::Registry::Directory::Error::NoEntriesFoundError]
             ##
             def calculate_identities(identifier)
-              return [@identity_directory.fetch(identifier)]
+              return @identities if not @identities.nil?
+              begin
+                result = @identity[:directory].fetch(identifier)
+                @identities = [Hashie.stringify_keys(result)]
+                return @identities
+              rescue Soar::Registry::Directory::Error::NoEntriesFoundError => e
+                raise SoarIdm::IdentityError
+              end
             end
 
           end