el_dap 0.0.3 → 0.0.4

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 .bundle
+.idea
 Gemfile.lock
 pkg/*
 test.rb

data/CHANGELOG

@@ -1,3 +1,8 @@
+0.0.4
+=====
+
+* Added support for Ruby 1.8, making use of the SystemTimer gem to correctly handle timeouts.
+
 0.0.3
 =====
 

data/README.rdoc

@@ -16,11 +16,21 @@ Additionally, users are also able to search the Active Directory.
 Just add this to your gem file:
 
   gem 'el_dap'
+  
+=== Ruby Version Dependencies
+
+ElDap will work out of the box with Ruby 1.9. 
+
+If you are using Ruby 1.8, you will need to manually install the *SystemTimer* gem so that timeout exceptions are handled 
+correctly. You will not be able to install ElDap on Ruby 1.8 unless you have this gem.
+
+  gem install SystemTimer
 
 == Features
 
 * Easily perform authentication against an Active Directory / LDAP server
 * Search an Active Directory based on wildcard search criteria
+* Use multiple servers to protect against timeouts
 
 == Usage
 

data/el_dap.gemspec

@@ -1,4 +1,8 @@
-# -*- encoding: utf-8 -*-
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+require 'base64'
+
 $:.push File.expand_path("../lib", __FILE__)
 require "el_dap/version"
 
@@ -7,10 +11,10 @@ Gem::Specification.new do |s|
   s.version     = ElDap::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ed James"]
-  s.email       = ["ed.james.email@gmail.com"]
+  s.email       = Base64.decode64("ZWQuamFtZXMuZW1haWxAZ21haWwuY29t\n")
   s.homepage    = "https://github.com/edjames/el_dap"
-  s.summary     = %q{A simple search and authentication tool for Active Directory using LDAP.}
-  s.description = %q{A simple search and authentication tool for Active Directory using LDAP.}
+  s.summary     = "Simple search and authentication tool for Active Directory"
+  s.description = "#{s.summary}. This included support for both Ruby 1.9 and ruby 1.8 (using the SystemTimer gem)."
 
   s.rubyforge_project = "el_dap"
 
@@ -20,4 +24,15 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.add_dependency("net-ldap", "~> 0.2.2")
+  s.add_development_dependency "bundler"
+  
+  # If Ruby version is 1.8 then check for SystemTimer gem
+  if RUBY_VERSION < "1.9"
+    begin
+      require 'system_timer'
+    rescue LoadError => ex
+      warn "WARNING: To use ElDap in Ruby 1.8 you must have the SystemTimer gem installed. Please run: gem install SystemTimer"
+      raise ex.message
+    end
+  end
 end

data/lib/el_dap.rb

@@ -1,11 +1,13 @@
 require 'net/ldap'
-require 'timeout'
 
+
+$: << File.dirname(__FILE__)
 require 'el_dap/api_methods'
 require 'el_dap/constants'
 require 'el_dap/exceptions'
 require 'el_dap/validator'
 require 'el_dap/worker'
+require 'el_dap/time_cop'
 require 'el_dap/base'
 
 module ElDap

data/lib/el_dap/base.rb

@@ -1,19 +1,19 @@
 module ElDap
   class Base
     attr_accessor :server_ips, :username, :password, :timeout, :treebase
-    
+
     def initialize
       @server_ips = []
       @timeout = 15
       yield(self) if block_given?
     end
-    
+
     def validate(username, password)
       return false if Validator.blank?(username, password)
-      
+
       @server_ips.each do |ip_address|
         begin
-          Timeout::timeout(self.timeout) do
+          TimeCop.timer.timeout(self.timeout) do
             worker = Worker.new(:username => username, :password => password, :ip_address => ip_address)
             return worker.bind
           end
@@ -22,26 +22,24 @@ module ElDap
         end
       end
     end
-    
+
     def search(search_string)
       return nil if Validator.blank?(search_string)
-      
-      search_result = []
-      
+
       @server_ips.each do |ip_address|
         begin
-          Timeout::timeout(self.timeout) do
+          TimeCop.timer.timeout(self.timeout) do
             worker = Worker.new(:username => self.username, :password => self.password, :ip_address => ip_address)
-            
             raise(InvalidCredentialsError, 'The user credentials provided are invalid') unless worker.bind
-            
             return worker.search_directory(search_string, self.treebase)
           end
         rescue Timeout::Error
           next
         end
       end
+      
+      false
     end
-    
+
   end
 end

data/lib/el_dap/time_cop.rb

@@ -0,0 +1,29 @@
+module ElDap
+  class TimeCop
+    
+    def self.timer
+      if ruby_version < "1.9" 
+        use_system_timer
+      else
+        use_timeout
+      end
+    end
+    
+    private
+    
+    def self.ruby_version
+      RUBY_VERSION
+    end
+    
+    def self.use_system_timer
+      require 'system_timer'
+      SystemTimer
+    end
+    
+    def self.use_timeout
+      require 'timeout'
+      Timeout
+    end
+    
+  end
+end

data/lib/el_dap/version.rb

@@ -1,3 +1,3 @@
 module ElDap
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/el_dap/base_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 module ElDap
   describe Base do
     before(:each) do
+      allow_message_expectations_on_nil
       @instance = Base.new do |i|
         i.username = 'name'
         i.password = 'password'
@@ -74,6 +75,12 @@ module ElDap
         @instance.search('name').should == ['result']
       end
       
+      it "should return false when all servers timeout" do
+        @worker.stub(:bind).and_return(true)
+        @worker.stub(:search_directory).and_raise(Timeout::Error)
+        @instance.search('name').should be_false
+      end
+      
       it "should throw an exception if the search user credentials are invalid" do
         @worker.should_receive(:bind).and_return(false)
         lambda{ @instance.search('name') }.should raise_error(InvalidCredentialsError, 'The user credentials provided are invalid')

data/spec/el_dap/time_cop_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module ElDap
+  describe TimeCop do
+    
+    it "should use the SystemTimer gem when Ruby version is 1.8" do
+      TimeCop.should_receive(:ruby_version).and_return('1.8')
+      TimeCop.should_receive(:use_system_timer)
+      TimeCop.timer
+    end
+    
+    it "should use the SystemTimer gem when Ruby version is 1.9" do
+      TimeCop.should_receive(:ruby_version).and_return('1.9')
+      TimeCop.should_receive(:use_timeout)
+      TimeCop.timer
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: el_dap
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-20 00:00:00.000000000Z
+date: 2011-04-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ldap
-  requirement: &83249460 !ruby/object:Gem::Requirement
+  requirement: &79902310 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 0.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *83249460
-description: A simple search and authentication tool for Active Directory using LDAP.
-email:
-- ed.james.email@gmail.com
+  version_requirements: *79902310
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &79902100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *79902100
+description: Simple search and authentication tool for Active Directory. This included
+  support for both Ruby 1.9 and ruby 1.8 (using the SystemTimer gem).
+email: ed.james.email@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -40,17 +51,18 @@ files:
 - TODO.rdoc
 - el_dap.gemspec
 - lib/el_dap.rb
-- lib/el_dap/.rvmrc
 - lib/el_dap/api_methods.rb
 - lib/el_dap/base.rb
 - lib/el_dap/constants.rb
 - lib/el_dap/exceptions.rb
+- lib/el_dap/time_cop.rb
 - lib/el_dap/validator.rb
 - lib/el_dap/version.rb
 - lib/el_dap/worker.rb
 - spec/el_dap/api_methods_spec.rb
 - spec/el_dap/base_spec.rb
 - spec/el_dap/constants_spec.rb
+- spec/el_dap/time_cop_spec.rb
 - spec/el_dap/validator_spec.rb
 - spec/el_dap/worker_spec.rb
 - spec/spec_helper.rb
@@ -77,5 +89,5 @@ rubyforge_project: el_dap
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: A simple search and authentication tool for Active Directory using LDAP.
+summary: Simple search and authentication tool for Active Directory
 test_files: []

data/lib/el_dap/.rvmrc

@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-environment_id="ruby-1.9.2-head@el_dap"
-
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]] ; then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-else
-  rvm --create  "$environment_id"
-fi
-