nusmods 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 646705ac8ac19ea152e6561e8b773146dfc72d47
-  data.tar.gz: a4b77c00d38cb854d8bee3fdd32094d4b99155ea
+  metadata.gz: 7ac41ee74ad59262404aaf3f1759626684bddcdd
+  data.tar.gz: 6ca47f3f3f368a8ed672a6888679350eca36712a
 SHA512:
-  metadata.gz: d9782a618b38ea224086c6f00d2faf6189079d2d53cd7027c7e3fc8d0be5ac661880c2cd63319e3b25eae635260a37133b7844644398c470cfea7158f621a93d
-  data.tar.gz: 7f47afb0189bbff35ffc7f287ee9b6da7ca7d5c823f6671194f532b6638f0aa1a2b505c2d57a91c3ebb9455834aa067719c170bac92c2c7333637eb2700951e2
+  metadata.gz: 5e7d05f743eb270e61bbc24e48ee67d07d6982131597713b265c5021faf2d909e315a4c67862ea6126e61655e86457abd4b33b9386897328ef5f5e06f4413b12
+  data.tar.gz: d0179c45e3f8c548a681d80bd0e2fe4517c833f2374ae40b50cf4fd619178f55603635af3549df61eb9f203b27c217a92466058f53cd8601e0864c9752bc0075

data/Gemfile

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

data/README.md

@@ -1,11 +1,11 @@
-A ruby wrapper for the NUSModsAPI
+A ruby wrapper for the NUSModsAPI (v0.0.3)
 ---
 
 ### Disclaimer 
 
 This gem is not maintained by the creator of NUSMods.
 
-NUSModsAPI repository: https://github.com/ahbeng/NUSModsAPI
+NUSModsAPI repository: [https://github.com/nusmodifications/nusmods-api](https://github.com/nusmodifications/nusmods-api)
 
 ---
 
@@ -36,61 +36,79 @@ client = NUSMods::Client.new #  => #<NUSMods::Client:0x007f85928efb10 @base_url=
 All methods are set to retrieve the current AY's records if you do not provide
 any parameters for year or semester.
 
+Every response is either an `Array` or a `Hash` object.
+
+Example:
+```ruby
+client.get_module_details("MA1101R").keys
+ => ["ModuleCode", "ModuleTitle", "Department", "ModuleDescription",
+"ModuleCredit", "Workload", "Prerequisite", "Preclusion", "ExamDate", "Types",
+"Lecturers", "IVLE", "Timetable", "CorsBiddingStats", "LecturePeriods",
+"TutorialPeriods"]
+```
+
 #### Faculty Departments
 
-Retrieves the list of faculty departments/sub-departments.
+Retrieves the list of faculty departments/sub-departments in a `Hash`.
 
-```rb
+```ruby
 client.get_faculty_departments(year = 2014, semester = 1)
+
+# => {"Arts & Social Sciences"=>["Centre For Language Studies", "Chinese Studies", "Communications And New Media", "Dean's Office (Arts & Social Sc.)", ...
 ```
 
 #### Lesson Types
 
-Retrieves a list of the types of lessons. This API call is not tied to a
+Retrieves a list of the types of lessons in a `Hash`. This API call is not tied to a
 specific AY or semester.
 
 ```rb
 client.get_lesson_types
+# => {"DESIGN LECTURE"=>"Tutorial", "LABORATORY"=>"Tutorial", "LECTURE"=>"Lecture" ... 
 ```
 
 #### Module codes
 
-Retrieves a list of all module codes offered in the semester.
+Retrieves a list of all module codes offered in the semester in an `Array`.
 
-```rb
+```ruby
 client.get_module_codes(year = 2014, semester = 1)
+# => ["ACC1002", "ACC1002X", "ACC2002", "ACC3601", "ACC3602", ...
 ```
 
 #### Module codes with names
 
-Retrieves a list of all module codes accompanied by their names.
+Retrieves a list of all module codes accompanied by their names in an `Array`.
 
-```rb
+```ruby
 client.get_module_codes_with_names(year = 2014, semester = 1)
+# => {"ACC1002"=>"Financial Accounting", "ACC1002X"=>"Financial Accounting", "ACC2002"=>"Managerial Accounting" ...
 ```
 
 #### Module details
 
-Retrieves all information about a specific module
+Retrieves all information about a specific module in a `Hash`
 
-```rb
+```ruby
 client.get_module_details("MA1101R", year = 2014, semester = 1)
+# => {"ModuleCode"=>"MA1101R", "ModuleTitle"=>"Linear Algebra I", "Department"=>"Mathematics", ...
 ```
 
 #### All modules
 
-Retrieves all information about every module. 
+Retrieves all information about every module in an `Array`. 
 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
+```ruby
 client.get_modules(year = 2014, semester = 1)
+# => [{ "ModuleCredit" => "4", "ModmavenTree" => { "name" => "ACC1002", "children" => [] }, "LockedModules" => [ "FIN3113", "ACC2002", "IS5116", "FIN2004", ...
 ```
 
-For more details, see [NUSModsAPI's README.][1]
+For exact response examples or more details, see [NUSMods API's README.][1]
 
 
-  [1]: https://github.com/ahbeng/NUSModsAPI/blob/master/README.md
+  [1]: https://github.com/nusmodifications/nusmods-api/blob/master/README.md
 
 
 ### Tests:

data/lib/nusmods.rb

@@ -1,16 +1,3 @@
-require 'faraday'
-require 'faraday_middleware'
 require 'nusmods/client'
 
-directory = File.expand_path(File.dirname(__FILE__))
-
-module NUSMods 
-  class << self
-
-    ## configure default
-    def configure
-      yield self
-    end
-
-  end
-end
+File.expand_path(File.dirname(__FILE__))

data/lib/nusmods/client.rb

@@ -1,5 +1,6 @@
+require 'httparty'
+require 'json'
 require 'nusmods/endpoints'
-require 'active_support/notifications'
 
 module NUSMods
   class Client
@@ -12,17 +13,10 @@ module NUSMods
 
     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
+    attr_accessor :conn
 
     def get(url)
-      response = connection.get url
-      response.body
+      JSON.parse(HTTParty.get(@base_url + url).body)
     end
 
     # Converts a provided year to the API requirements

data/lib/nusmods/endpoints.rb

@@ -2,7 +2,7 @@ module NUSMods
   module Endpoints
 
     CURRENT_YEAR = 2014
-    CURRENT_SEMESTER = 1
+    CURRENT_SEMESTER = 2
 
     # Returns a Array of all module codes in the given year and semester
     def get_module_codes(year = CURRENT_YEAR, semester = CURRENT_SEMESTER)

data/lib/nusmods/version.rb

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

data/nusmods.gemspec

@@ -17,7 +17,5 @@ Gem::Specification.new do |s|
 
   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'
+  s.add_dependency 'httparty'
 end

metadata

@@ -1,55 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: nusmods
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jingwen Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  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: 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.
@@ -58,7 +30,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .rspec
+- ".rspec"
 - Gemfile
 - README.md
 - lib/nusmods.rb
@@ -78,17 +50,17 @@ 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.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper interface for NUSModsAPI.