lse_courses 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86c640247013f44f18ba17e7abc6fa037e498e44
+  data.tar.gz: acd3967aac16df1b85f268cb092c34bf8b7bf58a
+SHA512:
+  metadata.gz: 553d717bfbf3cf480786afcd364c41d65d421335933bb7f0697ddfbd908dbff4a0014668b81bc7efee4bbfce77f13d7711ef7e2b565ea4edee898c70cd1de656
+  data.tar.gz: a906cc99a9718f5545ba6bec3a2fa859b0170c31efc5536de711745c5af84ec2aa22d8c6d547c6b492bb11ee31808b9f724fbb669997685bbd374bef1c7c2dfd

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tim Rogers
+
+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/README.md

@@ -0,0 +1,48 @@
+# LSE Courses
+
+A gem for accessing course data from the [London School of Economics](http://lse.ac.uk)'s [Calendar](http://www.lse.ac.uk/resources/calendar/).
+
+I'm planning to use this for a project, but I'm not 100% sure what yet - perhaps
+something along the line of [YalePlus](http://yaleplus.com/)'s Bluebook+.
+
+## Usage
+
+Add the gem to your Gemfile, then run `bundle install`:
+
+```
+gem 'lse_courses', git: 'git@github.com:timrogers/lse_courses.git'
+```
+
+You might need to add a call to `require 'lse_courses'` in your code, 
+dependent on your setup.
+
+You can retrieve an array with every course offered at LSE:
+
+```ruby
+courses = LSECourses::Course.all
+courses.each do |course|
+  puts "#{course.code} - #{course.name}"
+
+  # LSE records include surveys on courses - stored in #survey on the object
+  puts "#{course.survey.recommended_by}% of students recommend this cause"
+end
+```
+
+...or you can fetch a specific course by code:
+
+```ruby
+course = LSECourses::Course.find_by_code("LSE100")
+puts course.name
+```
+
+Upcoming features that should be added are some kind of search (e.g. for
+finding a course by name) and a way to find courses by type (e.g. undergraduate, graduate)...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new pull request
+

data/lib/lse_courses/course.rb

@@ -0,0 +1,132 @@
+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
+
+    def initialize(opts = {})
+      opts.each { |k, v| instance_variable_set("@#{k}", v) }
+    end
+
+    def undergraduate?
+      type == "Undergraduate"
+    end
+
+    def graduate?
+      type == "Graduate"
+    end
+
+    def research?
+      type == "Research"
+    end
+
+    # 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
+    end
+
+    def survey?
+      !!survey
+    end
+
+    alias_method :available_on_general_course?, :general_course?
+    alias_method :title, :name
+
+    # Class methods
+    def self.course_lists
+      {
+        "Undergraduate" => "http://www.lse.ac.uk/resources/calendar/courseGuides/undergraduate.htm",
+        "Graduate" => "http://www.lse.ac.uk/resources/calendar/courseGuides/graduate.htm",
+        "Research" => "http://www.lse.ac.uk/resources/calendar/courseGuides/research.htm"
+      }
+    end
+
+    def self.all
+      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
+
+          course = fetch_and_parse course_url
+          key_facts = course.css('#keyFacts-Content p')
+          code = course.css('#courseCode').text
+
+          results << course_page_to_object(course, type)
+        end
+      end
+
+      results
+    end
+
+    def self.find_by_code(code)
+      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
+
+          if code == course_code
+            course = fetch_and_parse(
+              URI.join(URI.parse(url), URI.parse(link['href'])).to_s
+            )
+
+            return course_page_to_object(course, type)
+          end
+        end
+      end
+
+      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.fetch_and_parse(url)
+      Nokogiri::HTML(open(url, &:read), 'UTF-8')
+    end
+  end
+end

data/lib/lse_courses/survey_result.rb

@@ -0,0 +1,10 @@
+module LSECourses
+  class SurveyResult
+    attr_reader :response_rate, :recommended_by, :reading_list, :materials,
+      :satisfied, :lectures, :integration, :contact, :feedback
+
+    def initialize(opts = {})
+      opts.each { |k, v| instance_variable_set("@#{k}", v) }
+    end
+  end
+end

data/lib/lse_courses/version.rb

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

data/lib/lse_courses.rb

@@ -0,0 +1,3 @@
+require 'lse_courses/course'
+require 'lse_courses/survey_result'
+require 'lse_courses/version'

data/lse_courses.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lse_courses/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lse_courses"
+  spec.version       = LSECourses::VERSION
+  spec.summary       = %Q{Access to data on courses at the London School of Economics and Political Science (LSE)}
+  spec.authors       = ["Tim Rogers"]
+  spec.email         = ["t.d.rogers@lse.ac.uk"]
+  spec.description   = %Q{Access to data on courses at the London School of Economics and Political Science (LSE)}
+  spec.homepage      = "https://github.com/timrogers/lse_courses"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "activesupport"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: lse_courses
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tim Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: Access to data on courses at the London School of Economics and Political
+  Science (LSE)
+email:
+- t.d.rogers@lse.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- lib/lse_courses.rb
+- lib/lse_courses/course.rb
+- lib/lse_courses/survey_result.rb
+- lib/lse_courses/version.rb
+- lse_courses.gemspec
+homepage: https://github.com/timrogers/lse_courses
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Access to data on courses at the London School of Economics and Political
+  Science (LSE)
+test_files: []