soar-registry-directory 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74f2f96f3112e94b32dbdf1df3158d4a7c90c243
+  data.tar.gz: bc374da550aeac5dfb1141a3e306aa6d3c2e0bbc
+SHA512:
+  metadata.gz: c685cac5ebf8519e8115d4f3fbb96860c3221caf1f01a4f60600e4700201f9effc54bd73cbe4fb80b1d0c8f493526f556ca59c720fd28f8db8260e81b01f2401
+  data.tar.gz: 598ec60e756b7a7d185d679632c7ea1649fee116d6e78d7792956ff1c824a277790fa9fedd9d3fe45dbe6e8fe33517549dacc0da999211ae42248c3eaa652f03

data/README.md

@@ -0,0 +1,82 @@
+# Soar::Registry::Directory
+
+Directory model and providers used by soar registries
+
+## Quick start
+
+### Example data
+
+```json
+"mytable": [{
+  "uuid": "1",
+  "email": "test1@example.com"
+}, {
+  "uuid": "2",
+  "email": "test2@example.com"
+}]
+
+```
+
+### Stub provider
+Create an instance of the stub provider by passing in the name, primary key and indexes of your table.
+```ruby
+> require 'soar/registry/directory'
+> provider = Soar::Registry::Directory::Provider::Stub.new({
+    table: "mytable",
+    primary_key: "uuid",
+    index: ["uuid", "email"] 
+})
+```
+### DynamodDb Provider
+```ruby
+> provider = Soar::Registry::Directory::Provider::DynamoDb.new({
+    credentials: {
+        username: "username",
+        password: "secret"
+    },
+    table: "mytable",
+    index: ['uuid', 'email'],
+    primary_key: "uuid",
+    configuration: {
+        region: 'us-west-2'
+        endpoint: 'http://localhost:8000'
+    }
+})
+
+```
+
+### The Model
+```ruby
+> directory = Soar::Registry::Directory.new(provider: provider)
+```
+
+## Tests
+
+### Stub provider
+
+#### Local
+```bash
+$ cucumber
+```
+
+#### CI
+```bash
+docker-compose --file docker-compose.stub.yml up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soar-registry-directory-test-provider-stub" -q | xargs docker inspect -f "{{ .State.ExitCode }}")
+exit $EXIT_CODE 
+```
+
+### DynamoDb provider
+
+#### Local
+```bash
+$ docker-compose --file docker-compose.dynamo_db.yml up
+$ CONFIG_FILE=config.dynamo_db.yml TEST_PROVIDER=DynamoDb cucumber
+```
+
+#### CI
+```bash
+docker-compose --file docker-compose.ci.dynamo_db.yml up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soar-registry-directory-test-provider-dynamo_db" -q | xargs docker inspect -f "{{ .State.ExitCode }}")
+exit $EXIT_CODE 
+```

data/lib/soar/registry/directory/error.rb

@@ -0,0 +1,9 @@
+module Soar
+  module Registry
+      module Directory
+        module Error
+          class NoEntriesFound < StandardError; end;
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+require 'soar/registry/directory/error'
+require 'soar/registry/directory/provider/stub'
+require 'soar/registry/directory/provider/dynamo_db'
+
+module Soar
+  module Registry
+    module Directory
+      class Model 
+
+        attr_reader :provider
+
+        ##
+        # @param provider [Soar::Registry::Directory::Provider::Stub|Soar::Registry::Directory::Provider::DynamoDb] object
+        ##
+        def initialize(provider: nil)
+          @provider = provider
+        end
+
+        ##
+        # @param entity [Hash]
+        ##
+        def put(entity)
+          @provider.put(entity)
+        end
+
+        ##
+        # @param primary_key [String] 
+        # @return [Hash] the identity
+        # @raise [Soar::Registry:::Directory::Error::NoEntriesFound] if primary key not found
+        ##
+        def fetch(primary_key)
+          @provider.fetch(primary_key)
+        end
+
+        ##
+        # @param key [String] attribute name
+        # @param value [String] attribute value
+        # @return [Array] list of entries
+        ##
+        def search(key, value)
+          @provider.search(key, value)
+        end
+
+        ##
+        # @return [Array] a list of primary keys and global secondary indexes
+        ##
+        def index
+          @provider.index
+        end
+
+      end
+    end
+  end
+end

data/lib/soar/registry/directory/provider/dynamo_db.rb

@@ -0,0 +1,118 @@
+require 'aws-sdk'
+require 'hashie'
+require 'soar/registry/directory/error'
+
+module Soar
+  module Registry
+    module Directory
+      module Provider
+        class DynamoDb 
+
+          LIMIT = 10
+          attr_reader :client
+
+          ##
+          # @param credentials [Hash] { username: 'username', password: 'secret'}
+          # @param table [String]
+          # @param primary_key [String]
+          # @param index [Array] primary key should be the first item
+          # @param configuration [Hash] { region: 'us-west-2', endpoint: 'http://localhost:8000' }
+          ##
+          def initialize(credentials: nil, table: nil, primary_key: nil, index: nil, configuration: nil)
+            @table_name = table
+            @primary_key = primary_key
+            @index = index
+            @credentials = Hashie.symbolize_keys(credentials)
+            configuration[:credentials] = Aws::Credentials.new(@credentials[:username], @credentials[:password])
+            @client = Aws::DynamoDB::Client.new(Hashie.symbolize_keys(configuration))
+          end
+
+          ##
+          ##
+          def put(entity)
+            @client.put_item({
+              table_name: @table_name,
+              item: entity
+            })
+          end
+
+          ##
+          # @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(primary_key)
+            options = {
+              table_name: @table_name,
+              key: {
+                "#{@primary_key}": primary_key
+              }
+            }
+            identity = @client.get_item(options)
+            raise Soar::Registry::Directory::Error::NoEntriesFound 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(key, value)
+            options = {
+              table_name: @table_name,
+              select: 'ALL_ATTRIBUTES',
+              limit: LIMIT,
+              key_condition_expression: "#{key} = :value",
+              expression_attribute_values: {
+                ":value": value 
+              }
+            }
+
+            options.merge!({index_name: "#{key}_index"}) if @index.include?(key)
+            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 index
+            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
+
+          ##
+          # Deletes existing table and creates a new one in its place
+          # @param name [String] table name
+          # @param structure [Hash] table structure
+          ##
+          def recreate_table(name: nil, structure: nil)
+
+            if @client.list_tables.table_names.include?(name) 
+              @client.delete_table({
+                table_name: name
+              })
+            end
+            @client.create_table(Hashie.symbolize_keys(structure))
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/soar/registry/directory/provider/stub.rb

@@ -0,0 +1,73 @@
+require 'soar/registry/directory/error'
+require 'hashie'
+require 'mince'
+require 'hashy_db'
+
+module Soar
+  module Registry
+    module Directory
+      module Provider
+        class Stub
+
+          @@interface = Mince::HashyDb::Interface
+
+          ##
+          # @param table [String] table name
+          # @param primary_key [String]
+          # @param index [Array] primary key should be the first item 
+          ##
+          def initialize(table: nil, primary_key: nil, index: nil)
+            @table = table
+            @primary_key = primary_key
+            @index = index
+            @@interface.clear
+          end
+
+          ##
+          # @param entity [Hash]
+          ##
+          def put(entity)
+            @@interface.add(@table, entity)
+          end
+
+          ##
+          # @param uuid [String]
+          # @return entry [Hash] 
+          # @raise [Soar::Registry:::Directory::Error::NoEntriesFound] if primary key not found
+          ##
+          def fetch(primary_key)
+            entry = @@interface.get_for_key_with_value(@table, @primary_key, primary_key)
+            raise Soar::Registry::Directory::Error::NoEntriesFound if entry.nil?
+            entry
+          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(key, value)
+            identities = []
+            @@interface.find_all(@table).each { |identity| 
+              if identity[key] == value
+                identities << identity
+              else
+                next
+              end
+            }
+            identities
+          end
+
+          ##
+          # @return [Array] a list of primary keys and global secondary indexes
+          ##
+          def index
+            @index
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/soar/registry/directory/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": {}
+        }
+    }
+]
+

data/lib/soar/registry/directory/test/fixtures/table_structure.json

@@ -0,0 +1,63 @@
+{
+    "table_name": "identities",
+    "key_schema": [
+        {
+            "attribute_name": "uuid",
+            "key_type": "HASH" 
+        }
+    ],
+    "attribute_definitions": [
+        {
+            "attribute_name": "uuid",
+            "attribute_type": "S"
+        },
+        {
+            "attribute_name": "entity_id",
+            "attribute_type": "S"
+        },
+        {
+            "attribute_name": "email",
+            "attribute_type": "S"
+        }
+    ],
+    "global_secondary_indexes": [
+        {
+            "index_name": "email_index",
+            "key_schema": [
+            {
+                "attribute_name": "email",
+                "key_type": "HASH"
+            }
+            ],
+            "projection": {
+                "projection_type": "ALL"
+
+            },
+            "provisioned_throughput": { 
+                "read_capacity_units": 10,
+                "write_capacity_units": 10
+            }
+        },
+        {
+            "index_name": "entity_id_index",
+            "key_schema": [
+            {
+                "attribute_name": "entity_id",
+                "key_type": "HASH"
+            }
+            ],
+            "projection": {
+                "projection_type": "ALL"
+
+            },
+            "provisioned_throughput": { 
+                "read_capacity_units": 10,
+                "write_capacity_units": 10
+            }
+        }
+    ],
+    "provisioned_throughput": { 
+        "read_capacity_units": 10,
+        "write_capacity_units": 10
+    }
+}

data/lib/soar/registry/directory/test/orchestrator.rb

@@ -0,0 +1,67 @@
+require 'soar/registry/directory/test/provider/stub'
+require 'soar/registry/directory/test/provider/dynamo_db'
+
+module Soar
+  module Registry
+    module Directory
+      module Test
+        class Orchestrator
+
+          def initialize(provider)
+            raise ArgumentError if provider.nil?
+            @provider = provider
+          end
+
+          def given_existing_data
+            @provider.given_existing_data
+          end
+
+          def given_configured_directory
+            @provider.given_configured_directory
+          end
+
+          def put_entry
+            @provider.put_entry
+          end
+
+          def search_for_entry
+            @provider.search_for_entry
+          end
+
+          def fetch_entry
+            @provider.fetch_entry
+          end
+
+          def request_index
+            @provider.request_index
+          end
+
+          def persisted?
+            @provider.persisted?
+          end
+
+          def returned?
+            @provider.returned?
+          end
+
+          def index?
+            @provider.index?
+          end
+
+          def single_entry?
+            @provider.single_entry?
+          end
+
+          def no_entries_found?
+            @provider.no_entries_found?
+          end
+
+          def no_matching_entries?
+            @provider.no_matching_entries?
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/soar/registry/directory/test/provider/dynamo_db.rb

@@ -0,0 +1,89 @@
+require 'soar/registry/directory'
+
+module Soar
+  module Registry
+    module Directory
+      module Test
+        module Provider
+          class DynamoDb
+
+            def initialize
+              @configuration = YAML.load_file("config/#{ENV['CONFIG_FILE']}")
+              @table = @configuration['provider']['table']['name']
+              @index = @configuration['provider']['table']['index'] 
+              @entries = JSON.parse(File.read("lib/soar/registry/directory/test/fixtures/entries.json"))
+            end
+
+            def given_configured_directory
+              @directory = Soar::Registry::Directory.new({
+                provider: Soar::Registry::Directory::Provider::DynamoDb.new({
+                  credentials: @configuration['provider']['credentials'], 
+                  table: @table,
+                  index: @index,
+                  primary_key: @index[0],
+                  configuration: @configuration['provider']['config']
+                })
+              })
+              @directory.provider.recreate_table({
+                name: @table, 
+                structure: JSON.parse(File.read("lib/soar/registry/directory/test/fixtures/table_structure.json"))
+              })
+            end
+
+            def given_existing_data
+              @entries.each{ |entry| 
+                @directory.put(entry)
+              }
+            end
+
+            def put_entry
+              @directory.put(@entries[0])
+            end
+
+            def search_for_entry
+              @result = @directory.search("email", @entries[0]['email'])
+            end
+
+            def request_index
+              @result = @directory.index
+            end
+
+            def fetch_entry
+              begin
+                @result = @directory.fetch(@entries[0]['uuid'])
+              rescue Soar::Registry::Directory::Error::NoEntriesFound
+                @error = true
+              end
+            end
+
+            def persisted?
+              @entries[0] == @directory.fetch(@entries[0]["uuid"])
+            end
+
+            def returned?
+              @result == [@entries[0]]
+            end
+
+            def index?
+              @result == @index
+            end
+
+            def single_entry?
+              @result == @entries[0]
+            end
+
+            def no_entries_found?
+              @error
+            end
+
+            def no_matching_entries?
+              @result == []
+            end
+
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/soar/registry/directory/test/provider/stub.rb

@@ -0,0 +1,81 @@
+require 'soar/registry/directory'
+
+module Soar
+  module Registry
+    module Directory
+      module Test
+        module Provider
+          class Stub
+
+            @@entry = {
+              "uuid" => SecureRandom.uuid,
+              "identifier" => SecureRandom.hex
+            }
+
+            @@index = ["identity_id", "email", "entity_id"]
+
+            def given_configured_directory
+              @directory = Soar::Registry::Directory.new({
+                provider: Soar::Registry::Directory::Provider::Stub.new({
+                  table: "identities",
+                  primary_key: "uuid",
+                  index: @@index
+                })
+              })
+            end
+
+            def given_existing_data
+              @directory.put(@@entry)
+            end
+
+            def put_entry
+              @directory.put(@@entry)
+            end
+
+            def search_for_entry
+              @entry = @directory.search("identifier", @@entry['identifier'])
+            end
+
+            def request_index
+              @index = @directory.index
+            end
+
+            def fetch_entry
+              begin
+                @entry = @directory.fetch(@@entry['uuid'])
+              rescue Soar::Registry::Directory::Error::NoEntriesFound
+                @error = true
+              end
+            end
+
+            def persisted?
+              @@entry == @directory.fetch(@@entry["uuid"])
+            end
+
+            def returned?
+              @entry == [@@entry]
+            end
+
+            def index?
+              @index == @@index
+            end
+
+            def single_entry?
+              @entry == @@entry
+            end
+
+            def no_entries_found?
+              @error
+            end
+
+            def no_matching_entries?
+              @entry == []
+            end
+
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/soar/registry/directory.rb

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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: soar-registry-directory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charles Mulder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-30 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: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.6
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.28
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.28
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.6
+description: Directories for soar registries
+email: charles.mulder@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/soar/registry/directory.rb
+- lib/soar/registry/directory/error.rb
+- lib/soar/registry/directory/model.rb
+- lib/soar/registry/directory/provider/dynamo_db.rb
+- lib/soar/registry/directory/provider/stub.rb
+- lib/soar/registry/directory/test/fixtures/entries.json
+- lib/soar/registry/directory/test/fixtures/table_structure.json
+- lib/soar/registry/directory/test/orchestrator.rb
+- lib/soar/registry/directory/test/provider/dynamo_db.rb
+- lib/soar/registry/directory/test/provider/stub.rb
+homepage: https://gitlab.host-h.net/registries/directory
+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: Soar Registry Directory
+test_files: []