cmu-person 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'net-ldap'
+gem 'rdoc'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    net-ldap (0.2.2)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.11)
+      json (~> 1.4)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  net-ldap
+  rcov
+  rdoc
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Seth Vargo
+
+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.markdown

@@ -0,0 +1,33 @@
+CMU Person
+==========
+
+Originally inspired by [David Taylor](https://github.com/tinystatemachine)'s [andrewid](https://github.com/tinystatemachine/andrewid), CMU Person is a simple rubygem used for searching Carnegie Mellon's LDAP servers for student information.
+
+Installation
+------------
+If you want to use this gem for personal use in your terminal, just type the following command in bash:
+```bash
+gem install cmu-person
+```
+
+If you plan to use this in a Rails project, add the following to your `Gemfile`:
+
+```ruby
+gem 'cmu-person'
+```
+
+Don't forget to run the `bundle` command to install the gem!
+
+Usage
+-----
+
+```ruby
+user = CMU::Person.new('svargo')
+user.first_name #=> "Seth"
+user.grade #=> "Junior"
+```
+
+```ruby
+user = CMU::Person.new('i_dont_exist')
+#=> RecordNotFound Exception
+```

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = 'cmu-person'
+  gem.homepage = 'http://github.com/sethvargo/cmu-person'
+  gem.license = 'MIT'
+  gem.summary = 'A simple interface for searching CMU LDAP directory'
+  gem.description = 'This tool is used to search Carnegie Mellon\'s LDAP directory. Provide an Andrew ID and this will automatically parse the results and return them in a readable format.'
+  gem.email = 'sethvargo@gmail.com'
+  gem.authors = ['Seth Vargo']
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cmu-person #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/cmu-person.rb

@@ -0,0 +1,77 @@
+require 'net/ldap'
+
+module CMU
+  class Person
+  	class RecordNotFound < StandardError;	end
+
+  	def initialize(andrewid)
+  		raise RecordNotFound unless @data = fetch(andrewid)
+  	end
+
+    def fetch(user)
+      ldap = Net::LDAP.new(:host => 'ldap.andrew.cmu.edu')
+      ldap.search(:base => 'ou=Person,dc=cmu,dc=edu', 
+                  :filter => 'cmuAndrewId='+user ).first
+    end
+
+    def andrew_id
+      @data[:cmuAndrewId].last
+    end
+
+    def name
+  		@data[:cn].last
+    end
+  
+    def last_name
+  		@data[:sn].last
+    end
+  
+    def first_name
+  		@data[:givenname].last
+    end
+  
+    def email
+    	if @data.attribute_names.include?(:cmupreferredmail)
+  	  	@data[:cmupreferredmail].last
+  	  else
+    		@data[:mail].last
+    	end
+    end
+  
+    def type 
+    	@data[:edupersonaffiliation].last
+    end
+  
+    def title
+     	if @data.attribute_names.include?(:title)
+  			@data[:title].last
+  		else
+  	  	if @data.attribute_names.include?(:cmutitle)
+  				@data[:cmutitle].last
+  			else
+  				nil
+  			end
+  		end  	
+  	end
+  
+    def grade
+    	if @data.attribute_names.include?(:cmustudentclass)
+  			@data[:cmustudentclass].last
+  		else
+  			nil
+  		end
+  	end  	
+
+    def department
+  	  @data[:cmudepartment].last
+    end
+
+    def school
+  	  @data[:edupersonschoolcollegename].last
+    end
+    
+    def to_s
+  		@data.collect{|i,j| i.to_s.ljust(30)+":\t"+(j.is_a?(Array) ? "[ "+j.join(", ")+" ]" : j.to_s)+"\n"}.join("\n")
+  	end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cmu-person'
+
+class Test::Unit::TestCase
+end

data/test/test_cmu-person.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestCmuPerson < Test::Unit::TestCase
+  should 'fetch a valid user' do
+    user = CMU::Person.new('svargo')
+    assert user.first_name == 'Seth'
+    assert user.last_name == 'Vargo'
+    assert user.andrew_id == 'svargo'
+  end
+  
+  should 'not fetch an invalid user' do
+    assert_raise(CMU::Person::RecordNotFound) { CMU::Person.new('not_a_user') }
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: cmu-person
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Seth Vargo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: &70273468779840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70273468779840
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70273468779360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70273468779360
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70273468778880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70273468778880
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70273468778400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70273468778400
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70273468777920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70273468777920
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70273468777440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70273468777440
+description: This tool is used to search Carnegie Mellon's LDAP directory. Provide
+  an Andrew ID and this will automatically parse the results and return them in a
+  readable format.
+email: sethvargo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/cmu-person.rb
+- test/helper.rb
+- test/test_cmu-person.rb
+homepage: http://github.com/sethvargo/cmu-person
+licenses:
+- MIT
+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: 589060480960458176
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A simple interface for searching CMU LDAP directory
+test_files: []