soar-registry-directory 6.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c32931eb5c662b57a167f89e9f37641f1069b9f2
-  data.tar.gz: 1bd2a2a6fd37c124228ec8e2fa656324a78250fb
+  metadata.gz: 184dcc7503dc83106a910320501e0051fb27e815
+  data.tar.gz: 286fc633c8ff058630867e01d34fad23fafe9bcf
 SHA512:
-  metadata.gz: 3f8c0d59dedfae89eed3d4fc0bfbb942c4cf583351761cfc1805fb28eb16537e0efb9197512c06cc163d24ce507292a2b94a98c2346a24d2c65941665e11fd0c
-  data.tar.gz: b2cf12ef9732c39407ff2796daca5266c60bce849688119dd6b16e3a7acb7f7d833146a36bab77d11483767346825fe152df5307a188b8e05231a7c9a0000c62
+  metadata.gz: 44e58322123aa440c2f668d3efa2c9d2f69c69826a4dd4b093e867e8fe1b46b88419b5014b74c55d0b71910ceaf6155b0ccc66109ba57303360bdb5c227ecb88
+  data.tar.gz: 4715812e40e690ddf0cb151f9b98e062bfcdb82dcb2c22a5a814a8ac8028ca43ecd8fc0f53539c4724a89eefe3212ac45089afd485e65aaf673721c65382d149

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

@@ -19,7 +19,7 @@ module Soar
         end
 
         ##
-        # @param [Hash] entity
+        # @param [Hash{String => }] entity
         # @return [Boolean]
         # @raise [Soar::Registry::Directory::Error::NetworkingError, Soar::Registry::Directory::Error::DuplicateEntryError]
         ##
@@ -29,7 +29,7 @@ module Soar
 
         ##
         # @param [String] primary_key
-        # @return [Hash] entry
+        # @return [Hash{String => }] entry
         # @raise [Soar::Registry:::Directory::Error::NoEntriesFound] if primary key not found
         # @raise [Soar::Registry::Directory::Error::NetworkingError]
         ##
@@ -40,7 +40,7 @@ module Soar
         ##
         # @param [String] key 
         # @param [String] value
-        # @return [Array] list of entries
+        # @return [Array<Hash{String => }>] list of entries
         # @raise [ArgumentError, Soar::Registry::Directory::Error::NetworkingError]
         ##
         def search(key, value)
@@ -48,7 +48,7 @@ module Soar
         end
 
         ##
-        # @return [Array] a list of provider specific indexes
+        # @return [Array<String>] a list of provider specific indexes
         # @raise [Soar::Registry::Directory::Error::NetworkingError]
         ##
         def index

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

@@ -1,5 +1,6 @@
 require 'soar/registry/directory/error'
 require 'net/ldap'
+require 'hashie'
 
 module Soar
   module Registry
@@ -22,7 +23,7 @@ module Soar
           ##
           def initialize(config: , base: , attributes: , index: , credentials: )
             adapt_exceptions do
-              @index = index.map { |x| x.to_sym }
+              @index = index
               @attributes = attributes
               @config = {
                 host: config['host'],
@@ -42,7 +43,7 @@ module Soar
           end
 
           ##
-          # @param [Hash{Symbol => }] entry
+          # @param [Hash{String => String, Number, Array}] entry
           # @return [Boolean] 
           # @raise [Soar::Registry::Directory::Error::DuplicateEntryError]
           ##
@@ -50,15 +51,15 @@ module Soar
             adapt_exceptions do
 
               @index.each { |index| 
-                if (entry[:attributes].keys.include?(index))
-                  result = search(index, entry[:attributes][index])
+                if (entry['attributes'].keys.include?(index))
+                  result = search(index, entry['attributes'][index])
                   raise Soar::Registry::Directory::Error::DuplicateEntryError if result.length > 0
                 end
               }
 
               @client.add({
-                dn: entry[:dn],
-                attributes: entry[:attributes]
+                dn: entry['dn'],
+                attributes: entry['attributes'].map { |k, v| [k.to_sym, v] }.to_h
               })
               return true
             end
@@ -66,7 +67,7 @@ module Soar
 
           ##
           # @param [String] primary key of the identity ie. the first index
-          # @return [Hash{Symbol => String, Number, Array}] single matching entry
+          # @return [Hash{String => 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
           ##
@@ -81,9 +82,9 @@ module Soar
               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[attribute] = result[0][attribute.to_sym][0]
               }
-              response
+              return response
             end
           end
 
@@ -91,7 +92,7 @@ module Soar
           ##
           # @param [String] key
           # @param [String] value
-          # @return [Array<Hash{Symbol => String, Array, Number}>] list of matching entries
+          # @return [Array<Hash{String => String, Array, Number}>] list of matching entries
           # @raise [ArgumentError] if value or named index is not specified
           ##
           def search(key, value)
@@ -106,7 +107,7 @@ module Soar
               entries.each { |entry|
                 response = {}
                 @attributes.each { |attribute| 
-                  response[attribute.to_sym] = entry[attribute.to_sym][0]
+                  response[attribute] = entry[attribute.to_sym][0]
                 }
                 result << response
               }
@@ -139,7 +140,7 @@ module Soar
           def adapt_exceptions
             begin
               yield
-            rescue Net::LDAP::BindingInformationInvalidError, Net::LDAP::ConnectionRefusedError, Errno::ECONNREFUSED => e
+            rescue Net::LDAP::BindingInformationInvalidError, Net::LDAP::NoBindResultError, Net::LDAP::ConnectionRefusedError, Errno::ECONNREFUSED => e
               raise Soar::Registry::Directory::Error::NetworkingError, e.message
             end
           end

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

@@ -38,7 +38,7 @@ module Soar
           end
 
           ##
-          # @param [Hash{Symbol => String, Number}] entry
+          # @param [Hash{String => String, Number}] entry
           # @return [Boolean]
           ##
           def put(entry)
@@ -51,7 +51,7 @@ module Soar
 
           ##
           # @param [String] primary key the first index
-          # @return [Hash{Symbol => String, Number}] single matching entry
+          # @return [Hash{String => 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
           ##
@@ -66,16 +66,16 @@ module Soar
                 field.name
               }
               result = mysql_statement.fetch
-              result = Hash[result.map.with_index { |value, index| 
+              return Hash[result.map.with_index { |value, index| 
                 [field_names[index.to_i], value]
-              }].symbolize_keys
+              }]
             end
           end
 
           ##
           # @param [String] key should be in indexed in db schema 
           # @param [String] value
-          # @return [Array<Hash{Symbol => String, Number}>] list of matching entries
+          # @return [Array<Hash{String => String, Number}>] list of matching entries
           # @raise [ArgumentError] if value or named index is not specified
           ##
           def search(key, value)
@@ -91,9 +91,9 @@ module Soar
               mysql_statement.each { |entry| 
                 result << Hash[entry.map.with_index { |value, index| 
                   [field_names[index.to_i], value]
-                }].symbolize_keys
+                }]
               }
-              result
+              return result
             end
           end
 
@@ -104,7 +104,7 @@ module Soar
             adapt_exceptions do
               index = []
               @client.query("SHOW INDEX FROM Client").each_hash { |entry| 
-                index << entry['Column_name'].to_sym
+                index << entry['Column_name']
               }
               index
             end

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

@@ -11,22 +11,22 @@ module Soar
             def initialize
               @configuration = YAML.load_file("config/#{ENV['CONFIG_FILE']}")
               @base = @configuration['provider']['config']['base']
-              @index = @configuration['provider']['config']['index'].map { |x| x.to_sym }
+              @index = @configuration['provider']['config']['index']
               @entries = [{
-                dn: "cn=John Smith,#{@base}",
-                attributes: {
-                  cn: "John Smith",
-                  mail: "test@example.com",
-                  objectclass: ["inetOrgPerson", "top"],
-                  sn: "Smith"
+                "dn" => "cn=John Smith,#{@base}",
+                "attributes" => {
+                  "cn" => "John Smith",
+                  "mail" => "test@example.com",
+                  "objectclass" => ["inetOrgPerson", "top"],
+                  "sn" => "Smith"
                 }
               }, {
-                dn: "cn=Sarel Cilliers,#{@base}",
-                attributes: {
-                  cn: "Sarel Cilliers",
-                  mail: "sarel@example.com",
-                  objectclass: ["inetOrgPerson", "top"],
-                  sn: "Cilliers"
+                "dn" => "cn=Sarel Cilliers,#{@base}",
+                "attributes" => {
+                  "cn" => "Sarel Cilliers",
+                  "mail" => "sarel@example.com",
+                  "objectclass" => ["inetOrgPerson", "top"],
+                  "sn" => "Cilliers"
                 }
               }]
               @connection_retries = 6
@@ -38,7 +38,7 @@ module Soar
                 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])
+                  provider.delete(entry['dn'])
                 }
               rescue Soar::Registry::Directory::Error::NetworkingError => e
                 raise if @connection_retries == 0
@@ -55,8 +55,8 @@ module Soar
             def given_existing_data
               @entries.each{ |entry| 
                 @directory.put(entry)
-                result = @directory.search("mail", entry[:attributes][:mail])
-                entry[:attributes][:entryuuid] = result[0][@index[0]]
+                result = @directory.search("mail", entry['attributes']['mail'])
+                entry['attributes']['entryuuid'] = result[0][@index[0]]
               }
             end
 
@@ -70,7 +70,6 @@ module Soar
                   password: @configuration['provider']['config']['credentials']['password']
                 }              
               })
-
             end
 
             def put_duplicate_entry
@@ -84,8 +83,8 @@ module Soar
             def put_entry
               begin
                 @directory.put(@entries[0])
-                result = @directory.search("mail", @entries[0][:attributes][:mail])
-                @entries[0][:attributes][:entryuuid] = result[0][@index[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
               end
@@ -93,7 +92,7 @@ module Soar
 
             def search_for_entry
               begin
-                @result = @directory.search("mail", @entries[0][:attributes][:mail])
+                @result = @directory.search("mail", @entries[0]['attributes']['mail'])
               rescue Soar::Registry::Directory::Error::NetworkingError => e
                 @error = e
               end
@@ -109,7 +108,7 @@ module Soar
 
             def fetch_entry
               begin
-                @result = @directory.fetch(@entries[0][:attributes][:entryuuid])
+                @result = @directory.fetch(@entries[0]['attributes']['entryuuid'])
               rescue Soar::Registry::Directory::Error::NoEntriesFoundError, Soar::Registry::Directory::Error::NetworkingError => e
                 @error = e
               end
@@ -120,15 +119,15 @@ module Soar
             end
 
             def persisted?
-              result = @directory.fetch(@entries[0][:attributes][:entryuuid])
-              entry = @entries[0][:attributes]
-              entry.delete(:objectclass)
+              result = @directory.fetch(@entries[0]['attributes']['entryuuid'])
+              entry = @entries[0]['attributes']
+              entry.delete('objectclass')
               result == entry
             end
 
             def returned?
-              entry = @entries[0][:attributes]
-              entry.delete(:objectclass)
+              entry = @entries[0]['attributes']
+              entry.delete('objectclass')
               @result == [entry]
             end
 
@@ -137,8 +136,8 @@ module Soar
             end
 
             def single_entry?
-              entry = @entries[0][:attributes]
-              entry.delete(:objectclass)
+              entry = @entries[0]['attributes']
+              entry.delete('objectclass')
               @result == entry
             end
 

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

@@ -12,20 +12,20 @@ module Soar
 
             def initialize
               @configuration = YAML.load_file("config/#{ENV['CONFIG_FILE']}")
-              @index = @configuration['provider']['config']['index'].map { |index| index.to_sym }
+              @index = @configuration['provider']['config']['index']
               @attributes = @configuration['provider']['config']['attributes']
               @entries = [{
-                ID: 1,
-                Client_Number: "C123456789",
-                Notifyemail_Invoice: "johnconner@example.com",
-                First_Name: 'John',
-                Surname: 'Connor'
+                "ID" => 1,
+                "Client_Number" => "C123456789",
+                "Notifyemail_Invoice" => "johnconner@example.com",
+                "First_Name" => 'John',
+                "Surname" => 'Connor'
               }, {
-                ID: 2,
-                First_Name: 'Sarah',
-                Surname: 'Connor',
-                Client_Number: "C101112134",
-                Notifyemail_Invoice: "sarahconnor@example.com" 
+                "ID" => 2,
+                "First_Name" => 'Sarah',
+                "Surname" => 'Connor',
+                "Client_Number" => "C101112134",
+                "Notifyemail_Invoice" => "sarahconnor@example.com" 
               }]
               @connection_retries = 6
             end
@@ -73,7 +73,7 @@ module Soar
 
             def search_for_entry
               begin
-                @result = @directory.search("Notifyemail_Invoice", @entries[0][:Notifyemail_Invoice])
+                @result = @directory.search("Notifyemail_Invoice", @entries[0]['Notifyemail_Invoice'])
               rescue Soar::Registry::Directory::Error::NetworkingError => e
                 @error = e.message
               end
@@ -89,14 +89,14 @@ module Soar
 
             def fetch_entry
               begin
-                @result = @directory.fetch(@entries[0][:ID])
+                @result = @directory.fetch(@entries[0]['ID'])
               rescue Soar::Registry::Directory::Error::NoEntriesFoundError, Soar::Registry::Directory::Error::NetworkingError => e
                 @error = e.message
               end
             end
 
             def persisted?
-              @directory.fetch(@entries[0][:ID]) == @entries[0]
+              @directory.fetch(@entries[0]['ID']) == @entries[0]
             end
 
             def returned?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soar-registry-directory
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Charles Mulder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashy_db