uwapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bd35dfe9fbd704be9fab9dc0565b28813a82219
+  data.tar.gz: fed1379bab2ca9e8a954fa6d30322a14b09b70e2
+SHA512:
+  metadata.gz: e3a3f12154c4f16cca043bca84f4d19a77555c8e42cbfa18c6b0245a91844f164a2020d10af9dbd0e158a684efa6128aa5b7661ce08aa116817e8bf24089135f
+  data.tar.gz: 532150f994548346829ed78b8fe3a14884f66293546884ee83549d8c5bf9e639e3179b79ae67da848294a111b4d09a756999f1e98d68a9e3ff4db1b6fdd034a9

data/.gitignore

@@ -0,0 +1,19 @@
+*.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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bill Li
+
+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,38 @@
+# UWAPI
+
+This gem is a wrapper for University of Waterloo's Open Data API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'uwapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uwapi
+
+## Usage
+
+1. Go to http://api.uwaterloo.ca/ and register for an API key.
+2. Use the gem.
+3. ???
+4. Profit.
+
+```ruby
+api = UWAPI.new(:api_key => 'foo')
+weather = api.Weather
+buildings = api.Buildings
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/uwapi.rb

@@ -0,0 +1,79 @@
+require 'rubygems'
+require 'httparty'
+require 'json'
+
+require 'uwapi/version'
+require 'uwapi/service/course'
+require 'uwapi/service/event'
+require 'uwapi/service/exam_info'
+require 'uwapi/service/experimental'
+require 'uwapi/service/faculty_info'
+require 'uwapi/service/food_services'
+require 'uwapi/service/geolocation'
+require 'uwapi/service/other'
+require 'uwapi/service/professor'
+require 'uwapi/service/schedule'
+require 'uwapi/service/weather'
+require 'uwapi/service/wireless_data'
+
+module UWAPI
+  class Result
+    def initialize(args)
+      if args.is_a?(Hash) && args.has_key?('response')
+        @result = args
+      else
+        raise ArgumentError, 'args is not a UWAPI returned result'
+      end
+    end
+
+    def result
+      @result ||= {}
+      @result
+    end
+
+    def meta
+      @result['response']['meta']
+    end
+
+    def success?
+      Integer.new(@result['response']['meta']['Status']) == 200
+    end
+
+    def failure?
+      !success?
+    end
+  end
+
+  class API
+    include Course, Event, ExamInfo, Experimental, FacultyInfo, FoodServices, Geolocation
+    include Other, Professor, Schedule, Weather, WirelessData
+
+    def initialize(args)
+      if args.include?(:api_key)
+        @api_key = args[:api_key]
+      else
+        raise ArgumentError, ':api_key is required. See http://api.uwaterloo.ca/'
+      end
+      @api_format = args[:api_format] if args.include?(:api_format)
+      raise ArgumentError, ':api_format must be one of [json, xml]' unless ['json', 'xml'].include?(api_format)
+    end
+
+    def api_format
+      @api_format ||= 'json'
+    end
+
+    def api_url
+      'http://api.uwaterloo.ca/public/v1/'
+    end
+
+    def api_key
+      @api_key
+    end
+
+    private
+    def get(opt)
+      request = HTTParty.get(api_url, :query => {:key => api_key, :output => api_format}.merge(opt))
+      UWAPI::Result.new(request)
+    end
+  end
+end

data/lib/uwapi/service/abstraction.rb

@@ -0,0 +1,35 @@
+module Abstraction
+  module ClassMethods
+    def call_with_q(methods)
+      return unless methods.is_a?(Array)
+      methods.each do |m|
+        define_method(m) do |args|
+          opt = {:service => __method__}
+          if args.include?(:q)
+            opt[:q] = args[:q]
+          else
+            raise ArgumentError, ':q is required'
+          end
+
+          opt[:term] = args[:term] if args.include?(:term)
+          get(opt)
+        end
+      end
+    end
+
+    def call_without_q(methods)
+      return unless methods.is_a?(Array)
+      methods.each do |m|
+        define_method(m) do
+          opt = {:service => __method__}
+          get(opt)
+        end
+      end
+    end
+  end
+  extend ClassMethods
+
+  def self.included(other)
+    other.extend(ClassMethods)
+  end
+end

data/lib/uwapi/service/academic_programs.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module AcademicPrograms
+  include Abstraction
+  call_without_q(['ProgramsList'])
+end

data/lib/uwapi/service/course.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module Course
+  include Abstraction
+  call_with_q(['CourseSearch', 'CourseInfo', 'Prerequisites', 'CourseFromRoom'])
+end

data/lib/uwapi/service/event.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module Event
+  include Abstraction
+  call_without_q(['Events', 'CalendarEvents', 'Holidays'])
+end

data/lib/uwapi/service/exam_info.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module ExamInfo
+  include Abstraction
+  call_without_q(['ExamSchedule'])
+end

data/lib/uwapi/service/experimental.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module Experimental
+  include Abstraction
+  call_with_q(['DirectorySearch'])
+end

data/lib/uwapi/service/faculty_info.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module FacultyInfo
+  include Abstraction
+  call_without_q(['FacultiesList', 'DepartmentsList', 'TermsList'])
+end

data/lib/uwapi/service/food_services.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module FoodServices
+  include Abstraction
+  call_without_q(['FoodServices', 'FoodMenu', 'VendingMachines', 'WatcardVendors'])
+end

data/lib/uwapi/service/geolocation.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module Geolocation
+  include Abstraction
+  call_without_q(['Buildings', 'ParkingList', 'BuildingCoordinates', 'WatPark'])
+end

data/lib/uwapi/service/other.rb

@@ -0,0 +1,4 @@
+require_relative 'abstraction'
+module Other
+  include Abstraction
+end

data/lib/uwapi/service/professor.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module Professor
+  include Abstraction
+  call_with_q(['ProfessorSearch'])
+end

data/lib/uwapi/service/publications.rb

@@ -0,0 +1,6 @@
+require_relative 'abstraction'
+module Publications
+  include Abstraction
+  call_without_q(['RecentDissertations'])
+  call_with_q(['DissertationDetails'])
+end

data/lib/uwapi/service/schedule.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module Schedule
+  include Abstraction
+  call_with_q(['Schedule'])
+end

data/lib/uwapi/service/weather.rb

@@ -0,0 +1,5 @@
+require_relative 'abstraction'
+module Weather
+  include Abstraction
+  call_without_q(['Weather'])
+end

data/lib/uwapi/service/wireless_data.rb

@@ -0,0 +1,6 @@
+require_relative 'abstraction'
+module WirelessData
+  include Abstraction
+  call_without_q(['APLocations'])
+  call_with_q(['APInfo'])
+end

data/lib/uwapi/version.rb

@@ -0,0 +1,3 @@
+module Uwapi
+  VERSION = "0.0.1"
+end

data/uwapi.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uwapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'uwapi'
+  spec.version       = Uwapi::VERSION
+  spec.authors       = ['Bill Li']
+  spec.email         = ['me@billxinli.com']
+  spec.description   = %q{University of Waterloo OpenData API Ruby Implementation}
+  spec.summary       = %q{University of Waterloo OpenData API Ruby Implementation}
+  spec.homepage      = 'https://github.com/billxinli/uwapi'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.add_dependency('httparty')
+  spec.add_dependency('json')
+  spec.add_development_dependency('bundler', '~> 1.3')
+  spec.add_development_dependency('rake')
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: uwapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bill Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-18 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: json
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: University of Waterloo OpenData API Ruby Implementation
+email:
+- me@billxinli.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uwapi.rb
+- lib/uwapi/service/abstraction.rb
+- lib/uwapi/service/academic_programs.rb
+- lib/uwapi/service/course.rb
+- lib/uwapi/service/event.rb
+- lib/uwapi/service/exam_info.rb
+- lib/uwapi/service/experimental.rb
+- lib/uwapi/service/faculty_info.rb
+- lib/uwapi/service/food_services.rb
+- lib/uwapi/service/geolocation.rb
+- lib/uwapi/service/other.rb
+- lib/uwapi/service/professor.rb
+- lib/uwapi/service/publications.rb
+- lib/uwapi/service/schedule.rb
+- lib/uwapi/service/weather.rb
+- lib/uwapi/service/wireless_data.rb
+- lib/uwapi/version.rb
+- uwapi.gemspec
+homepage: https://github.com/billxinli/uwapi
+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.0.2
+signing_key: 
+specification_version: 4
+summary: University of Waterloo OpenData API Ruby Implementation
+test_files: []