Fix compatibility with redmine 3.2

Refs: #166

Author: thorin

.travis.yml

@@ -1,5 +1,11 @@
 ---
 language: ruby
+sudo: false
+addons:
+  apt:
+    packages:
+      - ldap-utils
+      - slapd
 timeouts:
   bundle: 600
 rvm:
@@ -41,7 +47,6 @@ matrix:
    - env: REDMINE=v3.8.0
 gemfile: workspace/redmine/Gemfile
 before_install:
- - sudo apt-get update -qq && sudo apt-get install -qq slapd ldap-utils
  - ./script/ci.sh clone_redmine --target $REDMINE_DIR
  - cp ./config/database.yml.travis $REDMINE_DIR/config/database.yml
  - ./script/ci.sh install_plugin_gemfile

app/models/ldap_setting.rb

@@ -68,6 +68,8 @@ class LdapSetting
 
   [:login, *User::STANDARD_FIELDS].each {|f| module_eval("def #{f}; auth_source_ldap.attr_#{f}; end") }
 
+  LdapError = (Gem.loaded_specs['net-ldap'].version.to_s >= '0.12.0' ? Net::LDAP::Error : Net::LDAP::LdapError)
+
   def id
     @auth_source_ldap_id
   end
@@ -286,7 +288,7 @@ def validate_groupname_pattern
 
     def validate_group_filter
       Net::LDAP::Filter.construct(group_search_filter) if group_search_filter.present?
-    rescue Net::LDAP::LdapError
+    rescue LdapError
       errors.add :group_search_filter, :invalid
     end
 

lib/ldap_sync/core_ext/ber.rb

@@ -0,0 +1,44 @@
+if ('0.12.0'..'0.13.0') === Gem.loaded_specs['net-ldap'].version.to_s
+  ##
+  # A String object with a BER identifier attached.
+  #
+  class Net::BER::BerIdentifiedString < String
+    attr_accessor :ber_identifier
+
+    # The binary data provided when parsing the result of the LDAP search
+    # has the encoding 'ASCII-8BIT' (which is basically 'BINARY', or 'unknown').
+    #
+    # This is the kind of a backtrace showing how the binary `data` comes to
+    # BerIdentifiedString.new(data):
+    #
+    #  @conn.read_ber(syntax)
+    #     -> StringIO.new(self).read_ber(syntax), i.e. included from module
+    #     -> Net::BER::BERParser.read_ber(syntax)
+    #        -> (private)Net::BER::BERParser.parse_ber_object(syntax, id, data)
+    #
+    # In the `#parse_ber_object` method `data`, according to its OID, is being
+    # 'casted' to one of the Net::BER:BerIdentifiedXXX classes.
+    #
+    # As we are using LDAP v3 we can safely assume that the data is encoded
+    # in UTF-8 and therefore the only thing to be done when instantiating is to
+    # switch the encoding from 'ASCII-8BIT' to 'UTF-8'.
+    #
+    # Unfortunately, there are some ActiveDirectory specific attributes
+    # (like `objectguid`) that should remain binary (do they really?).
+    # Using the `#valid_encoding?` we can trap this cases. Special cases like
+    # Japanese, Korean, etc. encodings might also profit from this. However
+    # I have no clue how this encodings function.
+    def initialize args
+      super
+      #
+      # Check the encoding of the newly created String and set the encoding
+      # to 'UTF-8' (NOTE: we do NOT change the bytes, but only set the
+      # encoding to 'UTF-8').
+      current_encoding = encoding
+      if current_encoding == Encoding::BINARY
+        force_encoding('UTF-8')
+        force_encoding(current_encoding) unless valid_encoding?
+      end
+    end
+  end
+end

lib/ldap_sync/core_ext/string.rb

@@ -18,11 +18,13 @@
 require 'net/ldap'
 
 module Net::BER::Extensions::String
-  def raw_utf8_encoded
-    if self.respond_to?(:encode) && self.encoding.name != 'ASCII-8BIT'
-      self.encode('UTF-8').force_encoding('ASCII-8BIT')
-    else
-      self
+  if Gem.loaded_specs['net-ldap'].version.to_s < '0.12.0'
+    def raw_utf8_encoded
+      if self.respond_to?(:encode) && self.encoding.name != 'ASCII-8BIT'
+        self.encode('UTF-8').force_encoding('ASCII-8BIT')
+      else
+        self
+      end
     end
   end
 end

lib/ldap_sync/entity_manager.rb

@@ -21,6 +21,8 @@ module LdapSync::EntityManager
     def connect_as_user?; setting.account.include?('$login'); end
 
   private
+    LdapError = (Gem.loaded_specs['net-ldap'].version.to_s >= '0.12.0' ? Net::LDAP::Error : Net::LDAP::LdapError)
+
     def get_user_fields(username, user_data=nil, options={})
       fields_to_sync = setting.user_fields_to_sync
       if options.try(:fetch, :include_required, false)
@@ -314,9 +316,9 @@ def ldap_search(ldap, options, &block)
       block = Proc.new {|e| yield e[attrs] } if block_given?
       result = ldap.search(options, &block) or fail
       result.map {|e| e[attrs] } unless block_given? || result.nil?
-    rescue
+    rescue => exception
       os = ldap.get_operation_result
-      raise Net::LDAP::LdapError, "LDAP Error(#{os.code}): #{os.message}"
+      raise LdapError, "LDAP Error(#{os.code}): #{os.message}"
     end
 
     def n(field)

test/unit/auth_source_ldap_test.rb

@@ -458,8 +458,8 @@ class AuthSourceLdapTest < ActiveSupport::TestCase
     assert_equal '[email protected]', @user.mail
     assert_equal 'User', @user.firstname
     assert_equal 'Misc', @user.lastname
-    assert_equal nil, @user.custom_field_values[0].value
-    assert_equal nil, @user.custom_field_values[1].value
+    assert_equal 'en', @user.custom_field_values[0].value
+    assert_equal '0', @user.custom_field_values[1].value
   end
 
   test "#sync_user should delete groups" do