irjudson-dm-ldap-adapter 0.0.9

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 / 2009-05-22
+
+* Release!
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Montana State University
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO
+lib/ldap_adapter.rb
+lib/ldap_adapter/version.rb
+spec/integration/ldap_adapter_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/install.rb
+tasks/spec.rb

data/README.txt

@@ -0,0 +1,107 @@
+= dm-ldap-adapter
+
+A DataMapper adapter for Lightweight Directory Access Protocol (LDAP) servers.
+
+== Usage
+
+DM LDAP Adapter enables the creation of application objects that map
+against an existing LDAP server. For example, a "user" can map against
+the posixAccount schema in an LDAP server providing uidNumber,
+gidNumber, uid, homeDirectory and userPassword. These are intended to
+map to unix accounts so that authentication on unix systems can be
+centrally managed by the LDAP server.
+
+Currently, mapping LDAP schemas to application objects must be done
+manually by the developer, but the intent is to create a set of
+objects corresponding to the set of most commonly used LDAP schemas so
+application developers can leverage them with less effort.
+
+DataMapper.setup(:default, {
+                   :adapter => 'ldap',
+                   :host => 'localhost',
+                   :port => '389',
+                   :base => "ou=people,dc=example,dc=com",
+                   :username => "cn=admin,dc=example,dc=com",
+                   :password => "exPa5$w0rd"
+                 })
+
+
+class User
+  include DataMapper::Resource
+
+  @@base = "ou=people,dc=example,dc=com"
+
+  @@objectclass = [ "top", "person", "organizationalPerson", "inetOrgPerson",
+                     "extensibleObject", "shadowAccount", "posixAccount" ]
+
+  property :username,      String,   :field => "uid", :key => true
+  property :uuid,          String,   :field => "uniqueidentifier"
+  property :name,          String,   :field => "cn"
+  property :first_name,    String,   :field => "givenname"
+  property :last_name,     String,   :field => "sn"
+  property :mail,          String,   :field => "mail"
+  property :groupid,       Integer,  :field => "gidnumber"
+  property :userid,        Integer,  :field => "uidnumber"
+  property :homedirectory, String,   :field => "homedirectory"
+
+  def objectclass
+    @@objectclass
+  end
+
+  def make_dn
+    "uid=#{netid},#{@@base}"
+  end
+end
+
+This is exactly like normal datamapper models, with a couple of extras
+to make LDAP function.
+
+@@base is a class variable that defines where in the LDAP hierarchy
+this class of objects reside, it represents a path from the root. This
+is important because each piece of ldap data is uniquely identified by
+a distinguisedName which is the key attribute + @@base. For example,
+the distinguishedName "uid=testuser,ou=people,dc=example,dc=com"
+uniquely identifies the test user in the LDAP server.
+
+@@objectclass is the list of LDAP schemas that are required to define
+this particular LDAP object. Each schema contributes some set of
+attributes that, when taken together, define all the objects at that
+location in the LDAP tree. This list is required when new resources
+are created in LDAP, but ideally should be hidden from the application
+developer.
+
+== Code
+
+# Create
+user = User.new(:username => "dmtest", :uuid => UUID.random_create().to_s,
+                :name => "DataMapper Test", :homedirectory => "/home/dmtest",
+                :first_name => "DataMapperTest", :last_name => "User",
+                :userid => 3, :groupid => 500)
+
+user.save
+
+# Retrieve
+user = User.first(:username => 'dmtest')
+puts user
+
+# Modify
+user.update_attributes(:name => 'DM Test')
+user.save
+puts user
+
+# Delete
+result = user.destroy
+puts "Result: #{result}"
+
+== TODO:
+
+- Figure out a good testing strategy, get standard adapter tests in place
+
+- Finish query implementation (limit, order, etc)
+
+- Consider making pre-mapped resources corresponding to the most
+  commonly used LDAP object types so applications can use them without
+  duplication of effort for each application.
+
+- Documentation clean up
+

data/Rakefile

@@ -0,0 +1,30 @@
+require 'pathname'
+require 'rubygems'
+require 'hoe'
+
+ROOT    = Pathname(__FILE__).dirname.expand_path
+JRUBY   = RUBY_PLATFORM =~ /java/
+WINDOWS = Gem.win_platform?
+SUDO    = (WINDOWS || JRUBY) ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+require ROOT + 'lib/ldap_adapter/version'
+
+# define some constants to help with task files
+GEM_NAME    = 'dm-ldap-adapter'
+GEM_VERSION = DataMapper::LdapAdapter::VERSION
+
+Hoe.spec(GEM_NAME) do |p|
+  p.developer('Ivan R. Judson', 'ivan.judson [a] montana [d] edu')
+
+  p.description = 'A DataMapper Adapter for LDAP.'
+  p.summary = 'A DataMapper Adapter for LDAP (The Lightweight Directory Access Protocol)'
+  p.url = 'http://github.com/irjudson/dm-ldap-adapter'
+
+  p.clean_globs |= %w[ log pkg coverage ]
+  p.spec_extras = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO History.txt ] }
+
+  p.extra_deps << ['dm-core', "0.9.11"]
+
+end
+
+Pathname.glob(ROOT.join('tasks/**/*.rb').to_s).each { |f| require f }

data/lib/ldap_adapter.rb

@@ -0,0 +1,348 @@
+require 'dm-core'
+require 'net/ldap'
+
+module DataMapper
+  module Adapters
+    # The documentation for this adapter was taken from
+    #
+    # lib/dm-core/adapters/in_memory_adapter.rb
+    #
+    # Which is intended as a general source of documentation for the
+    # implementation to be followed by all DataMapper adapters.  The
+    # implementor is well advised to read over the adapter before
+    # implementing their own.
+    #
+    class LdapAdapter < AbstractAdapter
+      ##
+      # Used by DataMapper to put records into a data-store: "INSERT"
+      # in SQL-speak.  It takes an array of the resources (model
+      # instances) to be saved. Resources each have a key that can be
+      # used to quickly look them up later without searching, if the
+      # adapter supports it.
+      #
+      # @param [Array<DataMapper::Resource>] resources
+      #   The set of resources (model instances)
+      #
+      # @return [Integer]
+      #   The number of records that were actually saved into the
+      #   data-store
+      #
+      # @api semipublic
+      def create(resources)
+
+        created = 0
+        resources.each do |resource|
+          # Convert resources into LDAP (which just takes a hash!)
+          ldap_obj = convert_resource_to_hash(resource)
+          dn = resource.make_dn
+          ldap_obj[:objectclass] = resource.objectclass
+
+          if ldap_obj.nil? || dn.nil?
+            puts "Problem converting resource to hash for LdapAdapter"
+            return -1
+          end
+
+          # Call LDAP create
+          begin
+            @ldap.add(:dn => dn, :attributes => ldap_obj)
+          rescue Net::LDAP::LdapError => e
+            puts "There was an error adding the ldap object: ", e
+            puts " => #{@ldap.get_operation_result.message}"
+            return -1
+          end
+
+          # Accumulate successful create calls to return
+          if @ldap.get_operation_result.code == 0
+            created = created + 1
+          else
+            puts "LDAP Add Error: #{@ldap.get_operation_result.message}"
+          end
+        end
+
+        # Return number created
+        return created
+      end
+
+      ##
+      # Used by DataMapper to update the attributes on existing
+      # records in a data-store: "UPDATE" in SQL-speak. It takes a
+      # hash of the attributes to update with, as well as a query
+      # object that specifies which resources should be updated.
+      #
+      # @param [Hash] attributes
+      #   A set of key-value pairs of the attributes to update the
+      #   resources with.
+      # @param [DataMapper::Query] query
+      #   The query that should be used to find the resource(s) to update.
+      #
+      # @return [Integer]
+      #   the number of records that were successfully updated
+      #
+      # @api semipublic
+      def update(attributes, query)
+        updated = 0
+
+        # Convert query conditions to ldap filter
+        filter = convert_conditions(query.conditions)
+
+        # Convert attributes/query into LDAP
+        entries = @ldap.search(:filter => filter)
+
+        # Process updates (being careful to distinguish between add and update
+        entries.each do |entry|
+          existing = entry.attribute_names.map { |a| a.to_s }
+          attributes.each do |attribute, value|
+            property = attribute.field.to_s
+
+            ops = []
+            if existing.include?(property)
+              ops << [:replace, attribute.field.to_sym, value]
+            else
+              ops << [:add, attribute.field.to_sym, value]
+            end
+
+            @ldap.modify(:dn => entry.dn, :operations => ops)
+
+            if @ldap.get_operation_result.code == 0
+              updated = updated + 1
+            else
+              puts "LDAP Modify Error: #{@ldap.get_operation_result.message}"
+            end
+          end
+        end
+
+        # Return Number updated
+        return updated
+      end
+
+      ##
+      # Look up a single record from the data-store. "SELECT ... LIMIT
+      # 1" in SQL.  Used by Model#get to find a record by its
+      # identifier(s), and Model#first to find a single record by some
+      # search query.
+      #
+      # @param [DataMapper::Query] query
+      #   The query to be used to locate the resource.
+      #
+      # @return [DataMapper::Resource]
+      #   A Resource object representing the record that was found, or
+      #   nil for no matching records.
+      #
+      # @api semipublic
+      def read_one(query)
+        # Call read_many(query)
+        all_results = self.read_many(query)
+
+        # Return first result
+        return all_results.first
+      end
+
+      ##
+      # Looks up a collection of records from the data-store: "SELECT" in SQL.
+      # Used by Model#all to search for a set of records; that set is in a
+      # DataMapper::Collection object.
+      #
+      # @param [DataMapper::Query] query
+      #   The query to be used to seach for the resources
+      #
+      # @return [DataMapper::Collection]
+      #   A collection of all the resources found by the query.
+      #
+      # @api semipublic
+      def read_many(query)
+        resources = Array.new
+
+        # Convert query conditions to ldap filter
+        filter = convert_conditions(query.conditions)
+
+        # Convert attributes/query into LDAP
+        @ldap.search(:filter => filter, :return_result => false) do |entry|
+          values = query.fields.collect do |field|
+            entry[field.field.to_sym].first
+          end
+          resources << query.model.load(values, query)
+        end
+
+        # Return Results
+        resources
+      end
+
+      alias :read :read_many
+
+      ##
+      # Destroys all the records matching the given query. "DELETE" in SQL.
+      #
+      # @param [DataMapper::Query] query
+      #   The query used to locate the resources to be deleted.
+      #
+      # @return [Integer]
+      #   The number of records that were deleted.
+      #
+      # @api semipublic
+      def delete(query)
+
+        deleted = 0
+
+        # Convert query conditions to ldap filter
+        filter = convert_conditions(query.conditions)
+
+        # Convert attributes/query into LDAP
+        entries = @ldap.search(:filter => filter)
+
+        # Call LDAP Delete
+        entries.each do |entry|
+          result = @ldap.delete(:dn => entry.dn)
+
+          if @ldap.get_operation_result.code == 0
+            deleted = deleted + 1
+          else
+            puts "LDAP Delete Error: #{@ldap.get_operation_result.message}"
+          end
+        end
+
+        # Return number successfully deleted
+        return deleted
+      end
+
+      private
+
+      ##
+      # Make a new instance of the adapter. The @model_records ivar is
+      # the 'data-store' for this adapter. It is not shared amongst
+      # multiple incarnations of this adapter, eg
+      # DataMapper.setup(:default, :adapter => :in_memory);
+      # DataMapper.setup(:alternate, :adapter => :in_memory) do not
+      # share the data-store between them.
+      #
+      # @param [String, Symbol] name
+      #   The name of the DataMapper::Repository using this adapter.
+      # @param [String, Hash] uri_or_options
+      #   The connection uri string, or a hash of options to set up
+      #   the adapter
+      #
+      # @api semipublic
+      def initialize(name, uri_or_options)
+        super
+
+        if uri_or_options.class
+          @identity_maps = {}
+        end
+
+        @options = Hash.new
+
+        # Let's play with Options
+        @options[:attributes] = nil
+        @options[:scope] = Net::LDAP::SearchScope_WholeSubtree
+        @options[:filter] = nil
+        @options[:auth] = { :method => :simple }
+
+        uri_or_options.each do |k,v|
+          @options[k] = v
+        end
+
+#         if uri_or_options.is_a?(String)
+#           begin
+#             opt_array = URI.split(uri_or_options)
+#             @options[:scheme] = opt_array[0]
+#             @options[:auth][:username],@options[:auth][:password] = opt_array[1].split(':')
+#             @options[:host] = opt_array[2]
+#             @options[:port] = opt_array[3]
+
+#             # Registry from URI not used
+#             # @options[:registry] = opt_array[4]
+
+#             @options[:base] = opt_array[5]
+
+#             # Opaque from URI not used
+#             # @options[:opaque] = opt_array[6]
+
+#             # This is where the rest of the string is kept
+#             # According to the LDAP url spec it should look like
+#             # ?attributes?scope?filter, e.g.
+#             # ?uid?sub?(uid=username), however
+#             # URI strip appears to lose the first ?
+#             # So we parse it all out
+#             @options[:attributes],@options[:scope],@options[:filter] = opt_array[7].split('?')
+#             @options[:fragment] = opt_array[8]
+#           rescue InvalidURIError => e
+#             puts "Error parsing options for ldap adapter"
+#           end
+#         else
+#           @options.merge!(uri_or_options.dup)
+
+#           @options[:auth][:username] = @options[:username]
+#           @options[:auth][:password] = @options[:password]
+
+#           @options.delete(:adapter)
+#           @options.delete(:username)
+#           @options.delete(:password)
+#           @options.delete(:attributes)
+#           @options.delete(:filter)
+#         end
+
+        # Deal with SSL stuff
+        if @options[:scheme] == "ldaps" || @options[:port] == "636"
+          @options[:encryption] = { :method => :simple_tls }
+        end
+
+        puts "Options: #{@options.inspect}"
+
+        # Create the new LDAP client stub
+        @ldap = Net::LDAP.new(@options)
+
+        if ! @ldap.bind
+          puts "Tried to bind with options: #{@options.inspect}"
+          puts "Result: #{@ldap.get_operation_result.code}"
+          puts "Message: #{@ldap.get_operation_result.message}"
+        end
+      end
+
+      def convert_resource_to_hash(resource)
+        result = Hash.new
+        resource.send(:properties).each do |p|
+          result[p.field.to_sym] = p.get!(resource) unless p.get!(resource).nil?
+        end
+        result
+      end
+
+      def convert_conditions(conditions)
+        filters = Array.new
+        conditions.each do |condition|
+          case condition[0]
+          when :eql
+            filters << Net::LDAP::Filter.eq(condition[1].field(), condition[2].to_s)
+          when :lt
+            fle = Net::LDAP::Filter.le(condition[1].field(), condition[2].to_s)
+            fe = Net::LDAP::Filter.eq(condition[1].field(), condition[2].to_s)
+            filters << fle & ! fe
+          when :gt
+            fge = Net::LDAP::Filter.ge(condition[1].field(), condition[2].to_s)
+            fe = Net::LDAP::Filter.eq(condition[1].field(), condition[2].to_s)
+            filters << fge & ! fe
+          when :lte
+            filters << Net::LDAP::Filter.le(condition[1].field(), condition[2].to_s)
+          when :gte
+            filters << Net::LDAP::Filter.ge(condition[1].field(), condition[2].to_s)
+          when :not  : puts "!"
+            filters << Net::LDAP::Filter.ne(condition[1].field(), condition[2].to_s)
+          when :like
+            filters << Net::LDAP::Filter.eq(condition[1].field(), condition[2].to_s)
+          else
+            puts "Unknown condition: #{condition[0]}"
+          end
+        end
+
+        # Put them all together with an AND
+        ldap_filter = nil
+        filters.each do |filter|
+          if ldap_filter.nil?
+            ldap_filter = filter
+          else
+            ldap_filter = ldap_filter & filter
+          end
+        end
+        ldap_filter
+      end
+    end
+  end
+end

data/lib/ldap_adapter/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module LdapAdapter
+    VERSION = '0.0.9'
+  end
+end

data/spec/integration/ldap_adapter_spec.rb

@@ -0,0 +1,6 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe 'DataMapper::Adapters::LdapAdapter' do
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'pathname'
+require 'rubygems'
+
+gem 'addressable', '~>2.0'
+gem 'rspec', '>1.1.2'
+
+require 'addressable/uri'
+require 'spec'
+
+require 'dm-core'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/ldap_adapter'
+

data/tasks/install.rb

@@ -0,0 +1,13 @@
+def sudo_gem(cmd)
+  sh "#{SUDO} #{RUBY} -S gem #{cmd}", :verbose => false
+end
+
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"
+task :uninstall => [ :clobber ] do
+  sudo_gem "uninstall #{GEM_NAME} -v#{GEM_VERSION} -Ix"
+end

data/tasks/spec.rb

@@ -0,0 +1,25 @@
+begin
+  gem 'rspec', '~>1.1.11'
+  require 'spec'
+  require 'spec/rake/spectask'
+
+  task :default => [ :spec ]
+
+  desc 'Run specifications'
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+
+    begin
+      gem 'rcov', '~>0.8'
+      t.rcov = JRUBY ? false : (ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true)
+      t.rcov_opts << '--exclude' << 'spec'
+      t.rcov_opts << '--text-summary'
+      t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+    rescue LoadError
+      # rcov not installed
+    end
+  end
+rescue LoadError
+  # rspec not installed
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: irjudson-dm-ldap-adapter
+version: !ruby/object:Gem::Version 
+  version: 0.0.9
+platform: ruby
+authors: 
+- Ivan R. Judson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core~
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.11.0
+    version: 
+description: A DataMapper Adapter for LDAP, as simply as possible.
+email: 
+- ivan.judson [a] montana [d] edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- LICENSE
+- TODO
+- History.txt
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
+- lib/ldap_adapter.rb
+- lib/ldap_adapter/version.rb
+- spec/integration/ldap_adapter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/install.rb
+- tasks/spec.rb
+has_rdoc: true
+homepage: http://github.com/irjudson/dm-ldap-adapter
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dm-ldap-adapter
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A DataMapper Adapter for LDAP
+test_files: []
+