soar-registry-identity 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 484df2d3ddb8d8e2b5438fbad4b64f5082cbdf2b
-  data.tar.gz: 0115319b3e7636d6e5bd6cdf7eace3975dbadfdb
+  metadata.gz: 9437adb33b4379cc43f32fd3114f5747f232f6c8
+  data.tar.gz: 8da8b86504e04fe071dc025023ce0dd09df82a16
 SHA512:
-  metadata.gz: 015afb53bd02703e74b64e9ae518f60267eefa7c3965b0ad6a37505767c1240d2ab18bb92726af2775fbad2053299944e6dcfc145d284604fc351bcae8ac883b
-  data.tar.gz: 5ba3a6752b13b05e30888b6c3ef9967863e0c3db21f222a219924c9e433c64c6a6478e17bb4f6f503f3972eb2cdb4d899c84d1a4279a247dbb8f167061eee6af
+  metadata.gz: 3a8048aaeb8838dbe4addf80b864b2792790a7ad13ea432c8aa244feee4f807b409498cb859d8c3e206181643c2049b3d6402681f6ac7e81e1a0cdddcae19821
+  data.tar.gz: a35ba39309eee4ed3ded67690cca8090f52b09e906b17ab4bfb039eef8a98998948c42d442d87e94aad131a9690c26a5dd36ce6974a6c903f2586734b215b4b3

data/README.md

@@ -2,44 +2,63 @@
 
 ## Quickstart
 
+### Example data
+```javascript
+"identities" = [{
+    "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": ["*"]
+         }
+    }
+}]
+```
+
 ### Directory
 Create a directory provider
 
 ```ruby
 require 'soar/registry/directory'
-directory_provider = Soar::Registry::Directory::Provider::Stub.new
+directory_provider = Soar::Registry::Directory::Provider::Stub.new(
+  table: "identities",
+  primary_key: "uuid",
+  index: ["uuid", "entity_id", "email"]
+)
 ```
 
 Create a directory
 ```ruby
-directory = Soar::Registry::Directory.new({
-  provider: directory_provider
-})
+directory = Soar::Registry::Directory.new(directory_provider)
 ```
 
 ### Staff UUID IDR
 Search for staff by UUID.
 
-Create an identity provider. (Remember to pass in the directory)
+Create an identity provider. 
 ```ruby
 require 'soar/registry/identity'
-identity_provider = Soar::Registry::Identity::Provider::Staff::Id.new(directory)
+identity_provider = Soar::Registry::Identity::Provider::Staff::Id.new(directory: directory)
 ```
 
 Create an IDR
 ```ruby
-@id_idr = Soar::Registry::Identity.new(provider: identity_provider)
+@id_idr = Soar::Registry::Identity.new(identity_provider)
 ```
 
 ### Staff Email IDR
-Search for staff by email address. (Remember to pass in the directory)
+Search for staff by email address. 
 ```ruby
 require 'soar/registry/identity'
-identity_provider = Soar::Registry::Identity::Provider::Staff::Email.new(directory)
+identity_provider = Soar::Registry::Identity::Provider::Staff::Email.new(directory: directory)
 ```
 
 ```ruby
-@email_idr = Soar::Registry::Identity.new(provider: identity_provider)
+@email_idr = Soar::Registry::Identity.new(identity_provider)
 ```
 
 ### Getting a list of identifiers

data/lib/soar/registry/identity.rb

@@ -3,8 +3,8 @@ require 'soar/registry/identity/model'
 module Soar
   module Registry
     module Identity
-      def self.new(provider: nil)
-        Soar::Registry::Identity::Model.new(provider: provider)
+      def self.new(provider)
+        Soar::Registry::Identity::Model.new(provider)
       end
     end
   end

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

@@ -5,7 +5,7 @@ module Soar
   module Registry
     module Identity
       class Model
-        def initialize(provider: nil)
+        def initialize(provider)
           @provider = provider
         end
 

data/lib/soar/registry/identity/provider/staff/base.rb

@@ -14,7 +14,7 @@ module Soar
             ##
             # @param [Hash] configuration
             ##
-            def initialize(directory)
+            def initialize(directory: nil)
               @translator = Soar::Registry::Identity::Provider::Staff::Translator::Default.new
               @directory = directory
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar-registry-identity
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Charles Mulder
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 1.0.0
 description: Registry of identities
 email: charles.mulder@hetzner.co.za
 executables: []