lse_courses 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86c640247013f44f18ba17e7abc6fa037e498e44
-  data.tar.gz: acd3967aac16df1b85f268cb092c34bf8b7bf58a
+  metadata.gz: c7c9c9889a37a6207cd6532c6c8dd9063848fcc6
+  data.tar.gz: 176a2d786f26fa542c74b811376165016f762e21
 SHA512:
-  metadata.gz: 553d717bfbf3cf480786afcd364c41d65d421335933bb7f0697ddfbd908dbff4a0014668b81bc7efee4bbfce77f13d7711ef7e2b565ea4edee898c70cd1de656
-  data.tar.gz: a906cc99a9718f5545ba6bec3a2fa859b0170c31efc5536de711745c5af84ec2aa22d8c6d547c6b492bb11ee31808b9f724fbb669997685bbd374bef1c7c2dfd
+  metadata.gz: b7dd7f44f21af449cd850f376920ac5ae3e003eabb660f90fb6ecd252fb6bc97bb8373218e5f41747e734d1e616afd5597cc0cfed867875e60ce90bcabcfc26e
+  data.tar.gz: 2002eff56b061d4953db574ff339f3251b3eb13d37794bd667986ae04731b87ebffe358f1d804b1424dcce871c7853fc1d5b1a244dd9656e6be38e6565199681

data/README.md

@@ -9,7 +9,12 @@ something along the line of [YalePlus](http://yaleplus.com/)'s Bluebook+.
 
 Add the gem to your Gemfile, then run `bundle install`:
 
-```
+```ruby
+# Install from RubyGems
+source "http://rubygems.org"
+gem 'lse_courses', '0.0.3'
+
+# Install the latest version via Git
 gem 'lse_courses', git: 'git@github.com:timrogers/lse_courses.git'
 ```
 
@@ -19,10 +24,19 @@ dependent on your setup.
 You can retrieve an array with every course offered at LSE:
 
 ```ruby
+# You can just fetch the most basic information - name, code and type (e.g. undergraduate)
 courses = LSECourses::Course.all
+
+# ...or you can grab everything at once - this will take a long time
+courses = LSECourses::Course.all(preload: true)
+
 courses.each do |course|
   puts "#{course.code} - #{course.name}"
 
+  # Fetch a more detailed attribute, and we'll grab all of them for you
+  # and store them if you didn't preload the data originally
+  puts course.department
+
   # LSE records include surveys on courses - stored in #survey on the object
   puts "#{course.survey.recommended_by}% of students recommend this cause"
 end
@@ -31,8 +45,11 @@ end
 ...or you can fetch a specific course by code:
 
 ```ruby
-course = LSECourses::Course.find_by_code("LSE100")
+course = LSECourses::Course.find("LSE100")
 puts course.name
+
+# All the data is loaded straight up, since there's only one course to fetch
+puts course.department
 ```
 
 Upcoming features that should be added are some kind of search (e.g. for

data/lib/lse_courses/course.rb

@@ -1,16 +1,167 @@
-require 'active_support/core_ext/object/try'
 require 'nokogiri'
 
 module LSECourses
   class Course
-    attr_reader :code, :name, :department, :students, :average_class_size, 
-      :value, :assessments, :teachers, :availability, :prerequisites, 
-      :content, :teaching, :formative_coursework, :reading, :type, :survey
+    attr_reader :code, :name, :type
+    attr_accessor :url
 
     def initialize(opts = {})
       opts.each { |k, v| instance_variable_set("@#{k}", v) }
     end
 
+    def fetch_attributes
+      page = self.class.fetch_and_parse(url)
+      key_facts = page.css('#keyFacts-Content p')
+
+      @survey = if page.css('#survey-Label').any?
+        SurveyResult.new(
+          response_rate: page.css('#survey-Label-2 span').text.gsub("Response rate: ", "").gsub("%", "").to_f,
+          recommended_by: page.css('#survey-Content-Recommend p')[1].text.gsub("%", "").to_f,
+          reading_list: page.css('#survey-Content table tbody td')[1].text.to_f,
+          materials: page.css('#survey-Content table tbody td')[3].text.to_f,
+          satisfied: page.css('#survey-Content table tbody td')[5].text.to_f,
+          lectures: page.css('#survey-Content table tbody td')[7].text.to_f,
+          integration: page.css('#survey-Content table tbody td')[9].text.to_f,
+          contact: page.css('#survey-Content table tbody td')[11].text.to_f,
+          feedback: page.css('#survey-Content table tbody td')[13].text.to_f,
+        )
+      end
+
+      @code =  page.css('#courseCode').text
+      @name = page.css('span#title').text
+      @department = key_facts[0].text.gsub("Department: ", "")
+      @students = key_facts[1].text.gsub("Total students 2012/13:", "").to_i
+      @average_class_size = key_facts[2].text.gsub("Average class size 2012/13: ", "").to_i
+      @value = key_facts[3].text.gsub("Value: ", "")
+      @assessments = self.class.join_p_tags(page.css('#assessment-Content p'))
+      @teachers = self.class.join_p_tags(page.css('#teacherResponsible-Content p'))
+      @availability = self.class.join_p_tags(page.css('#availability-Content p'))
+      @prerequisites = self.class.join_p_tags(page.css('#preRequisites-Content p'))
+      @content = self.class.join_p_tags(page.css('#courseContent-Content p'))
+      @teaching = self.class.join_p_tags(page.css('#teaching-Content p'))
+      @formative_coursework = self.class.join_p_tags(page.css('#formativeCoursework-Content p'))
+      @reading = self.class.join_p_tags(page.css('#indicativeReading-Content p'))
+
+      self
+    end
+
+    def department
+      if @department
+        @department
+      else
+        fetch_attributes
+        @department
+      end
+    end
+
+    def students
+      if @students
+        @students
+      else
+        fetch_attributes
+        @students
+      end
+    end
+
+    def average_class_size
+      if @average_class_size
+        @average_class_size
+      else
+        fetch_attributes
+        @average_class_size
+      end
+    end
+
+    def value
+      if @value
+        @value
+      else
+        fetch_attributes
+        @value
+      end
+    end
+
+    def assessments
+      if @assessments
+        @assessments
+      else
+        fetch_attributes
+        @assessments
+      end
+    end
+
+    def teachers
+      if @teachers
+        @teachers
+      else
+        fetch_attributes
+        @teachers
+      end
+    end
+
+    def availability
+      if @availability
+        @availability
+      else
+        fetch_attributes
+        @availability
+      end
+    end
+
+    def prerequisites
+      if @prerequisites
+        @prerequisites
+      else
+        fetch_attributes
+        @prerequisites
+      end
+    end
+
+    def content
+      if @content
+        @content
+      else
+        fetch_attributes
+        @content
+      end
+    end
+
+    def teaching
+      if @teaching
+        @teaching
+      else
+        fetch_attributes
+        @teaching
+      end
+    end
+
+    def formative_coursework
+      if @formative_coursework
+        @formative_coursework
+      else
+        fetch_attributes
+        @formative_coursework
+      end
+    end
+
+    def reading
+      if @reading
+        @reading
+      else
+        fetch_attributes
+        @reading
+      end
+    end
+
+    def survey
+      if @survey
+        @survey
+      else
+        fetch_attributes
+        @survey
+      end
+    end
+
     def undergraduate?
       type == "Undergraduate"
     end
@@ -25,8 +176,7 @@ module LSECourses
 
     # Checks if this module is available to General Course students
     def general_course?
-      general_course_list = open("http://www.lse.ac.uk/resources/calendar/GeneralCourse/coursesNotAvailableToGeneralCStudents.htm")
-      !general_course_list.read.include? code
+      !self.class.general_course_page.include? code
     end
 
     def survey?
@@ -45,22 +195,31 @@ module LSECourses
       }
     end
 
-    def self.all
+    def self.all(options = {})
+      defaults = { preload: false }
+      options = defaults.merge(options)
+
       results = []
 
       course_lists.each_pair do |type, url|
         document = fetch_and_parse(url)
         document.css('table tr td p a').each do |link|
-          course_url = URI.join(URI.parse(url), URI.parse(link['href'])).to_s
+          abstract = link.text.split(" ")
 
-          course = fetch_and_parse course_url
-          key_facts = course.css('#keyFacts-Content p')
-          code = course.css('#courseCode').text
+          course_code = abstract.shift
+          name = abstract.join(" ")
+          course_url = URI.join(URI.parse(url), URI.parse(link['href'])).to_s
 
-          results << course_page_to_object(course, type)
+          results << self.new(
+            url: course_url,
+            name: name,
+            code: course_code,
+            type: type
+          )
         end
       end
 
+      results.each(&:fetch_attributes) if options[:preload]
       results
     end
 
@@ -68,15 +227,19 @@ module LSECourses
       course_lists.each_pair do |type, url|
         document = fetch_and_parse(url)
         document.css('table tr td p a').each do |link|
-          title = link.text
-          course_code = title.split(" ").first
+          abstract = link.text.split(" ")
 
-          if code == course_code
-            course = fetch_and_parse(
-              URI.join(URI.parse(url), URI.parse(link['href'])).to_s
-            )
+          course_code = abstract.shift
+          name = abstract.join(" ")
+          course_url = URI.join(URI.parse(url), URI.parse(link['href'])).to_s
 
-            return course_page_to_object(course, type)
+          if code == course_code
+            return self.new(
+              url: course_url,
+              name: name,
+              code: course_code,
+              type: type
+            ).fetch_attributes
           end
         end
       end
@@ -84,49 +247,18 @@ module LSECourses
       nil
     end
 
-    def self.course_page_to_object(page, type)
-      key_facts = page.css('#keyFacts-Content p')
-
-      survey_result = if page.css('#survey-Label').any?
-        SurveyResult.new(
-          response_rate: page.css('#survey-Label-2 span').text.gsub("Response rate: ", "").gsub("%", "").to_f,
-          recommended_by: page.css('#survey-Content-Recommend p')[1].text.gsub("%", "").to_f,
-          reading_list: page.css('#survey-Content table tbody td')[1].text.to_f,
-          materials: page.css('#survey-Content table tbody td')[3].text.to_f,
-          satisfied: page.css('#survey-Content table tbody td')[5].text.to_f,
-          lectures: page.css('#survey-Content table tbody td')[7].text.to_f,
-          integration: page.css('#survey-Content table tbody td')[9].text.to_f,
-          contact: page.css('#survey-Content table tbody td')[11].text.to_f,
-          feedback: page.css('#survey-Content table tbody td')[13].text.to_f,
-        )
-      end
-
-      self.new(
-        type: type,
-        code: page.css('#courseCode').text,
-        name: page.css('span#title').text,
-        department: key_facts[0].text.gsub("Department: ", ""),
-        students: key_facts[1].text.gsub("Total students 2012/13:", "").to_i,
-        average_class_size: key_facts[2].text.gsub("Average class size 2012/13: ", "").to_i,
-        value: key_facts[3].text.gsub("Value: ", ""),
-        assessments: join_p_tags(page.css('#assessment-Content p')),
-        teachers: join_p_tags(page.css('#teacherResponsible-Content p')),
-        availability: join_p_tags(page.css('#availability-Content p')),
-        prerequisites: join_p_tags(page.css('#preRequisites-Content p')),
-        content: join_p_tags(page.css('#courseContent-Content p')),
-        teaching: join_p_tags(page.css('#teaching-Content p')),
-        formative_coursework: join_p_tags(page.css('#formativeCoursework-Content p')),
-        reading: join_p_tags(page.css('#indicativeReading-Content p')),
-        survey: survey_result
-      )
-    end
-
     def self.join_p_tags(elements)
       elements.map(&:text).join("\n").strip
     end
 
+    def self.general_course_page
+      @general_course_page ||= open("http://www.lse.ac.uk/resources/calendar/GeneralCourse/coursesNotAvailableToGeneralCStudents.htm").read
+    end
+
     def self.fetch_and_parse(url)
       Nokogiri::HTML(open(url, &:read), 'UTF-8')
     end
+
+    self.singleton_class.send(:alias_method, :find, :find_by_code)
   end
 end

data/lib/lse_courses/version.rb

@@ -1,3 +1,3 @@
 module LSECourses
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 end

data/lse_courses.gemspec

@@ -18,5 +18,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "nokogiri"
-  spec.add_runtime_dependency "activesupport"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lse_courses
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tim Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,20 +24,6 @@ dependencies:
     - - '>='
       - !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: Access to data on courses at the London School of Economics and Political
   Science (LSE)
 email: