nusmods 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffd542cab0444df3984936ffcbea04c56a61b223
-  data.tar.gz: 1013a0a5f86fe8e53110825a3b6c4df7654354f1
+  metadata.gz: 646705ac8ac19ea152e6561e8b773146dfc72d47
+  data.tar.gz: a4b77c00d38cb854d8bee3fdd32094d4b99155ea
 SHA512:
-  metadata.gz: 2878d86aca5ee7de9ca47e18ae79c2088eaef9fa00d9cf38b9523690b18e44526dea6a0cd653299faed6fd6b87ed5cb292796b2e8b743916c29c036a19b4ad15
-  data.tar.gz: 3a4b8afe98a740992f7c5925a0a298ca36c0b55f16946419356c06ea5bbe5b15ea5e9a4e1f7e683a4565bb871d60c0ee85fed09106071610d9749ba752daf23c
+  metadata.gz: d9782a618b38ea224086c6f00d2faf6189079d2d53cd7027c7e3fc8d0be5ac661880c2cd63319e3b25eae635260a37133b7844644398c470cfea7158f621a93d
+  data.tar.gz: 7f47afb0189bbff35ffc7f287ee9b6da7ca7d5c823f6671194f532b6638f0aa1a2b505c2d57a91c3ebb9455834aa067719c170bac92c2c7333637eb2700951e2

data/.rspec

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'faraday'
+gem 'faraday_middleware'
+gem 'activesupport'

data/README.md

@@ -0,0 +1,105 @@
+A ruby wrapper for the NUSModsAPI
+---
+
+### Disclaimer 
+
+This gem is not maintained by the creator of NUSMods.
+
+NUSModsAPI repository: https://github.com/ahbeng/NUSModsAPI
+
+---
+
+### Installation
+
+```sh
+gem install nusmods
+```
+
+or add this line into your `Gemfile`
+
+```
+gem 'nusmods'
+```
+
+then, run `bundle install`.
+
+
+### Usage
+
+```rb
+require 'nusmods' # => true
+client = NUSMods::Client.new #  => #<NUSMods::Client:0x007f85928efb10 @base_url="http://api.nusmods.com/">
+```
+
+### Endpoints
+
+All methods are set to retrieve the current AY's records if you do not provide
+any parameters for year or semester.
+
+#### Faculty Departments
+
+Retrieves the list of faculty departments/sub-departments.
+
+```rb
+client.get_faculty_departments(year = 2014, semester = 1)
+```
+
+#### Lesson Types
+
+Retrieves a list of the types of lessons. This API call is not tied to a
+specific AY or semester.
+
+```rb
+client.get_lesson_types
+```
+
+#### Module codes
+
+Retrieves a list of all module codes offered in the semester.
+
+```rb
+client.get_module_codes(year = 2014, semester = 1)
+```
+
+#### Module codes with names
+
+Retrieves a list of all module codes accompanied by their names.
+
+```rb
+client.get_module_codes_with_names(year = 2014, semester = 1)
+```
+
+#### Module details
+
+Retrieves all information about a specific module
+
+```rb
+client.get_module_details("MA1101R", year = 2014, semester = 1)
+```
+
+#### All modules
+
+Retrieves all information about every module. 
+Note: This retrieves a large dataset, so it will take a while. It is highly
+suggested that you download a copy from the API directly and store it locally.
+
+```rb
+client.get_modules(year = 2014, semester = 1)
+```
+
+For more details, see [NUSModsAPI's README.][1]
+
+
+  [1]: https://github.com/ahbeng/NUSModsAPI/blob/master/README.md
+
+
+### Tests:
+
+```sh
+gem install rspec
+rspec spec/nusmods.rb
+```
+
+### License
+
+http://opensource.org/licenses/MIT

data/lib/nusmods.rb

@@ -1,68 +1,16 @@
-require 'json'
-require 'net/http'
+require 'faraday'
+require 'faraday_middleware'
+require 'nusmods/client'
 
-class NUSMods
+directory = File.expand_path(File.dirname(__FILE__))
 
-  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
-      fetch_json(endpoint)
-    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
-      fetch_json(endpoint)
-    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
-      fetch_json(endpoint)
-    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
-      fetch_json(endpoint)
-    rescue
-      raise "The requested resource is not available for the given year or semester."
-    end
-  end
+module NUSMods 
+  class << self
 
-  def get_module_details(year, semester, module_code)
-    endpoint = "http://api.nusmods.com/#{year}-#{year + 1}/#{semester}/modules/#{module_code}.json"
-    begin
-      fetch_json(endpoint)
-    rescue
-      raise "The requested resource is not available for the given year or semester."
+    ## configure default
+    def configure
+      yield self
     end
-  end
 
-  def get_modules(year, semester)
-    endpoint = "http://api.nusmods.com/#{year}-#{year + 1}/#{semester}/modules.json"
-    begin
-      fetch_json(endpoint)
-    rescue
-      raise "The requested resource is not available for the given year or semester."
-    end
   end
-
 end

data/lib/nusmods/client.rb

@@ -0,0 +1,34 @@
+require 'nusmods/endpoints'
+require 'active_support/notifications'
+
+module NUSMods
+  class Client
+
+    include Endpoints
+
+    def initialize(opts = {})
+      @base_url = "http://api.nusmods.com/"
+    end
+
+    private
+
+    def connection
+      Faraday.new(url: @base_url) do |f|
+        f.response :json, :content_type => /\bjson$/
+        f.use :instrumentation
+        f.adapter Faraday.default_adapter
+      end
+    end
+
+    def get(url)
+      response = connection.get url
+      response.body
+    end
+
+    # Converts a provided year to the API requirements
+    def format_year(year)
+      "#{year}-#{year+1}"
+    end
+
+  end
+end

data/lib/nusmods/endpoints.rb

@@ -0,0 +1,36 @@
+module NUSMods
+  module Endpoints
+
+    CURRENT_YEAR = 2014
+    CURRENT_SEMESTER = 1
+
+    # Returns a Array of all module codes in the given year and semester
+    def get_module_codes(year = CURRENT_YEAR, semester = CURRENT_SEMESTER)
+      get "#{format_year(year)}/#{semester}/moduleCodes.json"
+    end
+
+    # Returns a Hash of all module codes as keys, and its respective module name as values.
+    def get_module_codes_with_names(year = CURRENT_YEAR, semester = CURRENT_SEMESTER)
+      get "#{format_year(year)}/#{semester}/moduleList.json"
+    end
+
+    # Returns a Hash of all faculties as keys, and departments under the respective faculties as values.
+    def get_faculty_departments(year = CURRENT_YEAR, semester = CURRENT_SEMESTER)
+      get "#{format_year(year)}/#{semester}/facultyDepartments.json"
+    end
+
+    # Returns the types of lessons (lecture, tutorial, etc) in a Hash 
+    def get_lesson_types
+      get "lessonTypes.json"
+    end
+
+    def get_module_details(module_code, year = CURRENT_YEAR, semester = CURRENT_SEMESTER)
+      get "#{format_year(year)}/#{semester}/modules/#{module_code}.json"
+    end
+
+    def get_modules(year = CURRENT_YEAR, semester = CURRENT_SEMESTER)
+      get "#{format_year(year)}/#{semester}/modules.json"
+    end
+
+  end
+end

data/lib/nusmods/version.rb

@@ -0,0 +1,3 @@
+module NUSMods
+  VERSION = "0.0.3"
+end

data/nusmods.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nusmods/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'nusmods'
+  s.version     = NUSMods::VERSION
+  s.date        = Date.today.to_s
+  s.summary     = "A ruby wrapper interface for NUSModsAPI."
+  s.description = s.summary
+  s.authors     = ["Jingwen Chen"]
+  s.email       = 'jin@crypt.sg'
+  s.files       = ["lib/nusmods.rb"]
+  s.homepage    =
+    'http://rubygems.org/gems/nusmods'
+  s.license       = 'MIT'
+
+  s.files = `git ls-files -z`.split("\x0")
+  s.require_paths = %w( lib )
+  s.add_dependency 'faraday'
+  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'activesupport'
+end

data/spec/nusmods.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe NUSMods do
+
+  before :all do
+    @nm = NUSMods::Client.new
+  end
+
+  describe "#get_module_codes" do
+    it "should return an array if the requested resource exist" do
+      resp = @nm.get_module_codes
+      expect(resp.class).to eq(Array)
+    end
+  end
+
+  describe "#get_module_codes_with_names" do
+    it "should return a Hash if the requested resource exist" do
+      resp = @nm.get_module_codes_with_names
+      expect(resp.class).to eq(Hash)
+    end
+  end
+
+  describe "#get_faculty_departments" do
+    it "should return a Hash if the requested resource exist" do
+      resp = @nm.get_faculty_departments
+      expect(resp.class).to eq(Hash)
+    end
+  end
+
+  describe "#get_lesson_types" do
+    it "should return a Hash if the requested resource exist" do
+      resp = @nm.get_lesson_types
+      expect(resp.class).to eq(Hash)
+    end
+  end
+
+  describe "#get_module_details" do
+    it "should return a Hash if the requested resource exist" do
+      resp = @nm.get_module_details("CS1010")
+      expect(resp.class).to eq(Hash)
+    end
+  end
+
+  # describe "#get_modules" do
+  #   it "should return a Array if the requested resource exist" do
+  #     resp = @nm.get_modules
+  #     expect(resp.class).to eq(Array)
+  #   end
+  # end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# 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.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+
+  # points to the main nusmods.rb
+  require File.expand_path("../../lib/nusmods", __FILE__)
+end

metadata

@@ -1,23 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: nusmods
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 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.
+date: 2014-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  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: activesupport
+  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'
+description: A ruby wrapper interface for NUSModsAPI.
 email: jin@crypt.sg
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .rspec
+- Gemfile
+- README.md
 - lib/nusmods.rb
+- lib/nusmods/client.rb
+- lib/nusmods/endpoints.rb
+- lib/nusmods/version.rb
+- nusmods.gemspec
+- spec/nusmods.rb
+- spec/spec_helper.rb
 homepage: http://rubygems.org/gems/nusmods
 licenses:
 - MIT
@@ -28,18 +78,18 @@ 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
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: A ruby interface for NUSModsAPI.
+summary: A ruby wrapper interface for NUSModsAPI.
 test_files: []