uwaterlooapi 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b964bbcdda67f37363b799315ce0c95b4aa7ac7
+  data.tar.gz: 44de178a290b03b0bc45634eb277764d5790b9fe
+SHA512:
+  metadata.gz: 5aba26699122d38b24d90007c22cc0fcbdee824884e8a7291a3dbf064f1716100c53a0e08e117c3b60f078f5b8e29755a5eace703a795fb1e7c5d7d07d090feb
+  data.tar.gz: c14a5ba395d33a1475bbf81a7c09be6ca487c9a0984a8a8fb52f28981b74852d25575cd5c82b2bb4c4e98211889b4ce75daa3fa2e77e18820387c056005b7353

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+gemspec

data/README.md

@@ -0,0 +1,65 @@
+uwaterlooapi
+============
+
+RubyGem wrapper for the University of Waterloo OpenData API
+
+[![Build Status](https://travis-ci.org/amsardesai/uwaterlooapi.svg?branch=master)](https://travis-ci.org/amsardesai/uwaterlooapi)
+
+## Installation
+
+Add the following to your application's Gemfile:
+
+    gem 'uwaterlooapi'
+
+Or install it in your system:
+
+    $ gem install uwaterlooapi
+
+## Usage
+
+To use the API, you must first get an API key from http://api.uwaterloo.ca/.
+
+```ruby
+# Require the gem at the top of your ruby file
+require 'uwaterlooapi'
+
+# Initialize a new instance of the UWaterlooAPI
+api = UWaterlooAPI.new '<your-api-key-goes-here>'
+
+# Store an API query into a variable
+current_weather = api.weather.current # '/weather/current'
+uni_holidays = api.events.holidays # '/events/holidays'
+info_sessions = api.terms.term(1149).infosessions # '/terms/1149/infosessions'
+my_favorite_course = api.courses.subject('CS').catalog_number(247) # '/courses/CS/247'
+my_favorite_course_schedule = my_favorite_course.schedule # '/courses/CS/247/schedule'
+
+# Use the get method to manually retrieve the data and parse it
+current_weather.get.temperature_24hr_max_c
+
+# Or it will do it automatically for you
+current_weather.temperature_24hr_max_c # does the same as above
+uni_holidays.each do |holiday|
+  puts holiday.name
+end # this will print out every holiday
+uni_holidays[0].name # this will print out the first holiday
+
+# Requests will only be performed once for each query
+my_favorite_course.title # => 'Software Engineering Principles'
+my_favorite_course.url # => 'http://www.ucalendar.uwaterloo.ca/1415/COURSE/course-CS.html#CS247'
+
+# Check metadata of request
+my_favorite_course_schedule.get # Retrieves data from server
+if my_favorite_course_schedule.meta(:status) == 204
+  puts 'The schedule for this course cannot be found!'
+end
+```
+
+For details regarding all API endpoints, go here: https://github.com/uWaterloo/api-documentation
+
+## Contributing
+
+If you find bugs or simply want to contribute to this project:
+
+1. Fork this project
+2. Make your changes and push it to your fork
+3. Create a pull request in this repository

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/helpers/routes.rb

@@ -0,0 +1,62 @@
+module Routes
+  
+  # Route Methods
+  
+  def self.route(route)
+    @@routes ||= []
+    @@routes.push route
+  end
+
+  # Routes
+
+  route '/foodservices/menu'
+  route '/foodservices/notes'
+  route '/foodservices/diets'
+  route '/foodservices/outlets'
+  route '/foodservices/locations'
+  route '/foodservices/watcard'
+  route '/foodservices/announcements'
+  route '/foodservices/products/{product_id}'
+  route '/foodservices/{year}/{week}/menu'
+  route '/foodservices/{year}/{week}/notes'
+  route '/foodservices/{year}/{week}/announcements'
+  route '/courses/{subject}'
+  route '/courses/{course_id}'
+  route '/courses/{class_number}/schedule'
+  route '/courses/{subject}/{catalog_number}'
+  route '/courses/{subject}/{catalog_number}/schedule'
+  route '/courses/{subject}/{catalog_number}/prerequisites'
+  route '/courses/{subject}/{catalog_number}/examschedule'
+  route '/events'
+  route '/events/{site}'
+  route '/events/{site}/{id}'
+  route '/events/holidays'
+  route '/news'
+  route '/news/{site}'
+  route '/news/{site}/{id}'
+  route '/weather/current'
+  route '/terms/list'
+  route '/terms/{term}/examschedule'
+  route '/terms/{term}/{subject}/schedule'
+  route '/terms/{term}/{subject}/{catalog_number}/schedule'
+  route '/terms/{term}/infosessions'
+  route '/resources/tutors'
+  route '/resources/printers'
+  route '/resources/infosessions'
+  route '/resources/goosewatch'
+  route '/codes/units'
+  route '/codes/terms'
+  route '/codes/groups'
+  route '/codes/subjects'
+  route '/codes/instructions'
+  route '/buildings/list'
+  route '/buildings/{building_code}'
+  route '/buildings/{building}/{room}/courses'
+  route '/api/usage'
+  route '/api/services'
+  route '/api/methods'
+  route '/api/versions'
+  route '/api/changelog'
+  route '/server/time'
+  route '/server/codes'
+end

data/lib/helpers/uwaterlooapi_query.rb

@@ -0,0 +1,107 @@
+require 'recursive-open-struct'
+
+class UWaterlooAPIQuery
+  include Routes
+
+  def initialize(cur_route, cur_url, api_key)
+    @api_key = api_key
+    @cur_url = cur_url
+    @cur_route = cur_route
+    @retrieved_url = ''
+    @response = @meta = nil
+
+    # Select only routes that may come next
+    routes = @@routes.select { |s| s.start_with?(cur_route) }.
+      map { |s| s[@cur_route.length..-1] }.
+      join.split('/').uniq.delete_if(&:empty?)
+
+    # Define methods without parameters
+    routes.reject { |r| r =~ /^\{.*\}$/ }.
+      map(&:to_sym).each do |route|
+      
+      self.class.send :define_method, route do
+        if is_in_routes?("#{@cur_route}/#{route}")
+          UWaterlooAPIQuery.new "#{@cur_route}/#{route}", "#{@cur_url}/#{route}", api_key
+        else
+          raise NoMethodError
+        end
+      end
+    end
+
+    # Define methods with parameters
+    routes.select { |r| r =~ /^\{.*\}$/ }.
+      map { |r| r.delete('{}') }.
+      map(&:to_sym).each do |route|
+
+      self.class.send :define_method, route do |value|
+        raise ArgumentError if ["", 0].include? value
+        if is_in_routes?("#{@cur_route}/{#{route}}")
+          UWaterlooAPIQuery.new "#{@cur_route}/{#{route}}", "#{@cur_url}/#{value}", api_key
+        else
+          raise NoMethodError
+        end
+      end
+    end
+  end
+
+  # Get meta variables
+  def meta(var)
+    raise NoMethodError unless is_full_route? @cur_route
+    if @meta
+      @meta[var.to_s]
+    else
+      raise "No request has been made yet, so meta data is not available."
+    end
+  end
+
+  # Get data from server
+  def get
+    raise NoMethodError unless is_full_route? @cur_route
+    @retrieved_url = @cur_url
+    response = HTTParty.get("https://api.uwaterloo.ca/v2#{@cur_url}.json", { query: { key: @api_key, format: 'json' } })
+    case response.code
+    when 400...600
+      raise "UWaterloo API Server returned a #{response.code} error"
+    end
+    @response = RecursiveOpenStruct.new response, recurse_over_arrays: true
+    @meta = response['meta']
+    @response.data
+  end
+
+  def method_missing(method, *args, &block)
+    # Get data from API server
+    get unless just_made_request
+
+    if @response.data.respond_to? method
+      @response.data.send method, *args, &block
+    else
+      super
+    end
+  end
+
+  def respond_to?(method, include_private = false)
+    # Get data from API server
+    get unless just_made_request
+
+    if @response.data.respond_to? method
+      true
+    else
+      super
+    end
+  end
+
+  private
+
+  def just_made_request
+    @retrieved_url == @cur_url
+  end
+
+  def is_in_routes?(substring)
+    @@routes.any? { |s| s.start_with?(substring) }
+  end
+
+  def is_full_route?(substring)
+    @@routes.include? substring
+  end
+
+end

data/lib/uwaterlooapi.rb

@@ -0,0 +1,17 @@
+require 'httparty'
+require 'helpers/routes'
+require 'helpers/uwaterlooapi_query'
+
+class UWaterlooAPI
+  VERSION = '0.0.1'
+  include Routes
+
+  def initialize(api_key)
+    @@routes.map { |r| r.split('/')[1] }.uniq.map(&:to_sym).each do |route|
+      self.class.send :define_method, route do
+        UWaterlooAPIQuery.new "/#{route}", "/#{route}", api_key
+      end
+    end
+  end
+
+end

data/spec/responses/courses.json

@@ -0,0 +1 @@
+{"meta":{"requests":104,"timestamp":1414371683,"status":200,"message":"Request successful","method_id":1193,"method":{"disclaimer":"Review the 'No Warranty' section of the University of Waterloo Open Data License before using this data. If building services upon this data, please inform your users of the inherent risks (as a best practice)","license":"https:\/\/uwaterloo.ca\/open-data\/university-waterloo-open-data-license-agreement-v1"}},"data":[{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5682,"section":"LEC 001","campus":"UW U","associated_class":1,"related_component_1":null,"related_component_2":"201","enrollment_capacity":250,"enrollment_total":248,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[{"reserve_group":"Year 1 students ","enrollment_capacity":239,"enrollment_total":241}],"classes":[{"date":{"start_time":"12:30","end_time":"13:50","weekdays":"MW","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"OPT","room":"347"},"instructors":["Vasiga,Troy Michael John"]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5683,"section":"LEC 002","campus":"UW U","associated_class":2,"related_component_1":null,"related_component_2":"201","enrollment_capacity":350,"enrollment_total":344,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[{"reserve_group":"Yr 1 Honours Geomatics ","enrollment_capacity":47,"enrollment_total":37},{"reserve_group":"Year 1 students ","enrollment_capacity":263,"enrollment_total":266}],"classes":[{"date":{"start_time":"14:30","end_time":"15:50","weekdays":"MW","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"RCH","room":"101"},"instructors":["Vasiga,Troy Michael John"]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5684,"section":"LEC 003","campus":"STJ J","associated_class":3,"related_component_1":"112","related_component_2":"202","enrollment_capacity":50,"enrollment_total":56,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[{"reserve_group":"Year 1 students ","enrollment_capacity":50,"enrollment_total":53}],"classes":[{"date":{"start_time":"13:00","end_time":"14:20","weekdays":"TTh","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"STJ","room":"3014"},"instructors":["Case,Lori"]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5685,"section":"LEC 004","campus":"UW U","associated_class":4,"related_component_1":null,"related_component_2":"201","enrollment_capacity":40,"enrollment_total":38,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[{"reserve_group":"2A GBDA students only ","enrollment_capacity":40,"enrollment_total":33}],"classes":[{"date":{"start_time":"09:00","end_time":"11:50","weekdays":"Th","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"ECH","room":"1205"},"instructors":["Harrigan,Kevin"]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5686,"section":"LEC 005","campus":"UW U","associated_class":5,"related_component_1":null,"related_component_2":"201","enrollment_capacity":350,"enrollment_total":336,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[{"reserve_group":"Year 1 students ","enrollment_capacity":246,"enrollment_total":253}],"classes":[{"date":{"start_time":"16:00","end_time":"17:20","weekdays":"TTh","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"AL","room":"116"},"instructors":["Case,Lori"]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5689,"section":"LAB 101","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":85,"enrollment_total":69,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"10:00","end_time":"11:20","weekdays":"W","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5690,"section":"LAB 102","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":85,"enrollment_total":84,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"11:30","end_time":"12:50","weekdays":"W","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5691,"section":"LAB 103","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":85,"enrollment_total":84,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"13:00","end_time":"14:20","weekdays":"W","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5692,"section":"LAB 104","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":85,"enrollment_total":84,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"14:30","end_time":"15:50","weekdays":"W","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5693,"section":"LAB 105","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":85,"enrollment_total":89,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"10:00","end_time":"11:20","weekdays":"Th","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5694,"section":"LAB 106","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":85,"enrollment_total":92,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"11:30","end_time":"12:50","weekdays":"Th","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5695,"section":"LAB 107","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":80,"enrollment_total":87,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"13:00","end_time":"14:20","weekdays":"Th","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5696,"section":"LAB 108","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":80,"enrollment_total":87,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"14:30","end_time":"15:50","weekdays":"Th","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5721,"section":"LAB 109","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":80,"enrollment_total":57,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"08:30","end_time":"09:50","weekdays":"F","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5951,"section":"LAB 110","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":80,"enrollment_total":61,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"10:00","end_time":"11:20","weekdays":"F","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5952,"section":"LAB 111","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":80,"enrollment_total":84,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"11:30","end_time":"12:50","weekdays":"F","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5991,"section":"LAB 112","campus":"STJ U","associated_class":3,"related_component_1":null,"related_component_2":null,"enrollment_capacity":50,"enrollment_total":56,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"13:00","end_time":"14:20","weekdays":"F","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5992,"section":"LAB 113","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":80,"enrollment_total":88,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"14:30","end_time":"15:50","weekdays":"F","start_date":null,"end_date":null,"is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":"MC","room":"3003"},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5717,"section":"TST 201","campus":"UW U","associated_class":99,"related_component_1":"99","related_component_2":null,"enrollment_capacity":990,"enrollment_total":966,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"19:00","end_time":"20:50","weekdays":"M","start_date":"10\/28","end_date":"10\/28","is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":null,"room":null},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"},{"subject":"CS","catalog_number":"115","units":0.5,"title":"Introduction to Computer Science 1","note":"LEC 001 & 002 and 004 to 007 choose LAB section for Related 1. LEC 003 is auto-enrolled.","class_number":5905,"section":"TST 202","campus":"STJ J","associated_class":3,"related_component_1":null,"related_component_2":null,"enrollment_capacity":50,"enrollment_total":56,"waiting_capacity":0,"waiting_total":0,"topic":null,"reserves":[],"classes":[{"date":{"start_time":"19:00","end_time":"20:50","weekdays":"M","start_date":"10\/28","end_date":"10\/28","is_tba":false,"is_cancelled":false,"is_closed":false},"location":{"building":null,"room":null},"instructors":[]}],"held_with":[],"term":1139,"academic_level":"undergraduate","last_updated":"2013-12-23T20:01:31-05:00"}]}

data/spec/responses/timestamp.json

@@ -0,0 +1 @@
+{"meta":{"requests":104,"timestamp":1414369440,"status":200,"message":"Request successful","method_id":1087,"method":{}},"data":{"timestamp":1414369440,"datetime":"2014-10-26T20:24:00-04:00","timezone":"EDT","key_reset_time":1416978000}}

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'rspec'
+require 'webmock/rspec'
+require 'uwaterlooapi'
+
+WebMock.disable_net_connect! allow_localhost: true
+Dir.chdir File.dirname __FILE__
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.before(:each) do
+    stub_request(:get, 'https://api.uwaterloo.ca/v2/server/time.json?format=json&key=testkey').
+      to_return(status: 200, body: File.new('responses/timestamp.json'), headers: { 'Content-Type' => 'application/json; charset=utf-8' })
+    stub_request(:get, 'https://api.uwaterloo.ca/v2/terms/1139/CS/115/schedule.json?format=json&key=testkey').
+      to_return(status: 200, body: File.new('responses/courses.json'), headers: { 'Content-Type' => 'application/json; charset=utf-8' })
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  #config.order = 'random'
+end

data/spec/uwaterlooapi_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+describe UWaterlooAPI do
+  before :each do
+    @api = UWaterlooAPI.new 'testkey'
+  end
+
+  describe '#new' do
+    it 'returns a new UWaterlooAPI object' do
+      expect(@api).to be_an_instance_of(UWaterlooAPI)
+    end
+
+    it 'takes one parameter' do
+      expect{ UWaterlooAPI.new }.to raise_exception ArgumentError
+    end
+
+    it 'returns a UWaterlooAPIQuery object for foodservices' do
+      expect(@api.foodservices).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for courses' do
+      expect(@api.courses).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for events' do
+      expect(@api.events).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for news' do
+      expect(@api.news).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for weather' do
+      expect(@api.weather).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for terms' do
+      expect(@api.terms).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for resources' do
+      expect(@api.resources).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for codes' do
+      expect(@api.codes).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for buildings' do
+      expect(@api.buildings).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for api' do
+      expect(@api.api).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    it 'returns a UWaterlooAPIQuery object for server' do
+      expect(@api.server).to be_an_instance_of UWaterlooAPIQuery
+    end
+
+    context 'queries' do
+      before :each do
+        @time = @api.server.time
+      end
+
+      it 'makes one request' do
+        expect(@time.timestamp).to eq 1414369440
+        expect(@time.datetime).to eq '2014-10-26T20:24:00-04:00'
+        expect(a_request(:get, 'https://api.uwaterloo.ca/v2/server/time.json?format=json&key=testkey')).to have_been_made.once
+      end
+
+      it 'returns a RecursiveOpenStruct after response is parsed' do
+        expect(@time.key_reset_time).to eq 1416978000
+        expect(@time.get).to be_an_instance_of RecursiveOpenStruct
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115).schedule[0]).to be_an_instance_of RecursiveOpenStruct
+      end
+
+      it 'incrementally builds a query' do
+        expect(@api.terms.term(1139)).to be_an_instance_of UWaterlooAPIQuery
+        expect(@api.terms.term(1139).subject('CS')).to be_an_instance_of UWaterlooAPIQuery
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115)).to be_an_instance_of UWaterlooAPIQuery
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115).schedule).to be_an_instance_of UWaterlooAPIQuery
+      end
+
+      it 'makes one request over an iteration' do
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115).schedule.map { |s| s.topic }).to be_an_instance_of Array
+        expect(a_request(:get, 'https://api.uwaterloo.ca/v2/terms/1139/CS/115/schedule.json?format=json&key=testkey')).to have_been_made.once
+      end
+
+      it 'can directly retrieve a deeply nested property' do
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115).schedule[1].classes[0].instructors[0]).to eq 'Vasiga,Troy Michael John'
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115).schedule[5].classes[0].date.end_time).to eq '11:20'
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115).schedule[8].reserves.empty?).to eq true
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115).schedule[14].class_number).to eq 5951
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115).schedule[18].topic.nil?).to eq true
+        expect(@api.terms.term(1139).subject('CS').catalog_number(115).schedule[19].classes[0].date.is_closed).to eq false
+        expect(a_request(:get, 'https://api.uwaterloo.ca/v2/terms/1139/CS/115/schedule.json?format=json&key=testkey')).to have_been_made.times 6
+      end
+
+      it 'makes one request per get call' do
+        expect(@time.get).to be_an_instance_of RecursiveOpenStruct
+        expect(@time.get).to be_an_instance_of RecursiveOpenStruct
+        expect(a_request(:get, 'https://api.uwaterloo.ca/v2/server/time.json?format=json&key=testkey')).to have_been_made.times 2
+      end
+
+      it 'has a working respond_to? method' do
+        expect(@time.respond_to?(:get)).to eq true
+        expect(@time.respond_to?(:timestamp)).to eq true
+        expect(@time.respond_to?(:lolhi)).to eq false
+        expect(a_request(:get, 'https://api.uwaterloo.ca/v2/server/time.json?format=json&key=testkey')).to have_been_made.once
+      end
+
+      it 'has a working method_missing method' do
+        expect{ @time.hellobrah }.to raise_exception NoMethodError
+        expect(@time.timezone).to eq 'EDT'
+        expect(a_request(:get, 'https://api.uwaterloo.ca/v2/server/time.json?format=json&key=testkey')).to have_been_made.once        
+      end
+
+      it 'allows retrieval of metadata' do
+        expect{ @time.meta(:status) }.to raise_exception RuntimeError
+        @time.get
+        expect(@time.meta(:status)).to eq 200
+        expect(@time.meta(:method_id)).to eq 1087
+      end
+
+      it 'can detect invalid method chains' do
+        expect{ @api.terms.get }.to raise_exception NoMethodError
+        expect{ @api.terms.term(1139).meta :status }.to raise_exception NoMethodError
+        expect{ @api.courses.catalog_number(1) }.to raise_exception NoMethodError
+        expect{ @api.foodservices.year(2013).announcements }.to raise_exception NoMethodError
+      end
+    end
+  end
+end

data/uwaterlooapi.gemspec

@@ -0,0 +1,19 @@
+
+Gem::Specification.new do |spec|
+  spec.name        = 'uwaterlooapi'
+  spec.version     = '0.0.2'
+  spec.date        = '2014-10-26'
+  spec.summary     = "Ruby Gem wrapper for the University of Waterloo Open Data API"
+  spec.description = "Ruby Gem wrapper for the University of Waterloo Open Data API"
+  spec.authors     = ["Ankit Sardesai"]
+  spec.email       = 'me@ankitsardesai.ca'
+  spec.files       = `git ls-files`.split("\n")
+  spec.test_files  = `git ls-files spec`.split("\n")
+  spec.homepage    = 'http://rubygems.org/gems/uwaterlooapi'
+  spec.license     = 'MIT'
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'recursive-open-struct'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: uwaterlooapi
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ankit Sardesai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  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'
+- !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: webmock
+  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'
+description: Ruby Gem wrapper for the University of Waterloo Open Data API
+email: me@ankitsardesai.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/helpers/routes.rb
+- lib/helpers/uwaterlooapi_query.rb
+- lib/uwaterlooapi.rb
+- spec/responses/courses.json
+- spec/responses/timestamp.json
+- spec/spec_helper.rb
+- spec/uwaterlooapi_spec.rb
+- uwaterlooapi.gemspec
+homepage: http://rubygems.org/gems/uwaterlooapi
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Gem wrapper for the University of Waterloo Open Data API
+test_files:
+- spec/responses/courses.json
+- spec/responses/timestamp.json
+- spec/spec_helper.rb
+- spec/uwaterlooapi_spec.rb