sheffield_ldap_lookup 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create @sheffield_ldap_lookup

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Shuo Chen
+
+MIT License
+
+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/README.md

@@ -0,0 +1,29 @@
+# SheffieldLdapLookup
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sheffield_ldap_lookup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sheffield_ldap_lookup
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/sheffield_ldap_lookup/install_generator.rb

@@ -0,0 +1,9 @@
+module SheffieldLdapLookup
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    
+    def create_initializer
+      copy_file "sheffield_ldap_lookup.rb", "config/initializers/sheffield_ldap_lookup.rb"
+    end
+  end
+end

data/lib/generators/sheffield_ldap_lookup/templates/sheffield_ldap_lookup.rb

@@ -0,0 +1 @@
+SheffieldLdapLookup::LdapFinder.ldap_config = YAML.load_file("#{Rails.root}/config/ldap.yml")[Rails.env]

data/lib/sheffield_ldap_lookup/ldap_finder.rb

@@ -0,0 +1,32 @@
+require 'net/ldap'
+module SheffieldLdapLookup
+  class LdapFinder < Struct.new(:keyword)
+    class << self
+      attr_accessor :ldap_config
+    end
+    
+    def lookup
+      begin
+        @lookup ||= connection.search(filter: ldap_filter)[0]
+      rescue
+        {}
+      end
+    end
+
+    def ldap_filter(filter_class = Net::LDAP::Filter)
+      filter_class.eq(search_attribute, keyword)
+    end
+
+    def search_attribute
+      keyword =~ /\A[^@]+@[^@]+\z/ ? 'mail' : 'uid'
+    end
+
+    def ldap_config
+      self.class.ldap_config
+    end
+
+    def connection(ldap_class = Net::LDAP)
+      @connection ||= ldap_class.new(host: ldap_config['host'], port: ldap_config['port'], base: ldap_config['base'])
+    end
+  end
+end

data/lib/sheffield_ldap_lookup/version.rb

@@ -0,0 +1,3 @@
+module SheffieldLdapLookup
+  VERSION = "0.0.2"
+end

data/lib/sheffield_ldap_lookup.rb

@@ -0,0 +1,5 @@
+require "sheffield_ldap_lookup/version"
+require "sheffield_ldap_lookup/ldap_finder"
+module SheffieldLdapLookup
+  # Your code goes here...
+end

data/sheffield_ldap_lookup.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sheffield_ldap_lookup/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sheffield_ldap_lookup"
+  gem.version       = SheffieldLdapLookup::VERSION
+  gem.authors       = ["Shuo Chen"]
+  gem.email         = ["s.chen@epigenesys.co.uk"]
+  gem.description   = "A gem to fetch information from University of Sheffield LDAP server based on username or email address."
+  gem.summary       = "LDAP lookup"
+  gem.homepage      = "http://www.epigenesys.co.uk"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency('net-ldap')
+  
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rails', '~> 3.2')
+  gem.add_development_dependency('rspec')
+end

data/spec/lib/ldap_finder_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'sheffield_ldap_lookup/ldap_finder.rb'
+
+describe SheffieldLdapLookup::LdapFinder do
+  LDAP_CONFIG = { 'host' => 'localhost', 'port' => '389', 'base' => 'ou=Users' }
+  describe "#connection" do
+    it "should create a new LDAP connection" do
+      subject.stub(ldap_config: LDAP_CONFIG)
+      ldap_class = mock
+      ldap_class.should_receive(:new).with(host: LDAP_CONFIG['host'], port: LDAP_CONFIG['port'], base: LDAP_CONFIG['base'])
+      subject.connection(ldap_class)
+    end
+  end
+  
+  describe "#ldap_config" do
+    it "should load the LDAP configuration" do
+      SheffieldLdapLookup::LdapFinder.ldap_config = LDAP_CONFIG
+      subject.ldap_config.should == LDAP_CONFIG
+    end
+  end
+  
+  describe "#search_attribute" do
+    describe "determine to search against uid or email based on the format of the keyword" do
+      it "should use 'uid' attribute for username" do
+        finder = SheffieldLdapLookup::LdapFinder.new('username')
+        finder.search_attribute.should == 'uid'
+      end
+      
+      it "should use 'mail' attribute for email" do
+        finder = SheffieldLdapLookup::LdapFinder.new('test@test.com')
+        finder.search_attribute.should == 'mail'
+      end
+    end
+  end
+  
+  describe "#ldap_filter" do
+    it "should create a LDAP filter for the attribute and keyword" do
+      finder = SheffieldLdapLookup::LdapFinder.new('username')
+      finder.stub(search_attribute: 'uid')
+      filter_class = mock
+      filter_class.should_receive(:eq).with('uid', 'username')
+      finder.ldap_filter filter_class
+    end
+  end
+  
+  describe "#lookup" do
+    describe "use the LDAP filter to search for the entity and return the first result" do
+      let(:ldap_filter) { mock }
+      let(:connection)  { mock }
+      before { subject.stub(ldap_filter: ldap_filter, connection: connection) }
+      
+      it "should search the LDAP connection using the filter" do
+        connection.should_receive(:search).with(filter: ldap_filter).and_return([])
+        subject.lookup
+      end
+      
+      it "should return the first result" do
+        result = mock
+        connection.stub(search: [result])
+        subject.lookup.should == result
+      end
+      
+      it "should return an empty hash if cannot connect to LDAP" do
+        connection.stub(search: ->{raise})
+        subject.lookup.should == {}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$: << File.expand_path('../../lib', __FILE__)

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: sheffield_ldap_lookup
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Shuo Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to fetch information from University of Sheffield LDAP server based
+  on username or email address.
+email:
+- s.chen@epigenesys.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/sheffield_ldap_lookup/install_generator.rb
+- lib/generators/sheffield_ldap_lookup/templates/sheffield_ldap_lookup.rb
+- lib/sheffield_ldap_lookup.rb
+- lib/sheffield_ldap_lookup/ldap_finder.rb
+- lib/sheffield_ldap_lookup/version.rb
+- sheffield_ldap_lookup.gemspec
+- spec/lib/ldap_finder_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.epigenesys.co.uk
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4032560973816351922
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4032560973816351922
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: LDAP lookup
+test_files:
+- spec/lib/ldap_finder_spec.rb
+- spec/spec_helper.rb