nusmods 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3fd0eab99bd3b37856079d2fc44138e79abfdf9
+  data.tar.gz: 25a6c2303ad83a51e3a99b4e7e8b9441c8cee063
+SHA512:
+  metadata.gz: 8ac8cdb19d112637bd38694b6f8518c52cb07857d1448f029a8e920f201b68bea3a5af644378e627496eb1d0c82b6cf6e3a2807ecbe8e90d041a32e469140824
+  data.tar.gz: c39cf9cb8372c96e937eef0dce2193d0dacc5bc60f7d768874d2a29a6fdb54c860206a2b5636de3c861977bbdde0327f1a4d1d5116afe5860384273a40acb12b

data/lib/nusmods.rb

@@ -0,0 +1,68 @@
+require 'json'
+require 'net/http'
+
+class NUSMods
+
+  def fetch_json(url)
+    resp = Net::HTTP.get_response(URI.parse(url)) 
+    JSON.parse(resp.body) 
+  end
+
+  # Returns a Array of all module codes in the given year and semester
+  def get_module_codes(year, semester)
+    endpoint = "http://api.nusmods.com/#{year}-#{year + 1}/#{semester}/moduleCodes.json"
+    begin
+      @module_codes = fetch_json(endpoint) if @module_codes.nil?
+    rescue
+      raise "The requested resource is not available for the given year or semester."
+    end
+  end
+
+  # Returns a Hash of all module codes as keys, and its respective module name as values.
+  def get_module_codes_with_names(year, semester)
+    endpoint = "http://api.nusmods.com/#{year}-#{year + 1}/#{semester}/moduleList.json"
+    begin
+      @module_codes_with_names = fetch_json(endpoint) if @module_codes_with_names.nil?
+    rescue
+      raise "The requested resource is not available for the given year or semester."
+    end
+  end
+
+  # Returns a Hash of all faculties as keys, and departments under the respective faculties as values.
+  def get_faculty_departments(year, semester)
+    endpoint = "http://api.nusmods.com/#{year}-#{year + 1}/#{semester}/facultyDepartments.json"
+    begin
+      @faculty_departments = fetch_json(endpoint) if @faculty_departments.nil?
+    rescue
+      raise "The requested resource is not available for the given year or semester."
+    end
+  end
+
+  def get_lesson_types(year, semester)
+    endpoint = "http://api.nusmods.com/#{year}-#{year + 1}/#{semester}/lessonTypes.json"
+    begin
+      @lesson_types = fetch_json(endpoint) if @lesson_types.nil?
+    rescue
+      raise "The requested resource is not available for the given year or semester."
+    end
+  end
+
+  def get_module_details(year, semester, module_code)
+    endpoint = "http://api.nusmods.com/#{year}-#{year + 1}/#{semester}/modules/#{module_code}.json"
+    begin
+      @module_details = fetch_json(endpoint) if @module_details.nil?
+    rescue
+      raise "The requested resource is not available for the given year or semester."
+    end
+  end
+
+  def get_modules(year, semester)
+    endpoint = "http://api.nusmods.com/#{year}-#{year + 1}/#{semester}/modules.json"
+    begin
+      @modules = fetch_json(endpoint) if @modules.nil?
+    rescue
+      raise "The requested resource is not available for the given year or semester."
+    end
+  end
+
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: nusmods
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jingwen Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-16 00:00:00.000000000 Z
+dependencies: []
+description: This rubygem aims to provide an easier way to fetch data from the NUSMods
+  API, especially if you're building ruby apps.
+email: jin@crypt.sg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nusmods.rb
+homepage: http://rubygems.org/gems/nusmods
+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: A ruby interface for NUSModsAPI.
+test_files: []