cwru_directory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7115bc699d6829f6ff8bacb672e7b622c500b73e
+  data.tar.gz: 49a4899de3fa4f29f2480d66d5529be9b88fccd5
+SHA512:
+  metadata.gz: 6d6905486d2e9d90a5f60dbab52a96e38224d9c7189f31b4edbf61551138b4a3f0e6b8d71e9db953793589bce16e1845bc52e30f21d64bffc26508eca054ca74
+  data.tar.gz: fbc6864a947f0f85e65581f8fa87cbd1bd85ab66bc79e42b82735046d37c28581cce889ea9295f05cc58d493604b6a7a19f51392dbdf61cf7b7165b96c911d50

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cwru_directory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew Mason
+
+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.md

@@ -0,0 +1,93 @@
+# CWRUDirectory
+
+Make queries with the Case Western Reserve University [directory listing](https://webapps.case.edu/directory/index.html) in Ruby!
+
+Inspired by/derived from [the Python implementation](https://github.com/brenns10/caseid).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cwru_directory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cwru_directory
+
+## Usage
+
+### Configuration
+
+CWRUDirectory currently recognizes the following configuration options
+(you can set as many other options as you like, they just won't do anything):
+
+```ruby
+CWRUDirectory.configure do |config|
+  # case_id and password are used to authenticate with SSO to
+  # be able to access information not available to the public
+  config.case_id = 'abc123'
+  config.password = 'my-password'
+
+  # get_all_info is used to tell CWRUDirectory to actually get
+  # that extra info not available to the public
+  config.get_all_info = true
+end
+```
+
+### Queries
+
+CWRUDirectory has two ways to query the directory, simple and advanced.
+Both return a hash, which maps the categories to the sets of results for
+each category.
+
+#### The Result hash
+
+As mentioned above, each element of a result set is a hash, which has the following keys:
+  * `:name`
+  * `:phone_number`
+  * `:email`
+  * `:department`
+
+If you run this with the `get_all_info` config option set, you will also
+get some of the following, possibly more:
+  * `"Case Network ID"` - this one is always present (as far as I can tell)
+  * `"Title"` 
+  * `"Mail Stop Location Code"` - uhhh. I guess if you need that...
+
+#### Simple Queries
+
+Simple queries allow you to search by single search string in a given search mode.
+
+```ruby
+CWRUDirectory.simple 'my_search_string'
+# second argument is the search mode, defaults to :regular,
+# :phonetic is the only other option the Case directory supports
+CWRUDirectory.simple 'my_search_string', :phonetic
+```
+
+#### Advanced Queries
+
+You can also make "advanced" queries with many more attributes. The Case directory has the
+following attributes:
+  * `surname` - last name
+  * `givenname` - first name
+  * `department` - this isn't listed for most entries, so probably won't be that helpful to you
+  * `location` - ??? if you figure out what this actually is, let me know
+  * `category` - one of `'STUDENT', 'FACULTY', 'STAFF', 'EMERITI', 'ALL'`
+  * `search_text` - this is the same as the search text used in the simple queries
+  * `search_method` - same as simple queries
+
+Just pass in a hash of whichever ones you want to use; the rest will default to empty strings,
+except for `category` (default is `'ALL'`) and `search_method` (defaults to `:regular`)
+
+```ruby
+CWRUDirectory.advanced({surname: 'Mason', givenname: 'Andrew'})
+```
+
+That's all for now folks! LDAP probably coming soon.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cwru_directory"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cwru_directory.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cwru_directory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cwru_directory"
+  spec.version       = CWRUDirectory::VERSION
+  spec.authors       = ["Andrew Mason"]
+  spec.email         = ["mason@case.edu"]
+
+  spec.summary       = "Gem for making queries with the Case Western Reserve University directory listing"
+  spec.homepage      = "https://github.com/ajm188/cwru_directory"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'pry'
+
+  spec.add_runtime_dependency 'mechanize'
+end

data/lib/cwru_directory.rb

@@ -0,0 +1,120 @@
+require "cwru_directory/version"
+require 'cwru_directory/config'
+require 'cwru_directory/authentication'
+
+require 'mechanize' # Can't just open-uri because the URL does a redirect
+
+module CWRUDirectory
+  URL = 'https://webapps.case.edu/directory/lookup'
+  @agent ||= Mechanize.new
+
+  class << self
+    # Perform a simple search. Default search method is
+    # regular. Other option is phonetic, which actually seems
+    # to sort of work.
+    #
+    # Returns a hash, which maps each category (see the comments on
+    # the #advanced method) to the list of results for that category.
+    # Each result is itself a hash, with the keys:
+    #   * :name
+    #   * :phone_number
+    #   * :email
+    #   * :department
+    def simple(search_text, search_method = :regular)
+      search({search_text: search_text, search_method: search_method})
+    end
+
+    # Perform an advanced search with various params. Ones supported
+    # by the CWRU directory are:
+    #   * surname: last name
+    #   * givenname: first name
+    #   * department: not listed for most entries
+    #   * location: ???
+    #   * category: one of 'STUDENT', 'FACULTY', 'STAFF', or 'EMERITI'
+    #   * search_text: same as the argument to the simple search
+    #   * search_method: same as the argument to the simple search
+    #
+    # Returns a hash, exactly like the #simple method (see above)
+    def advanced(params = {})
+      search(params)
+    end
+
+    def search(params)
+      page = @agent.get(URL + '?' + to_query_string(default_search_params.merge(params))).parser
+      rows = page.xpath('//table[@class="dirresults"]/tr')
+      parse_results(rows)
+    end
+
+    def parse_results(rows)
+      header = nil
+      results = {}
+      index = 0
+      while index < rows.length
+        # We need more fine-grained control over the looping
+        # because each result is actually 2 rows in the table,
+        # but header rows are only one row. This is the worst
+        row = rows[index]
+        if row.children[0].get_attribute('class') == 'dirhdr'
+          # This is a new header section.
+          header = row.children[0].children[0].text
+          results[header] = []
+        elsif row.children[0].get_attribute('class') == 'breaker'
+          # This row is just for spacing. Ignore it.
+          index += 1
+          next
+        else
+          # This is a result row. Process it and the next row
+          results[header] << process_result(row, rows[index + 1])
+          index += 1
+        end
+        index += 1
+      end
+
+      if @config.get_all_info
+        authenticate! # we need to be authenticated for this
+        results.values.flatten.each do |result|
+          process_more_info(result, @agent.get(result[:more_info_link])) if result[:more_info_link]
+        end
+      end
+      results
+    end
+
+    def process_result(first_row, second_row)
+      {
+        name: first_row.children[0].text,
+        phone_number: first_row.children[1].text,
+        more_info_link: first_row.children[2].children[0].get_attribute('href'),
+        email: second_row.children[0].text,
+        department: second_row.children[1].text
+      }
+    end
+
+    def process_more_info(result, more_info_page)
+      html = more_info_page.parser
+      # The first row is the person's name and section, so we can skip that.
+      html.xpath('//table[@class="longlisting"]/tr').drop(1).each do |more_info_row|
+        attribute = more_info_row.children[0].text
+        # There is a td of padding between the attribute and the value
+        value = more_info_row.children[2].text
+
+        result[attribute] = value
+      end
+    end
+
+    def default_search_params
+      {
+        search_text: '',
+        surname: '',
+        givenname: '',
+        department: '',
+        location: '',
+        category: :all,
+        search_method: :regular
+      }
+    end
+
+    def to_query_string(params)
+      params.map { |k,v| "#{k}=#{v}" }.join('&')
+    end
+  end
+end

data/lib/cwru_directory/authentication.rb

@@ -0,0 +1,18 @@
+module CWRUDirectory
+  class << self
+    def authenticate!
+      return if @authenticated
+      # Surely this will return a result, then we can click 'MORE INFO'
+      # which will take us to the Single Sign On
+      page = @agent.get(URL + '?' + to_query_string(default_search_params.merge({surname: 'Mason', givenname: 'Andrew'})))
+
+      # Fill out the SSO form
+      login_page = page.link_with(text: 'MORE INFO').click
+      login_page.form_with(name: nil) do |form|
+        form.field_with(name: 'username').value = @config.case_id
+        form.field_with(name: 'password').value = @config.password
+      end.submit
+      @authenticated = true
+    end
+  end
+end

data/lib/cwru_directory/config.rb

@@ -0,0 +1,28 @@
+module CWRUDirectory
+  class Configuration
+    # Method missing gives us an attr_accessor for any attribute
+    # we might need on the configuration object.
+    # 
+    # Currently the only config attributes that are used are:
+    #   * case_id
+    #   * password
+    #   * get_all_info
+    def method_missing(meth, *args, &block)
+      meth_string = meth.to_s
+      attr_name = (meth_string.end_with?('=') ? meth_string[0..-2] : meth_string).to_sym
+
+      self.class.class_eval do
+        attr_accessor attr_name
+      end
+
+      self.send(meth, *args, &block)
+    end
+  end
+
+  class << self
+    def configure(&block)
+      @config ||= Configuration.new
+      yield @config if block_given?
+    end
+  end
+end

data/lib/cwru_directory/version.rb

@@ -0,0 +1,3 @@
+module CWRUDirectory
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: cwru_directory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mason@case.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cwru_directory.gemspec
+- lib/cwru_directory.rb
+- lib/cwru_directory/authentication.rb
+- lib/cwru_directory/config.rb
+- lib/cwru_directory/version.rb
+homepage: https://github.com/ajm188/cwru_directory
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Gem for making queries with the Case Western Reserve University directory
+  listing
+test_files: []