yaleldap 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5943d287b4b24158bc7ffb8cb6785f3df39fff70
-  data.tar.gz: 128656225ea369cd377915e5b4a271d62d5ea4bc
+  metadata.gz: 12d18261da5f2af81134acde14dda46077a89652
+  data.tar.gz: 5da0fffd53d2ec47c5486cec9f26a8a644da0ba9
 SHA512:
-  metadata.gz: a7805a8bcd7e614b1c5c3818b2e8dbd0d4eb8779e883efb1dacdd9e3f74d02e1332d3cfba815de42e8b24a124f05d9e6073a67db7f66f92fa02589cbeee8aeb1
-  data.tar.gz: 9587d3fc6858642104dbdf6740346b23247056d9897611776d833ebc194b9e7a6066eebcfdbed1e3c142ab1400bd63e2822325b20c0d22444e2d24a8918673aa
+  metadata.gz: 5c3df73a33cf141c6383d1b6175ed7eb7413a62c22301e362719d276ffb1a36de89cc4221a228964e8aa2151ded3ab470657bbf662a30dbe648086c5e343b8d0
+  data.tar.gz: beac04df0d2afabfb7025b56f4bb7975746f77906b91a8169649b9df1ae65fd0b477fa0138e6e81945712a19744d981af498a6ffe20e472bd5b0ac4c7c67518d

data/README.md

@@ -1,3 +1,7 @@
+[![Gem Version](https://badge.fury.io/rb/yaleldap.svg)](http://badge.fury.io/rb/yaleldap)
+[![Dependency Status](https://gemnasium.com/YaleSTC/yaleldap.svg)](https://gemnasium.com/YaleSTC/yaleldap)
+[![Inline docs](http://inch-ci.org/github/YaleSTC/yaleldap.png?branch=master)](http://inch-ci.org/github/YaleSTC/yaleldap)
+
 # Yaleldap
 
 Automatically connects to the LDAP server if you are on campus/VPN. Can be queried by UPI, and it will return a simple ruby hash with the relevant information.
@@ -18,9 +22,31 @@ Or install it yourself as:
 
 ## Usage
 
-`YaleLDAP.lookup_by_upi("123456")` will return a hash with commonly needed LDAP attributes.
+###UPI
+```
+YaleLDAP.lookup_by_upi("12714662")
+=> {:first_name=>"Casey", :last_name=>"Watts", :yale_upi=>"12714662", :netid=>"csw3", :email=>"casey.watts@yale.edu", :collegename=>"", :college=>"", :class_year=>""}
+```
+
+###NetID
+```
+YaleLDAP.lookup_by_netid("csw3")
+=> {:first_name=>"Casey", :last_name=>"Watts", :yale_upi=>"12714662", :netid=>"csw3", :email=>"casey.watts@yale.edu", :collegename=>"", :college=>"", :class_year=>""}
+```
+
+###Email
+```
+YaleLDAP.lookup_by_email("casey.watts@yale.edu")
+=> {:first_name=>"Casey", :last_name=>"Watts", :yale_upi=>"12714662", :netid=>"csw3", :email=>"casey.watts@yale.edu", :collegename=>"", :college=>"", :class_year=>""}
+```
+
+
+## Documentation
+The source code is documented on rdoc.info
 
+<http://rdoc.info/github/YaleSTC/yaleldap/master/frames>
 
+For more background on how the `net-ldap` gem works, check out this [Yale-specific gist](https://gist.github.com/caseywatts/ddea3996853050d1e5ad)
 
 ## Contributing
 

data/lib/yaleldap/version.rb

@@ -1,3 +1,5 @@
-module Yaleldap
-  VERSION = "0.0.1"
+#Version Goes Here
+module YaleLDAP
+  #Version Number
+  VERSION = "0.0.2"
 end

data/lib/yaleldap.rb

@@ -1,13 +1,32 @@
 require "yaleldap/version"
 require "net-ldap"
 
+#YaleLDAP Module is xyz
 module YaleLDAP
+  # Yale's LDAP Host
   LDAP_HOST = 'directory.yale.edu'
+
+  # Yale's LDAP Port
   LDAP_PORT = 389
+
+  # Specify to LDAP that we are searching for people
   LDAP_BASE = 'ou=People,o=yale.edu'
+
+  # The most common Yale LDAP atttributes that we care about extracting
   LDAP_ATTRS = %w(uid givenname sn mail collegename college class UPI)
 
-  # test with YaleLDAP.lookup_by_upi("12714662")
+  ##
+  # Lookup LDAP information by upi
+  # 
+  # @param
+  #   upi as a string, ex "12714662"
+  #
+  # @return
+  #   Standard hash (see extract_attributes)
+  # 
+  # @example
+  #   YaleLDAP.lookup_by_upi("12714662")
+
   def self.lookup_by_upi(upi)
     ldap = Net::LDAP.new host: LDAP_HOST, port: LDAP_PORT
     upifilter = Net::LDAP::Filter.eq('UPI', upi)
@@ -17,6 +36,18 @@ module YaleLDAP
     extract_attributes(ldap_response)
   end
 
+  ##
+  # Lookup LDAP information by netid
+  # 
+  # @param
+  #   netid as a string, ex "csw3"
+  #
+  # @return
+  #   Standard hash (see extract_attributes)
+  # 
+  # @example
+  #   YaleLDAP.lookup_by_netid("csw3")
+  #
   def self.lookup_by_netid(netid)
     ldap = Net::LDAP.new host: LDAP_HOST, port: LDAP_PORT
     upifilter = Net::LDAP::Filter.eq('uid', netid)
@@ -26,6 +57,18 @@ module YaleLDAP
     extract_attributes(ldap_response)
   end
 
+  ##
+  # Lookup LDAP information by Yale email address
+  # 
+  # @param
+  #   email as a string, ex "casey.watts@yale.edu"
+  #
+  # @return
+  #   Standard hash (see extract_attributes)
+  # 
+  # @example
+  #   YaleLDAP.lookup_by_email("casey.watts@yale.edu")
+  #
   def self.lookup_by_email(email)
     ldap = Net::LDAP.new host: LDAP_HOST, port: LDAP_PORT
     upifilter = Net::LDAP::Filter.eq('mail', email)
@@ -36,6 +79,11 @@ module YaleLDAP
   end
 
 private
+  #
+  # Input a raw LDAP response
+  #
+  # Output is a hash with keys: first_name, last_name, upi, netid, email, collegename, college, class_year
+  #
   def self.extract_attributes(ldap_response)
     # everyone has these
     first_name = ldap_response[0][:givenname][0]

data/yaleldap.gemspec

@@ -5,7 +5,7 @@ require 'yaleldap/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "yaleldap"
-  spec.version       = Yaleldap::VERSION
+  spec.version       = YaleLDAP::VERSION
   spec.authors       = ["caseywatts"]
   spec.email         = ["casey.s.watts@gmail.com"]
   spec.summary       = %q{Easy connection to Yale's LDAP}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaleldap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - caseywatts
@@ -93,3 +93,4 @@ signing_key:
 specification_version: 4
 summary: Easy connection to Yale's LDAP
 test_files: []
+has_rdoc: