gsr 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+main.rb
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matt Parmett
+
+MIT License
+
+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,41 @@
+# gsr.rb: A Ruby library for reserving Wharton GSRs #
+
+gsr.rb is a simple Ruby library that allows your application to easily book and cancel Wharton Group Study Room (GSR) reservations.
+
+## How to use gsr.rb ##
+
+*This section will change as gsr.rb is developed.  As such, this section may not be fully accurate, but I will try to keep the instructions as current as possible.*
+
+### Make a reservation ###
+
+To reserve a GSR for 60 minutes at noon on 9/18/2012 on the second floor:
+
+```ruby
+require 'gsr.rb'
+concierge = GSR.new(spike_username, spike_password)
+concierge.reserve('floor' => '2', 'start_time' => Time.new(2012, 9, 18, 12, 0, 0), 'duration' => 60)
+```
+
+```floor``` takes strings ```""```, ```"F"```, ```"G"```, ```"2"```, or ```"3"```.  The empty string, to which ```floor``` defaults, means any floor is acceptable.
+
+```start_time``` takes a Time object specifying the desired starting date and time (defaults to ```Time.now```).
+
+```duration``` takes an integer with a value of ```30```, ```60```, or ```90```.  If another integer is given, gsr.rb rounds up to the next largest interval.  ```duration``` defaults to ```90```.
+
+### Cancel a reservation ###
+
+To cancel the reservation closest to the current time (more specific cancellation functionality may be added in the future):
+
+```ruby
+require 'gsr.rb'
+concierge = GSR.new(spike_username, spike_password)
+concierge.cancel
+```
+
+## Warnings ##
+
+Security-wise, this probably isn't the most secure way to handle the spike username and password.  The user/pass combo is sent through a form on a secure web page, but no additional encryption/hashing is done on the credentials.  Still, if gsr.rb is incorporated into a Heroku app, for example, the spike credentials could be stored securely as environment variables.
+
+## TODO ##
+*	More robust cancellation system?
+*	Create gem

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/gsr.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gsr/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = "Matt Parmett"
+  gem.email         = "parm289@yahoo.com"
+  gem.description   = %q{Ruby wrapper for the Wharton GSR Reservation System}
+  gem.summary       = %q{Ruby wrapper for the Wharton GSR Reservation System}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gsr"
+  gem.require_paths = ["lib"]
+  gem.version       = Gsr::Ruby::VERSION
+  
+  gem.add_dependency "mechanize"
+end

data/lib/gsr.rb

@@ -0,0 +1,123 @@
+require 'mechanize'
+require 'open-uri'
+
+#Utility time methods
+class Time
+	#Converts start_time from time to formatted string
+	def format_start_time()
+		#Hour logic
+		if self.hour < 0
+			raise "Invalid self specified: hour can't be negative"
+		elsif self.hour == 0
+			hour = 12
+			half = "AM"
+		elsif self.hour == 12
+			hour = 12
+			half = "PM"
+		elsif self.hour > 12
+			hour = self.hour - 12
+			half = "PM"
+		else # 0 < self.hour < 12
+			hour = self.hour
+			half = "AM"
+		end
+		
+		#Minute logic
+		if self.min < 10
+			min = "0" + self.min.to_s
+		else
+			min = self.min.to_s
+		end
+		
+		return hour.to_s + ':' + min + " " + half
+	end
+	
+	#Converts start_date from date to formatted string
+	def format_start_date()
+		if Date.valid_date?(self.year, self.month, self.day)
+			return self.month.to_s + '/' + self.day.to_s
+		else
+			raise "Invalid start date specified."
+		end
+	end
+end
+
+# GSR class handles making GSR reservations
+class GSR
+	attr_accessor :username, :password, :spike_root_url
+	
+	def initialize(username, password, spike_root_url = "http://spike.wharton.upenn.edu/m/gsr.cfm?logout=true")
+		@username = username
+		@password = password
+		@spike_root_url = spike_root_url
+	end
+	
+	# Logs in to spike using mechanize
+	def spike_login()
+		agent = Mechanize.new
+		login = agent.get(self.spike_root_url) #Go to login page
+		loginform = agent.page.forms.first #Select login form
+		loginform.username = self.username
+		loginform.password = self.password
+		gsr = agent.submit(loginform, loginform.buttons.first) #Submit form and log in
+		return {'agent' => agent, 'gsr' => gsr}
+	end
+	
+	#Reserves the GSR
+	#requirements is an optional hash with keys:
+		#floor (string [F, G, 2, 3]), start_time (Time), duration (integer, minutes [30,60, or 90])
+	def reserve(requirements)		
+		#Check if we have a non-kosher floor and revert to default
+		requirements['floor'] = "" if !(requirements['floor'].nil?) and 
+			!(["", "F", "G", "2", "3"].include? requirements['floor'])
+		
+		#Default args
+		default_options = {'floor' => "", 'start_time' => Time.now, 'duration' => 90}
+		args = default_options.merge(requirements)
+		
+		#Convert start_date and start_time from date and time to correct form format
+		start_time = args['start_time'].format_start_time
+		start_date = args['start_time'].format_start_date
+		
+		#Duration logic - round to 30, 60, or 90 (nearest)
+		unless requirements['duration'].nil?
+			if args['duration'] <= 30
+				args['duration'] = 30
+			elsif args['duration'] <= 60
+				args['duration'] = 60
+			else
+				args['duration'] = 90
+			end
+		end
+		
+		agent = spike_login()['agent'] # Mechanize agent at successful login page
+		gsr = spike_login()['gsr'] # Mechanize page = successful login page
+		gsrform = gsr.form_with(:action => 'https://spike.wharton.upenn.edu/m/gsr.cfm') #Select GSR form
+
+		#Input GSR info
+		gsrform.preferred_floor = args['floor']
+		gsrform.start_date = start_date
+		gsrform.start_time = start_time
+		gsrform.duration = args['duration']
+		
+		#Submit reservation
+		submit = agent.submit(gsrform, gsrform.buttons.first)
+		
+		#Check if successful
+		raise "Error reserving GSR. Check supplied parameters." if submit.link_with(:text => 'Cancel').nil?
+		
+	end
+	
+	#Cancels most recent GSR reservation
+	def cancel()
+		agent = spike_login()['agent'] # Mechanize agent at successful login page
+		gsr = spike_login()['gsr'] # Mechanize page = successful login page
+		
+		cancel = gsr.link_with(:text => 'Cancel')
+		if (cancel.nil?)
+			raise "Error: You have no GSR reservation to cancel."
+		else
+			gsr = cancel.click
+		end
+	end
+end

data/lib/gsr/version.rb

@@ -0,0 +1,5 @@
+module Gsr
+  module Ruby
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: gsr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matt Parmett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for the Wharton GSR Reservation System
+email: parm289@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gsr.gemspec
+- lib/gsr.rb
+- lib/gsr/version.rb
+homepage: ''
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Wharton GSR Reservation System
+test_files: []