scashin133-net-ldap 0.1.3 → 0.1.4

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'hoe'
+gem 'hoe-git'
+
+group :development do
+  gem 'metaid'
+  gem 'rspec', '~> 2.0'
+  gem 'flexmock'
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    flexmock (0.8.11)
+    hoe (2.8.0)
+      rake (>= 0.8.7)
+    hoe-git (1.3.0)
+      hoe (>= 2.2.0)
+    metaid (1.0)
+    rake (0.8.7)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flexmock
+  hoe
+  hoe-git
+  metaid
+  rspec (~> 2.0)

data/Manifest.txt

@@ -1,4 +1,7 @@
+.bundle/config
 COPYING
+Gemfile
+Gemfile.lock
 Hacking.rdoc
 History.txt
 LICENSE
@@ -36,6 +39,7 @@ test/test_entry.rb
 test/test_filter.rb
 test/test_ldif.rb
 test/test_password.rb
+test/test_rename.rb
 test/test_snmp.rb
 test/testdata.ldif
 testserver/ldapserver.rb

data/Rakefile

@@ -1,5 +1,5 @@
 require "rubygems"
-require 'hanna/rdoctask'
+# require 'hanna/rdoctask'
 require 'hoe'
 
 $LOAD_PATH.unshift('lib')

data/lib/net/ldap.rb

@@ -246,7 +246,7 @@ require 'net/ldap/entry'
 # and then keeps it open while it executes a user-supplied block.
 # Net::LDAP#open closes the connection on completion of the block.
 class Net::LDAP
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 
   class LdapError < StandardError; end
 
@@ -496,7 +496,7 @@ class Net::LDAP
   #    ldap.modify(...)
   #  end
   def self.open(args)
-    ldap1 = LDAP.new(args)
+    ldap1 = new(args)
     ldap1.open { |ldap| yield ldap }
   end
 
@@ -532,7 +532,7 @@ class Net::LDAP
     else
       os.code = 0
     end
-    os.message = LDAP.result2string(os.code)
+    os.message = Net::LDAP.result2string(os.code)
     os
   end
 
@@ -1170,12 +1170,12 @@ class Net::LDAP::Connection #:nodoc:
       # go here.
     when :start_tls
       msgid = next_msgid.to_ber
-      request = [StartTlsOid.to_ber].to_ber_appsequence(Net::LdapPdu::ExtendedRequest)
+      request = [Net::LDAP::StartTlsOid.to_ber].to_ber_appsequence(Net::LDAP::PDU::ExtendedRequest)
       request_pkt = [msgid, request].to_ber_sequence
       @conn.write request_pkt
       be = @conn.read_ber(Net::LDAP::AsnSyntax)
       raise Net::LDAP::LdapError, "no start_tls result" if be.nil?
-      pdu = Net::LdapPdu.new(be)
+      pdu = Net::LDAP::PDU.new(be)
       raise Net::LDAP::LdapError, "no start_tls result" if pdu.nil?
       if pdu.result_code.zero?
         @conn = self.class.wrap_with_ssl(@conn)
@@ -1234,7 +1234,7 @@ class Net::LDAP::Connection #:nodoc:
     request_pkt = [msgid, request].to_ber_sequence
     @conn.write request_pkt
 
-    (be = @conn.read_ber(Net::LDAP::AsnSyntax) and pdu = Net::LdapPdu.new(be)) or raise Net::LDAP::LdapError, "no bind result"
+    (be = @conn.read_ber(Net::LDAP::AsnSyntax) and pdu = Net::LDAP::PDU.new(be)) or raise Net::LDAP::LdapError, "no bind result"
 
     pdu.result_code
   end
@@ -1273,7 +1273,7 @@ class Net::LDAP::Connection #:nodoc:
       request_pkt = [msgid, request].to_ber_sequence
       @conn.write request_pkt
 
-      (be = @conn.read_ber(Net::LDAP::AsnSyntax) and pdu = Net::LdapPdu.new(be)) or raise Net::LDAP::LdapError, "no bind result"
+      (be = @conn.read_ber(Net::LDAP::AsnSyntax) and pdu = Net::LDAP::PDU.new(be)) or raise Net::LDAP::LdapError, "no bind result"
       return pdu.result_code unless pdu.result_code == 14 # saslBindInProgress
       raise Net::LDAP::LdapError, "sasl-challenge overflow" if ((n += 1) > MaxSaslChallenges)
 
@@ -1401,7 +1401,7 @@ class Net::LDAP::Connection #:nodoc:
       result_code = 0
       controls = []
 
-      while (be = @conn.read_ber(Net::LDAP::AsnSyntax)) && (pdu = Net::LdapPdu.new(be))
+      while (be = @conn.read_ber(Net::LDAP::AsnSyntax)) && (pdu = Net::LDAP::PDU.new(be))
         case pdu.app_tag
         when 4 # search-data
           n_results += 1
@@ -1478,7 +1478,7 @@ class Net::LDAP::Connection #:nodoc:
     pkt = [next_msgid.to_ber, request].to_ber_sequence
     @conn.write pkt
 
-    (be = @conn.read_ber(Net::LDAP::AsnSyntax)) && (pdu = Net::LdapPdu.new(be)) && (pdu.app_tag == 7) or raise Net::LDAP::LdapError, "response missing or invalid"
+    (be = @conn.read_ber(Net::LDAP::AsnSyntax)) && (pdu = Net::LDAP::PDU.new(be)) && (pdu.app_tag == 7) or raise Net::LDAP::LdapError, "response missing or invalid"
     pdu.result_code
   end
 
@@ -1500,23 +1500,26 @@ class Net::LDAP::Connection #:nodoc:
     pkt = [next_msgid.to_ber, request].to_ber_sequence
     @conn.write pkt
 
-    (be = @conn.read_ber(Net::LDAP::AsnSyntax)) && (pdu = Net::LdapPdu.new(be)) && (pdu.app_tag == 9) or raise Net::LDAP::LdapError, "response missing or invalid"
+    (be = @conn.read_ber(Net::LDAP::AsnSyntax)) && (pdu = Net::LDAP::PDU.new(be)) && (pdu.app_tag == 9) or raise Net::LDAP::LdapError, "response missing or invalid"
     pdu.result_code
   end
 
   #--
   # TODO: need to support a time limit, in case the server fails to respond.
   #++
-  def rename(args)
+  def rename args
     old_dn = args[:olddn] or raise "Unable to rename empty DN"
     new_rdn = args[:newrdn] or raise "Unable to rename to empty RDN"
     delete_attrs = args[:delete_attributes] ? true : false
+		new_superior = args[:new_superior]
 
-    request = [old_dn.to_ber, new_rdn.to_ber, delete_attrs.to_ber].to_ber_appsequence(12)
-    pkt = [next_msgid.to_ber, request].to_ber_sequence
+		request = [old_dn.to_ber, new_rdn.to_ber, delete_attrs.to_ber]
+		request << new_superior.to_ber unless new_superior == nil
+  	
+    pkt = [next_msgid.to_ber, request.to_ber_appsequence(12)].to_ber_sequence
     @conn.write pkt
 
-    (be = @conn.read_ber(Net::LDAP::AsnSyntax)) && (pdu = Net::LdapPdu.new(be)) && (pdu.app_tag == 13) or raise Net::LDAP::LdapError, "response missing or invalid"
+    (be = @conn.read_ber(AsnSyntax)) && (pdu = LdapPdu.new( be )) && (pdu.app_tag == 13) or raise LdapError.new( "response missing or invalid" )
     pdu.result_code
   end
 
@@ -1530,7 +1533,7 @@ class Net::LDAP::Connection #:nodoc:
     pkt = [next_msgid.to_ber, request].to_ber_sequence
     @conn.write pkt
 
-    (be = @conn.read_ber(Net::LDAP::AsnSyntax)) && (pdu = Net::LdapPdu.new(be)) && (pdu.app_tag == 11) or raise Net::LDAP::LdapError, "response missing or invalid"
+    (be = @conn.read_ber(Net::LDAP::AsnSyntax)) && (pdu = Net::LDAP::PDU.new(be)) && (pdu.app_tag == 11) or raise Net::LDAP::LdapError, "response missing or invalid"
     pdu.result_code
   end
 end # class Connection

data/lib/net/ldap/filter.rb

@@ -1,3 +1,4 @@
+# Encoding: UTF-8
 # Copyright (C) 2006 by Francis Cianfrocca and other contributors. All
 # Rights Reserved.
 #
@@ -79,6 +80,8 @@ class Net::LDAP::Filter
     # <tt>mail</tt> value containing the substring "anderson":
     #
     #   f = Net::LDAP::Filter.eq("mail", "*anderson*")
+    #
+    # This filter does not perform any escaping
     def eq(attribute, value)
       new(:eq, attribute, value)
     end
@@ -136,10 +139,44 @@ class Net::LDAP::Filter
     # Creates a Filter object indicating that a particular attribute value
     # is either not present or does not match a particular string; see
     # Filter::eq for more information.
+    #
+    # This filter does not perform any escaping
     def ne(attribute, value)
       new(:ne, attribute, value)
     end
 
+    ##
+    # Creates a Filter object indicating that the value of a particular
+    # attribute must match a particular string. The attribute value is
+    # escaped, so the "*" character is interpreted literally.
+    def equals(attribute, value)
+      new(:eq, attribute, escape(value))
+    end
+
+    ##
+    # Creates a Filter object indicating that the value of a particular
+    # attribute must begin with a particular string. The attribute value is
+    # escaped, so the "*" character is interpreted literally.
+    def begins(attribute, value)
+      new(:eq, attribute, escape(value) + "*")
+    end
+
+    ##
+    # Creates a Filter object indicating that the value of a particular
+    # attribute must end with a particular string. The attribute value is
+    # escaped, so the "*" character is interpreted literally.
+    def ends(attribute, value)
+      new(:eq, attribute, "*" + escape(value))
+    end
+
+    ##
+    # Creates a Filter object indicating that the value of a particular
+    # attribute must contain a particular string. The attribute value is
+    # escaped, so the "*" character is interpreted literally.
+    def contains(attribute, value)
+      new(:eq, attribute, "*" + escape(value) + "*")
+    end
+
     ##
     # Creates a Filter object indicating that a particular attribute value
     # is greater than or equal to the specified value.
@@ -207,6 +244,30 @@ class Net::LDAP::Filter
     alias_method :present, :present?
     alias_method :pres, :present?
 
+    # http://tools.ietf.org/html/rfc4515 lists these exceptions from UTF1
+    # charset for filters. All of the following must be escaped in any normal
+    # string using a single backslash ('\') as escape. 
+    #
+    ESCAPES = {
+      '!' => '21', # EXCLAMATION    = %x21 ; exclamation mark ("!")
+      '&' => '26', # AMPERSAND      = %x26 ; ampersand (or AND symbol) ("&")
+      '*' => '2A', # ASTERISK       = %x2A ; asterisk ("*")
+      ':' => '3A', # COLON          = %x3A ; colon (":")
+      '|' => '7C', # VERTBAR        = %x7C ; vertical bar (or pipe) ("|")
+      '~' => '7E', # TILDE          = %x7E ; tilde ("~")
+    }
+    # Compiled character class regexp using the keys from the above hash. 
+    ESCAPE_RE = Regexp.new(
+      "[" + 
+      ESCAPES.keys.map { |e| Regexp.escape(e) }.join + 
+      "]")
+
+    ##
+    # Escape a string for use in an LDAP filter
+    def escape(string)
+      string.gsub(ESCAPE_RE) { |char| "\\" + ESCAPES[char] }
+    end
+
     ##
     # Converts an LDAP search filter in BER format to an Net::LDAP::Filter
     # object. The incoming BER object most likely came to us by parsing an

data/lib/net/ldap/pdu.rb

@@ -270,6 +270,7 @@ module Net
     when "LdapPduError"
       warn "Net::#{name} has been deprecated. Use Net::LDAP::PDU::Error instead."
       Net::LDAP::PDU::Error
+    when 'LDAP'
     else
       super
     end

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require 'net/ldap'
-require 'rubygems'
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   config.mock_with :flexmock
 end

data/spec/unit/ber/ber_spec.rb

@@ -4,12 +4,13 @@ require 'net/ber'
 require 'net/ldap'
 
 describe "BER encoding of" do
-  def properly_encode_and_decode
-    simple_matcher('properly encode and decode') do |given|
+  
+  RSpec::Matchers.define :properly_encode_and_decode do 
+    match do |given|
       given.to_ber.read_ber.should == given
     end
   end
-  
+   
   context "arrays" do
     it "should properly encode/decode []" do
       [].should properly_encode_and_decode

data/spec/unit/ldap/filter_spec.rb

@@ -44,5 +44,40 @@ describe Net::LDAP::Filter do
       end
     end
   end
-  
+  describe "<- .construct" do
+    it "should accept apostrophes in filters (regression)" do
+      Net::LDAP::Filter.construct("uid=O'Keefe").to_rfc2254.should == "(uid=O'Keefe)"
+    end 
+  end
+
+  describe "convenience filter constructors" do
+    def eq(attribute, value)
+      described_class.eq(attribute, value)
+    end
+    describe "<- .equals(attr, val)" do
+      it "should delegate to .eq with escaping" do
+        described_class.equals('dn', 'f*oo').should == eq('dn', 'f\2Aoo')
+      end 
+    end
+    describe "<- .begins(attr, val)" do
+      it "should delegate to .eq with escaping" do
+        described_class.begins('dn', 'f*oo').should == eq('dn', 'f\2Aoo*')
+      end 
+    end
+    describe "<- .ends(attr, val)" do
+      it "should delegate to .eq with escaping" do
+        described_class.ends('dn', 'f*oo').should == eq('dn', '*f\2Aoo')
+      end 
+    end
+    describe "<- .contains(attr, val)" do
+      it "should delegate to .eq with escaping" do
+        described_class.contains('dn', 'f*oo').should == eq('dn', '*f\2Aoo*')
+      end 
+    end
+  end
+  describe "<- .escape(str)" do
+    it "should escape !, &, *, :, | and ~" do
+      Net::LDAP::Filter.escape('!&*:|~').should == "\\21\\26\\2A\\3A\\7C\\7E"
+    end 
+  end
 end

data/test/test_rename.rb

@@ -0,0 +1,79 @@
+require 'common'
+
+class TestRename < Test::Unit::TestCase
+  def test_the_truth
+    assert true
+  end
+  # Commented out since it assumes you have a live LDAP server somewhere. This
+  # will be migrated to the integration specs, as soon as they are ready. 
+  
+  #   HOST= '10.10.10.71'
+  # PORT = 389
+  # BASE = "o=test"
+  # AUTH = { :method => :simple, :username => "cn=testadmin,#{BASE}", :password => 'password' }
+  # BASIC_USER = "cn=jsmith,ou=sales,#{BASE}"
+  # RENAMED_USER = "cn=jbrown,ou=sales,#{BASE}"
+  # MOVED_USER = "cn=jsmith,ou=marketing,#{BASE}"
+  # RENAMED_MOVED_USER = "cn=jjones,ou=marketing,#{BASE}"
+  # 
+  # def setup
+  #   # create the entries we're going to manipulate
+  #   Net::LDAP::open(:host => HOST, :port => PORT, :auth => AUTH) do |ldap|
+  #     if ldap.add(:dn => "ou=sales,#{BASE}", :attributes => { :ou => "sales", :objectclass => "organizationalUnit" })
+  #       puts "Add failed: #{ldap.get_operation_result.message} - code: #{ldap.get_operation_result.code}"
+  #     end
+  #     ldap.add(:dn => "ou=marketing,#{BASE}", :attributes => { :ou => "marketing", :objectclass => "organizationalUnit" })
+  #     ldap.add(:dn => BASIC_USER, :attributes => { :cn => "jsmith", :objectclass => "inetOrgPerson", :sn => "Smith" })
+  #   end
+  # end
+  # 
+  # def test_rename_entry
+  #   dn = nil
+  #   Net::LDAP::open(:host => HOST, :port => PORT, :auth => AUTH) do |ldap|
+  #     ldap.rename(:olddn => BASIC_USER, :newrdn => "cn=jbrown")
+  #       
+  #     ldap.search(:base => RENAMED_USER) do |entry|
+  #       dn = entry.dn
+  #     end
+  #   end
+  #   assert_equal(RENAMED_USER, dn)
+  # end
+  # 
+  # def test_move_entry
+  #   dn = nil
+  #   Net::LDAP::open(:host => HOST, :port => PORT, :auth => AUTH) do |ldap|
+  #     ldap.rename(:olddn => BASIC_USER, :newrdn => "cn=jsmith", :new_superior => "ou=marketing,#{BASE}")
+  #     
+  #     ldap.search(:base => MOVED_USER) do |entry|
+  #       dn = entry.dn
+  #     end
+  #   end
+  #   assert_equal(MOVED_USER, dn)
+  # end
+  # 
+  # def test_move_and_rename_entry
+  #   dn = nil
+  #   Net::LDAP::open(:host => HOST, :port => PORT, :auth => AUTH) do |ldap|
+  #     ldap.rename(:olddn => BASIC_USER, :newrdn => "cn=jjones", :new_superior => "ou=marketing,#{BASE}")
+  #     
+  #     ldap.search(:base => RENAMED_MOVED_USER) do |entry|
+  #       dn = entry.dn
+  #     end
+  #   end
+  #   assert_equal(RENAMED_MOVED_USER, dn)
+  # end
+  # 
+  # def teardown
+  #   # delete the entries
+  #   # note: this doesn't always completely clear up on eDirectory as objects get locked while
+  #   # the rename/move is being completed on the server and this prevents the delete from happening
+  #   Net::LDAP::open(:host => HOST, :port => PORT, :auth => AUTH) do |ldap|
+  #     ldap.delete(:dn => BASIC_USER)
+  #     ldap.delete(:dn => RENAMED_USER)
+  #     ldap.delete(:dn => MOVED_USER)
+  #     ldap.delete(:dn => RENAMED_MOVED_USER)
+  #     ldap.delete(:dn => "ou=sales,#{BASE}")
+  #     ldap.delete(:dn => "ou=marketing,#{BASE}")
+  #   end
+  # end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scashin133-net-ldap
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Francis Cianfrocca
@@ -19,29 +19,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-01 00:00:00 -07:00
+date: 2011-01-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rubyforge
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 0
-        - 4
-        version: 2.0.4
-  type: :development
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: archive-tar-minitar
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -53,11 +37,11 @@ dependencies:
         - 1
         version: 0.5.1
   type: :development
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: hanna
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -69,11 +53,11 @@ dependencies:
         - 2
         version: 0.1.2
   type: :development
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: hoe-git
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -83,11 +67,11 @@ dependencies:
         - 1
         version: "1"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: metaid
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -97,23 +81,23 @@ dependencies:
         - 1
         version: "1"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 47
         segments: 
         - 2
-        - 6
-        - 1
-        version: 2.6.1
+        - 8
+        - 0
+        version: 2.8.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 description: Pure Ruby LDAP library.
 email: 
 - blackhedd@rubyforge.org
@@ -131,7 +115,10 @@ extra_rdoc_files:
 - README.txt
 - Hacking.rdoc
 files: 
+- .bundle/config
 - COPYING
+- Gemfile
+- Gemfile.lock
 - Hacking.rdoc
 - History.txt
 - LICENSE
@@ -169,6 +156,7 @@ files:
 - test/test_filter.rb
 - test/test_ldif.rb
 - test/test_password.rb
+- test/test_rename.rb
 - test/test_snmp.rb
 - test/testdata.ldif
 - testserver/ldapserver.rb
@@ -215,4 +203,5 @@ test_files:
 - test/test_filter.rb
 - test/test_ldif.rb
 - test/test_password.rb
+- test/test_rename.rb
 - test/test_snmp.rb