oncourse 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ff62a2167ee5451cf1f72b9b3ca9ff65ba210ae
+  data.tar.gz: e1c80d3865f1f2adb24fd4687e29cabdf7a25e1d
+SHA512:
+  metadata.gz: 22bffbdf58374929970a8f62735ffadbc2c15bb418d0d0745e8b25e04dc37c708d6431919e031e6b3a69ed4642d7908ca769c33d755af7c0ce46481d8fca0709
+  data.tar.gz: a7e8f792a83abf9e48e74934948d69ba60578f60e679914f6046a7fe78984d3c6a6c955fa6b4c35af193d7c11869ae046a4ee673f25b5a3a13c3fa2ada836357

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oncourse.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 steve <stevecd123@gmail.com>
+
+MIT License
+
+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,55 @@
+# Oncourse
+
+Oncoursesystems.com is a web app written in ext3js that handles managing teacher
+lesson plans amongst many other things.  It has proven to be incredibly tedious to
+work with so I spent a day parsing its html and json requests involved with lessonplan
+editing.  This gem is the result.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oncourse'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oncourse
+
+## Usage
+
+    require 'oncourse'
+    client = Oncourse::Client.new('testuser', 'password')
+
+    # parse the weekly planner for a specific date and number of weeks.
+    # in the school I'm helping, the weeks start on monday, so this date should
+    # be a monday.  The week is that monday and the following 4 days.
+    # This method only parses the html, so it does not read the homework field.
+    # You'll only get the lesson.  Use client.read_lesson if you want the homework.
+    lessonplan = client.read_planner(Date.parse("2014-03-10"), 1)
+
+    # After a client.read_planner call, the planner is stored in an instance variable.
+    # We can now read all of the standards for each lesson we've read so far:
+    lessonplan_with_standards = client.read_planner_standards()
+    
+
+    # Save the lesson plan so far.
+    client.save_planner("./lessonplan_20140310.json")
+
+    # read a single lesson given a date and period.
+    # this method also returns homework
+    puts client.read_lesson(Date.today, 2)
+
+    # post a lesson
+    client.post_lesson("2 + 2 = 4", "homework: 3+3= ?", Date.today, 2)
+
+## Contributing
+
+1. Fork it ( http://github.com/stevecd/ruby-oncourse/fork )
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc "Open a pry session preloaded with this library"
+task :console do
+  sh "pry -r rubygems -I lib -r oncourse.rb"
+end

data/lib/oncourse.rb

@@ -0,0 +1,6 @@
+require "oncourse/version"
+require "oncourse/client"
+
+module Oncourse
+  # Your code goes here...
+end

data/lib/oncourse/client.rb

@@ -0,0 +1,239 @@
+require 'mechanize'
+module Oncourse
+  URLS = {
+    main: "http://www.oncoursesystems.com/",
+    set_planner: "http://www.oncoursesystems.com/planner/planner_frame.aspx", #date=20140310&user_id=user_id&template=N
+    get_planner: "http://www.oncoursesystems.com/planner/planner.aspx",
+    close_planner: "http://www.oncoursesystems.com/planner/planner_navigation_bar.aspx", #action=C&tabid=337113074
+    lesson_standards: "http://www.oncoursesystems.com/json.axd/lessonplan/references_linked", #post request, {id: <standards_id>}
+    link_standards: "http://www.oncoursesystems.com/json.axd/standards/link_standards",
+    read_standard_areas: "http://www.oncoursesystems.com/json.axd/standards/lesson_standard_areas", #post request, {setId: <standard_setId}
+    lesson_standard_filters: "http://www.oncoursesystems.com/json.axd/standards/lesson_standard_filters", #post request, {setId: <standard_setId>, subject: {standard_subject}}
+    lesson_standards_tree: "http://www.oncoursesystems.com/json.axd/standards/lesson_standards_tree",
+    read_lesson: "http://www.oncoursesystems.com/json.axd/LessonPlan/lesson_record",
+    post_lesson: "http://www.oncoursesystems.com/json.axd/LessonPlan/lesson_record_save",
+    lesson_tree: "http://www.oncoursesystems.com/json.axd/LessonPlan/lesson_tree" #{userId: <user_id>}
+  }
+  class Client
+    attr_accessor :mech, :user_id, :weeks, :request_rate, :lesson_tree
+
+    # create new mechanize object and go through login steps
+    def initialize(username,password,request_rate=1)
+      @request_rate = request_rate
+      @mech = Mechanize.new()
+      login_page = @mech.get(URLS[:main])
+      login_form = login_page.forms.first
+      login_form.Username = username
+      login_form.Password = password.strip
+      home_page = login_form.submit
+      script_tag = home_page.parser.search("script").select{|s| s.text.index('user_id')}.first
+      raise "Login failed, script_tag not present." unless script_tag
+      @user_id = /\"user_id\":\"([0-9]+)\"/.match(script_tag.text).captures.first
+      raise "Login failed, unable to find user_id" unless @user_id
+    end
+
+    # read lesson planner for current user starting at start_Date: start_date
+    # and going each week up to num_weeks
+    def read_planner(start_date, num_weeks)
+      @weeks = []
+      start = start_date
+      cell_ids = 0
+      itr = 0
+      num_weeks.times do
+        start += itr * 7
+        week = {start: start.strftime("%Y%m%d")}
+        week[:columns] = []
+
+        # a get request to this set_planner url sets the current viewed planner
+        @mech.get(URLS[:set_planner], {date: week[:start], user_id: @user_id, template:'N'})
+        rate_pause()
+
+        planner_frame = @mech.get(URLS[:get_planner])
+
+        # parse out column headers
+        columns = planner_frame.parser.search("tr.sheetRowHeader th:not(.sheetRow1stCell)").each_with_index.map{|cell, idx| {label: cell.text.strip, period: idx + 1}}
+
+        # parse out each cell, ids give date and period.
+        # Period corresponds to column number.
+        # .lessonPreview classes contain the markup and content created by ext3's text editor
+        # that teachers use to input lessons.
+        cells = planner_frame.parser.search(".sheetCell")
+        cells = cells.map do |cell|
+          cell_hash = {
+            date: cell['id'][0...-2],
+            period: cell['id'][-2..-1].to_i,
+            html: cell.search('.lessonPreview').first.inner_html
+          }
+          flag_element = cell.search('.sheetCellIcons img[src="/images/icons/flag_blue.png"]').first
+          if(flag_element)
+            match = /showStandard\(\'([0-9]+)\'\)/.match(flag_element['onclick'])
+            if(match && match.captures.first)
+              cell_hash[:standards_id] = match.captures.first
+            end
+          end
+          cell_hash
+        end
+        columns.each do |column|
+          column[:cells] = cells.select{|cell| cell[:period] == column[:period]}
+        end
+
+        week[:columns] = columns
+
+        @weeks << week
+        itr += 1
+        rate_pause()
+      end
+
+      return @weeks
+    end
+
+    def rate_pause
+      sleep((1 + rand(0.1)) * @request_rate)
+    end
+
+    def read_planner_standards()
+      raise "planner weeks empty" if !@weeks || @weeks.length == 0
+      keys = ["id", "header_name", "detail_name"]
+      @weeks.each do |week|
+        week[:columns].each do |column|
+          column[:cells].each do |cell|
+            next unless cell[:standards_id]
+
+            json_response = @mech.post(URLS[:lesson_standards], {
+              id: cell[:standards_id]
+            })
+
+            cell[:standards] = JSON.parse(json_response.content).map{|f| f.reject{|k,v| !keys.include?(k)}}
+            rate_pause()
+          end
+        end
+      end
+      return @weeks
+    end
+
+    def save_planner(filename)
+      File.open(filename, "w") { |f| f.puts JSON.pretty_generate(@weeks)}
+    end
+
+    # method to read one lesson through the json interface
+    # This is required before posting a lesson since it's the only way to get the
+    # homework field that I've found.  If you post an empty homework field, any previous
+    # homework entry will be lost
+    def read_lesson(date, period)
+      response = @mech.post(URLS[:read_lesson], {
+        userId: @user_id,
+        date: date.strftime("%m/%d/%Y"),
+        period: period
+      })
+      return JSON.parse(response.content)["ReturnValue"]
+    end
+
+    def read_lesson_tree()
+      return @lesson_tree if @lesson_tree
+      response = @mech.post(URLS[:lesson_tree], {userId: @user_id})
+
+      # oncourse returns invalid JSON, using this ugly regex for now.
+      fixed_json = fix_malformed_json(response.content)
+
+      @lesson_tree = JSON.parse(fixed_json)
+
+      return @lesson_tree
+    end
+
+    # oncourse produces a lot of malformed json.  It seems to strip the quotes off strings
+    # on deeply nested objects.  Not sure what they're doing wrong, since I don't think
+    # the problem is with ext3
+    def fix_malformed_json(malformed_json)
+      return malformed_json.gsub(/([a-z][a-zA-Z0-9_]+):(?!\s)/, '"\1":')
+    end
+
+    # read parent groups for standards
+    def read_standard_groups()
+      read_lesson_tree unless @lesson_tree
+
+      #have to traverse a big json tree here
+      standards_branch = @lesson_tree.find{|branch| branch["text"] == "Standards"}
+      return standards_branch["children"].map do |child|
+        {
+          label: child["text"],
+          set_id: child["xconfig"]["setId"]
+        }
+      end
+    end
+
+    # reads first child group of standards
+    def read_standard_areas(set_id)
+      response = @mech.post(URLS[:standard_areas], {setId: set_id})
+
+      return JSON.parse(fix_malformed_json(response.content))
+    end
+
+    # reads filters that must be applied after selecting first child group
+    def read_lesson_standard_filters(set_id, subject)
+      response = @mech.post(URLS[:lesson_standard_filters], {setId: set_id, subject: subject})
+
+      return JSON.parse(response.content)
+    end
+
+    # Reads a full list of standards for a given SetID, subject, grade, and year
+    def read_lesson_standards_tree(set_id, subject, grade, year)
+      response = @mech.post(URLS[:lesson_standards_tree], {
+        userId: @user_id,
+        setId: set_id,
+        subject: subject,
+        yearName: year,
+        searchText1: "",
+        searchOperator: "",
+        searchText2: "",
+        powerSetID: "",
+        mapID: "",
+        grade: grade,
+        showOnlyPowerSet: false,
+        activityDate: Date.today.strftime("%m/%d/%Y"), # seems arbitrary
+        activityPeriod: 1 # arbitrary
+      })
+
+      return JSON.parse(response.content)
+    end
+
+    def link_standard(standard_id, date, period)
+      response = @mech.post(URLS[:link_standards], {
+        objectType: "L",
+        id: standard_id,
+        date: date.strftime("%m/%d/%Y"),
+        period: period,
+        link: true
+      })
+
+      return JSON.parse(response.content)
+    end
+
+    def unlink_standard(standard_id, date, period)
+      response = @mech.post(URLS[:link_standards], {
+        objectType: "L",
+        id: standard_id,
+        date: date.strftime("%m/%d/%Y"),
+        period: period,
+        link: false
+      })
+
+      return JSON.parse(response.content)
+    end
+
+    # This method will absolutely overwrite anything that occupies this place
+    # in the lesson plan.  To play it safe, one should call read_lesson and store
+    # that response somewhere before using post lesson.  This way there is a backup
+    # of previous work.  Oncourse does not appear to keep a revision history on
+    # lesson plans.
+    def post_lesson(lesson, homework, date, period)
+      response = @mech.post(URLS[:post_lesson], {
+        userId: @user_id,
+        date: date.strftime("%m/%d/%Y"),
+        period: period,
+        notes: lesson,
+        homework: homework
+      })
+      return response
+    end
+  end
+end

data/lib/oncourse/version.rb

@@ -0,0 +1,3 @@
+module Oncourse
+  VERSION = "0.0.1"
+end

data/oncourse.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oncourse/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oncourse"
+  spec.version       = Oncourse::VERSION
+  spec.authors       = ["steve"]
+  spec.email         = ["stevecd123@gmail.com"]
+  spec.summary       = %q{Provides a basic lessonplan API}
+  spec.description   = %q{oncoursesystems.com's interface is very tedious to work with in a lot of cases, this gem uses mechanize to scrape and post lessonplan data}
+  spec.homepage      = "https://github.com/stevecd/ruby-oncourse"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  
+  spec.add_runtime_dependency "mechanize"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: oncourse
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- steve
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  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: oncoursesystems.com's interface is very tedious to work with in a lot
+  of cases, this gem uses mechanize to scrape and post lessonplan data
+email:
+- stevecd123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/oncourse.rb
+- lib/oncourse/client.rb
+- lib/oncourse/version.rb
+- oncourse.gemspec
+homepage: https://github.com/stevecd/ruby-oncourse
+licenses:
+- MIT
+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: Provides a basic lessonplan API
+test_files: []