ad-framework 0.1.0

data/lib/ad-framework/patterns/persistence.rb

@@ -0,0 +1,67 @@
+module AD
+  module Framework
+    module Patterns
+
+      module Persistence
+        class << self
+
+          def included(klass)
+            klass.class_eval do
+              extend AD::Framework::Patterns::Persistence::ClassMethods
+              include AD::Framework::Patterns::Persistence::InstanceMethods
+            end
+          end
+
+        end
+
+        module InstanceMethods
+
+          def new_entry?
+            !(self.fields[:distinguishedname] || self.fields[:dn])
+          end
+
+          def save
+            if self.new_entry?
+              self.create
+            else
+              self.update
+            end
+          end
+          def create
+            self.fields[:distinguishedname] = self.dn
+            self.fields[:objectclass] = (self.schema.object_classes.collect do |object_class|
+              object_class.schema.ldap_name
+            end).compact
+            self.connection.add({ :dn => self.dn, :attributes => self.fields.to_hash })
+            self.reload
+          end
+          def update
+            self.connection.open do |c|
+              self.fields.changes.each do |name, value|
+                c.replace_attribute(self.dn, name, value)
+              end
+            end
+            self.reload
+          end
+
+          def destroy
+            self.connection.delete(self.dn)
+          end
+
+        end
+
+        module ClassMethods
+
+          def create(args = {})
+            entry = self.new(args)
+            entry.create
+            entry
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/ad-framework/patterns/searchable.rb

@@ -0,0 +1,117 @@
+require 'ad-framework/utilities/entry_builder'
+require 'ad-framework/exceptions'
+
+module AD
+  module Framework
+    module Patterns
+
+      module Searchable
+        class << self
+
+          def included(klass)
+            klass.class_eval do
+              extend AD::Framework::Patterns::Searchable::ClassMethods
+              include AD::Framework::Patterns::Searchable::InstanceMethods
+            end
+          end
+
+        end
+
+        module InstanceMethods
+
+          def reload
+            args = {
+              :where => { :dn__eq => (self.fields[:distinguishedname] || self.fields[:dn]) },
+              :limit => 1
+            }
+            search_args = self.class.build_ad_search_args(args)
+            ldap_entry = self.connection.search(search_args).first
+            if ldap_entry
+              AD::Framework::Utilities::EntryBuilder.new(ldap_entry, { :reload => self })
+            else
+              dn = args[:where][:dn__eq]
+              raise(*[
+                AD::Framework::EntryNotFound,
+                "An entry could not be found with dn #{dn.inspect} (#{self.class})"
+              ])
+            end
+            self
+          end
+
+        end
+
+        module ClassMethods
+
+          def find(dn)
+            dn = self.build_ad_dn(dn)
+            args = { :where => { :dn__eq => dn }, :size => 1 }
+            object = self.fetch_ad_entry(args)
+            if !object
+              dn = args[:where][:dn__eq]
+              raise(*[
+                AD::Framework::EntryNotFound,
+                "An entry could not be found with dn #{dn.inspect} (#{self.class})"
+              ])
+            end
+            object
+          end
+
+          def first(args = {})
+            args = { :where => args, :size => 1 }
+            self.fetch_ad_entry(args)
+          end
+
+          def all(args = {})
+            self.fetch_ad_entry(args, true)
+          end
+
+          def build_ad_search_args(args = {})
+            default_args = {
+              :objectclass__eq => self.schema.ldap_name,
+              :base => self.schema.treebase
+            }
+            (args || {}).inject(default_args) do |search_args, (key, value)|
+              case(key.to_sym)
+              when :where
+                if value.kind_of?(Array)
+                  value = value.inject({}){|where, condition| where.merge(condition) }
+                end
+                search_args.merge(value)
+              when :limit
+                search_args.merge({ :size => value })
+              else
+                search_args.merge({ key => value })
+              end
+            end
+          end
+
+          protected
+
+          def fetch_ad_entry(args, collection = false)
+            search_args = self.build_ad_search_args(args)
+            results = self.connection.search(search_args)
+            if !collection
+              ldap_entry = results.first
+              AD::Framework::Utilities::EntryBuilder.new(ldap_entry).entry
+            else
+              results.collect do |ldap_entry|
+                AD::Framework::Utilities::EntryBuilder.new(ldap_entry).entry
+              end
+            end
+          end
+
+          def build_ad_dn(dn)
+            if dn !~ /DC=|CN=/
+              [ "CN=#{dn}", self.treebase ].compact.join(", ")
+            else
+              dn
+            end
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/ad-framework/patterns/validations.rb

@@ -0,0 +1,50 @@
+require 'ad-framework/utilities/validator'
+
+module AD
+  module Framework
+    module Patterns
+
+      module Validations
+        class << self
+
+          def included(klass)
+            klass.class_eval do
+              include AD::Framework::Patterns::Validations::InstanceMethods
+            end
+          end
+
+        end
+
+        module InstanceMethods
+          attr_accessor :errors
+          
+          def errors
+            @errors ||= {}
+          end
+
+          [ :create, :update ].each do |name|
+
+            define_method(name) do
+              if self.valid?
+                super
+                true
+              else
+                false
+              end
+            end
+
+          end
+
+          def valid?
+            validator = AD::Framework::Utilities::Validator.new(self)
+            self.errors = validator.errors
+            self.errors.empty?
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/ad-framework/schema.rb

@@ -0,0 +1,118 @@
+require 'ad-framework/attribute'
+
+module AD
+  module Framework
+
+    class Schema
+      attr_accessor :ldap_name, :rdn, :attributes, :structural_classes, :auxiliary_classes
+      attr_accessor :mandatory, :klass, :callbacks
+
+      def initialize(klass)
+        self.klass = klass
+
+        self.rdn = :name
+        self.auxiliary_classes = []
+        self.callbacks = {}
+
+        if self.klass.is_a?(::Class) && self.klass.superclass.respond_to?(:schema)
+          self.inherit_from(self.klass.superclass.schema)
+        else
+          self.attributes = Set.new
+          self.mandatory = Set.new
+          self.structural_classes = []
+        end
+      end
+
+      def ldap_name
+        if @ldap_name
+          [ AD::Framework.config.ldap_prefix,
+            @ldap_name
+          ].compact.join
+        end
+      end
+
+      def treebase
+        if @treebase && self.default_treebase && !(@treebase.include?(self.default_treebase))
+          [ @treebase, self.default_treebase ].join(", ")
+        else
+          (@treebase || self.default_treebase)
+        end
+      end
+
+      def treebase=(new_value)
+        @treebase = new_value
+      end
+
+      def add_attributes(attribute_names)
+        self.add_read_attributes(attribute_names)
+        self.add_write_attributes(attribute_names)
+      end
+
+      def add_read_attributes(attribute_names)
+        attribute_names.collect(&:to_sym).each do |name|
+          AD::Framework::Attribute.new(name).define_reader(self.klass)
+          self.attributes << name.to_sym
+        end
+      end
+
+      def add_write_attributes(attribute_names)
+        attribute_names.collect(&:to_sym).each do |name|
+          AD::Framework::Attribute.new(name).define_writer(self.klass)
+        end
+      end
+
+      def add_mandatory(attribute_names)
+        attribute_names.each do |attribute_name|
+          self.mandatory << attribute_name
+        end
+      end
+
+      def object_classes
+        [ self.structural_classes.to_a,
+          self.klass,
+          self.auxiliary_classes.to_a
+        ].flatten.compact
+      end
+
+      def add_auxiliary_class(klass)
+        self.auxiliary_classes << klass
+        self.bring_in(klass.schema)
+        self.auxiliary_classes.uniq!
+      end
+
+      def add_callback(timing, action, method_names)
+        self.callbacks[action.to_sym] ||= {}
+        self.callbacks[action.to_sym][timing.to_sym] ||= []
+        method_names.each do |method_name|
+          self.callbacks[action.to_sym][timing.to_sym] << method_name
+        end
+      end
+
+      def inspect
+        attrs_display = [ :klass, :ldap_name, :rdn, :attributes ].collect do |attr|
+          "#{attr}: #{self.send(attr).inspect}"
+        end
+        [ "#<#{self.class} ", attrs_display.join(", "), ">" ].join
+      end
+
+      protected
+
+      def default_treebase
+        AD::Framework.config.treebase
+      end
+
+      def inherit_from(schema)
+        self.attributes = schema.attributes.dup
+        self.structural_classes = schema.structural_classes.dup
+        self.structural_classes << self.klass.superclass
+        self.mandatory = schema.mandatory.dup
+      end
+
+      def bring_in(schema)
+        self.attributes.merge(schema.attributes)
+        self.mandatory.merge(schema.mandatory)
+      end
+    end
+
+  end
+end

data/lib/ad-framework/structural_class.rb

@@ -0,0 +1,61 @@
+require 'ad-framework/fields'
+require 'ad-framework/patterns/callbacks'
+require 'ad-framework/patterns/has_schema'
+require 'ad-framework/patterns/persistence'
+require 'ad-framework/patterns/searchable'
+require 'ad-framework/patterns/validations'
+
+module AD
+  module Framework
+
+    class StructuralClass
+      include AD::Framework::Patterns::HasSchema
+      include AD::Framework::Patterns::Persistence
+      include AD::Framework::Patterns::Searchable
+      include AD::Framework::Patterns::Callbacks
+      include AD::Framework::Patterns::Validations
+
+      attr_accessor :meta_class, :fields
+
+      def initialize(attributes = {})
+        self.meta_class = class << self; self; end
+
+        self.fields = AD::Framework::Fields.new(attributes.delete(:fields) || {})
+        if (treebase = (attributes.delete(:treebase) || attributes.delete("treebase")))
+          self.treebase = treebase
+        end
+
+        self.attributes = attributes
+      end
+
+      def treebase
+        self.schema.treebase
+      end
+      def treebase=(new_value)
+        self.schema.treebase = new_value
+      end
+
+      def connection
+        self.class.connection
+      end
+
+      def inspect
+        (attr_display = self.attributes.collect do |(name, value)|
+          "#{name}: #{value.inspect}"
+        end)
+        attr_display << "treebase: #{self.treebase.inspect}"
+        [ "#<#{self.class} ", attr_display.sort.join(", "), ">" ].join
+      end
+
+      class << self
+
+        def connection
+          AD::Framework.connection
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/ad-framework/utilities/entry_builder.rb

@@ -0,0 +1,77 @@
+require 'ad-framework/auxiliary_class'
+require 'ad-framework/exceptions'
+require 'ad-framework/fields'
+require 'ad-framework/structural_class'
+
+module AD
+  module Framework
+    module Utilities
+
+      class EntryBuilder
+        attr_accessor :ldap_entry, :entry, :fields
+
+        def initialize(ldap_entry, options = {})
+          self.ldap_entry = ldap_entry
+          
+          if self.ldap_entry
+            self.fields = AD::Framework::Fields.new(self.ldap_entry || {})
+            if options[:reload]
+              self.entry = options[:reload]
+              self.reload
+            else
+              self.build
+            end
+          end
+        end
+
+        def reload
+          self.entry.fields = self.fields
+          self.entry.schema.attributes.each do |name|
+            self.entry.send("#{name}_attribute_type").reset
+          end
+          self.link_auxiliary_classes
+        end
+
+        def build
+          structure = self.classes_structure
+          self.entry = structure[:structural_class].new({ :fields => self.fields })
+          self.link_auxiliary_classes(structure)
+        end
+
+        protected
+
+        def link_auxiliary_classes(structure = self.classes_structure)
+          (structure[:auxiliary_classes] || []).each do |klass|
+            if !self.entry.schema.auxiliary_classes.include?(klass)
+              self.entry.meta_class.class_eval do
+                include klass
+              end
+            end
+            self.entry.schema.add_auxiliary_class(klass)
+          end
+        end
+
+        def classes_structure
+          (self.fields["objectclass"] || []).inject({}) do |processed, ldap_name|
+            object_class = AD::Framework.defined_object_classes[ldap_name]
+            if !object_class
+              raise(*[
+                AD::Framework::ObjectClassNotDefined,
+                "An object class with the name #{ldap_name.inspect} is not defined"
+              ])
+            end
+            if object_class.ancestors.include?(AD::Framework::StructuralClass)
+              processed[:structural_class] = object_class
+            elsif object_class.included_modules.include?(AD::Framework::AuxiliaryClass)
+              processed[:auxiliary_classes] ||= []
+              processed[:auxiliary_classes] << object_class
+            end
+            processed
+          end
+        end
+
+      end
+
+    end
+  end
+end