fake_net_ldap 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    fake_net_ldap (0.0.1)
+      net-ldap
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    net-ldap (0.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fake_net_ldap!
+  rspec

data/README.rdoc

@@ -0,0 +1,96 @@
+= FakeNetLdap
+
+FakeNetLdap is a helper for faking LDAP sarches made via the net-ldap library.
+It works at a global level, without requiring modification of code or writing
+of extensive stubs.
+
+
+== FEATURES/PROBLEMS:
+
+It is pretty limited in what it can do.
+
+If it is used, all calls to bind, auth, and search are intercepted and not passed on
+to the net-ldap library.
+
+Queries must be made using Net::LDAP search method.
+
+Responses to queries must be registered otherwise a
+FakeNetLdap::ConnectionNotAllowed exception is raised.
+
+The registered responses are yielded to a block passed to the search method.
+
+== EXAMPLES:
+
+Start by requiring FakeNetLdap:
+
+  require 'rubygems'
+  require 'fake_net_ldap'
+
+=== Registering users for binding
+
+  FakeNetLdap.register_user(:username => "fred", :password => "secret")
+
+  connection = Net::LDAP.new
+  connection.auth("fred", "secret")
+  connection.bind                   # returns true
+  connection.auth("fred", "forgotten")
+  connection.bind                   # returns false
+
+=== Registering basic hash responses to searches
+
+  For situations where you want to fake a single response to the search
+
+  user_filter = Net::LDAP::Filter.eq('uid', 'some-user')
+  FakeNetLdap.register_query(user_filter, {"name" => "Fred Blogs"})
+
+  connection = Net::LDAP.new
+  results = []
+  connection.search(:filter=> user_filter) { |r| results << r }
+  puts results.inspect            # => [{"name" => "Fred Blogs"}]
+
+=== Registering a response to unregistered queries
+
+  To provide a default response to any queries that have not been registered
+  use:
+
+  FakeNetLdap.clear_query_registrations
+  FakeNetLdap.register_query(:unregistered_query, [{"name" => "Fred Blogs"}, {"name" => "John Smith"}])
+
+  unregistered_filter = Net::LDAP::Filter.eq('uid', 'some-user')
+  connection = Net::LDAP.new
+  results = []
+  connection.search(:filter=> unregistered_filter) { |r| results << r }
+  puts results.inspect            # => [{"name" => "Fred Blogs"}, {"name" => "John Smith"}]
+
+== REQUIREMENTS:
+
+net-ldap
+
+== INSTALL:
+
+gem install fake_net_ldap
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 roovo
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/fake_net_ldap.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fake_net_ldap/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fake_net_ldap"
+  s.version     = FakeNetLdap::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rupert Voelcker", "Richard Pilkington"]
+  s.email       = ["rupert.voelcker@bt.com", "richard.pilkington@bt.com"]
+  s.homepage    = ""
+  s.summary     = %q{Use to fake out calls to Net::LDAP}
+
+  s.add_dependency "net-ldap"
+
+  s.add_development_dependency "rspec"
+
+  s.rubyforge_project = "fake_net_ldap"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/fake_net_ldap.rb

@@ -0,0 +1,100 @@
+require 'singleton'
+
+require 'fake_net_ldap/ext/net_ldap'
+require 'fake_net_ldap/registry'
+require 'fake_net_ldap/responder'
+
+module FakeNetLdap
+
+  # This exception is raised if you try to make a query you haven't
+  # registered.
+  class ConnectionNotAllowed < StandardError ; end ;
+
+  # call-seq:
+  #   FakeNetLdap.clear_user_registrations
+  #
+  # clears all previously set user registrations
+  #
+  def self.clear_user_registrations
+    Registry.instance.clear_user_registrations
+  end
+
+  # call-seq:
+  #   FakeNetLdap.register_user(:username => 'some-user', :password => 'a-password')
+  #
+  # Register a username/password which can be used when binding to the faked Net::LDAP.
+  #
+  def self.register_user(attrs)
+    Registry.instance.register_user(attrs)
+  end
+
+  # call-seq:
+  #   FakeNetLdap.user_registered?(filter)
+  #
+  # Returns true if the username and password have been registered with FakeNetLdap.
+  #
+  def self.user_registered?(attrs)
+    Registry.instance.user_registered?(attrs)
+  end
+
+  # call-seq:
+  #   FakeNetLdap.clear_query_registrations
+  #
+  # clears all previously set query registrations
+  #
+  def self.clear_query_registrations
+    Registry.instance.clear_query_registrations
+  end
+
+  # call-seq:
+  #   FakeNetLdap.register_query(filter, response)
+  #
+  # Register a query filter and it's response.  The +query+ should be a
+  # Net::LDAP::Filter It can also be set to the symbol :unregistered_query, in which
+  # case any calls to the Net::LDAP search method with unregistered queries
+  # will result in the response provided being yielded.
+  #
+  # Responses will be yielded to a call to the Net::LDAP search method.
+  # method. The +response+ must be one of the following types:
+  #
+  # <tt>Hash</tt>::
+  #   For cases where a single response is expected from the LDAP directory.
+  #   The hash will be yielded as a result of calling the LDAP::Conn.search2 method.
+  #   Example:
+  #     filter = Net::LDAP::Filter.eq('uid', 'some-user')
+  #     FakeNetLdap.register_query(filter, {"uid" => "some-user"})
+  # <tt>Array</tt>::
+  #   For cases where multiple responses are expected fron the LDAP directory.
+  #   This should be an array of hashes.  Each hash in the array will be yielded
+  #   in turn. Example:
+  #     filter = Net::LDAP::Filter.eq('gid', 'users')
+  #     FakeNetLdap.register_query(filter, [{"uid" => "Fred Blogs"}, {"uid" => "John Smith"}])
+  # <tt>Exception</tt>::
+  #   The specified exception will be raised when the query is made.
+  #   Any +Exception+ class is valid. Example:
+  #     filter = Net::LDAP::Filter.eq('gid', 'users')
+  #     FakeNetLdap.register_query(filter, MyLdapError)
+  #
+  def self.register_query(filter, response)
+    Registry.instance.register_query(filter, response)
+  end
+
+  # call-seq:
+  #   FakeNetLdap.query_registered?(filter)
+  #
+  # Returns true if +filter+ is registered with FakeNetLdap.  This will always
+  # return true if the response for :unregistered_query has been registered.
+  #
+  def self.query_registered?(filter)
+    Registry.instance.query_registered?(filter)
+  end
+
+  # call-seq:
+  #   FakeNetLdap.response_for(filter)
+  #
+  # Returns the faked response object associated with +filter+.
+  #
+  def self.response_for(filter, &block)
+    Registry.instance.response_for(filter, &block)
+  end
+end

data/lib/fake_net_ldap/ext/net_ldap.rb

@@ -0,0 +1,23 @@
+require 'net/ldap'
+
+class Net::LDAP
+
+  def auth(username, password)
+    @username = username
+    @password = password
+  end
+
+  def bind
+    FakeNetLdap.user_registered?(:username => @username, :password => @password)
+  end
+
+  def search(attrs, &block)
+    if FakeNetLdap.query_registered?(attrs[:filter])
+      FakeNetLdap.response_for(attrs[:filter], &block)
+    else
+      raise FakeNetLdap::ConnectionNotAllowed,
+            "Real LDAP connections are disabled.  Unregistered query: #{attrs[:filter]}"
+    end
+  end
+
+end

data/lib/fake_net_ldap/registry.rb

@@ -0,0 +1,50 @@
+module FakeNetLdap
+
+  class Registry #:nodoc:
+
+    include Singleton
+
+    def initialize
+      clear_query_registrations
+      clear_user_registrations
+    end
+
+    def clear_user_registrations
+      @user_map = {}
+    end
+
+    def register_user(attrs)
+      @user_map[attrs[:username]] = attrs[:password]
+    end
+
+    def user_registered?(attrs)
+      @user_map.has_key?(attrs[:username]) && (@user_map[attrs[:username]] == attrs[:password])
+    end
+
+    def clear_query_registrations
+      @query_map = {}
+    end
+
+    def register_query(query, response)
+      @query_map[query.to_s] = FakeNetLdap::Responder.new(query, response)
+    end
+
+    def query_registered?(query)
+      @query_map.has_key?(query.to_s) || @query_map.has_key?('unregistered_query')
+    end
+
+    def response_for(query, &block)
+      registered = query_registered?(query.to_s)
+      if registered && @query_map.has_key?(query.to_s)
+        response = @query_map[query.to_s]
+      elsif registered
+        response = @query_map['unregistered_query']
+      else
+        return nil
+      end
+
+      response.respond(&block)
+    end
+  end
+end
+

data/lib/fake_net_ldap/responder.rb

@@ -0,0 +1,22 @@
+module FakeNetLdap
+
+  class Responder #:nodoc:
+
+    def initialize(query, response)
+      @query    = query
+      @response = response
+    end
+
+    def respond(&block)
+      case @response
+      when Hash
+        yield @response
+      when Array
+        @response.each { |r| yield r }
+      when Class
+        raise @response.new
+      end
+    end
+  end
+end
+

data/lib/fake_net_ldap/version.rb

@@ -0,0 +1,3 @@
+module FakeNetLdap
+  VERSION = "0.0.1"
+end

data/spec/clear_query_registrations_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "clearing query registrations" do
+
+  let(:filter) { Net::LDAP::Filter.present("objectclass") }
+
+  it "it should not show a query as registered after query registrations have been cleared" do
+    FakeNetLdap.register_query(filter, {"name" => "Fred Blogs"})
+    FakeNetLdap.clear_query_registrations
+    FakeNetLdap.query_registered?(filter).should be_false
+  end
+
+  it "it should raise an ConnectionNotAllowed exception after query registrations have been cleared" do
+    FakeNetLdap.register_query(filter, {"name" => "Fred Blogs"})
+    FakeNetLdap.clear_query_registrations
+    connection = ldap_connection
+    lambda { connection.search(:base => 'cn=plop', :filter => filter) { |r| } }.should raise_error(FakeNetLdap::ConnectionNotAllowed)
+  end
+end

data/spec/clear_user_registrations_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe "clearing user registrations" do
+
+  it "it should not show a user as registered after user registrations have been cleared" do
+    FakeNetLdap.register_user(:username => "fred", :password => "secret")
+    FakeNetLdap.clear_user_registrations
+    FakeNetLdap.user_registered?(:username => "fred", :password => "secret").should be_false
+  end
+
+  it "it should not allow binds once user registrations have been cleared" do
+    FakeNetLdap.register_user(:username => "fred", :password => "secret")
+    FakeNetLdap.clear_user_registrations
+    connection = ldap_connection
+    connection.auth("fred", "secret")
+    connection.bind.should be_false
+  end
+end

data/spec/register_query_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe "registering queries" do
+
+  let(:filter) { Net::LDAP::Filter.present("objectclass") }
+
+  before do
+    FakeNetLdap.clear_query_registrations
+  end
+
+  it "should allow queries to be registered to respond with a hash (for a single response)" do
+    FakeNetLdap.register_query(filter, {"name" => "Fred Blogs"})
+    FakeNetLdap.query_registered?(filter).should be_true
+  end
+
+  it "should allow queries to be registered to respond with an array (for multiple responses)" do
+    FakeNetLdap.register_query(filter, [{"name" => "Fred Blogs"}, {"name" => "John Smith"}])
+    FakeNetLdap.query_registered?(filter).should be_true
+  end
+
+  it "should allow queries to be registered which should raise an exception" do
+    FakeNetLdap.register_query(filter, StandardError)
+    FakeNetLdap.query_registered?(filter).should be_true
+  end
+
+  it "shold show an unregistered query as unregistered" do
+    FakeNetLdap.query_registered?(filter).should be_false
+  end
+
+  it "should yield the registered response if a hash response is registered" do
+    FakeNetLdap.register_query(filter,  {"name" => "Fred Blogs"})
+    responses = []
+    connection = ldap_connection
+    connection.search(:base => 'cn=plop', :filter => filter) do |result|
+      responses << result
+    end
+    responses.should == [{"name" => "Fred Blogs"}]
+  end
+
+  it "should yield the registered response if an array response is registered" do
+    FakeNetLdap.register_query(filter,  [{"name" => "Fred Blogs"}, {"name" => "John Smith"}])
+    filter_copy = Net::LDAP::Filter.present("objectclass")
+    responses = []
+    connection = ldap_connection
+    connection.search(:base => 'cn=plop', :filter => filter_copy) do |result|
+      responses << result
+    end
+    responses.should == [{"name" => "Fred Blogs"}, {"name" => "John Smith"}]
+  end
+
+  it "should raise an exception if an exception response is registered" do
+    class ExpectedException < StandardError ; end ;
+    FakeNetLdap.register_query(filter,  ExpectedException)
+    connection = ldap_connection
+    lambda { connection.search(:base => 'cn=plop', :filter => filter) { |r| } }.should raise_error(ExpectedException)
+  end
+end

data/spec/register_user_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "registering users" do
+
+  before do
+    FakeNetLdap.clear_user_registrations
+  end
+
+  it "should return true when binding for a registered user" do
+    FakeNetLdap.register_user(:username => "fred", :password => "secret")
+    connection = ldap_connection
+    connection.auth("fred", "secret")
+    connection.bind.should be_true
+  end
+
+  it "should return false when binding for an unregistered user" do
+    connection = ldap_connection
+    connection.auth("fred", "secret")
+    connection.bind.should be_false
+  end
+
+  it "should return false when binding for a registered user with the wrong password" do
+    FakeNetLdap.register_user(:username => "fred", :password => "secret")
+    connection = ldap_connection
+    connection.auth("fred", "wrong_password")
+    connection.bind.should be_false
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler.require
+require 'net/ldap'
+
+
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'fake_net_ldap'
+
+RSpec.configure do |c|
+  c.formatter = :doc
+end
+
+LDAP_HOST = "ldap.example.com"
+LDAP_PORT = 389
+
+def ldap_connection
+  Net::LDAP.new
+end

data/spec/unregistered_query_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "registering a response to unregistered queries" do
+
+  let(:filter) { Net::LDAP::Filter.present("objectclass") }
+
+  before do
+    FakeNetLdap.clear_query_registrations
+  end
+
+  it "should raise an ConnectionNotAllowed exception if the response to unregistered queries has not been set" do
+    FakeNetLdap.query_registered?(filter).should be_false
+    connection = ldap_connection
+    lambda { connection.search(:base => 'cn=plop', :filter => filter) { |r| } }.should raise_error(FakeNetLdap::ConnectionNotAllowed)
+  end
+
+  it "should say that a query is registered if it hasn't been but the response to unregistered queries has been set" do
+    FakeNetLdap.register_query(:unregistered_query, {"name" => "Fred Blogs"})
+    FakeNetLdap.query_registered?(filter).should be_true
+  end
+
+  it "should return the response if the response to unregistered queries has been set" do
+    FakeNetLdap.register_query(:unregistered_query, {"name" => "Fred Blogs"})
+    responses = []
+    connection = ldap_connection
+    connection.search(:base => 'cn=plop', :filter => filter) do |result|
+      responses << result
+    end
+    responses.should == [{"name" => "Fred Blogs"}]
+  end
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: fake_net_ldap
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rupert Voelcker
+- Richard Pilkington
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-ldap
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+email: 
+- rupert.voelcker@bt.com
+- richard.pilkington@bt.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- fake_net_ldap.gemspec
+- lib/fake_net_ldap.rb
+- lib/fake_net_ldap/ext/net_ldap.rb
+- lib/fake_net_ldap/registry.rb
+- lib/fake_net_ldap/responder.rb
+- lib/fake_net_ldap/version.rb
+- spec/clear_query_registrations_spec.rb
+- spec/clear_user_registrations_spec.rb
+- spec/register_query_spec.rb
+- spec/register_user_spec.rb
+- spec/spec_helper.rb
+- spec/unregistered_query_spec.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: fake_net_ldap
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Use to fake out calls to Net::LDAP
+test_files: 
+- spec/clear_query_registrations_spec.rb
+- spec/clear_user_registrations_spec.rb
+- spec/register_query_spec.rb
+- spec/register_user_spec.rb
+- spec/spec_helper.rb
+- spec/unregistered_query_spec.rb