anu-ldap 0.4.2

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem "jeweler"
+gem "net-ldap"
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    net-ldap (0.3.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  net-ldap
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Porter
+
+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.rdoc

@@ -0,0 +1,31 @@
+= AnuLdap
+
+== Description
+
+AnuLdap is a Ruby module for easily querying the ANU LDAP server.
+
+== Install
+
+ $ gem install anu-ldap
+
+== Usage
+
+ require "anu-ldap"
+
+ # Find users by email address:
+
+ entries = AnuLdap.find_by_email("david.porter@anu.edu.au")
+ entries.each do |e|
+   puts "Uni ID:     #{e[:uni_id]}"
+   puts "Email:      #{e[:email]}"
+   puts "Given name: #{e[:given_name]}"
+   puts "Surname:    #{e[:surname]}"
+ end
+
+ # Authenticate a user:
+
+ if AnuLdap.authenticate("u3990518", "secret")
+    puts "Successfully authenticated"
+ else
+    puts "Authentication failure"
+ end

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "anu-ldap"
+    gem.summary = "A Ruby library for querying the ANU LDAP server."
+    gem.email = "david.porter@anu.edu.au"
+    gem.homepage = "https://doiweb-repo2.anu.edu.au/repositories/es-projects/anu-auth"
+    gem.authors = ["David Porter"]
+    gem.add_dependency "net-ldap"
+    gem.files = FileList["lib/**/*.rb", "bin/*", '[A-Z]*', 'spec/**/*']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.2

data/lib/anu-ldap.rb

@@ -0,0 +1,80 @@
+require "net/ldap"
+
+# This module encapsulates queries of the ANU LDAP server.
+module AnuLdap
+
+  # Find all ANU LDAP entries with the given _uni_id_.
+  #
+  # Return entries as a hash with keys +:uni_id+, +:email+, +:given_name+,
+  # +:surname+, +:full_name+.
+  def self.find_all_by_uni_id(uni_id)
+    find_by("uid", uni_id)
+  end
+
+  # Find first ANU LDAP entry with the given _uni_id_.
+  #
+  # Return the entry as a hash with keys +:uni_id+, +:email+, +:given_name+,
+  # +:surname+, +:full_name+.
+  def self.find_by_uni_id(uni_id)
+    find_all_by_uni_id(uni_id).first
+  end
+
+  # Find all ANU LDAP entries with the given _email_.
+  #
+  # Return entries as a hash with keys +:uni_id+, +:email+, +:given_name+,
+  # +:surname+, +:full_name+.
+  def self.find_all_by_email(email)
+    find_by("mail", email)
+  end
+
+  # Find first ANU LDAP entry with the given _email_.
+  #
+  # Return the entry as a hash with keys +:uni_id+, +:email+, +:given_name+,
+  # +:surname+, +:full_name+.
+  def self.find_by_email(email)
+    find_all_by_email(email).first
+  end
+
+  # Authenticate credentials against ANU LDAP.
+  #
+  # Returns _true_ if authentication is successful, and _false_ otherwise.
+  def self.authenticate(uni_id, password)
+    ldap = get_new_ldap()
+    ldap.auth "uid=#{uni_id}, ou=people, o=anu.edu.au", password
+
+    ldap.bind
+  end
+
+  private
+
+  # Find all ANU LDAP entries with a given key-value pair.
+  def self.find_by(key_name, key_value)
+    filter = Net::LDAP::Filter.eq(key_name, key_value)
+
+    entries = get_new_ldap().search(:base       => "ou=people,o=anu.edu.au",
+                                    :filter     => filter,
+                                    :attributes => ["uid", "mail",
+                                                    "givenName", "sn", "cn"])
+
+    entries.map { |e| make_user_hash(e) }
+  end
+
+  # Get a new connection to the ANU LDAP server.
+  def self.get_new_ldap()
+    Net::LDAP.new(:host       => "ldap.anu.edu.au",
+                  :port       => 636,
+                  :encryption => :simple_tls)
+  end
+
+  # Create a hash of user details from an ldap entry.
+  def self.make_user_hash(ldap_entry)
+    {
+      :uni_id     => ldap_entry.uid.first,
+      :email      => ldap_entry.mail.first,
+      :given_name => ldap_entry.givenName.first,
+      :surname    => ldap_entry.sn.first,
+      :full_name  => ldap_entry.cn.first
+    }
+  end
+end
+

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: anu-ldap
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+  prerelease: 
+platform: ruby
+authors:
+- David Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70317091417720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70317091417720
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: &70317091431160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70317091431160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70317091428520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70317091428520
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: &70317091437380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70317091437380
+description: 
+email: david.porter@anu.edu.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/anu-ldap.rb
+homepage: https://doiweb-repo2.anu.edu.au/repositories/es-projects/anu-auth
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A Ruby library for querying the ANU LDAP server.
+test_files: []