cloud-templates 0.1.0

data/examples/lib/user_directory/render/etc/artifact_view.rb

@@ -0,0 +1,15 @@
+require 'user_directory/render/etc/registry'
+
+module UserDirectory
+  module Render
+    module Etc
+      ##
+      # Basic render
+      #
+      # It just puts a link between children and type registrar
+      class ArtifactView < Aws::Templates::Render::View
+        register_in Render::Etc
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/etc/composite_view.rb

@@ -0,0 +1,26 @@
+require 'aws/templates/composite'
+require 'user_directory/render/etc/artifact_view'
+
+module UserDirectory
+  module Render
+    module Etc
+      ##
+      # Composite render
+      #
+      # It aggregates group and passwd entries from children and merges
+      # them into single entry
+      class CompositeView < ArtifactView
+        artifact Aws::Templates::Composite
+
+        def prepare
+          rendered_for(instance.artifacts.values)
+            .each_with_object(Diff.new([], [])) do |diff, memo|
+              memo.passwd.concat(diff.passwd)
+              memo.group.concat(diff.group)
+              memo
+            end
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/etc/group_view.rb

@@ -0,0 +1,23 @@
+require 'user_directory/render/etc/artifact_view'
+
+module UserDirectory
+  module Render
+    module Etc
+      ##
+      # POSIX group render
+      #
+      # Creates group file entry.
+      class GroupView < ArtifactView
+        artifact UserDirectory::Group
+
+        def prepare
+          Diff.new [], [group_record.join(':')]
+        end
+
+        def group_record
+          in_instance { [name, 'x', id, members.map(&:login).join(',')] }
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/etc/person_view.rb

@@ -0,0 +1,19 @@
+require 'user_directory/render/etc/user_view'
+
+module UserDirectory
+  module Render
+    module Etc
+      ##
+      # Person render
+      #
+      # The same as POSIX user but with customized GECOS field.
+      class PersonView < UserView
+        artifact UserDirectory::Person
+
+        def user_info
+          in_instance { "#{cn},,#{phone}" }
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/etc/registry.rb

@@ -0,0 +1,33 @@
+require 'aws/templates/render/utils/base_type_views'
+require 'aws/templates/render/view'
+require 'pathname'
+
+module UserDirectory
+  module Render
+    ##
+    # UNIX passwd/group render
+    #
+    # Transforms formed catalog artifacts into standard UNIX passwd/group
+    # representation.
+    module Etc
+      extend Aws::Templates::Render::Utils::BaseTypeViews
+      initialize_base_type_views
+      register Pathname, Aws::Templates::Render::Utils::BaseTypeViews::ToString
+      Diff = Struct.new(:passwd, :group)
+
+      ##
+      # Diff view
+      #
+      # Creates Diff object out of the instance atached with recursively rendered passwd and group
+      # fields.
+      class DiffView < Aws::Templates::Render::BasicView
+        register_in Etc
+        artifact Diff
+
+        def to_rendered
+          Diff.new rendered_for(instance.passwd), rendered_for(instance.group)
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/etc/user_view.rb

@@ -0,0 +1,35 @@
+require 'user_directory/render/etc/artifact_view'
+require 'user_directory/artifacts/user'
+
+module UserDirectory
+  module Render
+    module Etc
+      ##
+      # POSIX user render
+      #
+      # It creates passwd file entry
+      class UserView < ArtifactView
+        artifact UserDirectory::User
+
+        def prepare
+          Diff.new [user_record.join(':')], []
+        end
+
+        def user_record
+          [
+            instance.login, 'x', instance.id, instance.group.id,
+            user_info, path_for(instance.home_directory), path_for(instance.shell)
+          ]
+        end
+
+        def user_info
+          instance.login
+        end
+
+        def path_for(obj)
+          obj && obj.path
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/etc.rb

@@ -0,0 +1,3 @@
+Dir.glob("#{File.dirname(__FILE__)}/etc/*.rb").each do |file|
+  require file
+end

data/examples/lib/user_directory/render/ldap/artifact_view.rb

@@ -0,0 +1,27 @@
+require 'aws/templates/artifact'
+require 'user_directory/render/ldap/registry'
+
+module UserDirectory
+  module Render
+    module LDAP
+      ##
+      # Basic render
+      #
+      # It just puts a link between children and type registrar
+      class ArtifactView < Aws::Templates::Render::View
+        register_in Render::LDAP
+        artifact Aws::Templates::Artifact
+
+        def prepare
+          { dn: instance.dn, objectClass: object_class }
+        end
+
+        protected
+
+        def object_class
+          %w[top]
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/ldap/composite_view.rb

@@ -0,0 +1,32 @@
+require 'aws/templates/composite'
+require 'user_directory/render/ldap/registry'
+
+module UserDirectory
+  module Render
+    module LDAP
+      ##
+      # Composite render
+      #
+      # It aggregates LDIF entries from the children into a single list
+      # putting composite's own LDIF entry into the list head.
+      class CompositeView < Aws::Templates::Render::View
+        register_in Render::LDAP
+        artifact Aws::Templates::Composite
+
+        def prepare
+          rendered_for(instance.artifacts.values).flatten.unshift(entry)
+        end
+
+        protected
+
+        def entry
+          { dn: instance.dn, objectClass: object_class }
+        end
+
+        def object_class
+          %w[top]
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/ldap/group_view.rb

@@ -0,0 +1,28 @@
+require 'user_directory/render/ldap/artifact_view'
+require 'user_directory/artifacts/group'
+
+module UserDirectory
+  module Render
+    module LDAP
+      ##
+      # POSIX group render
+      #
+      # Creates group LDIF entry.
+      class GroupView < ArtifactView
+        artifact UserDirectory::Group
+
+        def prepare
+          super().merge(
+            in_instance { { cn: cn, gidNumber: id, memberUid: members.map(&:login) } }
+          )
+        end
+
+        protected
+
+        def object_class
+          super() << 'posixGroup'
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/ldap/organization_view.rb

@@ -0,0 +1,26 @@
+require 'user_directory/render/ldap/composite_view'
+require 'user_directory/artifacts/organization'
+
+module UserDirectory
+  module Render
+    module LDAP
+      ##
+      # Catalog's organization render
+      #
+      # It renders into organization's LDIF entry with merged list of children.
+      class OrganizationView < CompositeView
+        artifact UserDirectory::Organization
+
+        protected
+
+        def entry
+          super().merge(o: instance.name)
+        end
+
+        def object_class
+          super() << 'organization'
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/ldap/person_view.rb

@@ -0,0 +1,39 @@
+require 'user_directory/render/ldap/user_view'
+require 'user_directory/artifacts/person'
+
+module UserDirectory
+  module Render
+    module LDAP
+      ##
+      # Person render
+      #
+      # It merges POSIX user entry with additional fields and object
+      # types valid for a real person.
+      class PersonView < UserView
+        artifact UserDirectory::Person
+
+        def prepare
+          hsh = in_instance do
+            hsh = {
+              gecos: "#{cn},,#{phone}",
+              givenName: given_name,
+              sn: last_name
+            }
+
+            hsh[:manager] = manager.dn if manager
+
+            hsh
+          end
+
+          super().merge(hsh)
+        end
+
+        protected
+
+        def object_class
+          super().concat(%w[inetOrgPerson person])
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/ldap/registry.rb

@@ -0,0 +1,16 @@
+require 'aws/templates/render/utils/base_type_views'
+require 'pathname'
+
+module UserDirectory
+  module Render
+    ##
+    # LDIF render
+    #
+    # Transforms formed catalog artifacts into LDIF definition.
+    module LDAP
+      extend Aws::Templates::Render::Utils::BaseTypeViews
+      initialize_base_type_views
+      register Pathname, Aws::Templates::Render::Utils::BaseTypeViews::ToString
+    end
+  end
+end

data/examples/lib/user_directory/render/ldap/unit_view.rb

@@ -0,0 +1,26 @@
+require 'user_directory/render/ldap/composite_view'
+require 'user_directory/artifacts/unit'
+
+module UserDirectory
+  module Render
+    module LDAP
+      ##
+      # Catalog's org unit render
+      #
+      # It renders into unit's LDIF entry with merged list of children.
+      class UnitView < CompositeView
+        artifact UserDirectory::Unit
+
+        protected
+
+        def entry
+          super().merge(ou: instance.name)
+        end
+
+        def object_class
+          super() << 'organizationalUnit'
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/ldap/user_view.rb

@@ -0,0 +1,39 @@
+require 'user_directory/render/ldap/artifact_view'
+require 'user_directory/artifacts/user'
+
+module UserDirectory
+  module Render
+    module LDAP
+      ##
+      # POSIX user render
+      #
+      # It creates POSIX user LDIF entry
+      class UserView < ArtifactView
+        artifact UserDirectory::User
+
+        def prepare
+          super().merge(cn: instance.cn).merge(passwd_block)
+        end
+
+        def object_class
+          super() << 'posixAccount'
+        end
+
+        def passwd_block
+          {
+            uid: instance.login,
+            uidNumber: instance.id,
+            gidNumber: instance.group.id,
+            homeDirectory: path_for(instance.home_directory),
+            loginShell: path_for(instance.shell),
+            gecos: instance.login
+          }
+        end
+
+        def path_for(obj)
+          obj && obj.path.to_s
+        end
+      end
+    end
+  end
+end

data/examples/lib/user_directory/render/ldap.rb

@@ -0,0 +1,3 @@
+Dir.glob("#{File.dirname(__FILE__)}/ldap/*.rb").each do |file|
+  require file
+end

data/examples/lib/user_directory/utils.rb

@@ -0,0 +1,18 @@
+require 'aws/templates/utils/parametrized/constraints'
+
+module UserDirectory
+  ##
+  # Auxilliary utils
+  module Utils
+    ##
+    # Custom constraint for phone number
+    #
+    # Checks if value passed is a valid phone number
+    def self.phone_number
+      Aws::Templates::Utils::Parametrized::Constraint::SatisfiesCondition
+        .new('Should be a valid phone number') do |phone|
+          phone =~ /^[+]?[0-9\-]+$/
+        end
+    end
+  end
+end

data/examples/lib/user_directory.rb

@@ -0,0 +1,23 @@
+require 'user_directory/artifacts/user'
+require 'user_directory/artifacts/person'
+require 'user_directory/artifacts/group'
+require 'user_directory/artifacts/unit'
+require 'user_directory/artifacts/team'
+require 'user_directory/artifacts/organization'
+
+require 'user_directory/render/etc'
+require 'user_directory/render/ldap'
+
+##
+# Example implementation of catalog
+#
+# This is a demonstration of how one could use the framework.
+# In this example, we can render set of users and groups embedded
+# into org structure into two principally different representations:
+# * UNIX passwd/group files
+# * LDIF definition
+# It is important to emphasize that representations are rendered from
+# the same logical source. It is an example of loosened MVC pattern
+# used in the framework.
+module UserDirectory
+end

data/examples/lib_path.rb

@@ -0,0 +1,2 @@
+libdir = File.dirname(__FILE__) + '/lib'
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)

data/examples/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'simplecov'