yaleldap 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 085e564098747fe02c8081c63e0bb948f512cf97
-  data.tar.gz: e933f0d8a93036961a9d4aa0f9ecc3078d746485
+  metadata.gz: 266a897095f24d430477b8e2102ddca166d36690
+  data.tar.gz: 92930d2a050274ed5875518dc3ddcd26196f1309
 SHA512:
-  metadata.gz: fd70cba221f0dcc68231ec5925745729e7abec850d82e04f4a26c9aaa2b86e3c831825873ea909f4b3d69fb163a91f5a18dd9429b2689bebe6bb76c61a50fea1
-  data.tar.gz: 1664a0f29d805d0a2a95ea94def8664b40b88b6e30c1c3b6a318b86f3ce595d7ca274de732c5752363f9d11cdcb87f0003ab970fa45ba1b80533b01ef2733012
+  metadata.gz: 8c4904fd23614ad5461bf4fe3cd249a69e76b42c202b3f82e269875bd83db4f331f8a4c43127d655d1059a43d523ef76bbda1eb48996af031f8ae398959f9a7d
+  data.tar.gz: a9d1d6491b2dc918971d6087a339aede227e0e9dbd5b0813c893e491da60181489266c61aaf29b68588e1bc0a3a87263ad9bd932ce744adcf4e666774f3c9f4e

data/README.md

@@ -25,34 +25,48 @@ Or install it yourself as:
 
     $ gem install yaleldap
 
-## Usage
+To play with it, open `irb` and try these:
 
-###UPI
 ```
-YaleLDAP.lookup(upi: "12714662")
-=> {:first_name=>"Casey", :nickname=>"", :last_name=>"Watts", :upi=>"12714662", :netid=>"csw3", :email=>"casey.watts@yale.edu", :college_name=>"", :college_abbreviation=>"", :class_year=>"", :school=>"", :telephone=>"", :address=>"ITS Student Technology Collaborative\nPO BOX 208300\nNew Haven, CT 06520-8300"}
+require 'yaleldap'
+attributes = YaleLDAP.lookup(netid: "csw3")
+attributes = YaleLDAP.lookup(email: "casey.watts@yale.edu")
+attributes = YaleLDAP.lookup(upi: "12714662")
 ```
 
+
+## Usage
+
 ###NetID
 ```
 YaleLDAP.lookup(netid: "csw3")
-=> {:first_name=>"Casey", :nickname=>"", :last_name=>"Watts", :upi=>"12714662", :netid=>"csw3", :email=>"casey.watts@yale.edu", :college_name=>"", :college_abbreviation=>"", :class_year=>"", :school=>"", :telephone=>"", :address=>"ITS Student Technology Collaborative\nPO BOX 208300\nNew Haven, CT 06520-8300"}
+=> {:first_name=>"Casey", :nickname=>"", :last_name=>"Watts", :upi=>"12714662", :netid=>"csw3", :email=>"casey.watts@yale.edu", :title=>"Assistant Manager", :division=>"Information Technology Services", :school=>"Information Technology Services", :school_abbreviation=>"", :organization=>"ITSCCT Web Technologies", :major=>"", :curriculum=>"", :college_name=>"", :college_abbreviation=>"", :class_year=>"", :telephone=>"203-436-5986", :address=>"ITS Student Technology Collaborative\nPO BOX 208300\nNew Haven, CT 06520-8300"}
 ```
 
 ###Email
 ```
 YaleLDAP.lookup(email: "casey.watts@yale.edu")
-=> {:first_name=>"Casey", :nickname=>"", :last_name=>"Watts", :upi=>"12714662", :netid=>"csw3", :email=>"casey.watts@yale.edu", :college_name=>"", :college_abbreviation=>"", :class_year=>"", :school=>"", :telephone=>"", :address=>"ITS Student Technology Collaborative\nPO BOX 208300\nNew Haven, CT 06520-8300"}
+=> {:first_name=>"Casey", :nickname=>"", :last_name=>"Watts", :upi=>"12714662", :netid=>"csw3", :email=>"casey.watts@yale.edu", :title=>"Assistant Manager", :division=>"Information Technology Services", :school=>"Information Technology Services", :school_abbreviation=>"", :organization=>"ITSCCT Web Technologies", :major=>"", :curriculum=>"", :college_name=>"", :college_abbreviation=>"", :class_year=>"", :telephone=>"203-436-5986", :address=>"ITS Student Technology Collaborative\nPO BOX 208300\nNew Haven, CT 06520-8300"}
+```
+
+###UPI
+```
+YaleLDAP.lookup(upi: "12714662")
+=> {:first_name=>"Casey", :nickname=>"", :last_name=>"Watts", :upi=>"12714662", :netid=>"csw3", :email=>"casey.watts@yale.edu", :title=>"Assistant Manager", :division=>"Information Technology Services", :school=>"Information Technology Services", :school_abbreviation=>"", :organization=>"ITSCCT Web Technologies", :major=>"", :curriculum=>"", :college_name=>"", :college_abbreviation=>"", :class_year=>"", :telephone=>"203-436-5986", :address=>"ITS Student Technology Collaborative\nPO BOX 208300\nNew Haven, CT 06520-8300"}
 ```
 
+
 ## Return Data
-- Yale's list of LDAP attributes are listed by their LDAP names [here](http://directory.yale.edu/phonebook/help.htm).
-- Our set of nicknames for Yale's attributes are in `lib/yaleldap.rb`
-- If you think there is a commonly used field we missed, file a github issue! :D
-- If you'd like more control over your YaleLDAP connection, you could do this all manually. [Here is a gist](https://gist.github.com/caseywatts/ddea3996853050d1e5ad) of how to use the 'net-ldap' gem to access Yale's LDAP.
-- Here are some examples of what the more vague LDAP terms contain:
+###What data is returned?
+>"What does the returned data look like? Where does it come from?"
+
+We map a memorable nickname to each of the less memorable formal LDAP names.
+- The easiest way to see what attributes are available is to test it out.
+- Our full list of nicknames is in `lib/yaleldap.rb` under `self.nicknames`
+- Yale's list of formal LDAP attribute names are listed [here](http://directory.yale.edu/phonebook/help.htm).
+- Here are some examples of what the more vague LDAP terms contain. We've included multiple aliases for some of these.
 ```
-Division (general, most people have this)
+Division [listed as division, school] - general category, most people have this. For students, this is their school)
   Yale College
   Graduate School of Arts & Sci
   Architecture School
@@ -60,23 +74,30 @@ Division (general, most people have this)
   MYSM School Of Medicine
   Information Technology Services
 
-Organization (more specific, staff tend to have these)
+Curriculum Code [listed as school_abbreviation] - seems to be abbreviation of division if they are a school?)
+  YC
+  GS
+  AC
+
+Organization [listed as organization] - more specific, staff tend to have these
   MPHARM Administration
   ITSCCT Web Technologies
 
-Curriculum/Major (more specific, students tend to have these)
+Curriculum/Major [listed as curriculum, major] - more specific, students tend to have these
   Pharmacology
   Architecture School
   Physics
-
-Curriculum Code (seems to be abbreviation of division if they are a school?)
-  YC
-  GS
-  AC
 ```
 
+### Something's Missing?
+>"I want some data that's in the [Yale Phonebook](http://directory.yale.edu/phonebook/index.htm) but it's not in the `YaleLDAP` gem."
+
+- If you think there is a commonly used field we missed, file a github issue! :D
+- If you'd like more control over your YaleLDAP connection, you could do this all manually. [Here is a gist](https://gist.github.com/caseywatts/ddea3996853050d1e5ad) of how to use the 'net-ldap' gem to access Yale's LDAP.
+
+
 ## Use in Rails
-You can use an "after_create" filter to have these attributes filled out after the user is created (maybe after first login if that's how your app works). `.slice(:first_name, :last_name, :netid)` will extract only the attributes you want to save to ActiveRecord. If your database uses diferent names you will have to rename the appropriate attributes manually, or just extract what you want.
+You can use an "after_create" filter to have these attributes filled out after the user is created (maybe after first login if that's how your app works). `.slice(:first_name, :last_name, :netid)` will extract only the attributes you want to save to ActiveRecord. If your database uses diferent names you will have to rename the appropriate attributes manually using your own ruby code.
 ```
 class User < ActiveRecord::Base
   after_create :get_ldap_attributes

data/lib/yaleldap/version.rb

@@ -1,5 +1,5 @@
 #Version Goes Here
 module YaleLDAP
   #Version Number
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

data/lib/yaleldap.rb

@@ -68,8 +68,8 @@ private
       "school" => "o",
       "school_abbreviation" => "curriculumshortname",
       "organization" => "ou",
-      "major" => "curriculum",
-      "curriculum" => "curriculum",
+      "major" => "major",
+      "curriculum" => "major",
       "college_name" => "collegename",
       "college_abbreviation" => "college",
       "class_year" => "class",
@@ -110,6 +110,7 @@ private
 
   def self.extract_attributes(ldap_response)
     attributes = {}
+    binding.pry
     nicknames.each do |nickname, ldapname|
       attribute = extract_attribute(ldap_response, ldapname)
       attribute = attribute.gsub(/\$/,"\n") #for address

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaleldap
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - caseywatts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-27 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler