cmu_person 0.0.1

data/.gitignore

@@ -0,0 +1,48 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    cmu_person (0.0.1)
+      net-ldap
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    net-ldap (0.2.2)
+    redcarpet (2.0.1)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    yard (0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cmu_person!
+  redcarpet
+  rspec
+  yard

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 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,41 @@
+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 (or other project managed by Bundler), add the following to your `Gemfile`:
+
+    gem 'cmu_person'
+
+Don't forget to run the `bundle` command to install the gem!
+
+Usage
+-----
+
+    user = CMU::Person.find('svargo')
+    user.first_name #=> "Seth"
+    user.grade #=> "Junior"
+
+ 
+
+    user = CMU::Person.new('i_dont_exist')
+    #=> CMU::RecordNotFound Exception
+
+For a complete list of methods, view the [YARD Documentation](http://rubydoc.info/gems/cmu_person/0.0.3/frames)
+
+License
+-------
+Copyright (c) 2012 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/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/cmu_person.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'cmu_person'
+  s.version     = '0.0.1'
+  s.author      = 'Seth Vargo'
+  s.email       = 'sethvargo@gmail.com'
+  s.homepage    = 'https://github.com/sethvargo/cmu_person'
+  s.summary     = %q{A simple interface for searching CMU LDAP directory}
+  s.description = %q{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.}
+
+  s.rubyforge_project = 'cmu_person'
+
+  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"]
+
+  # development dependencies
+  s.add_development_dependency 'redcarpet'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+  
+  # runtime dependencies
+  s.add_runtime_dependency 'net-ldap'
+end

data/lib/cmu_person/exceptions.rb

@@ -0,0 +1,6 @@
+# ::nodoc::
+# @private
+module CMU
+  # Simple error
+  class RecordNotFound < StandardError;	end
+end

data/lib/cmu_person/person.rb

@@ -0,0 +1,158 @@
+require 'net/ldap'
+
+# ::nodoc::
+# @private
+module CMU
+  # A CMU::Person class
+  class Person
+    # Attempts to create and return a new CMU::Person from the CMU LDAP directory.
+    #
+    # @param [String] the Andrew ID to search for
+    # @raise [CMU::RecordNotFound] if the Andrew ID does not exist
+    # @return [CMU::Person] a `CMU::Person` object
+  	def self.find(andrew_id)
+  	  CMU::Person.new(andrew_id)
+  	end
+  	
+  	# Attempts to create and return a new CMU::Person from the CMU LDAP directory.
+  	#   Unlink (see #find), this method will not raise an exception if the Andrew
+  	#   ID is not found.
+  	#
+  	# @param [String] the Andrew ID to search for
+    # @return [CMU::Person] a `CMU::Person` object
+  	def self.find_by_andrew_id(andrew_id)
+  	 begin
+  	   find(andrew_id)
+	   rescue
+	     nil
+     end
+  	end
+  	
+  	# ::nodoc::
+  	# @private
+  	def initialize(andrew_id)
+  	  ldap = Net::LDAP.new(:host => 'ldap.andrew.cmu.edu')
+      @data = ldap.search(:base => 'ou=Person,dc=cmu,dc=edu', 
+                  :filter => 'cmuAndrewId=' + andrew_id).first
+      raise CMU::RecordNotFound if @data.nil?
+  	end
+
+    # Returns the Andrew ID of the CMU Person
+    #
+    # @return [String] the Andrew ID of the CMU Person
+    def andrew_id
+      @andrew_id ||= @data[:cmuAndrewId].last
+    end
+    
+    # Returns the full name of the CMU Person
+    #
+    # @return [String] the full name of the current CMU Person
+    def name
+  		@name ||= @data[:cn].last
+    end
+  
+    # Returns the last name of the CMU Person
+    #
+    # @return [String] the last name of the current CMU Person
+    def last_name
+  		@last_name ||= @data[:sn].last
+    end
+  
+    # Returns the first name of the CMU Person
+    #
+    # @return [String] the first name of the current CMU Person
+    def first_name
+  		@first_name ||= @data[:givenname].last
+    end
+  
+    # Returns the email of the CMU Person. If the CMU Person has
+    #   listed a preferred email, it will be displayed. Otherwise,
+    #   the official Andrew Email will be used.
+    #
+    # @return [String] the email of the current CMU Person
+    def email
+    	if @data.attribute_names.include?(:cmupreferredmail)
+  	  	@email ||= @data[:cmupreferredmail].last
+  	  else
+    		@email ||= @data[:mail].last
+    	end
+    end
+    
+    # Returns the phone number for the CMU Person
+    #
+    # @return [String, nil] the phone number of the current CMU Person 
+    #   or nil if the person did not provide a phone number
+    def phone
+      if @data.attribute_names.include?(:cmupreferredtelephone)
+        @phone ||= @data[:cmupreferredtelephone].last.gsub(/[^0-9]/,'')
+      else
+        @phone ||= nil
+      end
+    end
+  
+    # Returns the type for the CMU Person
+    #
+    # @return [String] the type or role of the CMU Person
+    def type 
+    	@type ||= @data[:edupersonaffiliation].last
+    end
+  
+    # Returns the official title for the CMU Person
+    #
+    # @return [String, nil] the official title for the CMU Person or
+    #   nil if the CMU Person has not provided a title
+    def title
+     	if @data.attribute_names.include?(:title)
+  			@title ||= @data[:title].last
+  		else
+  	  	if @data.attribute_names.include?(:cmutitle)
+  				@title ||= @data[:cmutitle].last
+  			else
+  				@title ||= nil
+  			end
+  		end  	
+  	end
+  
+    # Returns the String representation of the grade of the CMU Person
+    #
+    # @return [String, nil] the String representation of the grade of 
+    #   the CMU Person ('Freshman', 'Sophomore', 'Junior', 'Senior',
+    #   'Masters', 'Doctorate') or nil for Faculty and Staff
+    def grade
+    	if @data.attribute_names.include?(:cmustudentclass)
+  			@grade ||= @data[:cmustudentclass].last
+  		else
+  			@grade ||= nil
+  		end
+  	end  	
+
+    # Returns department for the CMU Person
+    #
+    # @return [String, nil] the department for the current CMU Person 
+    #   or nil if the CMU Person is a student and/or has no department
+    def department
+  	  @department ||= @data[:cmudepartment].last
+    end
+
+    # Returns the "college" for the CMU Person
+    #
+    # @return [String, nil] the actual college the CMU Person belongs to
+    def school
+      filters = ['Student Employment', 'Undergraduate Admission and Student Aid', 'VP For Campus Affairs']
+  	  @school ||= @data[:edupersonschoolcollegename].reject{|c| filters.include?(c)}.last
+    end
+    
+    # ::nodoc::
+    # @private
+    def inspect
+      fields = %w(andrew_id first_name last_name email phone type title)
+      @inspect ||= "<CMU::Person #{fields.collect{|f| f + ': ' + self.send(f.to_sym).inspect}.join(', ')}>"
+    end
+    
+    # ::nodoc::
+    # @private
+    def to_s
+      @to_s ||= "<CMU::Person \"#{self.send(:name)} (#{self.send(:andrew_id)})\">"
+  	end
+  end
+end

data/lib/cmu_person.rb

@@ -0,0 +1,2 @@
+require 'cmu_person/person'
+require 'cmu_person/exceptions'

data/spec/cmu_person_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe CMU::Person do
+  before(:all) do
+    @seth = CMU::Person.find('svargo')
+    @bryan = CMU::Person.find('bleach')
+    @dano = CMU::Person.find('dorbegoz')
+    @profh = CMU::Person.find('lheimann')
+    @kaycee = CMU::Person.find('kpalko')
+  end
+  
+  it 'should fetch a valid user' do
+    @seth.first_name.should eql('Seth')
+    @seth.last_name.should eql('Vargo')
+    @seth.andrew_id.should eql('svargo')
+  end
+  
+  it 'should fetch another valid user' do
+    @bryan.first_name.should eql('Bryan')
+    @bryan.last_name.should eql('Leach')
+    @bryan.andrew_id.should eql('bleach')
+  end
+  
+  it 'new/find should raise an exception for an invalid user' do
+    lambda { CMU::Person.new('not_a_real_user') }.should raise_exception(CMU::RecordNotFound)
+    lambda { CMU::Person.find('not_a_real_user') }.should raise_exception(CMU::RecordNotFound)
+  end
+  
+  it 'find_by_andrew_id not raise an exception for an an invalid user' do
+    lambda { CMU::Person.find_by_andrew_id('not_a_real_user') }.should_not raise_exception
+  end
+  
+  it 'should return the user\'s email' do
+    @seth.email.should eql('svargo@andrew.cmu.edu')
+  end
+  
+  it 'should return the user\'s phone' do
+    @seth.phone.should eql('8144211811')
+  end
+  
+  it 'should return nil if phone is blank' do
+    @bryan.phone.should be_nil
+  end
+  
+  it 'should return the correct student type' do
+    @seth.type.should eql('Student')
+  end
+  
+  it 'should return the correct faculty type' do
+    @profh.type.should eql('Faculty')
+  end
+  
+  it 'should return the correct staff type' do
+    @kaycee.type.should eql('Staff')
+  end
+  
+  it 'should return the correct title' do
+    @seth.title.should eql('Head Grader')
+    @profh.title.should eql('Teaching Professor')
+    @kaycee.title.should eql('Housefellow/cdtr. of Student Activities')
+  end
+  
+  it 'should return nil if title is blank' do
+    @dano.title.should be_nil
+  end
+  
+  it 'should return the user\'s grade' do
+    @seth.grade.should eql('Senior')
+    @bryan.grade.should eql('Sophomore')
+  end
+  
+  it 'should return nil if grade is blank' do
+    @profh.grade.should be_nil
+    @kaycee.grade.should be_nil
+  end
+  
+  it 'should return the correct department' do
+    @profh.department.should eql('Is Program In Dietrich')
+    @kaycee.department.should eql('Student Campus Activities')
+    @seth.department.should eql('H&SS Interdisciplinary')
+    @bryan.department.should eql('Mechanical Engineering')
+    @dano.department.should eql('Civil & Environmental Engineering')
+  end
+
+  it 'should return the correct school' do
+    @profh.school.should eql('Dietrich College of Humanities and Social Sciences')
+    @seth.school.should eql('Dietrich College of Humanities and Social Sciences')
+    @bryan.school.should eql('Carnegie Institute of Technology')
+  end
+  
+  it 'should return nil if school is blank' do
+    @kaycee.school.should be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
+
+require 'cmu_person'

metadata

@@ -0,0 +1,106 @@
+--- !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: 2012-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70290382060060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70290382060060
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70290382059580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70290382059580
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70290382059120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70290382059120
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: &70290382058640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70290382058640
+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: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- cmu_person.gemspec
+- lib/cmu_person.rb
+- lib/cmu_person/exceptions.rb
+- lib/cmu_person/person.rb
+- spec/cmu_person_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sethvargo/cmu_person
+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: cmu_person
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A simple interface for searching CMU LDAP directory
+test_files:
+- spec/cmu_person_spec.rb
+- spec/spec_helper.rb
+has_rdoc: