northwestern-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af41ff1a8ac413a6b8c4157edcafd7f9133927ee
+  data.tar.gz: 976e00fd583c3e4880d91daf9da83c99f5d9a0e6
+SHA512:
+  metadata.gz: 53a0231139df6b5fa8c70bbe6dc794323b1d4c225b5aac5f22499b9fd3e2521b48147be4ea139f3caaa48b011d00603921454ddc859235727190493904b7d977
+  data.tar.gz: c230f691ecd2ad10e210e9855a04ff2992b1a1eaa66d3d8548e43022b2d3d547ea49d5728b349ee45e10132f85506e408005af33cc368143d0888c57071a2049

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Kowalczuk
+
+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,66 @@
+# Northwestern API
+
+A Ruby wrapper for the Northwestern Course data API.
+
+## Installation
+
+Add it to your Gemfile:
+
+    gem 'northwestern-api'
+
+run:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install northwestern-api
+
+## Usage
+
+You'll have to set your client ID somewhere, in some sort of config directory
+should do nicely.  If you're using Rails try the `config` directory and make an
+initializer.
+
+Initialize the Key like so:
+
+```
+require 'northwestern-api'
+
+module Northwestern
+  class Config
+    API_KEY = "###YOUR KEY GOES HERE###"
+  end
+end
+```
+
+Then you can use the API anywhere without making an instance of it. The
+endpoints from the API are all available.  For `courses/details` and
+`rooms/details` just use and underscore.
+
+Pass a list of parameters (not including your API key) as a Ruby hash to the
+method.  The resulting JSON is also parsed into Ruby Arrays and Hashes.
+
+Use like so:
+
+```ruby
+all_terms = Northwestern.terms
+# => [{"id"=>4560, "name"=>"2014 Fall", "start_date"=>"2014-09-23",
+"end_date"=>"2014-12-12"}, ... ]
+
+fall2014 = all_terms[0]["id"]
+
+fall_eecs_courses = Northwestern.courses({ term: fall2014, subject: "EECS" })
+# => [{"id"=>109680, "title"=>"An Introduction to Computer Science for
+Everyone", "term"=>"2014 Fall", "instructor"=>"Haoqi Zhang", "subject"=>"EECS",
+"catalog_num"=>"101-0", "section"=>"20", "room"=>"Annenberg Hall G15",
+"meeting_days"=>"MoWe", "start_time"=>"15:00", "end_time"=>"15:50",
+"seats"=>110, "topic"=>nil, "component"=>"LEC", "class_num"=>14597,
+"course_id"=>8093}, ... ]
+```
+
+## Issues
+
+If you find an issue, please put up a Github Issue request.  If you have an idea
+you think make the gem better or easier to use, feel free to run that by me too.
+Run now it's a very thin wrapper around those functions.

data/Rakefile

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

data/lib/northwestern.rb

@@ -0,0 +1,58 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Northwestern
+  BASE_URL = 'https://api.asg.northwestern.edu/'
+  class << self
+    def terms(params={})
+      self.get('/terms', {})
+    end
+
+    def schools(params={})
+      self.get('/schools', {})
+    end
+
+    def terms(params={})
+      self.get('/terms', {})
+    end
+
+    def subjects(params={})
+      self.get('/subjects', params)
+    end
+
+    def courses(params={})
+      self.get('/courses', params)
+    end
+
+    def course_details(params={})
+      self.get('/courses/details', params)
+    end
+
+    def instructors(params={})
+      self.get('/instructors', params)
+    end
+
+    def rooms(params={})
+      self.get('/rooms', params)
+    end
+
+    def room_details(params={})
+      self.get('/rooms/details', params)
+    end
+
+    def get(path, params)
+      if defined? Northwestern::Config::API_KEY
+        uri = URI(BASE_URL)
+        uri.path = path
+        uri.query = URI.encode_www_form(params.merge(
+          { key: Northwestern::Config::API_KEY }
+        ))
+
+        JSON.parse(Net::HTTP.get(uri))
+      else
+        "Please set your API key (see readme)"
+      end
+    end
+  end
+end

data/lib/northwestern/version.rb

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

data/northwestern-api.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'northwestern/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "northwestern-api"
+  spec.version       = Northwestern::VERSION
+  spec.authors       = ["Alex Kowalczuk"]
+  spec.email         = ["alexskowalczuk@gmail.com"]
+  spec.summary       = %q{A Ruby wrapper for the ASG Northwestern Course data API}
+  spec.homepage      = %q{https://github.com/northwesternapis/ruby-client}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: northwestern-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Kowalczuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 
+email:
+- alexskowalczuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/northwestern.rb
+- lib/northwestern/version.rb
+- northwestern-api.gemspec
+homepage: ''
+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.3.0
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the ASG Northwestern Course data API
+test_files: []