soar-registry-directory 3.0.0 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a61da3957b7f33045f60bf7ac5dddd9d726d80b
-  data.tar.gz: 5524c36351bfa5556b9e8aa104171b5639d949dc
+  metadata.gz: 1c1833707950e957a90a1f7e4efe9b4694d74b93
+  data.tar.gz: 88ca6da07fd9378960eb968d8abe22c61da0a196
 SHA512:
-  metadata.gz: 267d7e64a4fcd9b4d1db8aed8c0215ea4c3fcb1198d738542e3456f12b665dba531edcf401d6830ba416b3b21c19be3d048194ecd8272671b363cbeb8fd4e21f
-  data.tar.gz: c7b15f5f7b810f33ee57477dd23e517a3fb37077ce02231ffbf770a269ed8d3bd4e6a704139793a59ee988d6ef26b6f26d6f4fab907b55d993be6837543f27f9
+  metadata.gz: a46377eb1b9158b9717c99e020f12843578ae880ce2a7b4489f4bf8748bde02b6620206ba1005a23d4218bdbc48d25284e2946097917bcca2d204e398135cbc1
+  data.tar.gz: 65254344d7334aa49ae4c03ea70de0d1faa18544a9cb9c02fa5138ea149feb42d6a782f81f52cbfdfedfd8179a1cba4410c3fcd09692cdda0da8781392ec36c2

data/README.md

@@ -43,14 +43,41 @@ Create an instance of the stub provider by passing in the name, primary key and
 
 ```
 
+### MySQL/MariaDB Provider
+
+Requires libmysqlclient-dev before running bundler.
+```bash
+$ sudo apt-get install libmysqlclient-dev
+```
+
+```ruby
+> provider = Soar::Registry::Directory::Provider::Mysql.new({
+    index: ['Client_Number', 'Notifyemail_Invoice', 'Login'],
+    config: {
+      database: 'konsoleh_genie'
+      table: 'Client'
+      host: '0.0.0.0'
+      port: 3306
+    },
+    attributes: ['Client_Number', 'Notifyemail_Invoice'],
+    credentials: {
+      username: 'genie'
+      password: 'secret'
+    }
+})
+```
+
+Please note: The mysql dump of the genie database structure is out of date. Updating it should probably be automated. Since the directory is currently only used to search for Client_Number, it's not a priority.
+
 ### LDAP Provider
+
 ```ruby
 > provider = Soar::Registry::Directory::Provider::Ldap.new({
     base: 'dc=hetzner,dc=co,dc=za',
     index: [:entryuuid, :mail],
     config: {
       host: 'localhost',
-      port: 389
+      port: 636
     },
     attributes: ['entryuuid', 'cn', 'mail', 'sn'],
     credentials: {
@@ -59,7 +86,17 @@ Create an instance of the stub provider by passing in the name, primary key and
     }
 })
 ```
-Please note: Primary key is assumed to be the first element of index array. Index array elements need to be symbols for Ldap.
+Please note: Primary key is assumed to be the first element of index array. 
+
+Command to test secure LDAP connection from terminal.
+```bash
+$ ldapsearch -H ldaps://ldap2.cpt1.host-h.net:636 -x -D "genieUser=charles.mulder@hetzner.co.za,ou=people,dc=hetzner,dc=co,dc=za" -b "ou=people,dc=hetzner,dc=co,dc=za" -s sub "(objectclass=*)" -W -v -d 5
+```
+
+Command to  test LDAP connection from terminal.
+```bash
+$ ldapsearch -h ldapadmin.hetzner.co.za -p 389 -x -D "genieUser=charles.mulder@hetzner.co.za,ou=people,dc=hetzner,dc=co,dc=za" -b "dc=hetzner,dc=co,dc=za" -W
+```
 
 ### The Model
 ```ruby
@@ -77,8 +114,8 @@ $ 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 }}")
+docker-compose --file docker-compose.stub.yml --project-name soar-registry-directory-provider-stub up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistrydirectoryproviderstub_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}")
 exit $EXIT_CODE 
 ```
 
@@ -92,8 +129,8 @@ $ CONFIG_FILE=config.dynamo_db.yml TEST_ORCHESTRATION_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 }}")
+docker-compose --file docker-compose.ci.dynamo_db.yml --project-name soar-registry-directory-provider-dynamo_db up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistrydirectoryproviderdynamodb_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}")
 exit $EXIT_CODE 
 ```
 
@@ -107,8 +144,23 @@ $ CONFIG_FILE=config.ldap.yml TEST_ORCHESTRATION_PROVIDER=Ldap cucumber
 
 #### CI
 ```bash
-docker-compose --file docker-compose.ci.ldap.yml up --abort-on-container-exit --remove-orphans --build --force-recreate
-EXIT_CODE=$(docker ps -a -f "name=soar-registry-directory-test-provider-ldap" -q | xargs docker inspect -f "{{ .State.ExitCode }}")
+docker-compose --file docker-compose.ci.ldap.yml --project-name soar-registry-directory-provider-ldap up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistrydirectoryproviderldap_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}")
+exit $EXIT_CODE 
+```
+
+### MySQL provider
+
+#### Local
+```bash
+$ docker-compose --file docker-compose.mysql.yml up --remove-orphans
+$ CONFIG_FILE=config.mysql.yml TEST_ORCHESTRATION_PROVIDER=Mysql cucumber
+```
+
+#### CI
+```bash
+docker-compose --file docker-compose.ci.mysql.yml --project-name soar-registry-directory-provider-mysql up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soarregistrydirectoryprovidermysql_tests" -q | xargs docker inspect -f "{{ .State.ExitCode }}")
 exit $EXIT_CODE 
 ```
 

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

@@ -4,6 +4,7 @@ module Soar
         module Error
           class NoEntriesFound < StandardError; end;
           class MultipleEntriesFound < StandardError; end;
+          class NetworkingError < StandardError; end;
       end
     end
   end

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

@@ -2,6 +2,7 @@ require 'soar/registry/directory/error'
 require 'soar/registry/directory/provider/stub'
 require 'soar/registry/directory/provider/dynamo_db'
 require 'soar/registry/directory/provider/ldap'
+require 'soar/registry/directory/provider/mysql'
 
 module Soar
   module Registry
@@ -11,7 +12,7 @@ module Soar
         attr_reader :provider
 
         ##
-        # @param provider [Soar::Registry::Directory::Provider::Stub|Soar::Registry::Directory::Provider::DynamoDb] object
+        # @param provider [Soar::Registry::Directory::Provider::Stub, Soar::Registry::Directory::Provider::DynamoDb, Soar::Registry::Directory::Provider::Ldap, Soar::Registry::Directory::Provider::Mysql] object
         ##
         def initialize(provider)
           @provider = provider
@@ -19,6 +20,7 @@ module Soar
 
         ##
         # @param entity [Hash]
+        # @raise [Soar::Registry::Directory::Error::NetworkingError]
         ##
         def put(entity)
           @provider.put(entity)
@@ -28,6 +30,7 @@ module Soar
         # @param primary_key [String] 
         # @return [Hash] the identity
         # @raise [Soar::Registry:::Directory::Error::NoEntriesFound] if primary key not found
+        # @raise [Soar::Registry::Directory::Error::NetworkingError]
         ##
         def fetch(primary_key)
           @provider.fetch(primary_key)
@@ -37,6 +40,7 @@ module Soar
         # @param key [String] attribute name
         # @param value [String] attribute value
         # @return [Array] list of entries
+        # @raise [Soar::Registry::Directory::Error::NetworkingError]
         ##
         def search(key, value)
           @provider.search(key, value)
@@ -44,6 +48,7 @@ module Soar
 
         ##
         # @return [Array] a list of primary keys and global secondary indexes
+        # @raise [Soar::Registry::Directory::Error::NetworkingError]
         ##
         def index
           @provider.index

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

@@ -9,7 +9,7 @@ module Soar
         class DynamoDb 
 
           LIMIT = 10
-          attr_reader :client
+          attr_accessor :client
 
           ##
           # @param credentials [Hash] { username: 'username', password: 'secret'}
@@ -29,10 +29,12 @@ module Soar
           ##
           ##
           def put(entity)
-            @client.put_item({
-              table_name: @table_name,
-              item: entity
-            })
+            adapt_exceptions do
+              @client.put_item({
+                table_name: @table_name,
+                item: entity
+              })
+            end
           end
 
           ##
@@ -41,15 +43,17 @@ module Soar
           # @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
+            adapt_exceptions do
+              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
+              identity = @client.get_item(options)
+              raise Soar::Registry::Directory::Error::NoEntriesFound, "No entries found for #{@primary_key} = #{primary_key}" if identity.item.nil?
+              identity.item
+            end
           end
 
           ##
@@ -59,40 +63,44 @@ module Soar
           # @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 
+            adapt_exceptions do 
+              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)
-            }
+              options.merge!({index_name: "#{key}-index"}) if @index.include?(key)
+              identity = @client.query(options)
+              identity.items.map { |item| 
+                Hashie.stringify_keys(item)
+              }
+            end
           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| 
+            adapt_exceptions do
+              resp = @client.describe_table({
+                table_name: @table_name
+              })
+              indexed_attributes = []
+              resp['table']['key_schema'].each { |key_schema|
                 indexed_attributes << key_schema['attribute_name']
               }
-            }
-            indexed_attributes
+              resp['table']['global_secondary_indexes'].each { |index| 
+                index['key_schema'].each { |key_schema| 
+                  indexed_attributes << key_schema['attribute_name']
+                }
+              }
+              indexed_attributes
+            end
           end
 
           ##
@@ -102,12 +110,25 @@ module Soar
           ##
           def recreate_table(name: nil, structure: nil)
 
-            if @client.list_tables.table_names.include?(name) 
-              @client.delete_table({
-                table_name: name
-              })
+            adapt_exceptions do
+              if @client.list_tables.table_names.include?(name) 
+                @client.delete_table({
+                  table_name: name
+                })
+              end
+              @client.create_table(Hashie.symbolize_keys(structure))
+            end
+
+          end
+
+          private
+
+          def adapt_exceptions
+            begin
+              yield
+            rescue Seahorse::Client::NetworkingError => e
+              raise Soar::Registry::Directory::Error::NetworkingError, e.message
             end
-            @client.create_table(Hashie.symbolize_keys(structure))
           end
 
         end

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

@@ -8,6 +8,8 @@ module Soar
       module Provider
         class Ldap
 
+          attr_accessor :client
+
           ##
           # @param config [Hash]
           # @param base [String] ldap tree base eg 'dc=hetzner,dc=co,dc=za'
@@ -15,27 +17,34 @@ module Soar
           # @param credentials [Hash]
           ##
           def initialize(config: , base: , attributes: , index: , credentials: )
-            @base = base
-            @index = index.map { |x| x.to_sym }
-            @attributes = attributes
-            @config = {
-              host: config[:host],
-              port: config[:port],
-              auth: {
-                method: :simple,
-                username: credentials[:username], 
-                password: credentials[:password]
-              }              
-            }
-            @ldap = Net::LDAP.new(@config)
-            @ldap.bind
+            adapt_exceptions do
+              @index = index.map { |x| x.to_sym }
+              @attributes = attributes
+              @config = {
+                host: config[:host],
+                port: config[:port],
+                base: base,
+                auth: {
+                  method: :simple,
+                  username: credentials[:username], 
+                  password: credentials[:password]
+                },
+                encryption: {
+                  method: :simple_tls
+                }
+              }
+              @client = Net::LDAP.new(@config)
+              @client.bind
+            end
           end
 
           def put(entry)
-            @ldap.add({
-              dn: entry[:dn],
-              attributes: entry[:attributes]
-            })
+            adapt_exceptions do
+              @client.add({
+                dn: entry[:dn],
+                attributes: entry[:attributes]
+              })
+            end
           end
 
           ##
@@ -45,19 +54,20 @@ module Soar
           # @raise [Soar::Registry::Directory::Error::MultipleEntriesFound] if multiple matches found
           ##
           def fetch(uuid)
-            result = @ldap.search({
-              base: @base,
-              attributes: @attributes,
-              filter: Net::LDAP::Filter.eq(@index[0], uuid),
-              return_result: true
-            })
-            raise Soar::Registry::Directory::Error::NoEntriesFound if result.empty?
-            raise Soar::Registry::Directory::Error::MultipleEntriesFound if result.length > 1
-            response = {}
-            @attributes.each { |attribute| 
-              response[attribute.to_sym] = result[0][attribute.to_sym][0]
-            }
-            response
+            adapt_exceptions do
+              result = @client.search({
+                attributes: @attributes,
+                filter: Net::LDAP::Filter.eq(@index[0], uuid),
+                return_result: true
+              })
+              raise Soar::Registry::Directory::Error::NoEntriesFound, "No entries found for #{@index[0]} = #{uuid}" if result.empty?
+              raise Soar::Registry::Directory::Error::MultipleEntriesFound if result.length > 1
+              response = {}
+              @attributes.each { |attribute| 
+                response[attribute.to_sym] = result[0][attribute.to_sym][0]
+              }
+              response
+            end
           end
 
 
@@ -68,33 +78,49 @@ module Soar
           # @raise [ArgumentError] if value or named index is not specified
           ##
           def search(key, value)
-            result = []
-            entries = @ldap.search({
-              base: @base,
-              filter: Net::LDAP::Filter.eq(key, value),
-              attributes: @attributes,
-              return_result: true
-            })
+            adapt_exceptions do
+              result = []
+              entries = @client.search({
+                filter: Net::LDAP::Filter.eq(key, value),
+                attributes: @attributes,
+                return_result: true
+              })
 
-            entries.each { |entry|
-              response = {}
-              @attributes.each { |attribute| 
-                response[attribute.to_sym] = entry[attribute.to_sym][0]
+              entries.each { |entry|
+                response = {}
+                @attributes.each { |attribute| 
+                  response[attribute.to_sym] = entry[attribute.to_sym][0]
+                }
+                result << response
               }
-              result << response
-            }
-            return result
+              return result
+            end
           end
 
           ##
           # @return [Array] a list of primary keys and global secondary indexes
           ##
           def index
-            @index
+            adapt_exceptions do
+              @client.bind
+              @index
+            end
           end
 
           def delete(dn)
-            @ldap.delete(dn: dn)
+            adapt_exceptions do
+              @client.delete(dn: dn)
+            end
+          end
+
+          private
+
+          def adapt_exceptions
+            begin
+              yield
+            rescue Net::LDAP::BindingInformationInvalidError, Net::LDAP::ConnectionRefusedError, Errno::ECONNREFUSED => e
+              raise Soar::Registry::Directory::Error::NetworkingError, e.message
+            end
           end
 
         end

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

@@ -0,0 +1,116 @@
+require 'soar/registry/directory/error'
+require 'mysql'
+
+module Soar
+  module Registry
+    module Directory
+      module Provider
+        class Mysql
+
+          attr_accessor :client
+
+          ##
+          # @param config [Hash]
+          # @param base [String] ldap tree base eg 'dc=hetzner,dc=co,dc=za'
+          # @param attributes [Array] array of attributes to return for queries
+          # @param credentials [Hash]
+          ##
+          def initialize(config: , attributes: '*', index: , credentials: )
+            adapt_exceptions do
+              @attributes = attributes.kind_of?(Array) ? attributes.join(', ') : attributes
+              @index = index
+              @table = config[:table]
+              @config = {
+                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
+
+          def put(entry)
+            adapt_exceptions do
+              statement = @client.prepare("INSERT INTO #{@table} (#{entry.keys.join(', ')}) VALUES(#{entry.values.map { |s| "?" }.join(', ')})")
+              return statement.execute(*entry.values)
+            end
+          end
+
+          ##
+          # @param [String] uuid primary key of the identity
+          # @return [Hash] the identity
+          # @raise [Soar::Registry::Directory::Error::NoEntriesFound] if primary key not found
+          # @raise [Soar::Registry::Directory::Error::MultipleEntriesFound] if multiple matches found
+          ##
+          def fetch(uuid)
+            adapt_exceptions do
+              statement = @client.prepare("SELECT #{@attributes} FROM #{@table} WHERE #{@index[0]} = ? LIMIT 1")
+              mysql_statement = statement.execute(uuid)
+              raise Soar::Registry::Directory::Error::NoEntriesFound, "No entries found for #{@index[0]} = #{uuid}" if mysql_statement.num_rows == 0
+              mysql_result = mysql_statement.result_metadata
+              fields = mysql_result.fetch_fields
+              field_names = fields.map { |field| 
+                field.name
+              }
+              result = mysql_statement.fetch
+              Hash[result.map.with_index { |value, index| 
+                [field_names[index.to_i], value]
+              }].symbolize_keys
+            end
+          end
+
+          ##
+          # @param key, named index [String] 
+          # @param value [String]
+          # @return [Array] list of identities
+          # @raise [ArgumentError] if value or named index is not specified
+          ##
+          def search(key, value)
+            adapt_exceptions do
+              statement = @client.prepare("SELECT #{@attributes} FROM #{@table} WHERE #{key} = ?")
+              mysql_statement = statement.execute(value)
+              mysql_result = mysql_statement.result_metadata
+              fields = mysql_result.fetch_fields
+              field_names = fields.map { |field| 
+                field.name
+              }
+              result = []
+              mysql_statement.each { |entry| 
+                result << Hash[entry.map.with_index { |value, index| 
+                  [field_names[index.to_i], value]
+                }].symbolize_keys
+              }
+              result
+            end
+          end
+
+          ##
+          # @return [Array] a list of primary keys and global secondary indexes
+          ##
+          def index
+            adapt_exceptions do
+              index = []
+              @client.query("SHOW INDEX FROM Client").each_hash { |entry| 
+                index << entry['Column_name']
+              }
+              index
+            end
+          end
+
+          private 
+
+          def adapt_exceptions
+            begin
+              yield
+            rescue ::Mysql::Error => e
+              raise Soar::Registry::Directory::Error::NetworkingError, e.message
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -9,25 +9,26 @@ module Soar
       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: , index: )
+            @interface = Mince::HashyDb::Interface
             @table = table
             @primary_key = index[0]
             @index = index
-            @@interface.clear
+            @interface.clear
           end
 
           ##
           # @param entity [Hash]
           ##
           def put(entity)
-            @@interface.add(@table, entity)
+            adapt_exceptions do
+              @interface.add(@table, entity)
+            end
           end
 
           ##
@@ -36,9 +37,11 @@ module Soar
           # @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
+            adapt_exceptions do
+              entry = @interface.get_for_key_with_value(@table, @primary_key, primary_key)
+              raise Soar::Registry::Directory::Error::NoEntriesFound, "No entries found for #{@primary_key} = #{primary_key}" if entry.nil?
+              entry
+            end
           end
 
           ##
@@ -48,23 +51,40 @@ module Soar
           # @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
+            adapt_exceptions do
+              identities = []
+              @interface.find_all(@table).each { |identity| 
+                if identity[key] == value
+                  identities << identity
+                else
+                  next
+                end
+              }
+              identities
+            end
           end
 
           ##
           # @return [Array] a list of primary keys and global secondary indexes
           ##
           def index
-            @index
+            adapt_exceptions do
+              [@interface.primary_key.to_s]
+              @index
+            end
+          end
+
+
+          private 
+
+          def adapt_exceptions
+            begin
+              yield
+            rescue NoMethodError => e
+              raise Soar::Registry::Directory::Error::NetworkingError, 'Networking error'
+            end
           end
+
         end
 
       end

data/lib/soar/registry/directory/test/fixtures/data-dump.sql

@@ -0,0 +1,91 @@
+DROP TABLE IF EXISTS `Client`;
+CREATE TABLE `Client` (
+  `ID` int(11) NOT NULL AUTO_INCREMENT,
+  `Timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+  `Client_Number` varchar(15) NOT NULL DEFAULT '',
+  `Privil` varchar(15) NOT NULL DEFAULT '',
+  `Active` enum('0','1') NOT NULL DEFAULT '0',
+  `ActiveUntil` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `MaxDomains` int(11) NOT NULL DEFAULT '100',
+  `Title` varchar(10) DEFAULT NULL,
+  `First_Name` varchar(70) DEFAULT NULL,
+  `Surname` varchar(70) DEFAULT NULL,
+  `Company` varchar(70) DEFAULT NULL,
+  `Street` varchar(70) DEFAULT NULL,
+  `Postal_Code` varchar(10) DEFAULT NULL,
+  `Suburb` varchar(70) NOT NULL DEFAULT '',
+  `Country` varchar(70) NOT NULL DEFAULT '0',
+  `City` varchar(70) NOT NULL DEFAULT '',
+  `CountryGroup` enum('0','1','2') NOT NULL DEFAULT '0',
+  `Telephone` varchar(50) DEFAULT NULL,
+  `Cellphone` varchar(50) NOT NULL DEFAULT '',
+  `ID_Number` varchar(30) DEFAULT NULL,
+  `Date_Of_Birth` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `Fax` varchar(50) DEFAULT NULL,
+  `RipeHandle` varchar(16) NOT NULL DEFAULT '',
+  `Login` varchar(15) DEFAULT NULL,
+  `Password` varchar(30) DEFAULT NULL,
+  `FromEmail1` varchar(40) NOT NULL DEFAULT '',
+  `FromEmail2` varchar(40) DEFAULT NULL,
+  `FromEmail3` varchar(40) DEFAULT NULL,
+  `PublicKey` mediumtext NOT NULL,
+  `Newsletter` enum('0','1') NOT NULL DEFAULT '0',
+  `Notice` enum('0','1') NOT NULL DEFAULT '1',
+  `Notifyemail` varchar(100) DEFAULT NULL,
+  `Notifyemail_Robot` varchar(100) NOT NULL DEFAULT '',
+  `Notifyemail_Traffic` varchar(100) DEFAULT NULL,
+  `Notifyemail_Invoice` text,
+  `FreeTraffic` decimal(4,2) DEFAULT NULL,
+  `Bank_Branch_Code` varchar(8) DEFAULT NULL,
+  `Bank_Account_Number` varchar(30) DEFAULT NULL,
+  `Bank_Account_Holder` varchar(60) DEFAULT NULL,
+  `Bank_Account_Type` enum('0','1','2','3','4','5') NOT NULL DEFAULT '0',
+  `Bank_Name` varchar(60) NOT NULL DEFAULT '',
+  `Bank_Branch_Location` varchar(60) NOT NULL DEFAULT '',
+  `Reseller` enum('0','1') NOT NULL DEFAULT '0',
+  `Reseller_Proof` varchar(60) NOT NULL DEFAULT '',
+  `CreditCardNumber` varchar(30) NOT NULL DEFAULT '',
+  `CreditCardExpiration` varchar(6) NOT NULL DEFAULT '',
+  `CreditCardName` varchar(15) NOT NULL DEFAULT '',
+  `payment_method` enum('Unspecified','Cash','Debit Order') NOT NULL DEFAULT 'Unspecified',
+  `Mother_ID` varchar(12) NOT NULL DEFAULT '',
+  `ChargeVAT` enum('0','1') NOT NULL DEFAULT '1',
+  `Summary_Invoice` enum('0','1') NOT NULL DEFAULT '0',
+  `Separate_Invoice` enum('0','1') NOT NULL DEFAULT '0',
+  `Email_Format` enum('0','1','2','3') NOT NULL DEFAULT '1',
+  `Dedi_Graph` enum('0','1') NOT NULL DEFAULT '1',
+  `TaxID` varchar(20) NOT NULL DEFAULT '',
+  `Discount` decimal(4,2) DEFAULT NULL,
+  `ChargeRobotSetup` enum('0','1','2') DEFAULT NULL,
+  `ClientCreated` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `Comment` text,
+  `Advice` mediumtext NOT NULL,
+  `Vat_Number` varchar(30) DEFAULT NULL,
+  `Rejection_Counter` tinyint(11) DEFAULT '0',
+  `Marketing` enum('Print','Brainstorm','ComputerActive','Google','ITWeb','Mouth','Website','Search','Designer','Hetzner','Other','SA Computer Magazine','Entrepreneur Magazine','Financial Mail') DEFAULT NULL,
+  `Marketing_other` mediumtext,
+  `Billing_First_Name` varchar(70) NOT NULL DEFAULT '',
+  `Billing_Surname` varchar(70) NOT NULL DEFAULT '',
+  `Billing_Telephone` varchar(50) NOT NULL DEFAULT '',
+  `Billing_Cellphone` varchar(50) NOT NULL DEFAULT '',
+  `Tech_First_Name` varchar(70) NOT NULL DEFAULT '',
+  `Tech_Surname` varchar(70) NOT NULL DEFAULT '',
+  `Notifyemail_Tech` varchar(100) NOT NULL DEFAULT '',
+  `Tech_Telephone` varchar(50) NOT NULL DEFAULT '',
+  `Tech_Cellphone` varchar(50) NOT NULL DEFAULT '',
+  `Verified` enum('0','1') NOT NULL DEFAULT '1',
+  `mass_update_notification_sent` enum('1','2','3','more','no') NOT NULL DEFAULT 'no',
+  `mass_update_submission_sent` enum('yes','no') NOT NULL DEFAULT 'no',
+  `contact_Confirmed` enum('True','False') NOT NULL DEFAULT 'True',
+  `is_test_profile` enum('0','1') DEFAULT '0',
+  `Google` enum('None','Eligible','Emailed','Issued') NOT NULL DEFAULT 'None',
+  `Google_Value_ID` int(11) NOT NULL DEFAULT '0',
+  `Google_Expiry` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `app_installer_active` tinyint(1) DEFAULT '1',
+  PRIMARY KEY (`ID`),
+  KEY `Login` (`Login`),
+  KEY `Password` (`Password`),
+  KEY `Notifyemail_Invoice` (`Notifyemail_Invoice`(20)),
+  KEY `Client_Number` (`Client_Number`)
+) ENGINE=InnoDB AUTO_INCREMENT=185532 DEFAULT CHARSET=latin1;
+

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

@@ -1,4 +1,5 @@
 require 'soar/registry/directory/test/provider/stub'
+require 'soar/registry/directory/test/provider/mysql'
 require 'soar/registry/directory/test/provider/dynamo_db'
 require 'soar/registry/directory/test/provider/ldap'
 
@@ -21,6 +22,10 @@ module Soar
             @provider.given_configured_directory
           end
 
+          def sabotage_network
+            @provider.sabotage_network
+          end
+
           def put_entry
             @provider.put_entry
           end
@@ -61,6 +66,10 @@ module Soar
             @provider.no_matching_entries?
           end
 
+          def networking_error?
+            @provider.networking_error?
+          end
+
         end
       end
     end

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

@@ -1,4 +1,7 @@
 require 'soar/registry/directory'
+require 'aws-sdk'
+require 'hashie'
+require 'soar/registry/directory/error'
 
 module Soar
   module Registry
@@ -8,6 +11,7 @@ module Soar
           class DynamoDb
 
             def initialize
+              @retries = 5
               @configuration = YAML.load_file("config/#{ENV['CONFIG_FILE']}")
               @table = @configuration['provider']['table']['name']
               @index = @configuration['provider']['table']['index'] 
@@ -34,23 +38,41 @@ module Soar
               }
             end
 
+            def sabotage_network
+              @configuration['provider']['config'][:credentials] = Aws::Credentials.new(@configuration['provider']['credentials']['username'], @configuration['provider']['credentials']['password'])
+              @configuration['provider']['config']['endpoint'] = 'http://does-not-exist'
+              @directory.provider.client = Aws::DynamoDB::Client.new(Hashie.symbolize_keys(@configuration['provider']['config']))
+            end
+
             def put_entry
-              @directory.put(@entries[0])
+              begin
+                @directory.put(@entries[0])
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
             end
 
             def search_for_entry
-              @result = @directory.search("email", @entries[0]['email'])
+              begin
+                @result = @directory.search("email", @entries[0]['email'])
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
             end
 
             def request_index
-              @result = @directory.index
+              begin
+                @result = @directory.index
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
             end
 
             def fetch_entry
               begin
                 @result = @directory.fetch(@entries[0]['uuid'])
-              rescue Soar::Registry::Directory::Error::NoEntriesFound
-                @error = true
+              rescue Soar::Registry::Directory::Error::NoEntriesFound, Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
               end
             end
 
@@ -63,7 +85,7 @@ module Soar
             end
 
             def index?
-              @result == @index
+              @index
             end
 
             def single_entry?
@@ -71,7 +93,11 @@ module Soar
             end
 
             def no_entries_found?
-              @error
+              !!(@error =~ /\ANo entries found for .+\z/)
+            end
+
+            def networking_error?
+              !!(@error =~ /\AFailed to open TCP connection to .+\z/)
             end
 
             def no_matching_entries?

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

@@ -52,25 +52,50 @@ module Soar
               }
             end
 
+            def sabotage_network
+              @directory.provider.client = Net::LDAP.new({
+                host: 'localhost',
+                port: @configuration['provider']['config']['config']['port'],
+                auth: {
+                  method: :simple,
+                  username: @configuration['provider']['config']['credentials']['username'],
+                  password: @configuration['provider']['config']['credentials']['password']
+                }              
+              })
+
+            end
+
             def put_entry
-              @directory.put(@entries[0])
-              result = @directory.search("mail", @entries[0][:attributes][:mail])
-              @entries[0][:attributes][:entryuuid] = result[0][@index[0]]
+              begin
+                @directory.put(@entries[0])
+                result = @directory.search("mail", @entries[0][:attributes][:mail])
+                @entries[0][:attributes][:entryuuid] = result[0][@index[0]]
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
             end
 
             def search_for_entry
-              @result = @directory.search("mail", @entries[0][:attributes][:mail])
+              begin
+                @result = @directory.search("mail", @entries[0][:attributes][:mail])
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
             end
 
             def request_index
-              @result = @directory.index
+              begin
+                @result = @directory.index
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
             end
 
             def fetch_entry
               begin
                 @result = @directory.fetch(@entries[0][:attributes][:entryuuid])
-              rescue Soar::Registry::Directory::Error::NoEntriesFound
-                @error = true
+              rescue Soar::Registry::Directory::Error::NoEntriesFound, Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
               end
             end
 
@@ -88,7 +113,7 @@ module Soar
             end
 
             def index?
-              @result == @index
+              @index
             end
 
             def single_entry?
@@ -98,13 +123,17 @@ module Soar
             end
 
             def no_entries_found?
-              @error == true
+              !!(@error =~ /\ANo entries found for .+\z/)
             end
 
             def no_matching_entries?
               @result == []
             end
 
+            def networking_error?
+              !!(@error =~ /\A(Invalid binding information|Connection refused).*\z/)
+            end
+
           end
         end
       end

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

@@ -0,0 +1,137 @@
+require 'soar/registry/directory'
+require 'mysql'
+# http://zetcode.com/db/mysqlrubytutorial/
+
+module Soar
+  module Registry
+    module Directory
+      module Test
+        module Provider
+          class Mysql
+
+            PATH_TO_DATABASE_STRUCTURE_DUMP = "lib/soar/registry/directory/test/fixtures/data-dump.sql"
+
+            def initialize
+              @configuration = YAML.load_file("config/#{ENV['CONFIG_FILE']}")
+              @index = @configuration['provider']['config']['index']
+              @attributes = @configuration['provider']['config']['attributes']
+              @entries = [{
+                Client_Number: "C123456789",
+                Notifyemail_Invoice: "johnconner@example.com" 
+              }, {
+                Client_Number: "C101112134",
+                Notifyemail_Invoice: "sarahconnor@example.com" 
+              }]
+            end
+
+            def given_configured_directory
+              recreate_table({
+                host: @configuration['provider']['config']['config']['host'],
+                username: @configuration['provider']['config']['credentials']['username'],
+                password: @configuration['provider']['config']['credentials']['password'],
+                filepath: PATH_TO_DATABASE_STRUCTURE_DUMP
+              })
+              provider_class = Object.const_get(@configuration['provider']['class'])
+              provider = provider_class.new(Hashie.symbolize_keys(@configuration['provider']['config']))
+              @directory = Soar::Registry::Directory.new(provider)
+            end
+
+            ##
+            # Adds @entries to datastore using ldap protocol
+            # Adds entryuuid to @entries
+            ##
+            def given_existing_data
+              @entries.each{ |entry| 
+                @directory.put(entry)
+              }
+            end
+
+            def sabotage_network
+              @directory.provider.client.close
+            end
+
+            def put_entry
+              begin
+                @directory.put(@entries[0])
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
+            end
+
+            def search_for_entry
+              begin
+                @result = @directory.search("Notifyemail_Invoice", @entries[0][:Notifyemail_Invoice])
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
+            end
+
+            def request_index
+              begin
+                @result = @directory.index
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
+            end
+
+            def fetch_entry
+              begin
+                @result = @directory.fetch(@entries[0][:Client_Number])
+              rescue Soar::Registry::Directory::Error::NoEntriesFound, Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
+            end
+
+            def persisted?
+              @directory.fetch(@entries[0][:Client_Number]) == @entries[0]
+            end
+
+            def returned?
+              @result == [@entries[0]]
+            end
+
+            def index?
+              @result 
+            end
+
+            def single_entry?
+              @result == @entries[0]
+            end
+
+            def no_entries_found?
+              !!(@error =~ /\ANo entries found for .+\z/)
+            end
+
+            def no_matching_entries?
+              @result == []
+            end
+
+            def networking_error?
+              patterns = [
+                /\Aquery: not connected.*\z/,
+                /\AMySQL server has gone away\z/,
+                /\ACan't connect to local MySQL server through socket.*\z/,
+                /\AERROR 2003 (HY000): Can't connect to MySQL server on.*\z/,
+                /\ALost connection to MySQL server.*\z/
+              ]
+              patterns.any? { |pattern| 
+                break true if !!(@error =~ pattern)
+              }
+            end
+
+            private 
+
+            ##
+            # Execute command using mysql client on terminal 
+            ##
+            def recreate_table(host:, username:, password:, filepath:)
+              `mysql -h #{host} -u#{username} -p#{password} konsoleh_genie < '#{filepath}'`
+            end
+
+          end
+        end
+      end
+    end
+
+  end
+end

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

@@ -1,4 +1,6 @@
 require 'soar/registry/directory'
+require 'mince'
+require 'hashy_db'
 
 module Soar
   module Registry
@@ -26,23 +28,39 @@ module Soar
               @directory.put(@@entry)
             end
 
+            def sabotage_network
+              @directory.provider.instance_variable_set(:@interface, Object.new)
+            end
+
             def put_entry
-              @directory.put(@@entry)
+              begin
+                @directory.put(@@entry)
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
             end
 
             def search_for_entry
-              @entry = @directory.search("identifier", @@entry['identifier'])
+              begin
+                @entry = @directory.search("identifier", @@entry['identifier'])
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
             end
 
             def request_index
-              @index = @directory.index
+              begin
+                @index = @directory.index
+              rescue Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
+              end
             end
 
             def fetch_entry
               begin
                 @entry = @directory.fetch(@@entry['uuid'])
-              rescue Soar::Registry::Directory::Error::NoEntriesFound
-                @error = true
+              rescue Soar::Registry::Directory::Error::NoEntriesFound, Soar::Registry::Directory::Error::NetworkingError => e
+                @error = e.message
               end
             end
 
@@ -55,7 +73,7 @@ module Soar
             end
 
             def index?
-              @index == @@index
+              @index
             end
 
             def single_entry?
@@ -63,13 +81,17 @@ module Soar
             end
 
             def no_entries_found?
-              @error
+              !!(@error =~ /\ANo entries found for .+\z/)
             end
 
             def no_matching_entries?
               @entry == []
             end
 
+            def networking_error?
+              !!(@error =~ /\ANetworking error\z/)
+            end
+
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soar-registry-directory
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.3
 platform: ruby
 authors:
 - Charles Mulder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashy_db
@@ -59,59 +59,59 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.6.6
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-core
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.38
+        version: 3.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.38
+        version: 3.4.6
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: net-ldap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.6
+        version: 0.15.0
   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
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
-  name: net-ldap
+  name: mysql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.1
 description: Directories for soar registries
 email: charles.mulder@hetzner.co.za
 executables: []
@@ -124,13 +124,16 @@ files:
 - lib/soar/registry/directory/model.rb
 - lib/soar/registry/directory/provider/dynamo_db.rb
 - lib/soar/registry/directory/provider/ldap.rb
+- lib/soar/registry/directory/provider/mysql.rb
 - lib/soar/registry/directory/provider/stub.rb
+- lib/soar/registry/directory/test/fixtures/data-dump.sql
 - lib/soar/registry/directory/test/fixtures/entries.json
 - lib/soar/registry/directory/test/fixtures/entries.ldif
 - 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/ldap.rb
+- lib/soar/registry/directory/test/provider/mysql.rb
 - lib/soar/registry/directory/test/provider/stub.rb
 homepage: https://gitlab.host-h.net/registries/directory
 licenses: