soar-registry-identity 5.0.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79231792c26830f1ef26bf12dd425bc9f5f3384b
-  data.tar.gz: 42fa83abb9dcd2d28ee9a01f8da502273877cc69
+  metadata.gz: '08d1199a71caea3337960fec8dec9246ed0cd69f'
+  data.tar.gz: 6382f9113f1a48dec5e545a52faf5a4e09009b4e
 SHA512:
-  metadata.gz: c6f877cfc8a01e27627c66fe27617f40d8b1b6bca76b1cf3f0eb85676a1d3f1670e5925684b77b1b046fb22ad7c3809a0f72ee278e3884ba89993afea1e8b214
-  data.tar.gz: 6f195c1646a9178dd7c769cc124779c9d5cca769c7337bc3ea83c296945e5d6b30ea045ec5d84bdf0d243379c7f9ab320b4d1356b1639cfd1cc4451087762269
+  metadata.gz: 48b81c9ef2377c6ac5c700553626287681c298908385211c84fc8315a9a0594b0f09ce784294a36116b964fa77a9cc5118937a38ff337d5a36afd68012445fd5
+  data.tar.gz: e31db28d252fb764c18988b2cf221472f6f1081603680dcd10684925a8e3037cf1b7ceed884372f29ef7c89cf028fd9533ae3e391a51cff17ecbc9df745ce09b

data/README.md

@@ -1,5 +1,8 @@
 # Registry of identities
 
+## Documentation
+[rubydoc.info](http://www.rubydoc.info/gems/soar-registry-identity/)
+
 ## Quickstart
 
 ### Example data
@@ -172,13 +175,13 @@ $ docker-compose up --build --remove-orphans --force-recreate
 Soar::Registry::Identity::Provider::Customer::Uuid
 
 ```bash
-$ CUSTOMER_DIRECTORY_CONFIG_FILE=config.mysql.yml ROLES_DIRECTORY_CONFIG_FILE=config.dynamo_db.yml TEST_ORCHESTRATION_PROVIDER=Customer::Uuid bundle exec cucumber
+$ CUSTOMER_DIRECTORY_CONFIG_FILE=config.mysql.yml ROLES_DIRECTORY_CONFIG_FILE=config.dynamo_db.yml TEST_ORCHESTRATION_PROVIDER=Customer::Uuid bundle exec cucumber --tags ~@future
 ```
 
 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
+$ 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::Stub::Uuid

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

@@ -30,6 +30,7 @@ module Soar
         # @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
+        # @raise [SoarIdm::IdentityError]
         ##
         def get_attributes(identifier, role = nil)
           @provider.get_attributes(identifier, role)

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

@@ -19,13 +19,13 @@ module Soar
             end
 
             ##
-            # @param [String] identity_identifier
+            # @param [String] client_number
             #   a client_number that uniquely identifies an identity
             # @return [Hash] an identity
             ##
-            def calculate_identities(identity_identifier)
+            def calculate_identities(client_number)
               return @identities if not @identities.nil?
-              entries = @directory.search(@search_index, identity_identifier)
+              entries = @directory.search(@search_index, client_number)
               @identities = entries.empty? ? [] : [entries[0]]
               return @identities
             end

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

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

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

@@ -32,11 +32,11 @@ module Soar
             end
 
             ##
-            # @param [Hash{String => String,Number}] identity
+            # @param [String] identity_uuid
             # @return [Array<String>] list of roles
             ##
-            def calculate_roles(identity)
-              entries = @roles[:directory].search(@roles[:search_index], identity[@roles[:search_index]])
+            def calculate_roles(identity_uuid)
+              entries = @roles[:directory].search(@roles[:search_index], identity_uuid)
               roles = []
               entries.each do |entry|
                 roles << entry[@roles[:fetch_index][1]]
@@ -45,10 +45,10 @@ module Soar
             end
 
             ##
-            # @param [Hash{String => String, Number}] identity
+            # @param [String] identity_uuid
             # @return [Array<String,Number>] list of identifiers
             ##
-            def calculate_identifiers(identity)
+            def calculate_identifiers(identity_uuid)
               indexes = @identity[:directory].index
               #indexes.delete(@identity[:directory])
               identifiers = []
@@ -60,13 +60,13 @@ module Soar
             end
 
             ## 
-            # @param [Hash{String => String, Number}] identity
+            # @param [identifier] identity_uuid
             # @param [String] role
             # @return [Hash{String => String, Number, Hash, Array}] A hash of attributes 
             ##
-            def calculate_attributes(identity, role)
+            def calculate_attributes(identity_uuid, role)
               primary_key = {
-                @roles[:fetch_index][0] => identity[@roles[:fetch_index][0]],
+                @roles[:fetch_index][0] => identity_uuid,
                 @roles[:fetch_index][1] => role
               }
               result = @roles[:directory].fetch(primary_key)
@@ -77,45 +77,50 @@ module Soar
             end 
 
             ##
-            # @param [Hash{String => String, Number}] identity
+            # @param [String] identity_uuid
             # @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]]
+            def calculate_all_attributes(identity_uuid)
+              identity = {}
               role_entries = @roles[:directory].search(@roles[:search_index], identity_uuid)
               roles = {}
               role_entries.each do |role_entry|
+                identity = calculate_identity(identity_uuid, role_entry['identity_source']) if role_entry.key?('identity_source') 
                 roles[role_entry['identity_role']] = role_entry.key?('identity_role_attributes') ? role_entry['identity_role_attributes'] : {}
               end
+              raise SoarIdm::IdentityError if identity.empty?
               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
+            # @param [String] identity_uuid
+            # @param [String] identity_source
+            # @return [Hash{String => String, Number, Hash, Array}]
+            # @raise [SoarIdm::IdentityError]
             ##
-            def calculate_identities(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?
+            def calculate_identity(identity_uuid, identity_source)
+              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
+                source_identity = @identity[:directory].fetch(identity_id)
+                identity = {}
+                identity["identity_uuid"] = identity_uuid
+                identity["email"]  = source_identity[:Notifyemail_Invoice] if source_identity.key?(:Notifyemail_Invoice)
+                identity["firstname"] = source_identity[:First_Name] if source_identity.key?(:First_Name)
+                identity["lastname"] = source_identity[:Surname] if source_identity.key?(:Surname)
+                return identity
+              rescue Soar::Registry::Directory::Error::NoEntriesFoundError => e
+                raise SoarIdm::IdentityError, e.message
               end
-              identity[@roles[:search_index]] = identifier
-              @identities = [identity]
-              return @identities
+            end
+
+            ##
+            # @param [String] identifier a string that uniquely identifies an identity
+            # @return [Array<String>] identifiers
+            ##
+            def calculate_identities(identity_uuid)
+              return [identity_uuid]
             end
 
             private 
@@ -125,13 +130,6 @@ module Soar
               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
         end
       end

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

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

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

@@ -30,16 +30,16 @@ module Soar
             end
 
             ##
-            # @param [Hash{String => String}] identity
+            # @param [String] identity_uuid
             # @return [Array<String>] list of roles
             ##
-            def calculate_roles(identity)
-              entries = @roles[:directory].search(@roles[:search_index], identity[@identity[:fetch_index]])
+            def calculate_roles(identity_uuid)
+              entries = @roles[:directory].search(@roles[:search_index], identity_uuid)
               roles = []
               entries.each do |entry|
+                identity_source = entry['identity_source'] if entry.key?('identity_source') 
                 roles << entry[@roles[:fetch_index][1]]
               end
-              #raise SoarIdm::IdentityError if identity.nil? and roles.length == 0
               return roles
             end
 
@@ -57,13 +57,13 @@ module Soar
             end
 
             ## 
-            # @param [Hash{String => String, Number}] identity
+            # @param [String] identity_uuid
             # @param [String] role
             # @return [Hash{String => String, Number, Hash, Array}] A hash of attributes 
             ##
-            def calculate_attributes(identity, role)
+            def calculate_attributes(identity_uuid, role)
               primary_key = {
-                @roles[:fetch_index][0] => identity[@identity[:fetch_index]],
+                @roles[:fetch_index][0] => identity_uuid,
                 @roles[:fetch_index][1] => role
               }
               result = @roles[:directory].fetch(primary_key)
@@ -74,40 +74,36 @@ module Soar
             end 
 
             ## 
-            # @param [Hash{String => String, Number}] identity
+            # @param [String] identity_uuid
             # @return [Hash{String => String, Number, Hash, Array}] A hash of attributes 
             ##
-            def calculate_all_attributes(identity)
-              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'] : {}
+            def calculate_all_attributes(identity_uuid)
+              begin
+                role_entries = @roles[:directory].search(@roles[:search_index], identity_uuid)
+                roles = {}
+                role_entries.each { |role_entry|
+                  roles[role_entry['identity_role']] = role_entry.key?('identity_role_attributes') ? role_entry['identity_role_attributes'] : {}
+                }
+                identity = @identity[:directory].fetch(identity_uuid)
+                attributes = {}
+                attributes["identity_uuid"] = identity_uuid 
+                attributes["firstname"] = identity[:givenName] if identity.key?(:givenName)
+                attributes["lastname"] = identity[:sn] if identity.key?(:sn)
+                attributes["email"] = identity[:mail] if identity.key?(:mail)
+                attributes["roles"] = roles
+                return attributes
+              rescue Soar::Registry::Directory::Error::NoEntriesFoundError => e
+                raise SoarIdm::IdentityError, e.message
               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 string that uniquely identifies an identity
-            # @return [Array<Hash{String => String}>] identities
+            # @param [String] identity_uuid
+            # @return [Array<String>] identifiers
             # @raise [Soar::Registry::Directory::Error::NoEntriesFoundError]
             ##
-            def calculate_identities(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
+            def calculate_identities(identity_uuid)
+              return [identity_uuid]
             end
 
           end

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

@@ -21,44 +21,55 @@ module Soar
             end
 
             ##
-            # @param [Hash{String => String,Number}] identity
+            # @param [String] identity_uuid
             # @return [Array<String>] list of roles
             ##
-            def calculate_roles(identity)
-              return identity.key?('roles') ? identity['roles'].keys : []
+            def calculate_roles(identity_uuid)
+              begin
+                identity = @directory.fetch(identity_uuid)
+                return identity.key?('roles') ? identity['roles'].keys : []
+              rescue Soar::Registry::Directory::Error::NoEntriesFoundError => e
+                return []
+              end
             end
 
             ##
-            # @param [Hash{String => String, Number}] identity
+            # @param [String] identity_uuid
             # @return [Array<String,Number>] list of identifiers
             ##
-            def calculate_identifiers(identity)
+            def calculate_identifiers(identity_uuid)
             end
 
             ## 
-            # @param [Hash{String => String, Number}] identity
+            # @param [String] identity_uuid
             # @param [String] role
             # @return [Hash{String => String, Number, Hash, Array}] A hash of attributes 
             ##
-            def calculate_attributes(identity, role)
+            def calculate_attributes(identity_uuid, role)
+              identity = @directory.fetch(identity_uuid)
               return {
                 role => identity['roles'].key?(role) ? identity['roles'][role] : {}
               } 
             end 
 
             ##
-            # @param [Hash{String => String, Number}] identity
+            # @param [String] identity_uuid
             # @return [Hash{String => String, Number, Hash, Array}] A hash of attributes 
-            def calculate_all_attributes(identity)
-              return identity
+            def calculate_all_attributes(identity_uuid)
+              begin
+                identity = @directory.fetch(identity_uuid)
+                return identity
+              rescue Soar::Registry::Directory::Error::NoEntriesFoundError => e
+                raise SoarIdm::IdentityError, e.message
+              end
             end
 
             ##
-            # @param [String] identifier a string that uniquely identifies an identity
-            # @return [Array<Hash{String => String, Number }>] identities
+            # @param [String] identity_uuid
+            # @return [Array<String>] identities
             ##
-            def calculate_identities(identifier)
-              return [@directory.fetch(identifier)]
+            def calculate_identities(identity_uuid)
+              return [identity_uuid]
             end
 
 

data/lib/soar/registry/identity/test/orchestration_provider/customer/uuid.rb

@@ -83,6 +83,8 @@ module Soar
                 @idr = Soar::Registry::Identity.new(identity_provider)
               end
 
+              ##### when
+
               def get_roles
                 @result = @idr.get_roles(@identity_uuid) 
               end
@@ -92,9 +94,15 @@ module Soar
               end
 
               def get_identity_attributes
-                @result = @idr.get_attributes(@identity_uuid)
+                begin
+                  @result = @idr.get_attributes(@identity_uuid)
+                rescue SoarIdm::IdentityError => e
+                  @error = e
+                end
               end
 
+              ##### then
+
               def identity_attributes?
                 roles = {}
                 @roles.each do |entry| 
@@ -139,8 +147,7 @@ module Soar
               end
 
               def identity_error?
-                # this is not currently possible
-                @result == []
+                @error.is_a?(SoarIdm::IdentityError)
               end
 
               private

data/lib/soar/registry/identity/test/orchestration_provider/staff/uuid.rb

@@ -90,22 +90,26 @@ module Soar
                 @idr = Soar::Registry::Identity.new(identity_provider)
               end
 
+              ##### when
+
               def get_roles
+                @result = @idr.get_roles(@identity_uuid) 
+              end
+
+              def get_identity_attributes
                 begin
-                  @result = @idr.get_roles(@identity_uuid) 
+                  @result = @idr.get_attributes(@identity_uuid)
                 rescue SoarIdm::IdentityError => e
                   @error = e
                 end
               end
 
-              def get_identity_attributes
-                @result = @idr.get_attributes(@identity_uuid)
-              end
-
               def get_role_attributes
                 @result = @idr.get_attributes(@identity_uuid, @roles.nil? ? Faker::Company.unique.profession : @roles[0][:role])
               end
 
+              ##### then
+
               def identity_attributes?
                 roles = {}
                 @roles.each do |entry| 

data/lib/soar/registry/identity/test/orchestration_provider/stub/uuid.rb

@@ -64,12 +64,10 @@ module Soar
                 )
               end
 
+              ##### when
+
               def get_roles
-                begin
-                  @result = @idr.get_roles(@identity_uuid) 
-                rescue SoarIdm::IdentityError => e
-                  @error = e
-                end
+                @result = @idr.get_roles(@identity_uuid) 
               end
 
               def get_role_attributes
@@ -77,9 +75,15 @@ module Soar
               end
 
               def get_identity_attributes
-                @result = @idr.get_attributes(@identity_uuid)
+                begin
+                  @result = @idr.get_attributes(@identity_uuid)
+                rescue SoarIdm::IdentityError => e
+                  @error = e
+                end
               end
 
+              ##### then
+
               def identity_attributes?
                 @result == @identity
               end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soar-registry-identity
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.2
 platform: ruby
 authors:
 - Charles Mulder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: soar_idm