soar-registry-directory 5.0.2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dea4c5efb18d2280d073f6bce679b804f623360
-  data.tar.gz: 0ac2542962c087002260057a9f3e9defc87fc69d
+  metadata.gz: c32931eb5c662b57a167f89e9f37641f1069b9f2
+  data.tar.gz: 1bd2a2a6fd37c124228ec8e2fa656324a78250fb
 SHA512:
-  metadata.gz: 4e374679b5f7f74d35083bb4f6980af26559592c89922b1ca9360f940c156b681604dae1ddeab323058299f5c57e549bca2fc7636237a18b6f651bd5645db4c7
-  data.tar.gz: 5386f8ff844f3242fba8cd3c42e1f600ce1a885ca1455a50ff332dcd0e4b95437d57192dd6a97382c9bfc6e1551dad75c3c6a67729c92a8cb6baf9dd7b694301
+  metadata.gz: 3f8c0d59dedfae89eed3d4fc0bfbb942c4cf583351761cfc1805fb28eb16537e0efb9197512c06cc163d24ce507292a2b94a98c2346a24d2c65941665e11fd0c
+  data.tar.gz: b2cf12ef9732c39407ff2796daca5266c60bce849688119dd6b16e3a7acb7f7d833146a36bab77d11483767346825fe152df5307a188b8e05231a7c9a0000c62

data/README.md

@@ -7,13 +7,16 @@ Directory model and providers used by soar registries
 ### Example data
 
 ```json
-"mytable": [{
-  "uuid": "1",
-  "email": "test1@example.com"
-}, {
-  "uuid": "2",
-  "email": "test2@example.com"
-}]
+mytable = [
+  {
+    "uuid": "1",
+    "email": "test1@example.com"
+  }, 
+  {
+    "uuid": "2",
+    "email": "test2@example.com"
+  }
+]
 
 ```
 
@@ -30,22 +33,22 @@ Create an instance of the stub provider by passing in the name, primary key and
 ```ruby
 > provider = Soar::Registry::Directory::Provider::DynamoDb.new({
     table: {
-        name: 'identity_roles'
-        index: {
-            partition_key: 'partition_key'
-            sort_key: 'sort_key'
-            global_secondary_index: ['global_secondary_index1']
+        'name' => 'identity_roles'
+        'index' => {
+            'partition_key' => 'partition_key'
+            'sort_key ' => 'sort_key'
+            'global_secondary_index' => ['global_secondary_index1']
         }
     },
     configuration: {
-      region: 'us-west-2'
-      endpoint: 'http://localhost:8000'
-      http_read_timeout: 1, 
-      retry_limit: 0
+      'region' => 'eu-west-1'
+      'endpoint' => 'http://localhost:8000'
+      'http_read_timeout' => 1, 
+      'retry_limit' => 0
     },
     credentials: {
-        username: 'username'
-        password: 'secret'
+        'username' => 'username'
+        'password' => 'secret'
     }
 })
 
@@ -62,15 +65,15 @@ $ sudo apt-get install libmysqlclient-dev
 > provider = Soar::Registry::Directory::Provider::Mysql.new({
     index: ['ID', 'Client_Number', 'Notifyemail_Invoice', 'Login'],
     config: {
-      database: 'konsoleh_genie'
-      table: 'Client'
-      host: '0.0.0.0'
-      port: 3306
+      'database' => 'konsoleh_genie'
+      'table' => 'Client'
+      'host' => '0.0.0.0'
+      'port' => 3306
     },
     attributes: ['Client_Number', 'Notifyemail_Invoice'],
     credentials: {
-      username: 'genie'
-      password: 'secret'
+      'username' => 'genie'
+      'password' => 'secret'
     }
 })
 ```
@@ -81,20 +84,20 @@ Please note: The mysql dump of the genie database structure is out of date. Upda
 
 ```ruby
 > provider = Soar::Registry::Directory::Provider::Ldap.new({
-    base: 'dc=hetzner,dc=co,dc=za',
-    index: [:entryuuid, :mail],
+    base: 'ou=people,dc=hetzner,dc=co,dc=za',
+    index: ['entryuuid', 'mail'],
     config: {
-      host: 'localhost',
-      port: 636
+      'host' => 'localhost',
+      'port' => 636
     },
     attributes: ['entryuuid', 'cn', 'mail', 'sn'],
     credentials: {
-      username: 'cn=admin,dc=hetzner,dc=co,dc=za'
-      password: 'secret'
+      'username' => 'cn=admin,dc=hetzner,dc=co,dc=za'
+      'password' => 'secret'
     }
 })
 ```
-Please note: Primary key is assumed to be the first element of index array. 
+Please note: Primary key is assumed to be the first element of the index array. 
 
 Command to test secure LDAP connection from terminal.
 ```bash

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

@@ -12,31 +12,31 @@ module Soar
           attr_accessor :client
 
           ##
-          # @param [Hash] credentials
-          # @option credentials [String] :username
-          # @option credentials [String] :password
-          # @param [String] table table name
-          # @param [Hash] index 
-          # @option index [String] :partition_key
-          # @option index [String] :sort_key
-          # @option index [Array] :global_secondary_indexes
-          # @param configuration [Hash]
-          # @option configuration [String] :region
-          # @option configuration [String] :endpoint
+          # @param [Hash{String => String}] credentials
+          # @option credentials [String] username
+          # @option credentials [String] password
+          # @param [Hash{String => String}] table 
+          # @option table [String] name
+          # @option table [Hash{String => String}] index
+          #   * partition_key (String) 
+          #   * sort_key (String)
+          #   * global_secondary_indexes (Array<String>)
+          # @param [Hash{String => String}] configuration
+          # @option configuration [String] region
+          # @option configuration [String] endpoint
           ##
           def initialize(credentials: , table: , configuration: )
-            @table_name = table[:name]
-            index = table[:index]
-            @partition_key = index[:partition_key]
-            @sort_key = index[:sort_key] if index.key?(:sort_key)
-            @global_secondary_indexes = index[:global_secondary_index] if index.key?(:global_secondary_index)
-            @credentials = Hashie.symbolize_keys(credentials)
-            configuration[:credentials] = Aws::Credentials.new(@credentials[:username], @credentials[:password])
+            @table_name = table['name']
+            index = table['index']
+            @partition_key = index['partition_key']
+            @sort_key = index['sort_key'] if index.key?('sort_key')
+            @global_secondary_indexes = index['global_secondary_index'] if index.key?('global_secondary_index')
+            configuration['credentials'] = Aws::Credentials.new(credentials['username'], credentials['password'])
             @client = Aws::DynamoDB::Client.new(Hashie.symbolize_keys(configuration))
           end
 
           ##
-          # @param [Hash] entry
+          # @param [Hash{String => String, Hash, Number, Array}] entry
           # @return [Boolean]
           # @raise [Soar::Registry::Directory::Error::DuplicateEntryError]
           ##
@@ -58,10 +58,10 @@ module Soar
           end
 
           ##
-          # @param [Hash] primary_key 
-          # @option primary_key [String] :partition_key required
-          # @option primary_key [String] :sort_key required only when defined in schema
-          # @return [Hash] a single matching entry
+          # @param [Hash{String => String}] primary_key 
+          # @option primary_key [String] partition_key required
+          # @option primary_key [String] sort_key required only when defined in schema
+          # @return [Hash{String => Hash, String, Number, Array }] a single matching entry
           # @raise [Soar::Registry::Directory::Error::NoEntriesFoundError] if primary key not found
           ##
           def fetch(primary_key)
@@ -79,7 +79,7 @@ module Soar
           ##
           # @param [String] key
           # @param [String] value
-          # @return [Array] list of matching entries
+          # @return [Array<Hash{String => Hash, String, Number, Array}>] list of matching entries
           # @raise [ArgumentError] if query or index is not specified
           ##
           def search(key, value)
@@ -103,7 +103,7 @@ module Soar
           end
 
           ##
-          # @return [Array] a list of primary keys and global secondary indexes
+          # @return [Array<String>] a list of primary keys and global secondary indexes
           ##
           def index
             adapt_exceptions do
@@ -128,13 +128,13 @@ module Soar
           ##
           # Deletes existing table and creates a new one in its place
           # @param [String] name the table name
-          # @param [Hash] structure table structure
+          # @param [Hash{String => Hash, Array, String, Number]] structure table structure
           # @return [Boolean]
           ##
-          def recreate_table(name: nil, structure: nil)
+          def recreate_table(name:, structure:)
             adapt_exceptions do
               if @client.list_tables.table_names.include?(name) 
-                @client.delete_table({
+                result = @client.delete_table({
                   table_name: name
                 })
               end
@@ -153,6 +153,8 @@ module Soar
               raise Soar::Registry::Directory::Error::NetworkingError, e.message
             rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
               raise Soar::Registry::Directory::Error::DuplicateEntryError, e.message
+            rescue StandardError => e
+              raise e, e.message
             end
           end
 

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

@@ -1,6 +1,5 @@
 require 'soar/registry/directory/error'
 require 'net/ldap'
-require 'hashie'
 
 module Soar
   module Registry
@@ -11,27 +10,28 @@ module Soar
           attr_accessor :client
 
           ##
-          # @param [Hash] config
-          # @option config [String] :host
-          # @option config [Number] :port
+          # @param [Hash{String => String, Number}] config
+          # @option config [String] host
+          # @option config [Number] port
           # @param [String] base ldap tree base eg 'dc=hetzner,dc=co,dc=za'
-          # @param [Array] attributes array of attributes to return for queries
-          # @param [Hash] credentials
-          # @option credentials [String] :username
-          # @option credentials [String] :password
+          # @param [Array<String>] attributes array of attributes to return for queries
+          # @param [Array<String>] index
+          # @param [Hash{String => String}] credentials
+          # @option credentials [String] username
+          # @option credentials [String] password
           ##
           def initialize(config: , base: , attributes: , index: , credentials: )
             adapt_exceptions do
               @index = index.map { |x| x.to_sym }
               @attributes = attributes
               @config = {
-                host: config[:host],
-                port: config[:port],
+                host: config['host'],
+                port: config['port'],
                 base: base,
                 auth: {
                   method: :simple,
-                  username: credentials[:username], 
-                  password: credentials[:password]
+                  username: credentials['username'], 
+                  password: credentials['password']
                 },
                 encryption: {
                   method: :simple_tls
@@ -42,7 +42,7 @@ module Soar
           end
 
           ##
-          # @param [Hash] entry
+          # @param [Hash{Symbol => }] entry
           # @return [Boolean] 
           # @raise [Soar::Registry::Directory::Error::DuplicateEntryError]
           ##
@@ -66,7 +66,7 @@ module Soar
 
           ##
           # @param [String] primary key of the identity ie. the first index
-          # @return [Hash] single matching entry
+          # @return [Hash{Symbol => String, Number, Array}] single matching entry
           # @raise [Soar::Registry::Directory::Error::NoEntriesFoundError] if primary key not found
           # @raise [Soar::Registry::Directory::Error::MultipleEntriesFound] if multiple matches found
           ##
@@ -91,7 +91,7 @@ module Soar
           ##
           # @param [String] key
           # @param [String] value
-          # @return [Array] list of matching entries
+          # @return [Array<Hash{Symbol => String, Array, Number}>] list of matching entries
           # @raise [ArgumentError] if value or named index is not specified
           ##
           def search(key, value)
@@ -115,7 +115,7 @@ module Soar
           end
 
           ##
-          # @return [Array] a list of indexes
+          # @return [Array<String, Number>] a list of indexes
           ##
           def index
             adapt_exceptions do

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

@@ -10,35 +10,35 @@ module Soar
           attr_accessor :client
 
           ##
-          # @param [Hash] config
-          # @option config [String] :host
-          # @option config [Number] :port
-          # @option config [String] :database name
-          # @option config [String] :table name 
-          # @param [Array] attributes array of attributes to return for queries 
-          # @param [Array] index array of indexes starting with the primary key
-          # @param [Hash] credentials
-          # @option credentials [String] :username
-          # @option credentials [String] :password
+          # @param [Hash{String => String, Number}] config
+          # @option config [String] host
+          # @option config [Number] port
+          # @option config [String] database
+          # @option config [String] table
+          # @param [Array<String>] attributes array of attributes to return for queries 
+          # @param [Array<String>] index array of indexes starting with the primary key
+          # @param [Hash{String => String}] credentials
+          # @option credentials [String] 'username'
+          # @option credentials [String] 'password'
           ##
           def initialize(config: , attributes: '*', index: , credentials: )
             adapt_exceptions do
               @attributes = attributes.kind_of?(Array) ? attributes.join(', ') : attributes
               @index = index
-              @table = config[:table]
+              @table = config['table']
               @config = {
-                host: config[:host],
-                port: config[:port],
-                database: config[:database],
-                username: credentials[:username],
-                password: credentials[:password]
+                host: config['host'],
+                port: config['port'],
+                database: config['database'],
+                username: credentials['username'],
+                password: credentials['password']
               }
               @client = ::Mysql.new(@config[:host], @config[:username], @config[:password], @config[:database])
             end
           end
 
           ##
-          # @param [Hash] entry
+          # @param [Hash{Symbol => String, Number}] entry
           # @return [Boolean]
           ##
           def put(entry)
@@ -51,7 +51,7 @@ module Soar
 
           ##
           # @param [String] primary key the first index
-          # @return [Hash] single matching entry
+          # @return [Hash{Symbol => String, Number}] single matching entry
           # @raise [Soar::Registry::Directory::Error::NoEntriesFoundError] if primary key not found
           # @raise [Soar::Registry::Directory::Error::MultipleEntriesFound] if multiple matches found
           ##
@@ -75,7 +75,7 @@ module Soar
           ##
           # @param [String] key should be in indexed in db schema 
           # @param [String] value
-          # @return [Array] list of matching entries
+          # @return [Array<Hash{Symbol => String, Number}>] list of matching entries
           # @raise [ArgumentError] if value or named index is not specified
           ##
           def search(key, value)
@@ -98,7 +98,7 @@ module Soar
           end
 
           ##
-          # @return [Array] a list of indexes the first being the primary key
+          # @return [Array<String>] a list of indexes the first being the primary key
           ##
           def index
             adapt_exceptions do

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

@@ -11,7 +11,7 @@ module Soar
 
           ##
           # @param [String] table the table name
-          # @param [Array] indexes primary key should be the first item 
+          # @param [Array<String>] indexes primary key should be the first item 
           ##
           def initialize(table: , index: )
             @interface = Mince::HashyDb::Interface
@@ -22,7 +22,7 @@ module Soar
           end
 
           ##
-          # @param [Hash] entry
+          # @param [Hash{String => Hash, String, Number, Array}] entry
           # @raise [Soar::Registry::Directory::Error::DuplicateEntryError]
           # @return [Boolean]
           ##
@@ -38,7 +38,7 @@ module Soar
 
           ##
           # @param [String] primary_key
-          # @return [Hash] entry
+          # @return [Hash{String => Hash, String, Number, Array}] entry
           # @raise [Soar::Registry:::Directory::Error::NoEntriesFoundError] if primary key not found
           ##
           def fetch(primary_key)
@@ -52,7 +52,7 @@ module Soar
           ##
           # @param [String] key
           # @param [String] value 
-          # @return [Array] list of matching entries
+          # @return [Array<String>] list of matching entries
           # @raise [ArgumentError] if query or index is not specified
           ##
           def search(key, value)
@@ -70,7 +70,7 @@ module Soar
           end
 
           ##
-          # @return [Array] a list of provider specific indexes
+          # @return [Array<String>] a list of provider specific indexes
           ##
           def index
             adapt_exceptions do

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

@@ -1,6 +1,5 @@
 require 'soar/registry/directory'
 require 'aws-sdk'
-require 'hashie'
 require 'soar/registry/directory/error'
 
 module Soar
@@ -21,10 +20,10 @@ module Soar
 
             def given_configured_directory
               begin 
-                provider = Soar::Registry::Directory::Provider::DynamoDb.new(Hashie.symbolize_keys(@configuration['provider']['config']))
+                provider = Soar::Registry::Directory::Provider::DynamoDb.new(@configuration['provider']['config'].map { |k, v| [k.to_sym, v] }.to_h)
                 @directory = Soar::Registry::Directory.new(provider)
                 @directory.provider.recreate_table({
-                  name: @table[:name], 
+                  name: @table['name'], 
                   structure: JSON.parse(File.read("lib/soar/registry/directory/test/fixtures/table_structure.json"))
                 })
               rescue Soar::Registry::Directory::Error::NetworkingError => e
@@ -42,8 +41,8 @@ module Soar
             end
 
             def sabotage_network
-              @configuration['provider']['config']['configuration'][:endpoint] = 'http://does-not-exist'
-              @directory.provider.client = Aws::DynamoDB::Client.new(Hashie.symbolize_keys(@configuration['provider']['config']['configuration']))
+              @configuration['provider']['config']['configuration']['endpoint'] = 'http://does-not-exist'
+              @directory.provider.client = Aws::DynamoDB::Client.new(@configuration['provider']['config']['configuration'].map { |k, v| [k.to_sym, v] }.to_h)
             end
 
             def put_duplicate_entry
@@ -104,9 +103,9 @@ module Soar
 
             def index?
               @index == {
-                partition_key: @index[:partition_key],
-                sort_key: @index[:sort_key],
-                global_secondary_index: @index[:global_secondary_index]
+                "partition_key" => @index['partition_key'],
+                "sort_key" => @index['sort_key'],
+                "global_secondary_index" => @index['global_secondary_index']
               }
             end
 

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

@@ -1,5 +1,4 @@
 require 'soar/registry/directory'
-require 'hashie'
 require 'securerandom'
 
 module Soar
@@ -36,7 +35,7 @@ module Soar
             def given_configured_directory
               begin
                 provider_class = Object.const_get(@configuration['provider']['class'])
-                provider = provider_class.new(Hashie.symbolize_keys(@configuration['provider']['config']))
+                provider = provider_class.new(@configuration['provider']['config'].map { |k,v| [k.to_sym, v] }.to_h )
                 @directory = Soar::Registry::Directory.new(provider)
                 @entries.each { |entry|
                   provider.delete(entry[:dn])

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

@@ -1,6 +1,5 @@
 require 'soar/registry/directory'
-require 'mysql'
-# http://zetcode.com/db/mysqlrubytutorial/
+require 'mysql' # http://zetcode.com/db/mysqlrubytutorial/
 
 module Soar
   module Registry
@@ -34,7 +33,7 @@ module Soar
             def given_configured_directory
               begin
                 provider_class = Object.const_get(@configuration['provider']['class'])
-                provider = provider_class.new(Hashie.symbolize_keys(@configuration['provider']['config']))
+                provider = provider_class.new(@configuration['provider']['config'].map { |k,v| [k.to_sym, v]}.to_h )
                 provider.client.query("DROP TABLE IF EXISTS `Client`")
                 provider.client.query("CREATE TABLE Client ( ID int(11) NOT NULL AUTO_INCREMENT, Client_Number varchar(15) NOT NULL DEFAULT '', First_Name varchar(70) DEFAULT NULL, Surname varchar(70) DEFAULT NULL, Notifyemail_Invoice text, PRIMARY KEY (ID), KEY Notifyemail_Invoice (Notifyemail_Invoice(20)), KEY Client_Number (Client_Number))")
                 @directory = Soar::Registry::Directory.new(provider)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soar-registry-directory
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 6.0.0
 platform: ruby
 authors:
 - Charles Mulder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashy_db
@@ -64,20 +64,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.6
+        version: 3.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.6
+        version: 3.5.5
 - !ruby/object:Gem::Dependency
   name: net-ldap
   requirement: !ruby/object:Gem::Requirement