soar-registry-staff 0.0.3 → 0.0.4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar-registry-staff
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Charles Mulder
@@ -10,6 +10,34 @@ bindir: bin
 cert_chain: []
 date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashy_db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: mince
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: soar_idm
   requirement: !ruby/object:Gem::Requirement
@@ -91,13 +119,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/soar/registry/staff/directory/dynamo_db/base.rb
-- lib/soar/registry/staff/directory/dynamo_db/identity.rb
+- lib/soar/registry/staff/directory/dynamo_db.rb
 - lib/soar/registry/staff/directory/error.rb
-- lib/soar/registry/staff/identifier/factory.rb
-- lib/soar/registry/staff/identifier/hash.rb
-- lib/soar/registry/staff/identifier/id.rb
-- lib/soar/registry/staff/identity.rb
+- lib/soar/registry/staff/directory/stub.rb
+- lib/soar/registry/staff/identity/base.rb
+- lib/soar/registry/staff/identity/email.rb
+- lib/soar/registry/staff/identity/id.rb
+- lib/soar/registry/staff/test/directory/orchestrator.rb
+- lib/soar/registry/staff/test/directory/provider/base.rb
+- lib/soar/registry/staff/test/directory/provider/dynamo_db.rb
+- lib/soar/registry/staff/test/directory/provider/stub.rb
+- lib/soar/registry/staff/test/fixtures/identity_data.json
+- lib/soar/registry/staff/test/fixtures/identity_table.json
 - lib/soar/registry/staff/translator/dynamo_db.rb
 homepage: https://gitlab.host-h.net/registries/staff
 licenses:

data/lib/soar/registry/staff/directory/dynamo_db/base.rb

@@ -1,90 +0,0 @@
-require 'soar_idm/directory_provider'
-require 'aws-sdk'
-require 'hashie'
-require 'soar/registry/staff/directory/error'
-
-module Soar
-  module Registry
-    module Staff
-      module Directory
-        module DynamoDb
-          class Base < SoarIdm::DirectoryProvider
-
-            attr_reader :configuration, :credentials, :client
-
-            ##
-            # @param [Hash] configuration for the directory provider
-            # @return [Nil]
-            # @raise [Soar::Registry::Staff::Directory::Error::BootstrapError] if required configuration is missing
-            ##
-            def bootstrap(configuration)
-              @configuration = Hashie.stringify_keys(configuration)
-              raise Soar::Registry::Staff::Directory::Error::BootstrapError, 'Missing region' if not @configuration.has_key?('region')
-              raise Soar::Registry::Staff::Directory::Error::BootstrapError, 'Missing endpoint' if not @configuration.has_key?('endpoint')
-              @table_name = @configuration.delete('table')
-              raise Soar::Registry::Staff::Directory::Error::BootstrapError, 'Missing table name' if not @table_name
-            end
-
-            ##
-            # @return [Bool] whether directory provider received minimum required configuration
-            ##
-            def bootstrapped?
-              @configuration.has_key?('region') and @configuration.has_key?('endpoint') 
-            end
-
-            def uri
-              @configuration['endpoint']
-            end
-
-            def authenticate(credentials)
-              raise Soar::Registry::Staff::Directory::Error::AuthenticationError, 'missing username' if not credentials.key?('username')
-              raise Soar::Registry::Staff::Directory::Error::AuthenticationError, 'missing password' if not credentials.key?('password')
-              @credentials = {
-                "access_key_id" => credentials['username'],
-                "secret_access_key" => credentials['password']
-              }
-            end
-
-            def connect
-              begin
-                options = @configuration.dup
-                options['credentials'] = Aws::Credentials.new(@credentials['access_key_id'], @credentials['secret_access_key'])
-                @client = Aws::DynamoDB::Client.new(Hashie.symbolize_keys(options))
-                @client
-              rescue ArgumentError => e
-                raise Soar::Registry::Staff::Directory::Error::ConnectionError, e.message 
-              rescue 
-                raise Soar::Registry::Staff::Directory::Error::ConnectionError, 'error creating client'
-              end
-
-            end
-
-            def connected?
-              return @client.class.name == 'Aws::DynamoDB::Client'
-            end
-
-            def ready?
-              begin
-                #return @client.list_tables.table_names.class.name == 'Array'
-                resp = @client.describe_table({
-                  table_name: @table_name
-                })
-                return resp.table.table_name == @table_name
-              rescue Seahorse::Client::NetworkingError
-                return false
-              end
-            end
-
-            def put_identity(entity)
-              @client.put_item({
-                table_name: @table_name,
-                item: Hashie.symbolize_keys(entity)
-              })
-            end
-
-          end
-        end
-      end
-    end
-  end
-end

data/lib/soar/registry/staff/directory/dynamo_db/identity.rb

@@ -1,83 +0,0 @@
-require 'soar_idm/directory_provider'
-require 'soar/registry/staff/directory/dynamo_db/base'
-require 'aws-sdk'
-require 'hashie'
-
-module Soar
-  module Registry
-    module Staff
-      module Directory
-        module DynamoDb
-          class Identity < Base
-
-            LIMIT = 10
-            INDEXED_ATTRIBUTES = ['email', 'entity_id']
-
-            ##
-            # @param [String] identity_id primary key of the identity
-            # @return [Hash] the identity
-            # @raise [Soar::Registry::Staff::Directory::DynamoDb::Error::UniqueIdentifierNotFoundError] if primary key not found
-            ##
-            def fetch_identity(identifier)
-              options = {
-                table_name: @table_name,
-                key: {
-                  identity_id: identifier
-                }
-              }
-              identity = @client.get_item(options)
-              raise Soar::Registry::Staff::Directory::Error::UniqueIdentifierNotFoundError, 'Unable to find identity' if identity.item.nil?
-              identity.item
-            end
-
-            ##
-            # @param [String] identifier_attribute 
-            # @param [String] identifier_value
-            # @return [Array] list of identities
-            # @raise [ArgumentError] if query or index is not specified
-            ##
-            def search_identities(identifier_attribute, identifier_value)
-              raise ArgumentError, "Attribute is required" if identifier_attribute.nil?
-              raise ArgumentError, 'Value is required' if identifier_value.nil?
-              options = {
-                table_name: @table_name,
-                select: 'ALL_ATTRIBUTES',
-                limit: LIMIT,
-                key_condition_expression: "#{identifier_attribute} = :value",
-                expression_attribute_values: {
-                  ":value": identifier_value 
-                }
-              }
-
-              options.merge!({index_name: "#{identifier_attribute}_index"}) if INDEXED_ATTRIBUTES.include?(identifier_attribute)
-              identity = @client.query(options)
-              identity.items.map { |item| 
-                Hashie.stringify_keys(item)
-              }
-            end
-
-            ##
-            # @return [Array] a list of primary keys and global secondary indexes
-            ##
-            def indexed_attributes
-              resp = @client.describe_table({
-                table_name: @table_name
-              })
-              indexed_attributes = []
-              resp['table']['key_schema'].each { |key_schema|
-                indexed_attributes << key_schema['attribute_name']
-              }
-              resp['table']['global_secondary_indexes'].each { |index| 
-                index['key_schema'].each { |key_schema| 
-                  indexed_attributes << key_schema['attribute_name']
-                }
-              }
-              indexed_attributes
-            end
-
-          end
-        end
-      end
-    end
-  end
-end

data/lib/soar/registry/staff/identifier/factory.rb

@@ -1,40 +0,0 @@
-require 'soar/registry/staff/identifier/id'
-require 'soar/registry/staff/identifier/hash'
-
-module Soar
-  module Registry
-    module Staff
-      module Identifier
-        class Factory
-
-          ##
-          # @param [String] identifier_id or a json serialized hash with length 1 eg. '{"email":"test@example.com"}'
-          # @return [Soar::Registry::Staff::Identifier::Id|Soar::Registry::Staff::Identifier::Hash] identifier
-          ##
-          def get_identifier(identifier)
-            if is_json?(identifier)
-              return Soar::Registry::Staff::Identifier::Hash.new(identifier)
-            else
-              return Soar::Registry::Staff::Identifier::Id.new(identifier)
-            end
-          end
-
-          private
-
-          def is_json?(identifier)
-            begin
-              return JSON.parse(identifier)
-              return true
-            rescue JSON::ParserError => e
-              return false
-            end
-          end
-
-        end
-
-      end
-
-    end
-  end
-end
-

data/lib/soar/registry/staff/identifier/hash.rb

@@ -1,24 +0,0 @@
-module Soar
-  module Registry
-    module Staff
-      module Identifier
-        class Hash
-
-          class MultipleIdentifierTypesError < StandardError; end;
-
-          attr_reader :type
-          attr_reader :value
-
-          def initialize(identifier)
-            identifier = JSON.parse(identifier)
-            raise MultipleIdentifierTypesError, 'Multiple identifier types are not allowed' if identifier.length > 1
-            @type = identifier.keys[0]
-            @value = identifier[identifier.keys[0]]
-          end
-
-        end
-      end
-    end
-  end
-end
-

data/lib/soar/registry/staff/identifier/id.rb

@@ -1,18 +0,0 @@
-module Soar
-  module Registry
-    module Staff
-      module Identifier
-        class Id
-
-          attr_reader :value
-
-          def initialize(identifier)
-              @value = identifier.strip
-          end
-
-        end
-      end
-    end
-  end
-end
-

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

@@ -1,95 +0,0 @@
-require 'soar_idm/soar_idm'
-require 'soar/registry/staff/translator/dynamo_db'
-require 'soar/registry/staff/directory/dynamo_db/identity'
-require 'soar/registry/staff/identifier/factory'
-
-module Soar
-  module Registry
-    module Staff
-
-      class Identity < SoarIdm::IdmApi
-
-        attr_reader :directory
-        attr_reader :translator
-        attr_reader :client
-
-        ##
-        # @param [Hash] configuration
-        #   for example see config/config.yml
-        ##
-        def initialize(configuration)
-          @translator = Object.const_get(configuration['rule_set']['adaptor']).new
-          @directory = Object::const_get(configuration['provider']['adaptor']).new
-          @directory.bootstrap(configuration['provider']['config'])
-          @directory.authenticate(configuration['provider']['credentials'])
-          @client = @directory.connect
-          raise Soar::Registry::Staff::Directory::Error::BootstrapError if not @directory.bootstrapped? 
-          raise Soar::Registry::Staff::Directory::Error::ConnectionError if not @directory.connected?
-          raise Soar::Registry::Staff::Directory::Error::NotReadyError if not @directory.ready?
-        end
-
-        ##
-        # @param [String] identity_id
-        # @return [Array] list of roles
-        def calculate_roles(identity)
-          entry = @directory.fetch_identity(identity['identity_id'])
-          return nil if not entry
-          identity = @translator.get_identity(entry)
-          roles = []
-          identity['roles'].each do |role, attributes|
-            roles << role
-          end
-          roles
-        end
-
-        ##
-        # @param [String] identity_id
-        # @return [Array] list of identifiers
-        ##
-        def calculate_identifiers(identity)
-          indexes = @directory.indexed_attributes
-          entry = @directory.fetch_identity(identity['identity_id'])
-          identity = @translator.get_identity(entry)
-          identifiers = []
-          indexes.each { |index| 
-            identifiers << identity[index]
-          }
-          identifiers
-        end
-
-        ## 
-        # @param [String] identity_id
-        # @param [String] role
-        # @return [Hash] A hash of attributes 
-        def calculate_attributes(identity, role)
-          entry = @directory.fetch_identity(identity['identity_id'])
-          return nil if not entry
-          identity = @translator.get_identity(entry)
-          { role => identity['roles'][role] }
-        end 
-
-        ##
-        # @param [String] identity_id
-        # @return [Hash] Hash of attributes keyed by role
-        def calculate_all_attributes(identity)
-          entry = @directory.fetch_identity(identity['identity_id'])
-          @translator.get_identity(entry)
-        end
-
-        ##
-        # @param [String] identifier primary key (identity_id) or a json serialized hash with length 1 eg. '{"email":"test@example.com"}'
-        # @return [Hash] an identity
-        def calculate_identities(identifier)
-          identifier_factory = Soar::Registry::Staff::Identifier::Factory.new
-          identifier = identifier_factory.get_identifier(identifier)
-          if identifier.is_a?(Soar::Registry::Staff::Identifier::Id)
-            return [@translator.get_identity(@directory.fetch_identity(identifier.value))]
-          end
-          entries = @directory.search_identities(identifier.type, identifier.value )
-          return [@translator.get_identity(entries)[0]]
-        end
-
-      end
-    end
-  end
-end