yaleldap 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12d18261da5f2af81134acde14dda46077a89652
-  data.tar.gz: 5da0fffd53d2ec47c5486cec9f26a8a644da0ba9
+  metadata.gz: 22865d39103fa944e24f2889695cb00bcb35e1ae
+  data.tar.gz: 9f15790fe82aa385ff9ba4816549b32a568084b3
 SHA512:
-  metadata.gz: 5c3df73a33cf141c6383d1b6175ed7eb7413a62c22301e362719d276ffb1a36de89cc4221a228964e8aa2151ded3ab470657bbf662a30dbe648086c5e343b8d0
-  data.tar.gz: beac04df0d2afabfb7025b56f4bb7975746f77906b91a8169649b9df1ae65fd0b477fa0138e6e81945712a19744d981af498a6ffe20e472bd5b0ac4c7c67518d
+  metadata.gz: 7370b4871fe629f53934c40dbd8587884d5a45332d0ad56ea1de10f179f4e0803b7fcdfa5388891ab1582d0693251b5fbe3db250d58b6ea8b55bf80a3b3a11ba
+  data.tar.gz: a310204d85fbd47026089a50b69be846258d0e396bb24b9998882635d762ad0622d165629b2b0fba3719761f00eb473298d3906a20a262ebd346b66f3c7d8a74

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  enabled: true

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "2.0.0"
+script: bundle exec rspec spec
+addons:
+  code_climate:
+    repo_token: 26473d8ac983f8c195675b3369530ea84d26ee1d1101dd0300caa29f7642eb41 bundle exec rake

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
+gem "codeclimate-test-reporter", group: :test, require: nil
 # Specify your gem's dependencies in yaleldap.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', cmd: 'bundle exec rake' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/README.md

@@ -1,10 +1,15 @@
 [![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)
+[![Build Status](https://travis-ci.org/YaleSTC/yaleldap.svg?branch=testinghound)](https://travis-ci.org/YaleSTC/yaleldap)
+[![Code Climate](https://codeclimate.com/github/YaleSTC/yaleldap/badges/gpa.svg)](https://codeclimate.com/github/YaleSTC/yaleldap)
+[![Test Coverage](https://codeclimate.com/github/YaleSTC/yaleldap/badges/coverage.svg)](https://codeclimate.com/github/YaleSTC/yaleldap)
 [![Inline docs](http://inch-ci.org/github/YaleSTC/yaleldap.png?branch=master)](http://inch-ci.org/github/YaleSTC/yaleldap)
 
-# 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.
+Offers the most common Yale LDAP search queries, returning a convenient ruby hash with names you can understand. Makes it easy to conserve your Yale users' time and energy, saving them from typing again and again that basic information they *know* mother Yale already has on record.
+
+The LDAP server can only be connected to from Yale's campus or on Yale's VPN.
 
 ## Installation
 
@@ -24,29 +29,27 @@ Or install it yourself as:
 
 ###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=>""}
+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"}
 ```
 
 ###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=>""}
+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"}
 ```
 
 ###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=>""}
+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"}
 ```
 
 
 ## Documentation
-The source code is documented on rdoc.info
-
-<http://rdoc.info/github/YaleSTC/yaleldap/master/frames>
+The source code is documented thoroughly, view it 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)
+For more background on how the `net-ldap` gem works with specific Yale examples, check out this [Yale net-ldap gist](https://gist.github.com/caseywatts/ddea3996853050d1e5ad).
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,15 @@
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+# RSpec::Core::RakeTask.new(:spec) do |task|
+#   task.rspec_opts = ['--color', '--format', 'documentation']
+# end
+
+# task spec do
+#     'bundle exec rspec spec --color --format documentation'
+# end
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/yaleldap/version.rb

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

data/lib/yaleldap.rb

@@ -1,7 +1,7 @@
 require "yaleldap/version"
 require "net-ldap"
 
-#YaleLDAP Module is xyz
+#YaleLDAP Module contains the logic for YaleLDAP
 module YaleLDAP
   # Yale's LDAP Host
   LDAP_HOST = 'directory.yale.edu'
@@ -12,101 +12,109 @@ module YaleLDAP
   # 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)
-
   ##
-  # Lookup LDAP information by upi
-  # 
-  # @param
-  #   upi as a string, ex "12714662"
+  # lookup by an arbitrary query (netid, email, upi, etc)
+  #
+  # @param [Hash] input_hash the query we're looking up with just one key-value pair. It expects the keys 'email', 'netid', 'upi'.
+  #
+  # @return [hash]
+  #   our standard return hash (see README.md for a description of what it returns)
   #
-  # @return
-  #   Standard hash (see extract_attributes)
-  # 
   # @example
-  #   YaleLDAP.lookup_by_upi("12714662")
+  #   YaleLDAP.lookup(email: "casey.watts@yale.edu")
+  #   YaleLDAP.lookup(netid: "csw3")
+  #   YaleLDAP.lookup(upi: "12714662")
+  #
+  def self.lookup(input_hash)
+    lookup_filter = construct_filter(input_hash)
+    ldap_response = execute_query(lookup_filter)
+    attributes = extract_attributes(ldap_response)
+    return attributes
+  end
 
-  def self.lookup_by_upi(upi)
-    ldap = Net::LDAP.new host: LDAP_HOST, port: LDAP_PORT
-    upifilter = Net::LDAP::Filter.eq('UPI', upi)
-    ldap_response = ldap.search(base: LDAP_BASE,
-                     filter: upifilter,
-                     attributes: LDAP_ATTRS)
-    extract_attributes(ldap_response)
+private
+
+  ###
+  # Nickname Logic
+  ###
+
+  def self.convert_from_nickname(attribute)
+    attribute = attribute.to_s
+    nicknames[attribute]
   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)
-    ldap_response = ldap.search(base: LDAP_BASE,
-                     filter: upifilter,
-                     attributes: LDAP_ATTRS)
-    extract_attributes(ldap_response)
+  def self.convert_to_nickname(attribute)
+    attribute = attribute.to_s
+    nicknames.invert[attribute]
   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)
+  def self.search_attributes
+    nicknames.values
+  end
+
+  def self.nicknames
+    # a list of attributes we care about
+    # "nickname" => "ldapname"
+    # "somethingthatmakessense" => "somethingjargony"
+    return {
+      "first_name" => "givenname",
+      "nickname" => "eduPersonNickname",
+      "last_name" => "sn",
+      "upi" => "UPI",
+      "netid" => "uid",
+      "email" => "mail",
+      "college_name" => "collegename",
+      "college_abbreviation" => "college",
+      "class_year" => "class",
+      "school" => "organizationUnitName",
+      "telephone" => "officePhone",
+      "address" => "postalAddress"
+    }
+  end
+
+
+
+  ###
+  #LDAP Search Logic
+  ###
+
+
+  # Constructs a Net::LDAP::Filter object out of our user input
+  # @param the input hash we want users to input, such as {:email => "casey.watts@yale.edu"}
+  # @return a net-ldap Net::LDAP::Filter object with our desired query
+  def self.construct_filter(input_hash)
+    query_type_nickname = input_hash.keys.first
+    query_value = input_hash.values.first
+    query_type_ldapname = convert_from_nickname(query_type_nickname)
+    lookup_filter = Net::LDAP::Filter.eq(query_type_ldapname, query_value)
+    return lookup_filter
+  end
+
+  # Executes the query on the LDAP server.
+  # @param a net-ldap Net::LDAP::Filter object with our desired query
+  # @return the raw net-ldap LDAP response object
+  def self.execute_query(lookup_filter)
     ldap = Net::LDAP.new host: LDAP_HOST, port: LDAP_PORT
-    upifilter = Net::LDAP::Filter.eq('mail', email)
     ldap_response = ldap.search(base: LDAP_BASE,
-                     filter: upifilter,
-                     attributes: LDAP_ATTRS)
-    extract_attributes(ldap_response)
+                     filter: lookup_filter,
+                     attributes: search_attributes)
+    return ldap_response
   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]
-    last_name = ldap_response[0][:sn][0]
-    upi = ldap_response[0][:UPI][0]
-
-    # not everyone has these
-    netid = ldap_response[0][:uid][0] || ""
-    email = ldap_response[0][:mail][0] || ""
-    collegename = ldap_response[0][:collegename][0] || ""
-    college = ldap_response[0][:college][0] || ""
-    class_year = ldap_response[0][:class][0] || ""
+    attributes = {}
+    nicknames.each do |nickname, ldapname|
+      attribute = extract_attribute(ldap_response, ldapname)
+      attribute = attribute.gsub(/\$/,"\n") #for address
+      attributes[nickname.to_sym] = attribute
+    end
+    return attributes
+  end
 
-    return {
-      first_name: first_name,
-      last_name: last_name,
-      yale_upi: upi,
-      netid: netid,
-      email: email,
-      collegename: collegename,
-      college: college,
-      class_year: class_year
-    }
+  def self.extract_attribute(ldap_response, attribute_name)
+    attribute = ldap_response[0][attribute_name][0]
+    attribute ||= ""
   end
 
 end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'yaleldap'

data/spec/yaleldap_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe YaleLDAP do
+  it 'does stuff' do
+    true.should be_truthy
+  end
+  xit 'does stuffz' do
+    raise "trouble"
+  end
+end

data/yaleldap.gemspec

@@ -20,5 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec", "~> 3.1.0"
+
   spec.add_runtime_dependency "net-ldap"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaleldap
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - caseywatts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-16 00:00:00.000000000 Z
+date: 2014-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: net-ldap
   requirement: !ruby/object:Gem::Requirement
@@ -61,12 +103,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .hound.yml
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/yaleldap.rb
 - lib/yaleldap/version.rb
+- spec/spec_helper.rb
+- spec/yaleldap_spec.rb
 - yaleldap.gemspec
 homepage: http://github.com/YaleSTC/yaleldap
 licenses:
@@ -92,5 +139,7 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Easy connection to Yale's LDAP
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/yaleldap_spec.rb
 has_rdoc: