verso 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d77111f7d6014a8e8c6895adb5fce355dec560ae
-  data.tar.gz: 5358aaa41b752dec7dfacb6f041c920c5c00ae84
+  metadata.gz: 6cc8157c300f2bb76447aea7364fcc06456a837a
+  data.tar.gz: 7047e6972fb757fa0d37efc6658141051d08ccd2
 SHA512:
-  metadata.gz: 8bc3d7d4ab6f4bf5b29fb4d314c50c51e67a90eb62819ff905885abd1382cc03e678a1124ff80416099cfc2fd7af2c97e4602942630dcac64885678265162729
-  data.tar.gz: bf663a9bf8f9a497a87a9cb637753a932b774390665e662698cce90dc3ac21f3f8b67f38d95bac9922a56aa180b41fc0b5d9fa1a692674d83fab2939af42c9cb
+  metadata.gz: 296524656f995cd3119a199db8033dc0288850fc149eb2685b5cbd37dbe04e1e0c09513e16765c9ea0df8c5a3b4770380c907147cb7d54e0165ba7db6ad85328
+  data.tar.gz: 5a8032ba1ca5aafc5b7f9cd86c75381317c966ad4c5f6661a56d12143651255ffc6b9fd3c88d83487bb37363e3034677b836d10491b801f32f66ebe91c575e5e

data/README.md

@@ -18,7 +18,7 @@ The verso gem has been tested with Ruby 2.0.0, 1.9.3, and 1.8.7.
 
 ## Quick Start
 
-The wrapper should make a great starting pointing for getting course,
+The wrapper should make a great starting point 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
@@ -65,6 +65,91 @@ Search for Occupations, get back lists of "occupation data," i.e., a list of lis
     creds.first.title # => "Computer Programming (NOCTI)"
     creds.first.related_courses.last # => "Programming, Advanced"
 
+## New! verso-mt command line tool
+
+verso-mt is a command line tool for generating the simpler sorts of CSV reports
+from the CTE Resource Center Web API data. If you need to work on *collections*
+of related resources -- all the occupations related to a course, say, or all
+the courses related to a course, or all the credentials related to a course --
+then verso-mt won't help. You'll need to write a script. But if you only need a
+report from attributes on courses, credentials, or occupations, verso-mt
+totally makes this easy. It will even let you reach into related objects -- an
+occupation's pathway, say, or a credential's source.
+
+You can see a help message by typing `verso-mt -h`. Three sorts of resources
+can be fetched: course, credential, and occupation. Course is the default. Use
+the -q option to specify query parameters. The parameters permissible are
+discussed in the API documentation for CourseList, CredentialList, and
+OccupationList. Separate the parameter from its value with a colon (:) and
+separate multiple parameters with a plus (+), e.g. text:foo+edition:2013.
+Filters, specified with the -f option are formed the same way, but are used by
+verso-mt to filter out results after they're fetched from the server, based on
+a fuzzy match against the specified attribute. Specify the columns you wish to
+see in your CSV report with the -c option and a comma-separated list of
+attributes. You can use dot notation to reach into a related object. E.g., `-c
+title,source.title` could be used to get the title and source title for a list
+of credentials.
+
+Here are some examples:
+
+### Similar to examples/copyright_year.rb
+
+In this example, we do not specify the resource. It defaults to course.
+
+    verso-mt -c title,code,frontmatter.copyright_year,related_resources
+
+### similar to examples/course_notes.rb
+
+    verso-mt -c code,title,notes
+
+### similar to examples/cpo.rb
+
+Here we use the '-q' query parameter. You can send it any parameter mentioned
+in the API documentation for the corresponding resource. Here we are sending a
+wildcard (i.e., everything) in the text parameter for occupations.
+
+    verso-mt -r occupation -q text:* -c title,pathway.title,pathway.cluster.title
+
+### similar to examples/credential_cost.rb
+
+    verso-mt -r credential -c title,cost
+
+### similar to examples/credential_sources.rb
+
+Note in this example, we are reaching into the source, a related object, using
+dot notation.
+
+    verso-mt -r credential -c title,source.title,contractor_name
+
+### equivalent to examples/hours.rb
+
+Note in this example, we are using '-f' the filtering option. We ask it to
+filter out only courses that have 140 hours.
+
+    verso-mt -f hours:140 -c title,code,hours
+
+### equivalent to examples/hs_and_ms.rb
+
+Note we are specifying two filters here.
+
+    verso-mt -f is_hs?:true+is_ms?:true
+
+### equivalent to examples/hs_v_ms.rb
+
+    verso-mt -c title,code,is_ms?,is_hs?
+
+### equivalent to examples/passing_score.rb
+
+    verso-mt -r credential -c title,source.title,passing_score
+
+### all the courses related to 'energy' in 2013 edition with 'technology' in title
+
+    verso-mt -r course -q text:energy+edition:2013 -f title:technology -c title,code,edition
+
+### search credentials for 'web' and return all where source title matches nocti
+
+    verso-mt -r credential -q text:web -f source.title:nocti -c title,source.title
+
 ## Additional Documentation
 
 * [http://api.cteresource.org/docs](http://api.cteresource.org/docs)

data/bin/verso-mt

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+require 'csv'
+require 'optparse'
+require 'verso'
+
+module Verso
+  module ChainableSend
+    # takes a string of dot-separated method names and recursively calls
+    # Object#send with each
+    def chained_send(chain)
+      messages = chain.split('.')
+      if messages.length == 1
+        respond_to?(chain) ? send(chain) : ''
+      else
+        send(messages.first).
+          extend(Verso::ChainableSend).
+          chained_send(messages.slice(1, messages.length).join('.'))
+      end
+    end
+  end
+
+  class OccupationList
+  private
+
+    # confusingly, OccupationList is actually a list of OccupationData obj's
+    # monkey patch so it behaves as expected for this script
+    alias_method :occupations_datas, :occupations
+    def occupations
+      occupations_datas.flat_map { |od| od.occupations }
+    end
+  end
+
+  class OptionBucket
+    attr_accessor :resource, :params, :filters, :columns
+    def initialize(opts={})
+      @resource = opts[:resource] || 'course'
+      @params = opts[:params] || {}
+      @filters = opts[:filters] || {}
+      @columns = opts[:columns] || ['title', 'code']
+      fill!(opts[:argv] || ARGV)
+    end
+
+  private
+
+    def fill!(argv)
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: verso [options]'
+
+        opts.on('-h', '--helper', 'Show this message.') do
+          puts opts
+          exit
+        end
+
+        opts.on('-r', '--resource RES', ['course', 'credential', 'occupation'],
+                'API resource list to get',
+                'One of: course, credential, occupation.') do |res|
+          @resource = res
+        end
+
+        opts.on(
+          '-c', '--columns COLS', Array,
+          'Comma-separated list of resource attributes to display.') do |attrs|
+          @columns = attrs
+        end
+
+        opts.accept kv_pairs = Object.new do |val|
+          pairs = val.split('+')
+          raise OptionParser::InvalidArgument unless pairs.all? do |i|
+            i =~ /^[\w\s.\?]+:[\w\s.\*]+$/
+          end
+          pairs.inject({}) do |h, pair|
+            h[pair.split(':').first] = pair.split(':').last
+            h
+          end
+        end
+
+        opts.on(
+          '-f', '--filters FILTERS', kv_pairs,
+          'Plus-separated list of colon-separated PROP:VALUE pairs.') do |f|
+          @filters = f
+        end
+
+        opts.on(
+          '-q', '--query PARAMS', kv_pairs,
+          'Plus-separated list of colon-separated PARAM:VALUE pairs.',
+          'Parameters should correspond to those in the resource docs.') do |p|
+          @params = p
+        end
+      end
+      parser.parse!(argv)
+    end
+  end
+
+  class MultiTool
+    attr_reader :options
+    def initialize(options)
+      @options = options
+    end
+
+    def klass
+      eval("Verso::#{options.resource.capitalize}List")
+    end
+
+    def resources
+      klass.new(options.params).collect do |r|
+        r.extend(Verso::ChainableSend)
+      end
+    end
+
+    def filtered_resources
+      resources.select do |resource|
+        options.filters.all? do |k, v|
+          resource.chained_send(k).to_s =~ Regexp.new(v, Regexp::IGNORECASE)
+        end
+      end
+    end
+
+    def run(&block)
+      block.call(options, filtered_resources)
+    end
+  end
+end
+
+begin
+  options = Verso::OptionBucket.new
+rescue OptionParser::InvalidArgument => e
+  puts e
+  exit(1)
+end
+
+mt = Verso::MultiTool.new(options)
+mt.run do |options, resources|
+  puts CSV.generate_line(
+    options.columns.
+      collect { |c| "#{options.resource.capitalize} #{c.capitalize}" }
+  )
+  resources.each do |resource|
+    puts CSV.generate_line(
+      options.columns.collect { |col| resource.chained_send(col) }
+    )
+  end
+end

data/examples/associated_with.rb

@@ -0,0 +1,17 @@
+# usage: ruby associated_with.rb 'Title of a Standard'
+#
+# e.g., ruby associated_with.rb 'Science' # => all courses associated with
+# the Science standards body.
+
+require 'csv'
+require 'verso'
+
+standard = ARGV[0] || 'Science'
+
+puts CSV.generate_line(%w{ Code Title }) + "\n"
+
+Verso::CourseList.new.each do |c|
+  if c.standards.find { |c| c.title == standard }
+    puts CSV.generate_line([c.code, c.title])
+  end
+end

data/examples/ceop.rb

@@ -0,0 +1,20 @@
+# usage: ruby ceop.rb
+#
+# dumps CSV list of courses wth cluster, pathway, occupation information in CSV
+# format.
+
+require 'csv'
+require 'verso'
+
+puts CSV.generate_line(%w{ Title Code Edition Cluster Pathway Occupation })
+
+Verso::CourseList.new.each do |c|
+  c.occupation_data.each do |od|
+    od.occupations.each do |occupation|
+      puts CSV.generate_line(
+        [c.title, c.code, c.edition, od.cluster.title,
+         od.pathway.title, occupation.title]
+      )
+    end
+  end
+end

data/examples/copyright_year.rb

@@ -0,0 +1,21 @@
+# usage: ruby copyright_year.rb
+#
+
+require 'csv'
+require 'verso'
+
+puts CSV.generate_line(
+  %w(Program\ Area Title Code Copyright Related\ Resources)
+)
+courses = Verso::CourseList.new
+courses.sort_by { |course| course.title }.each do |course|
+  course.attrs[:program_areas].each do |pa|
+    puts CSV.generate_line [
+      pa,
+      course.title,
+      course.code,
+      course.frontmatter ? course.frontmatter.copyright_year : '',
+      course.related_resources.join(', ')
+    ]
+  end
+end

data/examples/course_notes.rb

@@ -0,0 +1,10 @@
+# usage: ruby course_notes.rb
+
+require 'csv'
+require 'verso'
+
+Verso::CourseList.new.each do |course|
+  unless course.notes.to_s.empty?
+    puts CSV.generate_line([course.code, course.title, course.notes])
+  end
+end

data/examples/cpo.rb

@@ -0,0 +1,11 @@
+# usage: ruby cpo.rb
+require 'csv'
+require 'verso'
+
+puts CSV.generate_line(%w(Occupation Pathway Cluster))
+ods = Verso::OccupationList.new(:text => '*')
+ods.each do |od|
+  od.occupations.each do |o|
+    puts CSV.generate_line [o.title, od.pathway.title, od.cluster.title]
+  end
+end

data/examples/credential_cost.rb

@@ -0,0 +1,9 @@
+# usage: ruby credential_cost.rb
+
+require 'csv'
+require 'verso'
+
+puts CSV.generate_line(['Title', 'cost'])
+Verso::CredentialList.new.each do |cred|
+  puts CSV.generate_line([cred.title, cred.cost])
+end

data/examples/credential_sources.rb

@@ -0,0 +1,10 @@
+# usage: ruby credential_sources.rb
+#
+
+require 'csv'
+require 'verso'
+
+puts CSV.generate_line(%w(Credential Source Contractor))
+Verso::CredentialList.new.each do |cred|
+  puts CSV.generate_line([cred.title, cred.source.title, cred.contractor_name])
+end

data/examples/credentials.rb

@@ -0,0 +1,25 @@
+# usage: ruby credentials.rb
+
+require 'csv'
+require 'verso'
+
+puts CSV.generate_line(
+  %w{ Title Description Source Contractor Related\ Courses }
+)
+
+Verso::CredentialList.new.each do |cred|
+  puts CSV.generate_line(
+    [cred.title,
+     cred.description.
+       gsub(/<\/?[^>]*>/, "").
+       strip.
+       gsub(/\r\n/, " | ").
+       gsub(/&[a-zA-Z]+;/, " "),
+     cred.source.title,
+     cred.contractor_name,
+     cred.
+       related_courses.
+         collect { |c| "#{c.title} (#{c.code})" }.
+         join('; ')]
+  )
+end

data/examples/hours.rb

@@ -0,0 +1,12 @@
+# usage: ruby hours.rb NN
+
+require 'csv'
+require 'verso'
+
+hours =  ARGV[0].to_i
+Verso::CourseList.new.
+  select { |c| c.hours == hours }.
+  sort_by { |c| c.title }.
+  each do |course|
+    puts CSV.generate_line [course.title, course.code]
+end

data/examples/hs_and_ms.rb

@@ -0,0 +1,9 @@
+# usage: ruby hs_and_ms.rb
+
+require 'verso'
+
+Verso::CourseList.new.each do |course|
+  if course.is_hs? && course.is_ms?
+    puts "#{course.title} (#{course.code})"
+  end
+end

data/examples/hs_v_ms.rb

@@ -0,0 +1,11 @@
+# usage: ruby hs_v_ms.rb
+
+require 'csv'
+require 'verso'
+
+Verso::CourseList.new.sort_by { |c| c.title + c.code }.each do |course|
+  puts CSV.generate_line(
+    ["#{course.title} (#{course.code})",
+     course.is_ms? && !course.is_hs? ? "MIDDLE" : "HIGH"]
+  )
+end

data/examples/pa_course_code_cluster_pathway.rb

@@ -0,0 +1,18 @@
+# usage: ruby pa_course_code_cluster_pathway.rb
+#
+# courses with clusters/pathways by (deprecated) program areas
+require 'csv'
+require 'verso'
+
+puts CSV.generate_line(%w{ Program\ Area Title Code Cluster Pathway })
+
+Verso::ProgramAreaList.new.each do |pa|
+  pa.courses.each do |course|
+    course.occupation_data.each do |od|
+      puts CSV.generate_line(
+        [pa.title, course.title, course.code,
+         od.cluster.title, od.pathway.title]
+      )
+    end
+  end
+end

data/examples/passing_score.rb

@@ -0,0 +1,13 @@
+# usage: ruby passing_score.rob
+#
+# list of credentials with passing score where available
+require 'csv'
+require 'verso'
+
+puts CSV.generate_line(['Title', 'Source', 'Passing Score'])
+Verso::CredentialList.new.each do |cred|
+  unless (cred.passing_score.to_s.empty? ||
+          cred.passing_score.to_s =~ /contact/i)
+    puts CSV.generate_line([cred.title, cred.source.title, cred.passing_score])
+  end
+end

data/examples/related_courses.rb

@@ -0,0 +1,14 @@
+#usage: ruby related_courses.rb
+#
+# list of each course and the codes of its related courses
+require 'csv'
+require 'verso'
+
+puts CSV.generate_line(%w{ Code Title Related\ Courses })
+
+Verso::CourseList.new.each do |course|
+  puts CSV.generate_line(
+    [course.code, course.title,
+     course.related_courses.collect { |c| c.code }.join(' ')]
+  )
+end

data/lib/verso/version.rb

@@ -1,3 +1,3 @@
 module Verso
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/verso.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.add_runtime_dependency 'json'
-  s.add_runtime_dependency 'addressable'
+  s.add_runtime_dependency 'addressable', '~> 2.3.5'
   s.add_development_dependency "webmock"
   s.add_development_dependency "redcarpet"
   s.add_development_dependency "rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verso
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Lee Capps
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -28,16 +28,16 @@ dependencies:
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.5
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +111,8 @@ dependencies:
 description: A Ruby wrapper for the Virginia CTE Resource Center's Web API
 email:
 - himself@leecapps.com
-executables: []
+executables:
+- verso-mt
 extensions: []
 extra_rdoc_files: []
 files:
@@ -120,6 +121,21 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- bin/verso-mt
+- examples/associated_with.rb
+- examples/ceop.rb
+- examples/copyright_year.rb
+- examples/course_notes.rb
+- examples/cpo.rb
+- examples/credential_cost.rb
+- examples/credential_sources.rb
+- examples/credentials.rb
+- examples/hours.rb
+- examples/hs_and_ms.rb
+- examples/hs_v_ms.rb
+- examples/pa_course_code_cluster_pathway.rb
+- examples/passing_score.rb
+- examples/related_courses.rb
 - lib/verso.rb
 - lib/verso/base.rb
 - lib/verso/cluster.rb
@@ -200,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: verso
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Verso API wrapper