soar-registry-identity 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 484df2d3ddb8d8e2b5438fbad4b64f5082cbdf2b
+  data.tar.gz: 0115319b3e7636d6e5bd6cdf7eace3975dbadfdb
+SHA512:
+  metadata.gz: 015afb53bd02703e74b64e9ae518f60267eefa7c3965b0ad6a37505767c1240d2ab18bb92726af2775fbad2053299944e6dcfc145d284604fc351bcae8ac883b
+  data.tar.gz: 5ba3a6752b13b05e30888b6c3ef9967863e0c3db21f222a219924c9e433c64c6a6478e17bb4f6f503f3972eb2cdb4d899c84d1a4279a247dbb8f167061eee6af

data/README.md

@@ -0,0 +1,126 @@
+# Registry of identities
+
+## Quickstart
+
+### Directory
+Create a directory provider
+
+```ruby
+require 'soar/registry/directory'
+directory_provider = Soar::Registry::Directory::Provider::Stub.new
+```
+
+Create a directory
+```ruby
+directory = Soar::Registry::Directory.new({
+  provider: directory_provider
+})
+```
+
+### Staff UUID IDR
+Search for staff by UUID.
+
+Create an identity provider. (Remember to pass in the directory)
+```ruby
+require 'soar/registry/identity'
+identity_provider = Soar::Registry::Identity::Provider::Staff::Id.new(directory)
+```
+
+Create an IDR
+```ruby
+@id_idr = Soar::Registry::Identity.new(provider: identity_provider)
+```
+
+### Staff Email IDR
+Search for staff by email address. (Remember to pass in the directory)
+```ruby
+require 'soar/registry/identity'
+identity_provider = Soar::Registry::Identity::Provider::Staff::Email.new(directory)
+```
+
+```ruby
+@email_idr = Soar::Registry::Identity.new(provider: identity_provider)
+```
+
+### Getting a list of identifiers
+```ruby
+> identifiers = @id_idr.get_identifiers("identity-820d5660-2204-4f7d-8c04-746313439b81") 
+> 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
+```ruby
+> roles = @id_idr.get_roles("identity-820d5660-2204-4f7d-8c04-746313439b81")
+> roles = @email_idr.get_roles("admin@hetzner.co.za")
+> puts roles.inspect
+["staff", "configuration_publisher", "configuration_consumer"]
+```
+
+### Getting a hash of attributes for a role 
+```ruby
+> role = 'staff'
+> attributes = @id_idr.get_attributes("identity-820d5660-2204-4f7d-8c04-746313439b81", role)
+> attributes = @email_idr.get_attributes("admin@hetzner.co.za", role)
+> puts attributes.inspect
+{
+    "staff": {
+        "department": "technical"
+    }
+}
+
+```
+
+### Getting a hash of all attributes
+```ruby
+> attributes = @id_idr.get_attributes("identity-820d5660-2204-4f7d-8c04-746313439b81")
+> attributes = @email_idr.get_attributes("admin@hetzner.co.za")
+> puts attributes.inspect
+{
+    "identity_id" => "identity-820d5660-2204-4f7d-8c04-746313439b81",
+    "entity_id"=> "entity-bad85eb9-0713-4da7-8d36-07a8e4b00eab",
+    "email"=> "admin@hetzner.co.za",
+    "roles"=> {
+        "staff"=> {},
+        "configuration_publisher"=> {
+            "configuration_identifiers"=> ["*"]
+        },
+        "configuration_consumer"=> {
+            "configuration_identifiers"=> ["*"]
+        }
+    },
+    "address"=> {
+        "detail"=> "Belvedere Office Park, Unit F",
+        "street"=> "Bella Rosa Street",
+        "suburb"=> "Tygervalley",
+        "city"=> "Durbanville",
+        "postal"=> "7550"
+    }
+}
+```
+
+
+## Tests
+
+### Local
+```bash
+$ bundle exec rspec 
+```
+
+### CI
+```bash
+docker-compose --file docker-compose.ci.yml  up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soar-registry-identity-provider-staff" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
+exit $EXIT_CODE;
+```
+
+## Resources
+* [DynamoDBLocal](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html)
+* [Multiple AWS Credentials](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs)
+* [AWS SDK for Ruby](http://docs.aws.amazon.com/amazondynamodb/latest/gettingstartedguide/GettingStarted.Ruby.html)
+
+## References
+* [soar idm](https://github.hetzner.co.za/hetznerZA/soar_idm/blob/master/lib/soar_idm/soar_idm.rb)
+* [Domain analysis](https://docs.google.com/a/hetzner.co.za/drawings/d/1vGdzjKPD3gzn1e0bsC4liFCyxY31Qjjxe3y41beVBzw/edit?usp=sharing)
+* [staff idr](https://github.hetzner.co.za/hetznerZA/idr_staff/blob/master/idr_staff/lib/idr_staff/staff_idr.rb)

data/lib/soar/registry/identity.rb

@@ -0,0 +1,11 @@
+require 'soar/registry/identity/model'
+
+module Soar
+  module Registry
+    module Identity
+      def self.new(provider: nil)
+        Soar::Registry::Identity::Model.new(provider: provider)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'soar/registry/identity/provider/staff/email'
+require 'soar/registry/identity/provider/staff/id'
+
+module Soar
+  module Registry
+    module Identity
+      class Model
+        def initialize(provider: nil)
+          @provider = provider
+        end
+
+        def get_roles(identifier)
+          @provider.get_roles(identifier)
+        end
+
+        def get_attributes(identifier, role = nil)
+          @provider.get_attributes(identifier, role)
+        end
+
+        def get_identifiers(identifier)
+          @provider.get_identifiers(identifier)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+require 'soar_idm/soar_idm'
+require 'soar/registry/identity/provider/staff/translator/default'
+
+module Soar
+  module Registry
+    module Identity
+      module Provider
+        module Staff
+          class Base < SoarIdm::IdmApi
+
+            attr_reader :directory
+            attr_reader :translator
+
+            ##
+            # @param [Hash] configuration
+            ##
+            def initialize(directory)
+              @translator = Soar::Registry::Identity::Provider::Staff::Translator::Default.new
+              @directory = directory
+            end
+
+            ##
+            # @param [Hash] identity
+            # @return [Array] list of roles
+            def calculate_roles(identity)
+              entry = @directory.fetch(identity[@directory.index[0]])
+              return nil if not entry
+              identity = @translator.get_identity(entry)
+              roles = []
+              identity['roles'].each do |role, attributes|
+                roles << role
+              end
+              roles
+            end
+
+            ##
+            # @param [Hash] identity
+            # @return [Array] list of identifiers
+            ##
+            def calculate_identifiers(identity)
+              indexes = @directory.index
+              entry = @directory.fetch(identity[@directory.index[0]])
+              identity = @translator.get_identity(entry)
+              identifiers = []
+              indexes.each { |index| 
+                identifiers << identity[index]
+              }
+              identifiers
+            end
+
+            ## 
+            # @param [Hash] identity
+            # @param [String] role
+            # @return [Hash] A hash of attributes 
+            def calculate_attributes(identity, role)
+              entry = @directory.fetch(identity[@directory.index[0]])
+              return nil if not entry
+              identity = @translator.get_identity(entry)
+              { role => identity['roles'][role] }
+            end 
+
+            ##
+            # @param [Hash] identity
+            # @return [Hash] Hash of attributes keyed by role
+            def calculate_all_attributes(identity)
+              entry = @directory.fetch(identity[@directory.index[0]])
+              @translator.get_identity(entry)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'soar/registry/identity/provider/staff/base'
+
+module Soar
+  module Registry
+    module Identity
+      module Provider
+        module Staff
+          class Email < Base
+
+            ##
+            # @param [String] identifier, an email address that uniquely identifies an identity
+            # @return [Hash] an identity
+            ##
+            def calculate_identities(identifier)
+              entries = @directory.search("email", identifier )
+              return [@translator.get_identity(entries)[0]]
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require 'soar/registry/identity/provider/staff/base'
+
+module Soar
+  module Registry
+    module Identity
+      module Provider
+        module Staff
+          class Id < Base
+
+            ##
+            # @param [String] identifier, a primary key that uniquely identifies an identity
+            # @return [Hash] an identity
+            ##
+            def calculate_identities(identifier)
+              return [@translator.get_identity(@directory.fetch(identifier))]
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/soar/registry/identity/provider/staff/translator/default.rb

@@ -0,0 +1,31 @@
+module Soar
+  module Registry
+    module Identity
+      module Provider
+        module Staff
+          module Translator
+            class Default
+
+              ##
+              # @param [Hash] entry a single entry from datasource
+              # @returns [Hash] identity a single identity
+              ##
+              def get_identity(entry)
+                return entry
+              end
+
+              ##
+              # @param [Array] entries a list of entries from data source
+              # @return [Array] identities a list of identities
+              ##
+              def get_identities(entries)
+                return entries
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/soar/registry/identity/test/fixtures/entries.json

@@ -0,0 +1,60 @@
+[
+    {
+        "uuid": "identity-62936e70-1815-439b-bf89-8492855a7e6b",
+        "entity_id": "entity-2d931510-d99f-494a-8c67-87feb05e1594",
+        "email": "test+publisher@hetzner.co.za",
+        "roles": {
+            "staff": {
+                "department": "technical"
+            },
+            "configuration_publisher": {
+                "configuration_identifiers": ["*"]
+            }
+        }
+    }, 
+    {
+        "uuid": "identity-43353f18-8afe-11e6-ae22-56b6b6499611",
+        "entity_id": "entity-2d931510-d99f-494a-8c67-87feb05e1594",
+        "email": "test+consumer@hetzner.co.za",
+        "roles": {
+            "staff": {},
+            "configuration_consumer": {
+                "configuration_identifiers": ["*"]
+            }
+
+        }
+    }, 
+    {
+        "uuid": "identity-820d5660-2204-4f7d-8c04-746313439b81",
+        "entity_id": "entity-bad85eb9-0713-4da7-8d36-07a8e4b00eab",
+        "email": "admin@hetzner.co.za",
+        "roles": {
+            "staff": {},
+            "configuration_publisher": {
+                "configuration_identifiers": ["*"]
+            },
+            "configuration_consumer": {
+                "configuration_identifiers": ["*"]
+            }
+
+        },
+        "address": {
+            "detail": "Belvedere Office Park, Unit F",
+            "street": "Bella Rosa Street",
+            "suburb": "Tygervalley",
+            "city": "Durbanville",
+            "postal": "7550"
+        }
+    },
+    {
+        "uuid": "identity-1ff472a6-8df3-4f13-82c3-89fde26db3cf",
+        "entity_id": "entity-bad85eb9-0713-4da7-8d36-07a8e4b00eab",
+        "email": "none@example.com",
+        "client_nr": "C123456789",
+        "roles": {
+            "customer": {},
+            "reseller": {}
+        }
+    }
+]
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: soar-registry-identity
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charles Mulder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: soar_idm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: soar-registry-directory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: Registry of identities
+email: charles.mulder@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/soar/registry/identity.rb
+- lib/soar/registry/identity/model.rb
+- lib/soar/registry/identity/provider/staff/base.rb
+- lib/soar/registry/identity/provider/staff/email.rb
+- lib/soar/registry/identity/provider/staff/id.rb
+- lib/soar/registry/identity/provider/staff/translator/default.rb
+- lib/soar/registry/identity/test/fixtures/entries.json
+homepage: https://gitlab.host-h.net/registries/identity
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Identity Registry
+test_files: []