uw_sws 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8f8ad0d260027bc86df6f305e6db08e492c893e
-  data.tar.gz: 7a3a971bac4e86c7467413153c9c334355f06581
+  metadata.gz: b43d286493de2d453829548668644a2e344b208f
+  data.tar.gz: 8d1ebf5d0e86047954ef2f68d2c3ce6466493266
 SHA512:
-  metadata.gz: 1701fe5db759b97ca7b457a18121588d32fcf2b1b9c8eb4e781df12bd11a219c797990762eb3e14002994283c651422f2d52966cf61785cfc83becae17a25c4a
-  data.tar.gz: 4908ca8f63935a1281a10a8aef972d297590a0916f6c8d274cf746892e5b13faf7e46fae5c40b8068077ce870ba7b906fbc3284ab610d696cc2f3692e1feddfa
+  metadata.gz: 96e279568721f916be1cf0f0dceacb25e8986326786119fc85b2e80255380f80ccb4063a1b68a3d1e985191b1e5788a9b260183b333693b061c2c0592aabf884
+  data.tar.gz: 695c902508566fdb5762ad8b5d68df71e7189f4984242e5f436ce4051baaafe10ecdfe8667ca46ab042d553b42717ab9d348fdfb0a2fc18783907e43f75169a6

data/README.md

@@ -1,10 +1,10 @@
 # UW Student Web Service
-This implements almost all of the public and private [v4 UW Student Webservice
-endpoints](https://wiki.cac.washington.edu/display/SWS/Student+Web+Service+Client+Home+Page).  It's designed to fetch the JSON endpoints and return a Hash.  This gem has the capability to cache all web requests to assit with speedy development.
+This implements most of the [v5 UW Student Webservice
+endpoints](https://wiki.cac.washington.edu/display/SWS/Student+Web+Service+Client+Home+Page).  Each endpoint is querried for their json response and a hash is then returned.  This gem has the capability to cache all web requests to assit with speedy development.
 
 ## USE
 
-### Installation (for use in your project)
+### Installation
 
     gem install uw_sws
 
@@ -12,28 +12,65 @@ endpoints](https://wiki.cac.washington.edu/display/SWS/Student+Web+Service+Clien
 Basic example below gives you hash of term data for winter 2013
 
     require 'uw_student_webservice'
-    service = UwStudentWebService.new
+    service = UwSws.new
     term    = service.term(2013, "winter")
 
 Maybe you want all the Geology courses from 1985?
 
     require 'uw_student_webservice'
-    service = UwStudentWebService.new
+    service = UwSws.new
     courses = service(1985, "winter", curriculum: "GEOG")
 
 For cases where you need to page through results you can check for the existance
 of ``service.next`` and make follow up queries based on it's data.
 
     require 'uw_student_webservice'
-    service = UWStudentWebService.new
+    service = UwSws.new
     courses = service.courses(1985, "autumn", curriculum: "GEOG", size: 25)
     puts service.next
 
-For a full list of examples see /test
+For a full list of examples see ``/test``
 
 ### Caching
 
-If you pass ``use_cache: true`` as a parameter to ``UWStudentWebService.new`` all web requests will be cached in your local file system. However, you will need to have a cache directory in the root of whatever projects you are using this gem in.
+If you pass ``use_cache: true`` as a parameter to ``UwSws.new`` all web requests will be cached in your local file system. However, you will need to have a cache directory in the root of whatever projects you are using this gem in.
+
+## Endpoint Implementation
+All links below go to the official service documentation.  The code block refers to it's implementation in this gem.  See the tests for how to use all the supported endpoints.
+
+``service = UwSws.new(...params...)``
+
+#### Fully Supported
+* [Campus](https://wiki.cac.washington.edu/display/SWS/Campus+Search+Resource+V5)  ``service.campus``
+* [College Search](https://wiki.cac.washington.edu/display/SWS/College+Search+Resource+V5)  ``service.colleges``
+* [Course](https://wiki.cac.washington.edu/display/SWS/Course+Resource+v5) ``service.course``
+* [Course Search](https://wiki.cac.washington.edu/display/SWS/Course+Search+Resource+V5) ``service.courses``
+* [Curriculumn Search](https://wiki.cac.washington.edu/display/SWS/Curriculum+Search+Resource+V5) ``service.curricula``
+* [Department Search](https://wiki.cac.washington.edu/display/SWS/Department+Search+Resource+V5) ``service.departments``
+* [Enrollment](https://wiki.cac.washington.edu/display/SWS/Enrollment+Resource+V5) ``service.enrollment``
+* [Enrollment Search](https://wiki.cac.washington.edu/display/SWS/Enrollment+Search+Resource+V5) ``service.enrollments``
+* [Personal Financial](https://wiki.cac.washington.edu/display/SWS/Personal+Financial+Resource+V5) ``service.finance``
+* [Person](https://wiki.cac.washington.edu/display/SWS/Person+Resource+V5) ``service.person``
+* [Person Search](https://wiki.cac.washington.edu/display/SWS/Person+Search+Resource+V5) ``service.people``
+* [Registration](https://wiki.cac.washington.edu/display/SWS/Registration+Resource+V5) ``service.registration``
+* [Registration Search](https://wiki.cac.washington.edu/display/SWS/Registration+Search+Resource+v5) ``service.registrations``
+* [Section](https://wiki.cac.washington.edu/display/SWS/Section+Resource+V5) ``service.section``
+* [Section Search](https://wiki.cac.washington.edu/display/SWS/Section+Search+Resource+v5) ``service.sections``
+* [Term](https://wiki.cac.washington.edu/display/SWS/Term+Resource+V5) ``service.term``
+* [Test Score](https://wiki.cac.washington.edu/display/SWS/Test+Score+Resource+V5) ``service.test_score``
+
+#### Partially Supported (may or may not work)
+* [Notice](https://wiki.cac.washington.edu/display/SWS/Notice+Resource+V5) ``service.notice``
+
+#### Not implemented in this gem
+Most of these are not implemented due to additional security requirements beyond a simple 509 cert.  Requirements such as permissions in ASTRA or x-uw-act-as permissions passed in the header.  Feel free fork and make a pull request with working tests if you have those permissions.
+
+* [Degree Audit] (https://wiki.cac.washington.edu/display/SWS/SWS+v5+API) (all of them) under review
+* [Change of Major](https://wiki.cac.washington.edu/display/SWS/Change+of+Major+Resource) extra security needed
+* [Enrollment Majors ](https://wiki.cac.washington.edu/display/SWS/Enrollment+Majors) extra security needed
+* [Resource List](https://wiki.cac.washington.edu/display/SWS/Resource+List+V5) not needed!
+* [Section Status](https://wiki.cac.washington.edu/display/SWS/Section+Status+Resource+V5)  extra security needed
+* [Version List](https://wiki.cac.washington.edu/display/SWS/Version+List+Resource+v5) not needed!
 
 
 ## Development
@@ -45,7 +82,7 @@ If you pass ``use_cache: true`` as a parameter to ``UWStudentWebService.new`` al
     bundle install
 
 ### Setup and Tests
-Make sure to delete /test/test_private_endpoints.rb if you are not authorized at those endpoints otherwise half the tests will fail.  Change the ``cache`` symlink to point a valid path or create a directory for it like below.
+Change the ``cache`` symlink to point to a valid path or create a directory for it like below.  As you can see in ``/test`` you will need to also provide the full path to your 509 cert and key before running ``rake``.
 
     rm cache
     mkdir cache
@@ -59,5 +96,8 @@ Make sure to delete /test/test_private_endpoints.rb if you are not authorized at
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## TO DO
-The end points are going through some major changes this year (2014) and testing of those changes will be available in June.  A new major version will most likely be created to incorporate those changes since they are changing the way authorization works.
+### Changes Since < 2.0.0
+* v4 is no longer used, all queries are now against v5
+* no more public endpoints, all queries now require a cert
+* Endpoints that ended with _search have been changed to their plural form (person_search to people)
+* A few new endpoints were added, see list above for whats supported

data/lib/uw_sws/version.rb

@@ -1,3 +1,3 @@
 module UwSws
-  VERSION = "1.0.3"
+  VERSION = "2.0.0"
 end

data/lib/uw_sws.rb

@@ -6,71 +6,69 @@ class UwSws
   attr_reader :last, :next
 
   def initialize(throw_404: true, logger: Logger.new(STDOUT),
-                 use_cache: true, cert: "", key: "", throw_HEPPS: true)
-    @base             = "https://ws.admin.washington.edu/student/v4/public/"
-    @base_private     = "https://ws.admin.washington.edu/student/v4/"
+                 use_cache: true, cert: "", key: "", throw_HEPPS: true,
+                 base: "https://ws.admin.washington.edu/student/v5/")
+    @base             = base
     @last             = nil
     @next             = ""
     @use_cache        = use_cache
     @logger           = logger
     @throw_404        = throw_404
     @throw_HEPPS      = throw_HEPPS
-    @private_endpoint = false
     load_config(cert, key)
   end
 
   def campus
-    parse("#{endpoint}campus.json")
+    parse "campus.json"
   end
 
   def colleges(campus)
-    data = parse("#{endpoint}college.json?campus_short_name=#{campus}")
+    data = parse "college.json?campus_short_name=#{campus}"
 
     data["Colleges"]
   end
 
   def departments(college)
-    fix_param(college)
-    data = parse("#{endpoint}department.json?college_abbreviation=#{college}")
+    fix_param college
+    data = parse "department.json?college_abbreviation=#{college}"
 
     data["Departments"]
   end
 
   def curricula(year, quarter, department: "", count: 0)
-    fix_param(department)
-    data = parse("#{endpoint}curriculum.json?year=#{year}&quarter=#{quarter}"\
+    fix_param department
+    data = parse("curriculum.json?year=#{year}&quarter=#{quarter}"\
                  "&future_terms=#{count}&department_abbreviation=#{department}")
 
     data["Curricula"]
   end
 
-  def course(year, quarter, curriculum, number, is_private: false)
-    fix_param(curriculum)
-    data = parse("#{endpoint(is_private)}course/#{year},#{quarter},"\
-                 "#{curriculum},#{number}.json")
+  def course(year, quarter, curriculum, number)
+    fix_param curriculum
+    data = parse "course/#{year},#{quarter},#{curriculum},#{number}.json"
     data
   end
 
   def term(year, quarter)
-    parse("#{endpoint}term/#{year},#{quarter}.json")
+    parse "term/#{year},#{quarter}.json"
   end
 
   def term_current
-    parse("#{endpoint}term/current.json")
+    parse "term/current.json"
   end
 
   def term_next
-    parse("#{endpoint}term/next.json")
+    parse "term/next.json"
   end
 
   def term_previous
-    parse("#{endpoint}term/previous.json")
+    parse "term/previous.json"
   end
 
   def sections(year, curriculum: "", instructor: "", count: 0, quarter: "",
-               course_num: "", is_private: false)
-    fix_param(curriculum)
-    data = parse("#{endpoint(is_private)}section.json?year=#{year}"\
+               course_num: "")
+    fix_param curriculum
+    data = parse("section.json?year=#{year}"\
                  "&quarter=#{quarter}&curriculum_abbreviation=#{curriculum}"\
                  "&future_terms=#{count}&course_number=#{course_num}"\
                  "&reg_id=#{instructor}")
@@ -81,11 +79,10 @@ class UwSws
   def courses(year, quarter, curriculum: "", course: "", has_sections: "",
               size: 100, start: "", count: "", get_next: false)
     if get_next
-      url = @next.sub("student/v4/public/", "")
-      data = parse("#{endpoint}#{url}")
+      data = parse @next.sub("/student/v5/", "")
     else
-      fix_param(curriculum)
-      data = parse("#{endpoint}course.json?&year=#{year}&quarter=#{quarter}"\
+      fix_param curriculum
+      data = parse("course.json?&year=#{year}&quarter=#{quarter}"\
                    "&curriculum_abbreviation=#{curriculum}&"\
                    "course_number=#{course}&page_size=#{size}"\
                    "&page_start=#{start}"\
@@ -96,79 +93,51 @@ class UwSws
     data["Courses"]
   end
 
-  def section(year, quarter, curriculum, number, id, is_private: false)
-    fix_param(curriculum)
-    data = parse("#{endpoint(is_private)}course/#{year},#{quarter}," \
-                 "#{curriculum},#{number}/#{id}.json")
-
-    data
+  def section(year, quarter, curriculum, number, id)
+    fix_param curriculum
+    parse "course/#{year},#{quarter},#{curriculum},#{number}/#{id}.json"
   end
 
-  #
-  # these are for UW stff/faculty only, authentcation required
-  # other methods that have is_private: as a param option can call
-  # the private endpoint as well as the public endpoint
-  #
-
   def test_score(type, regid)
-    parse("#{endpoint(true)}testscore/#{type},#{regid}.json")
-  end
-
-  def enrollment_search(regid, verbose: "")
-    data = parse("#{endpoint(true)}enrollment.json?reg_id=#{regid}"\
-                 "&verbose=#{verbose}")
-
-    verbose.empty? ? data["EnrollmentLinks"] : data["Enrollments"]
+    parse "testscore/#{type},#{regid}.json"
   end
 
   def enrollment(year, quarter, regid, verbose: "")
-    parse("#{endpoint(true)}enrollment/#{year},#{quarter},#{regid}.json"\
-          "?verbose=#{verbose}")
+    parse "enrollment/#{year},#{quarter},#{regid}.json?verbose=#{verbose}"
   end
 
-  def section_status(year, quarter, curric, course, id)
-    fix_param(curric)
-
-    parse("#{endpoint(true)}course/#{year},#{quarter},#{curric}," \
-          "#{course}/#{id}/status.json")
-  end
+  def enrollments(regid, verbose: "")
+    data = parse "enrollment.json?reg_id=#{regid}&verbose=#{verbose}"
 
-  def term_private(year, quarter)
-    parse("#{endpoint(true)}term/#{year},#{quarter}.json")
-  end
-
-  def term_current_private
-    parse("#{endpoint(true)}term/current.json")
+    verbose.empty? ? data["EnrollmentLinks"] : data["Enrollments"]
   end
 
-  def term_next_private
-    parse("#{endpoint(true)}term/next.json")
-  end
+  def section_status(year, quarter, curric, course, id)
+    fix_param curric
 
-  def term_previous_private
-    parse("#{endpoint(true)}term/previous.json")
+    parse "course/#{year},#{quarter},#{curric},#{course}/#{id}/status.json"
   end
 
   def person(regid)
-    parse("#{endpoint(true)}person/#{regid}.json")
+    parse "person/#{regid}.json"
   end
 
-  def person_search(type, id)
-    parse("#{endpoint(true)}person.json?#{type}=#{id}")
+  def people(type, id)
+    parse "person.json?#{type}=#{id}"
   end
 
   def registration(year, quarter, curric, course, id, reg_id, dup_code = "")
-    fix_param(curric)
+    fix_param curric
 
-    parse("#{endpoint(true)}registration/#{year},#{quarter},#{curric}," \
+    parse("registration/#{year},#{quarter},#{curric}," \
           "#{course},#{id},#{reg_id},#{dup_code}.json")
   end
 
-  def registration_search(year, quarter, curriculum: "", course: "",
+  def registrations(year, quarter, curriculum: "", course: "",
                           section: "", reg_id: "", active: "",
                           reg_id_instructor: "")
-    fix_param(curriculum)
-    data = parse("#{endpoint(true)}registration.json?year=#{year}&"\
+    fix_param curriculum
+    data = parse("registration.json?year=#{year}&"\
                  "quarter=#{quarter}&curriculum_abbreviation=#{curriculum}&"\
                  "course_number=#{course}&section_id=#{section}&"\
                  "reg_id=#{reg_id}&is_active=#{active}&"\
@@ -177,6 +146,18 @@ class UwSws
     data["Registrations"]
   end
 
+  def notice(regid)
+    parse "notice/#{regid}.json"
+  end
+
+  def change_of_major(year, quarter, regid)
+    parse "enrollment/#{year},#{quarter},#{regid}/major.json"
+  end
+
+  def finance(regid)
+    parse "person/#{regid}/financial.json"
+  end
+
   private
 
   def default_logger
@@ -194,18 +175,12 @@ class UwSws
     end
   end
 
-  def endpoint(is_private = false)
-    @private_endpoint = is_private
-
-    is_private ? @base_private : @base
-  end
-
   def parse(url)
-    data = request(url)
+    data = request "#{@base}#{url}"
     return nil unless !data.nil?
-    data = clean(data)
+    data = clean data
 
-    @last = JSON.parse(data)
+    @last = JSON.parse data
     @logger.debug "fetched - #{@last}"
     @next = @last["Next"].nil? ? "" : @last["Next"]["Href"]
 
@@ -241,16 +216,12 @@ class UwSws
     data
   end
 
-  def restful_client(url, is_private: false)
-    if @private_endpoint
-      RestClient::Resource.new(
-        url,
-        ssl_client_cert: OpenSSL::X509::Certificate.new(@cert_file),
-        ssl_client_key: OpenSSL::PKey::RSA.new(@key_file),
-        log: @logger)
-    else
-      RestClient::Resource.new(url, log: @logger)
-    end
+  def restful_client(url)
+    RestClient::Resource.new(
+      url,
+      ssl_client_cert: OpenSSL::X509::Certificate.new(@cert_file),
+      ssl_client_key: OpenSSL::PKey::RSA.new(@key_file),
+      log: @logger)
   end
 
   def get_cache(file)
@@ -271,10 +242,10 @@ class UwSws
 
   def load_config(cert, key)
     if ! (cert.empty? && key.empty?)
-      does_exist?(cert)
-      @cert_file = File.read(cert)
-      does_exist?(key)
-      @key_file  = File.read(key)
+      does_exist? cert
+      @cert_file = File.read cert
+      does_exist? key
+      @key_file  = File.read key
       @logger.debug "loaded cert and key files"
     end
 
@@ -282,7 +253,7 @@ class UwSws
   end
 
   def does_exist?(file)
-    raise "Could not find #{file}" unless File.exist?(file)
+    raise "Could not find #{file}" unless File.exist? file
   end
 
   def clean_bools(data)
@@ -297,7 +268,7 @@ class UwSws
   end
 
   def clean(data)
-    data = clean_spaces(data)
-    data = clean_bools(data)
+    data = clean_spaces data
+    data = clean_bools data
   end
 end

data/test/test_endpoints.rb

@@ -0,0 +1,332 @@
+require "minitest/autorun"
+require "json"
+require "logger"
+require_relative "../lib/uw_sws"
+
+describe UwSws do
+  before do
+    log       = Logger.new("log.txt")
+    log.level = Logger::FATAL
+
+    # cert and key are required
+    # do not explicity set URL if you want to make sure to use v5 production
+    cert   = "/home/marc/.keys/milesm.bschool.pem"
+    key    = "/home/marc/.keys/ItsAllGood.key"
+    url    = "https://ucswseval1.cac.washington.edu/student/v5/"
+    @regid = "DB79E7927ECA11D694790004AC494FFE"
+    @uw    = UwSws.new(cert: cert, key: key, throw_HEPPS: false,
+                       logger: log, use_cache: true, base: url)
+  end
+
+  describe "when getting test scores " do
+    it "it must not be nil" do
+      @uw.test_score("SAT", "9136CCB8F66711D5BE060004AC494FFE")
+      @uw.last.wont_be_nil
+    end
+  end
+
+  describe "when getting term " do
+    it "it must not be nil" do
+      @uw.term(2013, :summer)
+      @uw.last.wont_be_nil
+    end
+  end
+
+  describe "when getting terms " do
+    it "must respond with a FirstDay" do
+      data = @uw.term(2013, :summer)
+      data["FirstDay"].wont_be_nil
+    end
+  end
+
+  describe "when getting section status " do
+    it "it must not be nil" do
+      # this endpoint requires extra permissions that I don't have
+      # @uw.section_status(2009, "winter", "MUSAP", 218, "A")
+      # @uw.last.wont_be_nil
+    end
+  end
+
+  describe "when getting sections " do
+    it "must return at least 5 of them" do
+      @uw.sections(1999, curriculum: "OPMGT").size.must_be :>, 5
+    end
+  end
+
+  describe "when getting a course " do
+    it "must return course data" do
+      data = @uw.course(1992, :autumn, "CSE", 142)
+      data["FirstEffectiveTerm"].wont_be_empty
+    end
+  end
+
+  describe "when getting a person " do
+    it "must not be nil" do
+      @uw.person(@regid)
+      @uw.last.wont_be_nil
+    end
+  end
+
+  describe "when doing a search for a person " do
+    it "each must not be nil" do
+      @uw.people("reg_id", @regid)
+      @uw.last.wont_be_nil
+      @uw.people("net_id", "milesm")
+      @uw.last.wont_be_nil
+      @uw.people("student_number", "0242267")
+      @uw.last.wont_be_nil
+      @uw.people("employee_id", "864004999")
+      @uw.last.wont_be_nil
+    end
+  end
+
+  describe "when doing an enrollment search " do
+    it "it must equal 2" do
+      @uw.enrollments(@regid).size.must_equal(2)
+    end
+  end
+
+  describe "when doing a verbose enrollment search " do
+    it "it must have 2" do
+      @uw.enrollments(@regid, verbose: "on").size.must_equal(2)
+    end
+  end
+
+  describe "when getting a grade within an enrollment " do
+    it "it must equal 3.9" do
+      data = @uw.enrollment(2002, :summer, @regid, verbose: "on")
+      data["Registrations"][0]["Grade"].must_equal("3.9")
+    end
+  end
+
+  #
+  # NOTE ABOUT REGISTRATION SEARCHES
+  # THEY ONLY WORK WITH CURRENT TERMS....
+  # these tests will fail unless the params are in the present year/quarter
+  #
+  describe "when getting a registration " do
+    it "it must not be nil" do
+      # since registrations are not available for prev terms
+      # make this a current year and valid regid
+      #
+      #term = @uw.term_current
+      #@uw.registration(term["Year"], term["Quarter"], "CSE", 142, "A",
+      #                 "6ADA93ABA771476481FE44FC086C74DA")
+      #@uw.last.wont_be_nil
+    end
+  end
+
+  describe "when searching for active course registrations " do
+    it "it must be greater than 100" do
+      term = @uw.term_current
+      data = @uw.registrations(term["Year"], term["Quarter"],
+                                     curriculum: "CSE", course: 142,
+                                     section: "A", active: "on")
+      data.size.must_be :>, 100
+    end
+  end
+
+  describe "when searching for course registrations " do
+    it "it must be greater than 200" do
+      term = @uw.term_current
+      data = @uw.registrations(term["Year"], term["Quarter"],
+                                     curriculum: "CSE", course: 142,
+                                     section: "A")
+      data.size.must_be :>, 200
+    end
+  end
+
+  describe "when searching for person registrations " do
+    it "it must have more than 1" do
+      # registrations are only available for current terms
+      term = @uw.term_current
+      data = @uw.registrations(term["Year"], term["Quarter"],
+                                     curriculum: "CSE", course: 142,
+                                     section: "A", active: "on")
+
+      result = @uw.registrations(term["Year"], term["Quarter"],
+                                       reg_id: data[0]["RegID"])
+      result.size.must_be :>, 0
+    end
+  end
+
+
+  describe "when getting campus list " do
+    it "must return at least 3 of them" do
+      data = @uw.campus
+      campus = data["Campuses"]
+      campus.size.must_be :>, 2
+    end
+  end
+
+  describe "when checking last response " do
+    it "it must not be nil" do
+      @uw.term(1921, :winter)
+      @uw.last.wont_be_nil
+    end
+  end
+
+
+  describe "when asked for the current, next and previous terms " do
+    it "each must respond with a FirstDay" do
+      @uw.term_current["FirstDay"].wont_be_nil
+      @uw.term_next["FirstDay"].wont_be_nil
+      @uw.term_previous["FirstDay"].wont_be_nil
+    end
+  end
+
+  describe "when asked for colleges " do
+    it "must return at least 10 of them" do
+      @uw.colleges("SEATTLE").size.must_be :>, 9
+    end
+  end
+
+  describe "when asked for departments " do
+    it "must return at least 12 of them" do
+      @uw.departments("A & S").size.must_be :>, 11
+    end
+  end
+
+  describe "when asked for curriculum " do
+    it "must return at least 5 of them" do
+      @uw.curricula(1999, :winter, department: "B A").size.must_be :>, 5
+    end
+  end
+
+  describe "when asked for all curricula in a year " do
+    it "must return at least 100 of them" do
+      # note...this can timeout if too many future terms are requested
+      @uw.curricula(1990, :autumn).size.must_be :>, 99
+    end
+  end
+
+  # section searches
+  #   instructor or curriculum are required
+  #   year is also required
+  #   with no quarter you get all quarters
+  #   quarter is required if searching by instructor
+  describe "when asked for sections " do
+    it "must return at least 5 of them" do
+      @uw.sections(1999, curriculum: "OPMGT").size.must_be :>, 5
+    end
+  end
+
+  describe "when asked for sections in a quarter " do
+    it "must return at least 5 of them" do
+      @uw.sections(2000, curriculum: "engl", quarter: :autumn)
+                  .size.must_be :>, 5
+    end
+  end
+
+  describe "when asked for future sections " do
+    it "must return at 898 of them" do
+      @uw.sections(2000, curriculum: "engl", quarter: :autumn, count: 3)
+                  .size.must_equal(898)
+    end
+  end
+
+  describe "when asked for sections in a course " do
+    it "must return at least 2 of them" do
+      @uw.sections(1992, curriculum: "OPMGT", quarter: :winter,
+                   course_num: 301).size.must_be :>, 2
+    end
+  end
+
+  describe "when asked for sections an instructor is teaching " do
+    it "must return at least 1 of them" do
+      @uw.sections(2009, instructor: "78BE067C6A7D11D5A4AE0004AC494FFE",
+                   quarter: :summer).size.must_be :>, 0
+    end
+  end
+
+  describe "when asked for section with a HEPPS error " do
+    it "must respond with error 500" do
+      @uw.section(2013, :autumn, "PB AF", 521, "A").must_be_nil
+    end
+  end
+  # course searches
+  #   curric is not needed if searching by course number
+  #   future terms must be 0-2, but, must be zero if exclude course w/o section
+  #   make sure to page larger results using page_size and page_start
+  #     while !@uw.next.nil?
+  #        get result, append, next
+  #   the following query string attributes dont seem to work
+  #     course_title_starts, course_title_contains,
+
+  describe "when asked for courses in a curriculum " do
+    it "must return at least 10 of them" do
+      @uw.courses(1985, :winter, curriculum: "GEOG").size.must_be :>, 9
+    end
+  end
+
+  describe "when asked for courses having number = 100 " do
+    it "must return at least 10 of them" do
+      @uw.courses(1985, :winter, course: 100).size.must_be :>, 9
+    end
+  end
+
+  describe "when asked for courses having number = 100 with future terms " do
+    it "must return at least 10 of them" do
+      @uw.courses(2013, :winter, course: 100, count: 2).size.must_be :>, 9
+    end
+  end
+
+  describe "when asked for courses in a curriculum having sections " do
+    it "must return at least 5 of them" do
+      @uw.courses(2005, :autumn, curriculum: "ENGL", has_sections: "on")
+                  .size.must_be :>, 5
+    end
+  end
+
+  describe "when paging courses in a curriculum " do
+    it "must have a url that indicates next page" do
+      # this particular curric has 107 courses
+      # ideally, you would want to join results until .next is empty
+      @uw.courses(1985, :autumn, curriculum: "GEOG", size: 25)
+      @uw.next.wont_be_empty
+      @uw.courses(nil, nil, get_next: true).size.must_equal(25)
+      @uw.courses(nil, nil, get_next: true).size.must_equal(25)
+      @uw.courses(nil, nil, get_next: true).size.must_equal(25)
+      @uw.courses(nil, nil, get_next: true).size.must_equal(7)
+      @uw.next.must_be_empty
+    end
+  end
+
+  describe "when asked for a section " do
+    it "must have 8 enrolled" do
+      # who were these first 8 to take this infamous course?
+      # I took it in 2002...it was C++ then
+      data = @uw.section(1992, :autumn, "CSE", 142, "AA")
+      data["CurrentEnrollment"].must_equal(8)
+    end
+  end
+
+  describe "when asked to test a section with a zero start room number " do
+    it "must return without error" do
+      @uw.section(2010, "spring", "ARTS", 150, "A").wont_be_nil
+    end
+  end
+
+  describe "when getting notices " do
+    it "it must not be nil" do
+      term = @uw.term_current
+      data = @uw.registrations(term["Year"], term["Quarter"],
+                                     curriculum: "CSE", course: 142,
+                                     section: "A", active: "on")
+
+      # the following generates 500 errors...
+      #puts @uw.notice data[0]["RegID"]
+    end
+  end
+
+  describe "when getting financial info " do
+    it "it must not be nil" do
+      term = @uw.term_current
+      data = @uw.registrations(term["Year"], term["Quarter"],
+                                     curriculum: "CSE", course: 142,
+                                     section: "A", active: "on")
+      result = @uw.finance data[0]["RegID"]
+      result["Person"].wont_be_nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uw_sws
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Nogbit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -66,8 +66,7 @@ files:
 - Rakefile
 - lib/uw_sws.rb
 - lib/uw_sws/version.rb
-- test/test_private_endpoints.rb
-- test/test_public_endpoints.rb
+- test/test_endpoints.rb
 - uw_sws.gemspec
 homepage: https://github.com/UWFosterIT/uwsws
 licenses:
@@ -89,10 +88,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Wraps most of the rest endpoints
 test_files:
-- test/test_private_endpoints.rb
-- test/test_public_endpoints.rb
+- test/test_endpoints.rb

data/test/test_private_endpoints.rb

@@ -1,161 +0,0 @@
-require "minitest/autorun"
-require "json"
-require "logger"
-require_relative "../lib/uw_sws"
-
-describe UwSws do
-  before do
-    log       = Logger.new("log.txt")
-    log.level = Logger::FATAL
-
-    cert   = "/home/marc/.keys/milesm.bschool.pem"
-    key    = "/home/marc/.keys/ItsAllGood.key"
-    @regid = "DB79E7927ECA11D694790004AC494FFE"
-    @uw    = UwSws.new(cert: cert, key: key, logger: log, use_cache: true)
-  end
-
-  #
-  # all of these test are for private endpoints
-  # they require that you initialize the service with a cert
-  # and a key file as they are required for all of these tests.
-  # Simply delete this test if you want your rake to pass and are
-  # not using these endpoints
-  #
-  describe "when getting test score private endpoint " do
-    it "it must not be nil" do
-      @uw.test_score("SAT", "9136CCB8F66711D5BE060004AC494FFE")
-      @uw.last.wont_be_nil
-    end
-  end
-
-  describe "when getting term private endpoint " do
-    it "it must not be nil" do
-      @uw.term_private(2013, "autumn")
-      @uw.last.wont_be_nil
-    end
-  end
-
-  describe "when asked for the current, next and previous term private " do
-    it "each must respond with a FirstDay" do
-      @uw.term_current_private["FirstDay"].wont_be_nil
-      @uw.term_next_private["FirstDay"].wont_be_nil
-      @uw.term_previous_private["FirstDay"].wont_be_nil
-    end
-  end
-
-  describe "when getting section status private endpoint " do
-    it "it must not be nil" do
-      # this endpoint requires extra permissions that I dont have
-      # @uw.section_status(2009, "winter", "MUSAP", 218, "A")
-      # @uw.last.wont_be_nil
-    end
-  end
-
-  describe "when getting sections private endpoint " do
-    it "must return at least 5 of them" do
-      @uw.sections(1999, curriculum: "OPMGT", is_private: true)
-                   .size.must_be :>, 5
-    end
-  end
-
-  describe "when getting a section private endpoint " do
-    it "must have 8 enrolled" do
-      data = @uw.section(1992, "autumn", "CSE", 142, "AA", is_private: true)
-      data["CurrentEnrollment"].must_equal("8")
-    end
-  end
-
-  describe "when getting a course private endpoint " do
-    it "must return course data" do
-      data = @uw.course(1992, "autumn", "CSE", 142, is_private: true)
-      data["FirstEffectiveTerm"].wont_be_empty
-    end
-  end
-
-  describe "when getting a person private endpoint " do
-    it "must not be nil" do
-      @uw.person(@regid)
-      @uw.last.wont_be_nil
-    end
-  end
-
-  describe "when doing a search for a person private endpoint " do
-    it "each must not be nil" do
-      @uw.person_search("reg_id", @regid)
-      @uw.last.wont_be_nil
-      @uw.person_search("net_id", "milesm")
-      @uw.last.wont_be_nil
-      @uw.person_search("student_number", "0242267")
-      @uw.last.wont_be_nil
-      @uw.person_search("employee_id", "864004999")
-      @uw.last.wont_be_nil
-    end
-  end
-
-  describe "when doing an enrollment search private endpoint " do
-    it "it must equal 2" do
-      @uw.enrollment_search(@regid).size.must_equal(2)
-    end
-  end
-
-  describe "when doing a verbose enrollment search private endpoint " do
-    it "it must have 2" do
-      @uw.enrollment_search(@regid, verbose: "on").size.must_equal(2)
-    end
-  end
-
-  describe "when getting a grade within an enrollment private endpoint " do
-    it "it must equal 3.9" do
-      data = @uw.enrollment(2002, "summer", @regid, verbose: "on")
-      data["Registrations"][0]["Grade"].must_equal("3.9")
-    end
-  end
-
-  #
-  # NOTE ABOUT REGISTRATION SEARCHES
-  # THEY ONLY WORK WITH CURRENT TERMS....
-  # these tests will fail unless the params are in the present year/quarter
-  #
-  describe "when getting a registration private endpoint " do
-    it "it must not be nil" do
-      # since registrations are not available for prev terms
-      # make this a current year and valid regid
-      #
-      #term = @uw.term_current
-      #@uw.registration(term["Year"], term["Quarter"], "CSE", 142, "A",
-      #                 "6ADA93ABA771476481FE44FC086C74DA")
-      #@uw.last.wont_be_nil
-    end
-  end
-
-  describe "when searching for active course registrations private endpoint " do
-    it "it must be greater than 100" do
-      term = @uw.term_current
-      data = @uw.registration_search(term["Year"], term["Quarter"],
-                                     curriculum: "CSE", course: 142,
-                                     section: "A", active: "on")
-      data.size.must_be :>, 100
-    end
-  end
-
-  describe "when searching for course registrations private endpoint " do
-    it "it must be greater than 200" do
-      term = @uw.term_current
-      data = @uw.registration_search(term["Year"], term["Quarter"],
-                                     curriculum: "CSE", course: 142,
-                                     section: "A")
-      data.size.must_be :>, 200
-    end
-  end
-
-  describe "when searching for person registrations private endpoint " do
-    it "it must have more than 10" do
-      # since registrations are not available for prev terms
-      # make this a current year and valid regid
-      #
-      #@uw.registration_search(2013, "autumn",
-      #                        reg_id: "6ADA93ABA771476481FE44FC086C74DA")
-      #   .size.must_be :>, 10
-    end
-  end
-end

data/test/test_public_endpoints.rb

@@ -1,201 +0,0 @@
-require "minitest/autorun"
-require "json"
-require "logger"
-require_relative "../lib/uw_sws"
-
-describe UwSws do
-  before do
-    log       = Logger.new("log.txt")
-    log.level = Logger::FATAL
-    @uw       = UwSws.new(logger: log, use_cache: true, throw_HEPPS: false)
-  end
-
-  def terms
-    [:winter, :spring, :summer, :autumn]
-  end
-
-  describe "when asked for campus " do
-    it "must return at least 3 of them" do
-      data = @uw.campus
-      campus = data["Campuses"]
-      campus.size.must_be :>, 2
-    end
-  end
-
-  describe "web checking last RESTful respone " do
-    it "it must not be nil" do
-      @uw.term(1921, terms[0])
-      @uw.last.wont_be_nil
-    end
-  end
-
-  describe "web asked for terms " do
-    it "must respond with a FirstDay" do
-      data = @uw.term(2013, terms[2])
-      data["FirstDay"].wont_be_nil
-    end
-  end
-
-  describe "when asked for the current, next and previous terms " do
-    it "each must respond with a FirstDay" do
-      @uw.term_current["FirstDay"].wont_be_nil
-      @uw.term_next["FirstDay"].wont_be_nil
-      @uw.term_previous["FirstDay"].wont_be_nil
-    end
-  end
-
-  describe "when asked for colleges " do
-    it "must return at least 10 of them" do
-      @uw.colleges("SEATTLE").size.must_be :>, 9
-    end
-  end
-
-  describe "when asked for departments " do
-    it "must return at least 12 of them" do
-      @uw.departments("A & S").size.must_be :>, 11
-    end
-  end
-
-  describe "when asked for curriculumn " do
-    it "must return at least 5 of them" do
-      @uw.curricula(1999, terms[0], department: "B A").size.must_be :>, 5
-    end
-  end
-
-  describe "when asked for all curricula in a year " do
-    it "must return at least 100 of them" do
-      # note...this can timeout if too many future terms are requested
-      @uw.curricula(1990, terms[3]).size.must_be :>, 99
-    end
-  end
-
-  # section searches
-  #   instructor or curriculumn are required
-  #   year is also required
-  #   with no quarter you get all quarters
-  #   quarter is required if searching by instructor
-  describe "when asked for sections " do
-    it "must return at least 5 of them" do
-      @uw.sections(1999, curriculum: "OPMGT").size.must_be :>, 5
-    end
-  end
-
-  describe "when asked for sections in a quarter " do
-    it "must return at least 5 of them" do
-      @uw.sections(2000, curriculum: "engl", quarter: "autumn")
-                  .size.must_be :>, 5
-    end
-  end
-
-  describe "when asked for future sections " do
-    it "must return at 898 of them" do
-      @uw.sections(2000, curriculum: "engl", quarter: "autumn", count: 3)
-                  .size.must_equal(898)
-    end
-  end
-
-  describe "when asked for sections in a course " do
-    it "must return at least 2 of them" do
-      @uw.sections(1992, curriculum: "OPMGT", quarter: "winter",
-                   course_num: 301).size.must_be :>, 2
-    end
-  end
-
-  describe "when asked for sections an instructor is teaching " do
-    it "must return at least 1 of them" do
-      @uw.sections(2009, instructor: "78BE067C6A7D11D5A4AE0004AC494FFE",
-                   quarter: terms[2]).size.must_be :>, 0
-    end
-  end
-
-  describe "when asked for section with a HEPPS error " do
-    it "must respond with error 500" do
-      @uw.section(2013, "autumn", "PB AF", 521, "A").must_be_nil
-    end
-  end
-  # course searches
-  #   cirric is not needed if searching by course number
-  #   future terms must be 0-2, but, must be zero if exclude course w/o section
-  #   make sure to page larger results using page_size and page_start
-  #     while !@uw.next.nil?
-  #        get result, append, next
-  #   the following query string attributes dont seem to work
-  #     course_title_starts, course_title_contains,
-
-  describe "when asked for courses in a curriculm " do
-    it "must return at least 10 of them" do
-      @uw.courses(1985, "winter", curriculum: "GEOG").size.must_be :>, 9
-    end
-  end
-
-  describe "when asked for courses having number = 100 " do
-    it "must return at least 10 of them" do
-      @uw.courses(1985, "winter", course: 100).size.must_be :>, 9
-    end
-  end
-
-  describe "when asked for courses having number = 100 with future terms " do
-    it "must return at least 10 of them" do
-      @uw.courses(2013, "winter", course: 100, count: 2).size.must_be :>, 9
-    end
-  end
-
-  describe "when asked for courses in a curriculm having sections " do
-    it "must return at least 5 of them" do
-      @uw.courses(2005, "autumn", curriculum: "ENGL", has_sections: "on")
-                  .size.must_be :>, 5
-    end
-  end
-
-  describe "when paging courses in a curriculm " do
-    it "must have a url that indicates next page" do
-      # this particular curric has 107 courses
-      # ideally, you would want to join results until .next is empty
-      @uw.courses(1985, "autumn", curriculum: "GEOG", size: 25)
-      @uw.next.wont_be_empty
-      @uw.courses(nil, nil, get_next: true).size.must_equal(25)
-      @uw.courses(nil, nil, get_next: true).size.must_equal(25)
-      @uw.courses(nil, nil, get_next: true).size.must_equal(25)
-      @uw.courses(nil, nil, get_next: true).size.must_equal(7)
-      @uw.next.must_be_empty
-    end
-  end
-
-  describe "when asked for courses without sections " do
-    it "must return less than with sections" do
-      @uw.courses(1985, "autumn", curriculum: "GEOG", size: 150)
-      count_with = @uw.last["TotalCount"]
-
-      @uw.courses(1985, "autumn", curriculum: "GEOG", size: 150,
-                  has_sections: "on")
-      count_without = @uw.last["TotalCount"]
-
-      count_with.must_be :>, count_without
-    end
-  end
-
-  #
-  # remaining public endpoints
-  #
-  describe "when asked for a course " do
-    it "must return course data" do
-      data = @uw.course(1992, "autumn", "CSE", 142)
-      data["FirstEffectiveTerm"].wont_be_empty
-    end
-  end
-
-  describe "when asked for a section " do
-    it "must have 8 enrolled" do
-      # who were these first 8 to take this infamous course?
-      # I took it in 2002...it was C++ then
-      data = @uw.section(1992, "autumn", "CSE", 142, "AA")
-      data["CurrentEnrollment"].must_equal("8")
-    end
-  end
-
-  describe "when asked to test a section with a zero start room number " do
-    it "must return without error" do
-      @uw.section(2010, "spring", "ARTS", 150, "A").wont_be_nil
-    end
-  end
-end