pcr-ruby 0.2 → 0.2.1

data/.gitignore

@@ -17,4 +17,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-instructors.txt
+instructors.txt
+examples.rb

data/README.md

@@ -2,13 +2,20 @@
 
 pcr-ruby is a simple, intuitive way to retrieve course data from the Penn Course Review API in Ruby.  With pcr-ruby and a valid API token (which you can request [here](https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dGZOZkJDaVkxdmc5QURUejAteFdBZGc6MQ#gid=0)), your Ruby project has access to reviews, ratings, and other information for all Penn courses.
 
+## Installation ##
+
+pcr-ruby is a gem hosted on rubygems, so installation is as simple as:
+```
+gem install pcr-ruby
+```
+
 ## How to use pcr-ruby #
 
 *This section may change a lot as pcr-ruby is developed.  As such, this section may not be fully accurate, but I will try to keep the instructions as current as possible.*
 
 pcr-ruby follows the structure of the PCR API, with a few name changes to make object identities and roles clearer in your code.  (Before using pcr-ruby, you should most definitely read the PCR API documentation, the link to which you should recieve upon being granted your API token.)
 
-The PCR API essentially consists of four types of objects: 'Courses', 'Sections', 'Instructors', and 'Course Histories'.  pcr-ruby aims to provide intuitive access to the data contained in these four object types while abstracting you and your user from background processing and unnecessary data.  To that end, pcr-ruby (thus far) consists of two types of objects: 'Courses', 'Sections', and 'Instructors'.
+The PCR API essentially consists of four types of objects: 'Courses', 'Sections', 'Instructors', and 'Course Histories'.  pcr-ruby aims to provide intuitive access to the data contained in these four object types while abstracting you and your user from background processing and unnecessary data.  To that end, pcr-ruby (thus far) consists of three types of objects: 'Courses', 'Sections', and 'Instructors'.
 
 ### 'Courses' in pcr-ruby ###
 
@@ -44,7 +51,6 @@ require 'pcr-ruby'
 pcr = PCR.new(api_token)
 section = pcr.section(id)
 ```
-Possible instance variables available for setting in the Section initialize method are: aliases, id, name, path, semester.
 
 Sections have the following instance variables:
 *	**aliases** -- an array of the Section's course listings.  Most of the time, a Section will only have one listing (the course code followed by a section code, like "-001"), but Sections that are cross-listed between departments may have multiple listings.
@@ -88,7 +94,7 @@ Here are some (hopefully very simple and intuitive) usage examples for pcr-ruby:
 Let's say we want to find the average course quality rating for Introduction to International Relations, PSCI-150:
 
 ```ruby
-require 'pcr.rb'
+require 'pcr-ruby'
 course_code = "PSCI-150"
 pcr = PCR.new(API_TOKEN)
 course = pcr.course(course_code)
@@ -98,9 +104,9 @@ puts course.average("rCourseQuality") #=> 3.041
 Or, even more briefly:
 
 ```ruby
-require 'pcr.rb'
+require 'pcr-ruby'
 pcr = PCR.new(API_TOKEN)
-puts pcr.course("PSCI-150")course.average("rCourseQuality")
+puts pcr.course("PSCI-150").average("rCourseQuality")
 #=> 3.041
 ```
 
@@ -108,7 +114,7 @@ puts pcr.course("PSCI-150")course.average("rCourseQuality")
 Finding the most recent section's course difficulty rating is just as easy:
 
 ```ruby
-require 'pcr.rb'
+require 'pcr-ruby'
 pcr = PCR.new(API_TOKEN)
 course = pcr.course("PSCI-150")
 puts course.recent("rDifficulty") #=> 2.5
@@ -116,7 +122,7 @@ puts course.recent("rDifficulty") #=> 2.5
 
 ### Get professor's average "ability to stimulate student interest" rating ###
 ```ruby
-require 'pcr.rb'
+require 'pcr-ruby'
 pcr = PCR.new(API_TOKEN)
 instructor = pcr.instructor("1090-LINDA-H-ZHAO")
 puts instructor.average("rStimulateInterest").round(2) #=> 1.7

data/lib/classes/course.rb

@@ -1,32 +1,28 @@
-#Course object matches up with the coursehistory request of the pcr api.
-#A Course essentially is a signle curriculum and course code, and includes all Sections across time (semesters).
 class Course < PCR
   attr_accessor :course_code, :sections, :id, :name, :path, :reviews
   
   def initialize(course_code)
-    if course_code.is_a? String and course_code.isValidCourseCode?
+    if course_code.is_a? String && course_code.isValidCourseCode?
       @course_code = course_code
       
       #Read JSON from the PCR API
       api_url = @@api_endpt + "coursehistories/" + self.course_code + "/?token=" + @@token
       json = JSON.parse(open(api_url).read)
       
-      #Create array of Section objects, containing all Sections found in the API JSON for the Course
+      #Create array of Section objects
       @sections = []
-      json["result"]["courses"].each do |c|
-        @sections << Section.new(c["id"])
-      end
+      json["result"]["courses"].each { |c| @sections << Section.new(c["id"]) }
       
       #Set variables according to Course JSON data
       @id = json["result"]["id"]
       @name = json["result"]["name"]
       @path = json["result"]["path"]
       
-      #Get reviews for the Course -- unfortunately this has to be a separate query
-      api_url_reviews = @@api_endpt + "coursehistories/" + self.id.to_s + "/reviews?token=" + @@token
+      #Get reviews for the Course -- this has to be a separate query
+      api_url_reviews = @@api_endpt + "coursehistories/" + 
+                        self.id.to_s + "/reviews?token=" + @@token
       json_reviews = JSON.parse(open(api_url_reviews).read)
       @reviews = json_reviews["result"]["values"]
-
     else
       raise CourseError, "Invalid course code specified.  Use format [DEPT-###]."
     end
@@ -34,19 +30,16 @@ class Course < PCR
   
   def average(metric)
     #Ensure that we know argument type
-    if metric.is_a? Symbol
-      metric = metric.to_s
-    end
-    
+    metric = metric.to_s if metric.is_a? Symbol
+
     if metric.is_a? String
       #Loop vars
-      total = 0
-      n = 0
+      total, n = 0, 0
       
-      #For each section, check if ratings include metric arg -- if so, add metric rating to total and increment counting variable
+      #For each section, check if ratings include metric arg
+      #if so, add metric rating to total && increment counting variable
       self.reviews.each do |review|
-        ratings = review["ratings"]
-        if ratings.include? metric
+        if review["ratings"].include? metric
           total = total + review["ratings"][metric].to_f
           n = n + 1
         else
@@ -55,8 +48,7 @@ class Course < PCR
       end
       
       #Return average score as a float
-      (total/n)
-      
+      (total / n)
     else
       raise CourseError, "Invalid metric format. Metric must be a string or symbol."
     end
@@ -64,24 +56,22 @@ class Course < PCR
   
   def recent(metric)
     #Ensure that we know argument type
-    if metric.is_a? Symbol
-      metric = metric.to_s
-    end
-    
+    metric = metric.to_s if metric.is_a? Symbol
     
     if metric.is_a? String
       #Get the most recent section
       section = self.sections[-1]
       
-      #Iterate through all the section reviews, and if the section review id matches the id of the most recent section, return that rating
+      #Iterate through all the section reviews, and if the section review id matches
+      #the id of the most recent section, return that rating
       self.reviews.each do |review|
         if review["section"]["id"].to_s[0..4].to_i == section.id
           return review["ratings"][metric]
         end
       end
       
+      #Else, metric hasn't been found
       raise CourseError, "No ratings found for #{metric} in #{section.semester}."
-      
     else
       raise CourseError, "Invalid metric format. Metric must be a string or symbol."
     end

data/lib/classes/instructor.rb

@@ -3,7 +3,7 @@ class Instructor < PCR
   attr_accessor :id, :name, :path, :sections, :reviews
   
   def initialize(id)    
-    #Assign args. ID is necessary because that's how we look up Instructors in the PCR API.
+    #Assign args
     if id.is_a? String
       @id = id
     else
@@ -13,47 +13,38 @@ class Instructor < PCR
     #Hit PCR API to get missing info based on id
     self.getInfo
     self.getReviews
-
   end
   
   #Hit the PCR API to get all missing info
-  #Separate method in case we want to conduct it separately from a class init
   def getInfo
     api_url = @@api_endpt + "instructors/" + self.id + "?token=" + @@token
     json = JSON.parse(open(api_url).read)
-    
     @name = json["result"]["name"].downcase.titlecase unless @name
     @path = json["result"]["path"] unless @path
     @sections = json["result"]["reviews"]["values"] unless @sections #Mislabeled reviews in PCR API
   end
   
-  #Separate method for getting review data in case we don't want to make an extra API hit each init
+  #Separate method for getting review data
   def getReviews
-    if not self.reviews #make sure we don't already have reviews
-      api_url = @@api_endpt + "instructors/" + self.id + "/reviews?token=" + @@token
-      json = JSON.parse(open(api_url).read)
-      
-      @reviews = json["result"]["values"] #gets array
-    end
+    api_url = @@api_endpt + "instructors/" + self.id + "/reviews?token=" + @@token
+    json = JSON.parse(open(api_url).read)
+    @reviews = json["result"]["values"] #array
   end
   
   #Get average value of a certain rating for Instructor
   def average(metric)
     #Ensure that we know argument type
-    if metric.is_a? Symbol
-      metric = metric.to_s
-    end
+    metric = metric.to_s if metric.is_a? Symbol
     
     if metric.is_a? String
       #Loop vars
-      total = 0
-      n = 0
+      total, n = 0, 0
       
-      #For each section, check if ratings include metric arg -- if so, add metric rating to total and increment counting variable
+      #For each section, check if ratings include metric arg
+      #if so, add metric rating to total and increment counting variable
       self.getReviews
       self.reviews.each do |review|
-        ratings = review["ratings"]
-        if ratings.include? metric
+        if review["ratings"].include? metric
           total = total + review["ratings"][metric].to_f
           n = n + 1
         else
@@ -62,8 +53,7 @@ class Instructor < PCR
       end
       
       #Return average score as a float
-      (total/n)
-      
+      (total / n)
     else
       raise CourseError, "Invalid metric format. Metric must be a string or symbol."
     end
@@ -72,9 +62,7 @@ class Instructor < PCR
   #Get most recent value of a certain rating for Instructor
   def recent(metric)
     #Ensure that we know argument type
-    if metric.is_a? Symbol
-      metric = metric.to_s
-    end
+    metric = metric.to_s if metric.is_a? Symbol
     
     if metric.is_a? String
       #Iterate through reviews and create Section for each section reviewed, presented in an array
@@ -93,10 +81,10 @@ class Instructor < PCR
       sections.reverse! #Newest first
       targets = []
       sections.each do |s|
-        s.hit_api(:get_reviews => true)
+        s.hit_api
         if sections.index(s) == 0
           targets << s
-        elsif s.semester == sections[0].semester and s.id != sections[0].id
+        elsif s.semester == sections[0].semester && s.id != sections[0].id
           targets << s
         else
           break
@@ -104,8 +92,7 @@ class Instructor < PCR
       end
       
       #Calculate recent rating
-      total = 0
-      num = 0
+      total, num = 0, 0
       targets.each do |section|
         #Make sure we get the rating for the right Instructor
         section.ratings.each do |rating|
@@ -121,8 +108,7 @@ class Instructor < PCR
       end
 
       # Return recent rating
-      total / num
-      
+      (total / num)
     else
       raise CourseError, "Invalid metric format. Metric must be a string or symbol."
     end

data/lib/classes/section.rb

@@ -7,15 +7,13 @@ class Section < PCR
     @id = id
     
     # Hit api to fill additional info
-    self.hit_api() unless hit_api == false
-    
+    self.hit_api unless hit_api == false
   end
   
-  def hit_api()
+  def hit_api
     data = ["aliases", "name", "path", "semester", "description"]
     api_url = @@api_endpt + "courses/" + self.id.to_s + "?token=" + @@token
     json = JSON.parse(open(api_url).read)
-    
     data.each do |d|
       case d
       when "aliases"
@@ -33,10 +31,9 @@ class Section < PCR
     
     # Get review data
     self.get_reviews
-    
   end
   
-  def get_reviews()
+  def get_reviews
     api_url = @@api_endpt + "courses/" + self.id.to_s + "/reviews?token=" + @@token
     json = JSON.parse(open(api_url).read)
     @comments = []

data/lib/pcr-ruby/version.rb

@@ -1,5 +1,5 @@
 module Pcr
   module Ruby
-    VERSION = "0.2"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pcr-ruby
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000 Z
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json