soar-authentication-identity 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 921b00f418350cbcf3502a43b74e2092060ef9e9
+  data.tar.gz: bc6ed7553575ff5d8a46eda43d0bfd9f65794bc7
+SHA512:
+  metadata.gz: 6d1af45bee7f55541161938a3f85bc07ba9464b18b7510af40c7bc5f63ab287af0fc1423eaa3f295ffcd1ae78ff48ec3c9facab9df1672ea76be9cfd196622b2
+  data.tar.gz: a74b19be7d9060c72aedad3ca20a1ef3922120d5ac34713a900071c4ec5559a5df2e7dee31178f696ead0df3961d33cb5ac75cc3808af6c8e44f9a64db2e7783

data/.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |spec|
+  spec.name          = "soar-authentication-identity"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Charles Mulder"]
+  spec.email         = ["charles.mulder@hetzner.co.za"]
+
+  spec.summary       = %q{ Translate an identifier into a UUID}
+  spec.homepage      = "https://github.com/hetznerZA/soar-authentication-identity"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'soar-registry-identity', '~> 1.0'
+  spec.add_runtime_dependency 'soar-registry-directory', '~> 1.0'
+end

data/.gitignore

@@ -0,0 +1,22 @@
+*.swp
+*.swo
+# Used by dotenv library to load environment variables.
+# .env
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+soar-authentication-identity

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.3
+WORKDIR /usr/local/src
+ADD Gemfile .gemspec /usr/local/src/
+RUN bundle install --without development --with test
+ADD . /usr/local/src/
+CMD bundle exec cucumber
+

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soar-uuid.gemspec
+gemspec
+
+group :test do
+  gem 'cucumber', '~> 2.4'
+  gem 'rspec-expectations', '~> 3.5'
+end

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    soar-authentication-identity (0.0.0)
+      soar-registry-directory (~> 1.0)
+      soar-registry-identity (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.22.5)
+      activesupport (= 3.2.22.5)
+      builder (~> 3.0.0)
+    activesupport (3.2.22.5)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    aws-sdk (2.6.32)
+      aws-sdk-resources (= 2.6.32)
+    aws-sdk-core (2.6.32)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.6.32)
+      aws-sdk-core (= 2.6.32)
+    aws-sigv4 (1.0.0)
+    builder (3.0.4)
+    cucumber (2.4.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.5.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 4.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.2.5)
+    gherkin (4.0.0)
+    hashie (3.4.6)
+    hashy_db (2.1.0)
+    i18n (0.7.0)
+    jmespath (1.3.1)
+    jsender (0.2.2)
+    mince (2.3.0)
+      activemodel (~> 3.0)
+      activesupport (~> 3.0)
+    multi_json (1.12.1)
+    multi_test (0.1.2)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    soar-registry-directory (1.0.0)
+      aws-sdk (~> 2.6, >= 2.6.6)
+      aws-sdk-core (~> 2.6, >= 2.6.28)
+      hashie (~> 3.4, >= 3.4.6)
+      hashy_db (~> 2.1)
+      mince (~> 2.3)
+    soar-registry-identity (1.0.0)
+      soar-registry-directory (~> 1.0.0)
+      soar_idm (~> 0.0.2)
+    soar_idm (0.0.2)
+      jsender
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber (~> 2.4)
+  rspec-expectations (~> 3.5)
+  soar-authentication-identity!
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -0,0 +1,50 @@
+# soar-authentication-identity
+Used by authentication service to translate an identity identifier into an UUID
+
+[Domain analysis](https://docs.google.com/a/hetzner.co.za/drawings/d/1b50Ml3PLQd25SYxKIiaZ7sIUxHwXx2c0muBZauYDnwA/edit?usp=sharing)
+
+## Quickstart
+
+### Staff identity provider
+```ruby
+> identity = Soar::Authentication::Identity::Factory.create(authenticated_identifier: 'staff@hetzner.co.za')
+> puts identity.uuid
+"85777bfa-b743-4ba9-8308-e8a1e4d44fbe"
+```
+
+## Tests
+
+### Local
+
+#### Stub identity provider
+```bash
+$ TEST_ORCHESTRATION_PROVIDER=Stub cucumber
+```
+
+#### Staff identity provider
+```bash
+$ TEST_ORCHESTRATION_PROVIDER=Staff cucumber
+```
+
+#### Customer identity provider
+Not implemented
+
+#### Domain identity provider
+Not implemented
+
+### CI
+
+#### Stub identity provider
+```bash
+docker-compose --file docker-compose.stub.yml up --abort-on-container-exit --remove-orphans
+EXIT_CODE=$(docker ps -a -f "name=soar-authentication-identity-provider-stub" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
+exit $EXIT_CODE;
+```
+
+#### Staff identity provider
+```bash
+docker-compose --file docker-compose.staff.yml up --abort-on-container-exit --remove-orphans
+EXIT_CODE=$(docker ps -a -f "name=soar-authentication-identity-provider-staff" -q | xargs docker inspect -f "{{ .State.ExitCode }}");
+exit $EXIT_CODE;
+```
+

data/Rakefile

@@ -0,0 +1,14 @@
+task :default => :test
+
+task :test do
+  Rake::Task['rspec'].execute
+  Rake::Task['cucumber'].execute
+end
+
+task :rspec do
+  `rspec`
+end
+
+task :cucumber do
+  `cucumber`
+end

data/config/config.yml

@@ -0,0 +1,7 @@
+provider:
+  class: 'Soar::Registry::Staff::Directory::Stub'
+  config: 
+    endpoint: 'stub'
+  credentials:
+    username: 'username'
+    password: 'secret'

data/docker-compose.staff.yml

@@ -0,0 +1,13 @@
+version: "2"
+services:
+    tests:
+        build: 
+            context: .
+        image: soar-authentication-identity-provider-staff
+        container_name: soar-authentication-identity-provider-staff
+        environment:
+            - TEST_ORCHESTRATION_PROVIDER=Staff
+
+
+
+

data/docker-compose.stub.yml

@@ -0,0 +1,13 @@
+version: "2"
+services:
+    tests:
+        build: 
+            context: .
+        image: soar-authentication-identity-provider-stub
+        container_name: soar-authentication-identity-provider-stub
+        environment:
+            - TEST_ORCHESTRATION_PROVIDER=Stub
+
+
+
+

data/lib/soar/authentication/identity/error.rb

@@ -0,0 +1,13 @@
+
+module Soar
+  module Authentication
+    module Identity
+      module Error
+        class UnknownIdentityError < StandardError
+        end
+      end
+    end
+  end
+end
+
+

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

@@ -0,0 +1,41 @@
+require 'soar/authentication/identity'
+
+module Soar
+  module Authentication
+    module Identity
+      module Factory
+
+        ##
+        # @param authenticated_identifier [String]
+        # @raise [ArgumentError]
+        # @return [Soar::Authentication::Identity::Model]
+        ##
+        def self.create(directory: nil, authenticated_identifier: nil)
+          raise ArgumentError if authenticated_identifier.nil? or directory.nil?
+          provider = get_provider(directory, authenticated_identifier)
+          Soar::Authentication::Identity.new(provider)
+        end
+
+        private
+
+        def self.get_provider(directory, authenticated_identifier)
+          case authenticated_identifier
+            when /@hetzner.co.za\z/
+              Soar::Authentication::Identity::Provider::Staff.new({
+                directory: directory,
+                authenticated_identifier: authenticated_identifier
+              })
+            when /D\d*$/
+              raise NotImplementedError, 'Domain identities require an implementation'
+            when /^[CF]{0,1}\d*$/
+              raise NotImplementedError, 'Customer identities require an implementation'
+            else
+              raise Soar::Authentication::Identity::Error::UnknownIdentityError, 'Unknown identity'
+          end
+          
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'soar/authentication/identity/error'
+require 'soar/authentication/identity/provider/staff'
+require 'soar/authentication/identity/provider/stub'
+
+module Soar
+  module Authentication
+    module Identity
+      class Model
+        
+        def initialize(provider)
+          @provider = provider
+        end
+
+        def uuid
+          @provider.uuid
+        end
+
+      end
+    end
+  end
+end

data/lib/soar/authentication/identity/provider/staff.rb

@@ -0,0 +1,25 @@
+require 'soar/registry/identity'
+
+module Soar
+  module Authentication
+    module Identity
+      module Provider
+        class Staff
+
+          def initialize(directory: nil, authenticated_identifier: nil)
+            @directory = directory
+            identity_provider = Soar::Registry::Identity::Provider::Staff::Email.new(directory: @directory)
+            identity_registry = Soar::Registry::Identity.new(identity_provider)
+            @attributes = identity_registry.get_attributes(authenticated_identifier)
+          end
+
+          def uuid
+            primary_key = @directory.index[0]
+            @attributes[primary_key]
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/soar/authentication/identity/provider/stub.rb

@@ -0,0 +1,23 @@
+require 'soar/registry/identity'
+
+module Soar
+  module Authentication
+    module Identity
+      module Provider
+        class Stub
+
+          def initialize(directory: nil, authenticated_identifier: nil)
+            @directory = directory
+            @entries = @directory.search("identifier", authenticated_identifier)
+          end
+
+          def uuid
+            primary_key = @directory.index[0]
+            @entries[0][primary_key]
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/soar/authentication/identity/test/orchestration_provider/staff.rb

@@ -0,0 +1,65 @@
+require 'soar/authentication/identity/factory'
+require 'soar/registry/directory'
+require 'securerandom'
+
+module Soar
+  module Authentication
+    module Identity 
+      module Test
+        module OrchestrationProvider
+          class Staff
+
+            def initialize()
+              directory_provider = Soar::Registry::Directory::Provider::Stub.new({
+                table: "mytable",
+                primary_key: "uuid",
+                index: ["uuid", "email"] 
+              })
+              @directory = Soar::Registry::Directory.new(directory_provider)
+
+            end
+
+            ##
+            # @return [Nil]
+            ##
+            def given_existing_identity
+
+              @entry = {
+                "uuid" => SecureRandom.uuid,
+                "email" => 'test@hetzner.co.za'
+              }
+
+              @directory.put(@entry)
+
+            end
+
+            ##
+            # @return [Nil]
+            ##
+            def given_authenticated_identifier
+              @identity = Soar::Authentication::Identity::Factory.create({
+                directory: @directory, 
+                authenticated_identifier: @entry["email"]
+              })
+            end
+
+            ##
+            # @return [Nil]
+            ##
+            def request_uuid
+              @identity.uuid
+            end
+
+            ##
+            # @return [Boolean]
+            ##
+            def uuid?
+              @entry["uuid"] == @identity.uuid
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/soar/authentication/identity/test/orchestration_provider/stub.rb

@@ -0,0 +1,64 @@
+require 'soar/registry/directory'
+require 'soar/authentication/identity'
+require 'securerandom'
+
+module Soar
+  module Authentication
+    module Identity 
+      module Test
+        module OrchestrationProvider
+          class Stub
+
+            def initialize()
+              directory_provider = Soar::Registry::Directory::Provider::Stub.new({
+                table: "mytable",
+                primary_key: "uuid",
+                index: ["uuid", "identifier"] 
+              })
+              @directory = Soar::Registry::Directory.new(directory_provider)
+            end
+
+            ##
+            # @return [Nil]
+            ##
+            def given_existing_identity
+
+              @entry = {
+                "uuid" => SecureRandom.uuid,
+                "identifier" => 'test@hetzner.co.za'
+              }
+
+              @directory.put(@entry)
+            end
+
+            ##
+            # @return [Nil]
+            ##
+            def given_authenticated_identifier
+              identity_provider = Soar::Authentication::Identity::Provider::Stub.new({
+                directory: @directory,
+                authenticated_identifier: @entry['identifier']
+              })
+              @identity = Soar::Authentication::Identity::new(identity_provider)
+            end
+
+            ##
+            # @return [Nil]
+            ##
+            def request_uuid
+              @identity.uuid
+            end
+
+            ##
+            # @return [Boolean]
+            ##
+            def uuid?
+              @entry["uuid"] == @identity.uuid
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/soar/authentication/identity/test/orchestrator.rb

@@ -0,0 +1,45 @@
+require 'securerandom'
+
+module Soar
+  module Authentication
+    module Identity
+      module Test
+        class Orchestrator
+
+          def initialize(provider)
+            @provider = provider
+          end
+
+          ##
+          # @return [Nil]
+          ##
+          def given_existing_identity
+            @provider.given_existing_identity
+          end
+
+          ##
+          # @return [Nil]
+          ##
+          def given_authenticated_identifier
+            @provider.given_authenticated_identifier
+          end
+
+          ##
+          # @return [Nil]
+          ##
+          def request_uuid
+            @provider.request_uuid
+          end
+
+          ##
+          # @return [Boolean]
+          ##
+          def uuid?
+            @provider.uuid?
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/soar/authentication/identity.rb

@@ -0,0 +1,14 @@
+require 'soar/authentication/identity/model'
+require 'soar/authentication/identity/error'
+
+module Soar
+  module Authentication
+    module Identity
+
+      def self.new(provider)
+        Soar::Authentication::Identity::Model.new(provider)
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: soar-authentication-identity
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charles Mulder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: soar-registry-identity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: soar-registry-directory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- charles.mulder@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemspec"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- config/config.yml
+- docker-compose.staff.yml
+- docker-compose.stub.yml
+- lib/soar/authentication/identity.rb
+- lib/soar/authentication/identity/error.rb
+- lib/soar/authentication/identity/factory.rb
+- lib/soar/authentication/identity/model.rb
+- lib/soar/authentication/identity/provider/staff.rb
+- lib/soar/authentication/identity/provider/stub.rb
+- lib/soar/authentication/identity/test/orchestration_provider/staff.rb
+- lib/soar/authentication/identity/test/orchestration_provider/stub.rb
+- lib/soar/authentication/identity/test/orchestrator.rb
+homepage: https://github.com/hetznerZA/soar-authentication-identity
+licenses: []
+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: Translate an identifier into a UUID
+test_files: []