soar-registry-staff 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f544b6dad6e1d457e519a2224be548670b5246ac
-  data.tar.gz: c2d23d9e7ca7d1054494eaa8a1f7592cad6fe4e9
+  metadata.gz: b870c2449a793ab6ce47a3b265be8eecd6f7d688
+  data.tar.gz: dcab46f89e3425a949580f83a78f00ab240953fc
 SHA512:
-  metadata.gz: 07dc861ee7813b76348ec62e22303bed71f0e3b6b4cd6bdf9662f2b333b61eb9dd72645c656a2325d4353dc9d333d0c652307e47d9bd6811d1ed0bbda8aa0fd2
-  data.tar.gz: 5e5845c4717996db03667913cab21840ceabde5dc338b906eacaf78784b56faa19a35de10307dbb77aaa08563ecd4932d4ebcdfc0ad5a70640d420b5b5f06e04
+  metadata.gz: 152fa38f09839258442d7e73b4f2a18124786d40f8770d4bc174c690e8efeb20afc386eca7851d4d2e92cf5e5eef4aaa2514edf4749ca63f334cbecca626b13e
+  data.tar.gz: d8f7afdcbdf5607a9997d58a3b539e39e04a99afe144d5adaa0f4d9da5a8500b598147af83b458e4a05a05a17e0c8af477b48fde474620087755a73ce4b51c11

data/README.md

@@ -23,21 +23,24 @@ provider:
 
 ### Create an instance of the staff identity registry
 ```ruby
+require 'soar/registry/staff/identity'
 @idr = Soar::Registry::Staff::Identity.new(configuration)
 ```
 
 ### Getting a list of identifiers
 ```ruby
-> identifiers = @idr.get_identifiers( {"email" => "admin@hetzner.co.za"} ) 
-> identifiers = @idr.get_identifiers( {"identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81"} ) 
+> identifiers = @idr.get_identifiers("identity-820d5660-2204-4f7d-8c04-746313439b81") 
+> identifiers = @idr.get_identifiers({"email" => "admin@hetzner.co.za"}.to_json) 
+> identifiers = @idr.get_identifiers({"identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81"}.to_json) 
 > puts identifiers.inspect
 ["admin@hetzner.co.za", "identity-820d5660-2204-4f7d-8c04-746313439b81"]
 ```
 
 ### Getting a list of roles
 ```ruby
-> roles = @idr.get_roles( {"email" => "admin@hetzner.co.za"} )
-> roles = @idr.get_roles( {"identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81"} )
+> roles = @idr.get_roles("identity-820d5660-2204-4f7d-8c04-746313439b81")
+> roles = @idr.get_roles({"email" => "admin@hetzner.co.za"}.to_json)
+> roles = @idr.get_roles({"identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81"}.to_json)
 > puts roles.inspect
 ["staff", "configuration_publisher", "configuration_consumer"]
 ```
@@ -45,8 +48,9 @@ provider:
 ### Getting a hash of attributes for a role 
 ```ruby
 > role = 'staff'
-> attributes = @idr.get_attributes( {"email" => "admin@hetzner.co.za"}, role)
-> attributes = @idr.get_attributes( {"identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81"}, role )
+> attributes = @idr.get_attributes("identity-820d5660-2204-4f7d-8c04-746313439b81", role)
+> attributes = @idr.get_attributes({"email" => "admin@hetzner.co.za"}.to_json, role)
+> attributes = @idr.get_attributes({"identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81"}.to_json, role)
 > puts attributes.inspect
 {
     "staff": {
@@ -58,8 +62,9 @@ provider:
 
 ### Getting a hash of all attributes
 ```ruby
-> attributes = @idr.get_attributes( {"email" => "admin@hetzner.co.za"} )
-> attributes = @idr.get_attributes( {"identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81"} )
+> attributes = @idr.get_attributes("identity-820d5660-2204-4f7d-8c04-746313439b81")
+> attributes = @idr.get_attributes({"email" => "admin@hetzner.co.za"}.to_json)
+> attributes = @idr.get_attributes({"identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81"}.to_json)
 > puts attributes.inspect
 {
     "identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81",

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

@@ -0,0 +1,40 @@
+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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,18 @@
+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,6 +1,7 @@
 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
@@ -76,15 +77,16 @@ module Soar
         end
 
         ##
-        # @param [String|Hash] identity_id or identifier (a hash containing attribute name and attribute value)
-        # @return [Array]
+        # @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)
-          if @translator.is_json?(identifier)
-            identifier = @translator.get_identifier(identifier)
-            entries = @directory.search_identities(identifier.keys[0], identifier[identifier.keys[0]] )
-            return [@translator.get_identity(entries)[0]]
+          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
-          return [@translator.get_identity(@directory.fetch_identity(identifier))]
+          entries = @directory.search_identities(identifier.type, identifier.value )
+          return [@translator.get_identity(entries)[0]]
         end
 
       end

data/lib/soar/registry/staff/translator/dynamo_db.rb

@@ -12,15 +12,6 @@ module Soar
             return entry
           end
 
-          def is_json?(json)
-            begin
-              JSON.parse(json)
-              return true
-            rescue JSON::ParserError => e
-              return false
-            end
-          end
-
           ##
           # @param [Array] entries a list of entries from data source
           # @return [Array] identities a list of identities
@@ -29,13 +20,6 @@ module Soar
             return entries
           end
 
-          ##
-          # @param [String|Hash] identifier could be a json string or a ruby hash
-          # @return [Hash] identifier with identifying attribute key and attribute value
-          ##
-          def get_identifier(identifier)
-            identifier.is_a?(Hash) ? identifier : JSON.parse(identifier)
-          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar-registry-staff
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Charles Mulder
@@ -94,6 +94,9 @@ files:
 - lib/soar/registry/staff/directory/dynamo_db/base.rb
 - lib/soar/registry/staff/directory/dynamo_db/identity.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/translator/dynamo_db.rb
 homepage: https://gitlab.host-h.net/registries/staff