explorecourses 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7d56d24bea09a0b5ada6fbd5ffafbc100308a0f
-  data.tar.gz: a777da99099db311f7d972a714afba71795cfe6b
+  metadata.gz: c224e6b907a6b894da50ac2e36c92b2ff4640f93
+  data.tar.gz: 749be8eb5a1c35dc381a26a48ff0aa20eae04b67
 SHA512:
-  metadata.gz: c90b7878b4e73e5ca9b7f168ae5549ce68f85bc5b6d5fdbea00672c62f879952c8d60236ce2791c9d187ec30cb38e886e8e9857ba8cf2874b686745b34d4c644
-  data.tar.gz: 8337dc8febba926aa9e10edaf721661c1bf2e5acbb86e4c0fa074250d64446aac3d9beef11ed9ca64f807c0ff65f13072f05a4ef8d37813106dcbb2a679b1833
+  metadata.gz: 412639c4c7166f257437b7a2f4348b55dbe03fc422c2e16a4e1931ddbb142dc3878a039b68cc02ec5fd070f365a103e58b5df1d1728f7d1e04f20e7fe756e052
+  data.tar.gz: 5a46fba6bc7059f8a5ecde84648c0f565bbeacd5049676813f3c0d7a7b0afdfc9d4de02d551a8b237682d38eeb3c058840fb1d9b03d6f3ccf7325a576255ac0f

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,59 @@
+### ExploreCourses for Ruby
+
+##### Installation
+
+Assuming that you have RubyGems, either run
+
+	gem install explorecourses
+	
+to install for your system or add the following to your Gemfile
+
+	gem 'explorecourses'
+	
+then run
+	
+	bundle install
+	
+##### Usage
+
+Until I add documentation annotations to the source code, I recommend reading the source directly to find out what properties can be accessed.
+
+	require 'explorecourses'
+	
+	# Search for all the courses
+	courses = ExploreCourses.query_courses("CS 140")
+	
+	# Get the title of the course
+	courses[0].title
+	=> "Operating Systems and Systems Programming"
+	
+	# Get the number of sections for the course
+	courses[0].sections.length
+	=> 3
+
+##### Checklist
+
+* Add RDoc style documentation to all source code
+* Add tests
+
+##### License
+
+Copyright (c) 2014 Roger Chen
+
+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/explorecourses.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+    s.name          = 'explorecourses'
+    s.version       = '0.1'
+    s.date          = '2014-09-26'
+    s.summary       = 'Ruby wrapper for ExploreCourses API'
+    s.description   = 'Allow Ruby programs to easily access the ExploreCourses API'
+    s.authors       = ['Roger Chen']
+    s.email         = 'rogerthechen@gmail.com'
+    s.homepage      = 'https://rogr.me/projects/explorecourses-gem'
+    s.license       = 'MIT'
+
+    s.files        = `git ls-files`.split("\n")
+    s.require_path = 'lib'
+
+    s.add_dependency "nokogiri", "~> 1.6"
+    s.add_dependency "typhoeus", "~> 0.6"
+end

data/lib/explorecourses.rb

@@ -0,0 +1,5 @@
+require 'explorecourses/course'
+require 'explorecourses/section'
+require 'explorecourses/schedule'
+require 'explorecourses/instructor'
+require 'explorecourses/base'

data/lib/explorecourses/base.rb

@@ -0,0 +1,111 @@
+require 'nokogiri'
+require 'typhoeus'
+
+module ExploreCourses
+
+    URL_BASE_SEARCH = "http://explorecourses.stanford.edu/search?"
+    XML_VERSION = "xml-20140630"
+
+    def self.check_xml_version
+        request = Typhoeus::Request.new(URL_BASE_SEARCH, params: { view: XML_VERSION })
+        request.run
+        response = request.response
+        if response
+            doc = Nokogiri::XML(response.body)
+            return { deprecated: doc.at_xpath("//deprecated").content,
+                    latest_version: doc.at_xpath("//latestVersion").content}
+        end
+    end
+
+    def self.query_courses(query)
+        params = {
+            view: XML_VERSION,
+            q: query
+        }
+        request = Typhoeus::Request.new(URL_BASE_SEARCH, params: params)
+        request.run
+        response = request.response
+        if response
+            doc = Nokogiri::XML(response.body)
+            # use XPath to navigate the XML body
+            courses_xml = doc.xpath(".//course")
+            courses = []
+            courses_xml.each do |course_xml|
+                year = course_xml.at_xpath(".//year").content
+                subject = course_xml.at_xpath(".//subject").content
+                code = course_xml.at_xpath(".//code").content
+                title = course_xml.at_xpath(".//title").content
+                description = course_xml.at_xpath(".//description").content
+                gers = course_xml.at_xpath(".//gers").content
+                repeatable = course_xml.at_xpath(".//repeatable").content
+                grading = course_xml.at_xpath(".//grading").content
+                units_min = course_xml.at_xpath(".//unitsMin").content
+                units_max = course_xml.at_xpath(".//unitsMax").content
+                sections = retrieve_sections(course_xml.xpath(".//section"))
+                courses << Course.new(year, subject, code, title, description, gers, repeatable,
+                        grading, units_min, units_max, sections)
+            end
+            return courses
+        end
+    end
+
+    private
+
+    def self.retrieve_sections(sections_xml)
+        sections = []
+        sections_xml.each do |section_xml|
+            class_id = section_xml.at_xpath(".//classId").content
+            term = section_xml.at_xpath(".//term").content
+            term_id = section_xml.at_xpath(".//termId").content
+            subject = section_xml.at_xpath(".//subject").content
+            code = section_xml.at_xpath(".//code").content
+            units = section_xml.at_xpath(".//units").content
+            section_number = section_xml.at_xpath(".//sectionNumber").content
+            component = section_xml.at_xpath(".//component").content
+            num_enrolled = section_xml.at_xpath(".//numEnrolled").content
+            max_enrolled = section_xml.at_xpath(".//maxEnrolled").content
+            num_waitlist = section_xml.at_xpath(".//numWaitlist").content
+            max_waitlist = section_xml.at_xpath(".//maxWaitlist").content
+            enroll_status = section_xml.at_xpath(".//enrollStatus").content
+            add_consent = section_xml.at_xpath(".//addConsent").content
+            drop_consent = section_xml.at_xpath(".//dropConsent").content
+            course_id = section_xml.at_xpath(".//courseId").content
+            schedules = retrieve_schedules(section_xml.xpath(".//schedule"))
+            sections << Section.new(class_id, term, term_id, subject, code, units, section_number, component, 
+                    num_enrolled, max_enrolled, num_waitlist, max_waitlist, enroll_status, add_consent, 
+                    drop_consent, course_id, schedules)
+        end
+        return sections
+    end
+
+    def self.retrieve_schedules(schedules_xml)
+        schedules = []
+        schedules_xml.each do |schedule_xml|
+            start_date = schedule_xml.at_xpath(".//startDate").content
+            end_date = schedule_xml.at_xpath(".//endDate").content
+            start_time = schedule_xml.at_xpath(".//startTime").content
+            end_time = schedule_xml.at_xpath(".//endTime").content
+            location = schedule_xml.at_xpath(".//location").content
+            # Cleaning up after whoever put all the \t and \n in the string...
+            days = schedule_xml.at_xpath("./days").content.gsub(/[\t\n]/, ' ').split.join(',')
+            instructors = retrieve_instructors(schedule_xml.xpath(".//instructor"))
+            schedules << Schedule.new(start_date, end_date, start_time, end_time, location, days, instructors)
+        end
+        return schedules
+    end
+
+    def self.retrieve_instructors(instructors_xml)
+        instructors = []
+        instructors_xml.each do |instructor_xml|
+            name = instructor_xml.at_xpath(".//name").content
+            first_name = instructor_xml.at_xpath(".//firstName").content
+            middle_name = instructor_xml.at_xpath(".//middleName").content
+            last_name = instructor_xml.at_xpath(".//lastName").content
+            sunet = instructor_xml.at_xpath(".//sunet").content
+            role = instructor_xml.at_xpath(".//role").content
+            instructors << Instructor.new(name, first_name, middle_name, last_name, sunet, role)
+        end
+        return instructors
+    end
+
+end

data/lib/explorecourses/course.rb

@@ -0,0 +1,25 @@
+module ExploreCourses
+
+    class Course
+        
+        def initialize(year, subject, code, title, description, gers, repeatable, grading, units_min, 
+                units_max, sections)
+            @year = year
+            @subject = subject
+            @code = code
+            @title = title
+            @description = description
+            @gers = gers
+            @repeatable = repeatable
+            @grading = grading
+            @units_min = units_min
+            @units_max = units_max
+            @sections = sections
+        end
+
+        attr_reader :year, :subject, :code, :title, :description, :gers, :repeatable, :grading, :units_min, 
+                :units_max, :sections
+
+    end
+
+end

data/lib/explorecourses/instructor.rb

@@ -0,0 +1,18 @@
+module ExploreCourses
+   
+    class Instructor
+
+        def initialize(name, first_name, middle_name, last_name, sunet, role)
+            @name = name
+            @first_name = first_name
+            @middle_name = middle_name
+            @last_name = last_name
+            @sunet = sunet
+            @role = role
+        end
+
+        attr_reader :name, :first_name, :middle_name, :last_name, :sunet, :role
+
+    end
+
+end

data/lib/explorecourses/schedule.rb

@@ -0,0 +1,19 @@
+module ExploreCourses
+
+    class Schedule
+
+        def initialize(start_date, end_date, start_time, end_time, location, days, instructors)
+            @start_date = start_date
+            @end_date = end_date
+            @start_time = start_time
+            @end_time = end_time
+            @location = location
+            @days = days
+            @instructors = instructors
+        end
+
+        attr_reader :start_date, :end_date, :start_time, :end_time, :location, :days, :instructors
+
+    end
+
+end

data/lib/explorecourses/section.rb

@@ -0,0 +1,32 @@
+module ExploreCourses
+
+    class Section
+
+        def initialize(class_id, term, term_id, subject, code, units, section_number, component, num_enrolled, 
+            max_enrolled, num_waitlist, max_waitlist, enroll_status, add_consent, drop_consent, course_id, schedules)
+            @class_id = class_id
+            @term = term
+            @term_id = term_id
+            @subject = subject
+            @code = code
+            @units = units
+            @section_number = section_number
+            @component = component
+            @num_enrolled = num_enrolled
+            @max_enrolled = max_enrolled
+            @num_waitlist = num_waitlist
+            @max_waitlist = max_waitlist
+            @enroll_status = enroll_status
+            @add_consent = add_consent
+            @drop_consent = drop_consent
+            @course_id = course_id
+            @schedules = schedules
+        end
+
+        attr_reader :class_id, :term, :term_id, :subject, :code, :units, :section_number, :component, 
+                :num_enrolled, :max_enrolled, :num_waitlist, :max_waitlist, :enroll_status, :add_consent,
+                :drop_consent, :course_id, :schedules
+
+    end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: explorecourses
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Roger Chen
@@ -9,13 +9,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-09-26 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: Allow Ruby programs to easily access the ExploreCourses API
 email: rogerthechen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- README.md
+- explorecourses.gemspec
+- lib/explorecourses.rb
+- lib/explorecourses/base.rb
+- lib/explorecourses/course.rb
+- lib/explorecourses/instructor.rb
+- lib/explorecourses/schedule.rb
+- lib/explorecourses/section.rb
 homepage: https://rogr.me/projects/explorecourses-gem
 licenses:
 - MIT