verso 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Virginia Department of Education
+
+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,75 @@
+# The Verso Ruby Gem
+
+A Ruby wrapper for the Virginia CTE Resource Center's [Web
+API](http://api.cteresource.org), providing access to Virginia's Career and
+Technical Education curriculum, course, and occupation data.
+
+## Installation
+
+    git clone git://github.com/jlcapps/verso.git
+    cd verso
+    rake install
+
+## Caveat
+
+This gem has been *extracted* from a larger project, the Web application that
+presents [Verso](http://www.cteresource.org/verso/), the [Administrative
+Planning Guide](http://www.cteresource.org/apg/), and the [Career Planning
+Guide](http://www.cteresource.org/cpg/) on the Virginia CTE Resource Center Web
+site. For this reason the object interfaces are sometimes inconsistent (for
+instance collection objects do not always respond to all the expected
+methods -- `#to_a` is your friend), the specs are incomplete, and the
+documentation is nil.
+
+All that said, the wrapper is reasonably complete, and should make a great
+starting pointing for getting course, curriculum, and occupation data out of
+Verso. The classes available in lib/verso correspond to the resources described
+in the [API documentation](http://api.cteresource.org/docs). The usual points
+of entry are the [Cluster List](http://api.cteresource.org/docs/clusters), the
+[Course List](http://api.cteresource.org/docs/courses), the [Occupation
+List](http://api.cteresource.org/docs/occupations), and the [Credential
+List](http://api.cteresource.org/docs/credentials).
+
+## Quick Start
+
+### Start with Clusters
+
+    require 'verso'
+    cluster = Verso::ClusterList.new.last
+    cluster.pathways.first.title # => "Facility and Mobile Equipment Maintenance"
+    cluster.pathways.first.occupations.first.title # => "Aircraft Mechanic and Service Technician"
+    cluster.pathways.first.occupations.first.related_courses.first.title # => "Automotive Technology I"
+
+### Start with Courses
+
+    require 'verso'
+    course = Verso::CourseList.new(:code => "6321").first
+    course.title # => "Accouting, Advanced"
+    da = course.duty_areas.to_a[5] # I warned you about the incomplete interface . . . .
+    da.title # => "Using Technology to Implement Accounting Procedures"
+    da.tasks.last.statement # => "Apply emerging technology trends used in the accounting profession."
+
+### Start with Occupations
+
+Search for Occupations, get back lists of "occupation data," i.e., a list of lists of Occupations, grouped by Cluster and Pathway. To wit:
+
+    require 'verso'
+    ods = Verso::OccupationList.new(:text => "golf")
+    ods.count # => 3
+    ods.first.cluster.title # => "Agriculture, Food and Natural Resources"
+    ods.first.pathway.title # => "Environmental Service Systems"
+    ods.first.occupations.count # => 3
+    occupation = ods.first.occupations.first
+    occupation.title => "Turf Farmer"
+    course = occupation.related_courses.last.title # => "Turf Grass Applications, Advanced"
+
+### Start with Credentials
+
+    require 'verso'
+    creds = Verso::CredentialList.new(:text => "programming")
+    creds.first.title # => "Computer Programming (NOCTI)"
+    creds.first.related_courses.last # => "Programming, Advanced"
+
+In general, the objects returned from the wrapper should respond to calls to
+the attributes described in the API documentation. Open an issue on GitHub or
+send an email to lcapps@cteresource.org if you have questions or concerns.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/verso.rb

@@ -0,0 +1,33 @@
+require 'addressable/uri'
+require 'json'
+require 'net/http'
+require 'ostruct'
+
+require 'verso/http_get'
+require 'verso/cluster'
+require 'verso/cluster_list'
+require 'verso/correlation_list'
+require 'verso/course'
+require 'verso/course_list'
+require 'verso/credential'
+require 'verso/credential_list'
+require 'verso/duty_area'
+require 'verso/edition_list'
+require 'verso/emphasis'
+require 'verso/emphasis_list'
+require 'verso/examination_list'
+require 'verso/extra'
+require 'verso/extras_list'
+require 'verso/frontmatter'
+require 'verso/occupation'
+require 'verso/occupation_data'
+require 'verso/occupation_list'
+require 'verso/pathway'
+require 'verso/program_area_list'
+require 'verso/program_area'
+require 'verso/sol_correlation_list'
+require 'verso/standard'
+require 'verso/standards_list'
+require 'verso/task'
+require 'verso/task_list'
+require 'verso/version'

data/lib/verso/cluster.rb

@@ -0,0 +1,43 @@
+module Verso
+  class Cluster
+    include HTTPGet
+
+    def initialize(opts)
+      @raw_cluster = opts
+    end
+
+    def method_missing(mname)
+      if !@raw_cluster.has_key?(mname.to_s)
+        @raw_cluster.merge!(JSON.parse(http_get("/clusters/#{id}"))["cluster"])
+      end
+      @raw_cluster[mname.to_s]
+    end
+
+    def id
+      @raw_cluster["id"]
+    end
+
+    def title
+      @title ||= @raw_cluster["title"] || @raw_cluster["cluster"]["title"]
+    end
+
+    def contact
+      @contact ||= OpenStruct.new(method_missing(:contact))
+    end
+
+    def slug
+      @raw_cluster["title"].parameterize
+    end
+
+    def pathways
+      @pathways ||= method_missing(:pathways).
+        collect { |p| Pathway.new(p) }
+    end
+
+    def courses
+      @courses ||= CourseList.new(:cluster => slug.gsub('-', ' ')).
+                     sort_by { |c| c.title + c.edition }.
+                     uniq { |c| c.code + c.edition }
+    end
+  end
+end

data/lib/verso/cluster_list.rb

@@ -0,0 +1,19 @@
+module Verso
+  class ClusterList
+    include Enumerable
+    include HTTPGet
+
+    def clusters
+      @clusters ||= JSON.parse(http_get('/clusters/'))["clusters"].
+                      collect { |c| Cluster.new(c) }
+    end
+
+    def each &block
+      clusters.each &block
+    end
+
+    def last
+      clusters[-1]
+    end
+  end
+end

data/lib/verso/correlation_list.rb

@@ -0,0 +1,53 @@
+module Verso
+  class CorrelationList
+    include Enumerable
+    include HTTPGet
+
+    def initialize(context, name)
+      @context = context
+      @name = name
+    end
+
+    def title
+      @title ||= @context.standards.find { |s| s.name == @name }.title
+    end
+
+    def code
+      @context.code
+    end
+
+    def edition
+      @context.edition
+    end
+
+    def tasklist
+      @context.duty_areas
+    end
+
+    def sol_names
+      @sol_names ||= @context.standards.sols.collect { |s| s.name }
+    end
+
+    def correlations
+      @correlations ||= JSON.parse(
+        http_get("/courses/#{code},#{edition}/standards/#{@name}/correlations")
+      )["correlations"]
+    end
+
+    def each &block
+      count = 0
+      tasklist.each do |da|
+        da.tasks.each do |task|
+          count += 1
+          related = correlations.find { |c| c["id"] == task.id }
+          if related.nil?
+            next
+          else
+            related["number"] = count
+            yield Task.new(related)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/verso/course.rb

@@ -0,0 +1,84 @@
+module Verso
+  class Course
+    include HTTPGet
+
+    def initialize(raw_course)
+      @raw_course = raw_course
+    end
+
+    def method_missing(mname)
+      if !@raw_course.has_key?(mname.to_s)
+        @raw_course = JSON.parse(http_get("/courses/#{code},#{edition}"))
+      end
+      @raw_course.has_key?(mname.to_s) ? @raw_course[mname.to_s] : super
+    end
+
+    def task(tid)
+      @tasks ||= {}
+      @tasks[tid] ||= Task.new("code" => code, "edition" => edition, "id" => tid)
+    end
+
+    def frontmatter
+      @frontmatter ||= if self.related_resources.include?("frontmatter")
+                         Frontmatter.new("code" => code, "edition" => edition)
+                       else
+                         nil
+                       end
+    end
+
+    def duty_areas
+      @duty_areas ||= TaskList.new(:code => code, :edition => edition)
+    end
+
+    def occupation_data
+      @occupation_data ||= method_missing(:occupation_data).
+        collect { |od| OccupationData.new(od) }
+    end
+
+    def prerequisites
+      @prerequisites ||= prerequisite_courses.collect { |c| Course.new(c) }
+    end
+
+    def related_courses
+      @related_courses ||= method_missing(:related_courses).
+                             collect { |c| Course.new(c) }
+    end
+
+    def credentials
+      @credentials ||= method_missing(:credentials).
+                         collect { |c| Credential.new(c) }
+    end
+
+    def certifications
+      @certfications ||= credentials.select { |c| c.type == "Certification" }
+    end
+
+    def licenses
+      @licenses ||= credentials.select { |c| c.type == "License" }
+    end
+
+    def standards
+      @standards ||= if self.related_resources.include?("standards")
+                       StandardsList.from_course(self)
+                     else
+                       StandardsList.new([], self)
+                     end
+    end
+
+    def is_ms?
+      grade_levels.split.first.to_i < 9
+    end
+
+    def is_hs?
+      grade_levels.split.last.to_i > 8
+    end
+
+    def extras
+      @extras ||= if related_resources.include?("extras")
+                    ExtrasList.new(:code => code, :edition => edition)
+                  else
+                    []
+                  end
+    end
+  end
+end

data/lib/verso/course_list.rb

@@ -0,0 +1,36 @@
+module Verso
+  class CourseList
+    include Enumerable
+    include HTTPGet
+
+    def initialize(raw_query)
+      @q_uri = Addressable::URI.new(
+        :path => '/courses',
+        :query_values => raw_query.
+          select { |k, v| v }.
+          reject { |k, v| v.to_s.empty? }
+      )
+    end
+
+    def courses
+      @courses ||= if @q_uri.query_values.values.any?
+                     JSON.parse(http_get(@q_uri.request_uri))["courses"].
+                       collect { |c| Course.new(c) }
+                   else
+                     []
+                   end
+    end
+
+    def each &block
+      courses.each &block
+    end
+
+    def last
+      courses[-1]
+    end
+
+    def empty?
+      courses.empty?
+    end
+  end
+end

data/lib/verso/credential.rb

@@ -0,0 +1,34 @@
+module Verso
+  class Credential
+    include HTTPGet
+
+    def initialize(opts)
+      @raw_credential = opts
+    end
+
+    def method_missing(mname)
+      if @raw_credential[mname.to_s].nil?
+        @raw_credential.merge!(
+          JSON.parse(http_get("/credentials/#{id}"))["credential"]
+        )
+      end
+      @raw_credential[mname.to_s]
+    end
+
+    def source
+      @source ||= OpenStruct.new(method_missing(:source))
+    end
+
+    def details
+      @details ||= if @raw_credential.has_key?("details")
+                     @raw_credential["details"]
+                   else
+                     method_missing(:details)
+                   end.to_s
+    end
+
+    def related_courses
+      method_missing(:related_courses).collect { |rc| Course.new(rc) }
+    end
+  end
+end

data/lib/verso/credential_list.rb

@@ -0,0 +1,28 @@
+module Verso
+  class CredentialList
+    include Enumerable
+    include HTTPGet
+
+    attr_reader :credentials
+
+    def initialize(opts={})
+      @q_uri = Addressable::URI.new(:path => '/credentials')
+      @q_uri.query_values = opts unless opts[:text].to_s.empty?
+      @credentials = JSON.parse(http_get(@q_uri.request_uri))["credentials"].
+        collect { |c| Credential.new(c) }.
+        sort_by { |c| c.title }
+    end
+
+    def each &block
+      credentials.each &block
+    end
+
+    def last
+      credentials[-1]
+    end
+
+    def empty?
+      credentials.empty?
+    end
+  end
+end