Merge remote-tracking branch 'origin/master' into release-scripts

Author: Jerry Cheung

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contribution guide
+
+Thank you for using net-ldap. If you'd like to help, keep these guidelines in
+mind.
+
+## Submitting a New Issue
+
+If you find a bug, or would like to propose an idea, file a [new issue][issues].
+Include as many details as possible:
+
+- Version of net-ldap gem
+- LDAP server version
+- Queries, connection information, any other input
+- output or error messages
+
+## Sending a Pull Request
+
+[Pull requests][pr] are always welcome!
+
+Check out [the project's issues list][issues] for ideas on what could be improved.
+
+Before sending, please add tests and ensure the test suite passes.
+
+To run the full suite:
+
+  `bundle exec rake`
+
+To run a specific test file:
+
+  `bundle exec ruby test/test_ldap.rb`
+
+To run a specific test:
+
+  `bundle exec ruby test/test_ldap.rb -n test_instrument_bind`
+
+Pull requests will trigger automatic continuous integration builds on
+[TravisCI][travis]. To run integration tests locally, see the `test/support`
+folder.
+
+## Styleguide
+
+```ruby
+# 1.9+ style hashes
+{key: "value"}
+
+# Multi-line arguments with `\`
+MyClass.new \
+  foo: 'bar',
+  baz: 'garply'
+```
+
+[issues]: https://github.com/ruby-net-ldap/ruby-net-ldap/issues
+[pr]: https://help.github.com/articles/using-pull-requests
+[travis]: https://travis-ci.org/ruby-ldap/ruby-net-ldap

History.rdoc

@@ -1,3 +1,40 @@
+=== Net::LDAP 0.9.0
+* Major changes:
+  * Dropped support for ruby 1.8.7, ruby >= 1.9.3 now required
+* Major enhancements:
+  * Add support for search time limit parameter
+  * Instrument received messages, PDU parsing
+* Minor enhancments:
+  * Add support for querying ActiveDirectory capabilities from root dse
+* Bug fixes:
+  * Fix reads for multiple concurrent requests with shared, open connections mixing up the results
+  * Fix search size option
+  * Fix BER encoding bug
+* Code clean-up:
+  * Added integration test suite
+  * Switch to minitest
+
+* Details
+  * #150 Support querying ActiveDirectory capabilities when searching root dse
+  * #142 Encode true as xFF
+  * #124, #145, #146 Cleanup gemspec
+  * #138, #144 Track response messages by message id
+  * #141 Magic number/constant cleanup
+  * #119, #129, #130, #132, #133, #137 Integration tests
+  * #115 Search timeout support
+  * #140 Fix search size option
+  * #139 Cleanup and inline documentation for Net::LDAP::Connection#search
+  * #131 Instrumentation
+  * #116 Refactor Connection#write
+  * #126 Update gitignore
+  * #128 Fix whitespace
+  * #113, #121 Switch to minitest
+  * #123 Base64 encoded dn
+  * #114 Separate file for Net::LDAP::Connection
+  * #104 Parse version spec in LDIF datasets
+  * #106 ldap.modify doc fixes
+  * #111 Fix test deprecations
+
 === Net::LDAP 0.5.0 / 2013-07-22
 * Major changes:
   * Required Ruby version is >=1.9.3

lib/net/ber/core_ext/true_class.rb

@@ -5,8 +5,7 @@ module Net::BER::Extensions::TrueClass
   ##
   # Converts +true+ to the BER wireline representation of +true+.
   def to_ber
-    # 20100319 AZ: Note that this may not be the completely correct value,
-    # per some test documentation. We need to determine the truth of this.
-    "\001\001\001"
+    # http://tools.ietf.org/html/rfc4511#section-5.1
+    "\001\001\xFF".force_encoding("ASCII-8BIT")
   end
 end

lib/net/ldap.rb

@@ -1194,9 +1194,16 @@ def delete_tree(args)
   def search_root_dse
     rs = search(:ignore_server_caps => true, :base => "",
                 :scope => SearchScope_BaseObject,
-                :attributes => [ :namingContexts, :supportedLdapVersion,
-                  :altServer, :supportedControl, :supportedExtension,
-                  :supportedFeatures, :supportedSASLMechanisms])
+                :attributes => [
+                  :altServer,
+                  :namingContexts,
+                  :supportedCapabilities,
+                  :supportedControl,
+                  :supportedExtension,
+                  :supportedFeatures,
+                  :supportedLdapVersion,
+                  :supportedSASLMechanisms
+                ])
     (rs and rs.first) or Net::LDAP::Entry.new
   end
 

net-ldap.gemspec

@@ -7,8 +7,6 @@ Gem::Specification.new do |s|
   s.name = %q{net-ldap}
   s.version = Net::LDAP::VERSION
   s.license = "MIT"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Francis Cianfrocca", "Emiel van de Laar", "Rory O'Connell", "Kaspar Schiess", "Austin Ziegler", "Michael Schaarschmidt"]
   s.date = %q{2012-02-28}
   s.description = %q{Net::LDAP for Ruby (also called net-ldap) implements client access for the
@@ -29,28 +27,11 @@ the most recent LDAP RFCs (4510-4519, plutions of 4520-4532).}
   s.homepage = %q{http://github.com/ruby-ldap/ruby-net-ldap}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
-  s.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
-  s.rubygems_version = %q{1.5.2}
+  s.required_ruby_version = ">= 1.9.3"
   s.summary = %q{Net::LDAP for Ruby (also called net-ldap) implements client access for the Lightweight Directory Access Protocol (LDAP), an IETF standard protocol for accessing distributed directory services}
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<hoe-git>, ["~> 1"])
-      s.add_development_dependency(%q<hoe-gemspec>, ["~> 1"])
-      s.add_development_dependency(%q<flexmock>, [">= 1.3.0"])
-      s.add_development_dependency(%q<hoe>, [">= 2.9.1"])
-    else
-      s.add_dependency(%q<hoe-git>, ["~> 1"])
-      s.add_dependency(%q<hoe-gemspec>, ["~> 1"])
-      s.add_dependency(%q<flexmock>, [">= 1.3.0"])
-      s.add_dependency(%q<hoe>, [">= 2.9.1"])
-    end
-  else
-    s.add_dependency(%q<hoe-git>, ["~> 1"])
-    s.add_dependency(%q<hoe-gemspec>, ["~> 1"])
-    s.add_dependency(%q<flexmock>, [">= 1.3.0"])
-    s.add_dependency(%q<hoe>, [">= 2.9.1"])
-  end
+  s.add_development_dependency("hoe-git", "~> 1")
+  s.add_development_dependency("hoe-gemspec", "~> 1")
+  s.add_development_dependency("flexmock", ">= 1.3.0")
+  s.add_development_dependency("hoe", ">= 2.9.1")
 end

test/ber/test_ber.rb

@@ -12,8 +12,9 @@ def test_array
     assert_equal ary, encoded_ary.read_ber
   end
 
+  # http://tools.ietf.org/html/rfc4511#section-5.1
   def test_true
-    assert_equal "\x01\x01\x01", true.to_ber
+    assert_equal "\x01\x01\xFF".b, true.to_ber
   end
 
   def test_false

test/integration/test_ber.rb

@@ -0,0 +1,30 @@
+require_relative '../test_helper'
+
+class TestBERIntegration < LDAPIntegrationTestCase
+  # Test whether the TRUE boolean value is encoded correctly by performing a
+  # search operation.
+  def test_true_ber_encoding
+    # request these attrs to simplify test; use symbols to match Entry#attribute_names
+    attrs = [:dn, :uid, :cn, :mail]
+
+    assert types_entry = @ldap.search(
+      base: "dc=rubyldap,dc=com",
+      filter: "(uid=user1)",
+      size: 1,
+      attributes: attrs,
+      attributes_only: true
+    ).first
+
+    # matches attributes we requested
+    assert_equal attrs, types_entry.attribute_names
+
+    # assert values are empty
+    types_entry.each do |name, values|
+      next if name == :dn
+      assert values.empty?
+    end
+
+    assert_includes Net::LDAP::ResultCodesSearchSuccess,
+      @ldap.get_operation_result.code, "should be a successful search operation"
+  end
+end