clever-ruby 0.6.2 → 0.7.0

data/test/data/vcr_cassettes/teachers.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: ''
     headers:
       Accept:
-      - "*/*; q=0.5, application/xml"
+      - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
@@ -23,13 +23,13 @@ http_interactions:
       Access-Control-Allow-Methods:
       - GET,PATCH,POST,DELETE
       Access-Control-Allow-Origin:
-      - "*"
+      - ! '*'
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Tue, 09 Sep 2014 21:49:06 GMT
+      - Fri, 12 Sep 2014 20:48:34 GMT
       Etag:
-      - '"-409931571"'
+      - ! '"-409931571"'
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -39,8 +39,8 @@ http_interactions:
       Connection:
       - keep-alive
     body:
-      encoding: UTF-8
-      string: '{"data":[{"data":{"created":"2012-11-11T15:00:14.036Z","credentials":{"district_password":"Acoev0oow4","district_username":"spinka_leo"},"district":"4fd43cc56d11340000000005","email":"spinka.leo@example.net","last_modified":"2014-02-26T21:15:01.038Z","name":{"first":"Leo","last":"Spinka","middle":"R"},"school":"530e595026403103360ff9fe","sis_id":"11","teacher_number":"539224","title":"Grade
+      encoding: US-ASCII
+      string: ! '{"data":[{"data":{"created":"2012-11-11T15:00:14.036Z","credentials":{"district_password":"Acoev0oow4","district_username":"spinka_leo"},"district":"4fd43cc56d11340000000005","email":"spinka.leo@example.net","last_modified":"2014-02-26T21:15:01.038Z","name":{"first":"Leo","last":"Spinka","middle":"R"},"school":"530e595026403103360ff9fe","sis_id":"11","teacher_number":"539224","title":"Grade
         3 Common Branch Teacher","id":"509fbd7ec474fab64a8e9d53"},"uri":"/v1.1/teachers/509fbd7ec474fab64a8e9d53"},{"data":{"created":"2012-11-27T15:04:48.474Z","credentials":{"district_password":"OMeitoo3v","district_username":"reuben.conn"},"district":"4fd43cc56d11340000000005","email":"conn_reuben@example.net","last_modified":"2014-02-26T21:15:01.234Z","name":{"first":"Reuben","last":"Conn","middle":"K"},"school":"530e595026403103360ff9ff","sis_id":"33","teacher_number":"215041","title":"Grade
         8 Mathematics Teacher","id":"50b4d690ad221ab95f1c6c39"},"uri":"/v1.1/teachers/50b4d690ad221ab95f1c6c39"},{"data":{"created":"2012-12-01T15:02:36.961Z","credentials":{"district_password":"ru3o8rusbf","district_username":"steven.ogden"},"district":"4fd43cc56d11340000000005","email":"ogden_steven@example.net","last_modified":"2014-02-26T21:15:01.485Z","name":{"first":"Steven","last":"Ogden","middle":"Q"},"school":"530e595026403103360ff9fd","sis_id":"81","teacher_number":"474958","title":"High
         School Science Teacher","id":"50ba1c0c4eda5d94372227eb"},"uri":"/v1.1/teachers/50ba1c0c4eda5d94372227eb"},{"data":{"created":"2012-12-05T15:00:02.670Z","credentials":{"district_password":"Coo0ooyahgh","district_username":"hauck.haylie"},"district":"4fd43cc56d11340000000005","email":"hauck.haylie@example.com","last_modified":"2014-02-26T21:15:01.358Z","name":{"first":"Haylie","last":"Hauck","middle":"J"},"school":"530e595026403103360ff9fd","sis_id":"48","teacher_number":"830340","title":"Grade
@@ -131,7 +131,7 @@ http_interactions:
         Coach","id":"530e5955d50c310f36112c18"},"uri":"/v1.1/teachers/530e5955d50c310f36112c18"},{"data":{"created":"2014-02-26T21:15:01.572Z","credentials":{"district_username":"m_paucek","district_password":"jhga8salgh"},"district":"4fd43cc56d11340000000005","email":"paucek_m@example.org","last_modified":"2014-02-26T21:15:01.574Z","name":{"first":"Meaghan","middle":"P","last":"Paucek"},"school":"530e595026403103360ff9fd","sis_id":"93","teacher_number":"843713","title":"High
         School Drama Teacher","id":"530e5955d50c310f36112c19"},"uri":"/v1.1/teachers/530e5955d50c310f36112c19"}],"paging":{"current":1,"total":1,"count":89},"links":[{"rel":"self","uri":"/v1.1/teachers"}]}'
     http_version: 
-  recorded_at: Tue, 09 Sep 2014 21:49:06 GMT
+  recorded_at: Fri, 12 Sep 2014 20:48:34 GMT
 - request:
     method: get
     uri: https://DEMO_KEY:@api.clever.com/v1.1/teachers?count=true
@@ -140,7 +140,7 @@ http_interactions:
       string: ''
     headers:
       Accept:
-      - "*/*; q=0.5, application/xml"
+      - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
@@ -155,11 +155,11 @@ http_interactions:
       Access-Control-Allow-Methods:
       - GET,PATCH,POST,DELETE
       Access-Control-Allow-Origin:
-      - "*"
+      - ! '*'
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Tue, 09 Sep 2014 21:49:06 GMT
+      - Fri, 12 Sep 2014 20:48:34 GMT
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -169,8 +169,8 @@ http_interactions:
       Connection:
       - keep-alive
     body:
-      encoding: UTF-8
-      string: '{"count":89,"links":[{"rel":"self","uri":"/v1.1/teachers?count=true"}]}'
+      encoding: US-ASCII
+      string: ! '{"count":89,"links":[{"rel":"self","uri":"/v1.1/teachers?count=true"}]}'
     http_version: 
-  recorded_at: Tue, 09 Sep 2014 21:49:06 GMT
+  recorded_at: Fri, 12 Sep 2014 20:48:34 GMT
 recorded_with: VCR 2.4.0

data/test/integration/api_operations/list_test.rb

@@ -28,7 +28,7 @@ describe Clever::APIOperations::List do
   end
 
   [[Clever::District, 1], [Clever::School, 3], [Clever::Teacher, 89],
-   [Clever::Student, 1004], [Clever::Section, 379], [Clever::Event, 13]].each do |test_data|
+   [Clever::Student, 1004], [Clever::Section, 379], [Clever::Event, 7]].each do |test_data|
     resource, expected = test_data
     name = resource_name resource
 

data/test/integration/district_test.rb

@@ -3,14 +3,6 @@ require 'test_helper'
 module Minitest
   # Add assertions to Minitest
   module Assertions
-    def assert_valid_object_list(plural_object_name, object_count, instance_name)
-      VCR.use_cassette("districts_#{plural_object_name}", allow_playback_repeats: true) do
-        district = Clever::District.all.first
-        district.send(plural_object_name).size.must_equal object_count
-        district.send(plural_object_name).first.must_be_instance_of instance_name
-      end
-    end
-
     def assert_valid_object_pages(object_name, limit, page_count)
       VCR.use_cassette("districts_#{object_name}_pages", allow_playback_repeats: true) do
         district = Clever::District.all.first
@@ -34,54 +26,30 @@ end
 describe Clever::District do
   before do
     Clever.configure do |config|
-      config.api_key = 'DEMO_KEY'
+      config.token = 'DEMO_TOKEN'
     end
   end
 
-  it "retrieves a district's schools" do
-    assert_valid_object_list 'schools', 3, Clever::School
-  end
-
-  it "retrieves a district's teachers" do
-    assert_valid_object_list 'teachers', 89, Clever::Teacher
-  end
-
-  it "retrieves a district's sections" do
-    assert_valid_object_list 'sections', 100, Clever::Section
-  end
-
-  it "retrieves a district's students" do
-    assert_valid_object_list 'students', 100, Clever::Student
-  end
-
-  it "retrieves a district's events" do
-    assert_valid_object_list 'events', 13, Clever::Event
-  end
-
-  it "retrieves a district's students with a small filter" do
-    VCR.use_cassette('districts_students_filtered') do
-      @district = Clever::District.all.first
-      @district.students(limit: 2).size.must_equal 2
+  # TODO: this is outdated and should be removed!
+  describe 'pages methods' do
+    it "pages a district's schools" do
+      assert_valid_object_pages 'school', 2, 2
     end
-  end
 
-  it "pages a district's schools" do
-    assert_valid_object_pages 'school', 2, 2
-  end
-
-  it "pages a district's teachers" do
-    assert_valid_object_pages 'teacher', 10, 9
-  end
+    it "pages a district's teachers" do
+      assert_valid_object_pages 'teacher', 10, 9
+    end
 
-  it "pages a district's sections" do
-    assert_valid_object_pages 'section', 10, 38
-  end
+    it "pages a district's sections" do
+      assert_valid_object_pages 'section', 10, 38
+    end
 
-  it "pages a district's students" do
-    assert_valid_object_pages 'student', 50, 21
-  end
+    it "pages a district's students" do
+      assert_valid_object_pages 'student', 50, 21
+    end
 
-  it "pages a district's events" do
-    assert_valid_object_pages 'event', 1, 14
+    it "pages a district's events" do
+      assert_valid_object_pages 'event', 1, 8
+    end
   end
 end

data/test/integration/error_handling_test.rb

@@ -12,7 +12,7 @@ describe 'Error handling' do
     VCR.use_cassette('error_handling') do
       @district = Clever::District.all.first
       lambda do
-        @district.events created_since: '2013-02-15T 2:30:42 0000'
+        @district.events(created_since: '2013-02-15T 2:30:42 0000').first
       end.must_raise Clever::InvalidRequestError
     end
   end

data/test/integration/nested_resource_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+describe Clever::NestedResource do
+  before do
+    Clever.configure do |config|
+      config.token = 'DEMO_TOKEN'
+    end
+  end
+
+  [Clever::District, Clever::School, Clever::Student,
+   Clever::Event, Clever::Section, Clever::Teacher].each do |resource|
+    next if resource.linked_resources.nil?
+    resource.linked_resources.each do |link|
+      it "retrieves a #{resource.shortname}'s #{link}" do
+        VCR.use_cassette("#{resource.shortname}_#{link}") do
+          result = resource.find.first.send link
+          if Clever::Util.singular?(link.to_s)
+            result.must_be_instance_of Clever::APIResource.named(link.to_s)
+          else
+            result.must_be_instance_of Clever::NestedResource
+            result.size.must_equal result.count # check count request measures actual data size
+          end
+        end
+      end
+    end
+  end
+end

data/test/unit/api_resource_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+describe Clever::APIResource do
+  describe :named do
+    let :resources do
+      { district: Clever::District,
+        school: Clever::School,
+        section: Clever::Section,
+        event: Clever::Event,
+        teacher: Clever::Teacher,
+        student: Clever::Student }
+    end
+
+    it 'returns nil on nonexistent resources' do
+      Clever::APIResource.named('fake_resource').must_equal nil
+    end
+
+    it 'returns valid responses for both symbol and string inputs' do
+      resources.each do |res_name, klass|
+        Clever::APIResource.named(res_name.to_s).must_equal klass
+        Clever::APIResource.named(res_name.to_sym).must_equal klass
+      end
+    end
+
+    it 'returns valid responses for both singular and plural words' do
+      resources.each do |res_name, klass|
+        Clever::APIResource.named(res_name.to_s).must_equal klass
+        Clever::APIResource.named(res_name.to_s.pluralize).must_equal klass
+      end
+    end
+  end
+end

data/test/unit/optional_attributes_test.rb

@@ -13,27 +13,21 @@ describe 'Optional attributes' do
   end
 
   it 'returns nil for an optional attribute that isnt present' do
-    school = @schools.find { |s| s.id == '530e595026403103360ff9fd' }
-
-    # add an attribute that will not be exist in the test data
-    ops = school.optional_attributes
-    ops << :legit_attribute
-    Clever::School.class_eval "
-      def optional_attributes
-        #{ops}
-      end"
+    school = Clever::School.new 1
 
     # Must not raise a NoMethodError.
-    school.legit_attribute.must_equal nil
+    school.state_id.must_equal nil
   end
 
   it 'has the expected value for an optional attribute that is present' do
-    school = @schools.find { |s| s.id == '530e595026403103360ff9fd' }
-    school.state_id.must_equal '712345'
+    VCR.use_cassette('optional_present') do
+      school = @schools.find { |s| s.id == '530e595026403103360ff9fd' }
+      school.state_id.must_equal '712345'
+    end
   end
 
   it 'raises a NoMethodError for an invalid attribute' do
-    school = @schools.find { |s| s.id == '530e595026403103360ff9fd' }
+    school = Clever::School.new 1
     -> { school.some_attribute_that_doesnt_exist }.must_raise NoMethodError
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clever-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Clever Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -185,6 +185,7 @@ files:
 - clever-ruby.gemspec
 - lib/clever-ruby.rb
 - lib/clever-ruby/api_operations/list.rb
+- lib/clever-ruby/api_operations/nested_list.rb
 - lib/clever-ruby/api_operations/page.rb
 - lib/clever-ruby/api_operations/pagelist.rb
 - lib/clever-ruby/api_operations/results_list.rb
@@ -199,6 +200,7 @@ files:
 - lib/clever-ruby/errors/invalid_request_error.rb
 - lib/clever-ruby/event.rb
 - lib/clever-ruby/json.rb
+- lib/clever-ruby/nested_resource.rb
 - lib/clever-ruby/school.rb
 - lib/clever-ruby/section.rb
 - lib/clever-ruby/student.rb
@@ -206,21 +208,20 @@ files:
 - lib/clever-ruby/util.rb
 - lib/clever-ruby/version.rb
 - test/data/vcr_cassettes/district_count.yml
+- test/data/vcr_cassettes/district_events.yml
 - test/data/vcr_cassettes/district_find_by_page.yml
 - test/data/vcr_cassettes/district_find_multiple.yml
 - test/data/vcr_cassettes/district_find_one.yml
+- test/data/vcr_cassettes/district_schools.yml
+- test/data/vcr_cassettes/district_sections.yml
+- test/data/vcr_cassettes/district_students.yml
+- test/data/vcr_cassettes/district_teachers.yml
 - test/data/vcr_cassettes/districts.yml
 - test/data/vcr_cassettes/districts_event_pages.yml
-- test/data/vcr_cassettes/districts_events.yml
 - test/data/vcr_cassettes/districts_school_pages.yml
-- test/data/vcr_cassettes/districts_schools.yml
 - test/data/vcr_cassettes/districts_section_pages.yml
-- test/data/vcr_cassettes/districts_sections.yml
 - test/data/vcr_cassettes/districts_student_pages.yml
-- test/data/vcr_cassettes/districts_students.yml
-- test/data/vcr_cassettes/districts_students_filtered.yml
 - test/data/vcr_cassettes/districts_teacher_pages.yml
-- test/data/vcr_cassettes/districts_teachers.yml
 - test/data/vcr_cassettes/error_handling.yml
 - test/data/vcr_cassettes/event_count.yml
 - test/data/vcr_cassettes/event_find_by_page.yml
@@ -228,30 +229,53 @@ files:
 - test/data/vcr_cassettes/event_find_one.yml
 - test/data/vcr_cassettes/events.yml
 - test/data/vcr_cassettes/school_count.yml
+- test/data/vcr_cassettes/school_district.yml
+- test/data/vcr_cassettes/school_events.yml
 - test/data/vcr_cassettes/school_find_by_page.yml
 - test/data/vcr_cassettes/school_find_multiple.yml
 - test/data/vcr_cassettes/school_find_one.yml
+- test/data/vcr_cassettes/school_sections.yml
+- test/data/vcr_cassettes/school_students.yml
+- test/data/vcr_cassettes/school_teachers.yml
 - test/data/vcr_cassettes/schools.yml
 - test/data/vcr_cassettes/schools_optional_attributes.yml
 - test/data/vcr_cassettes/section_count.yml
+- test/data/vcr_cassettes/section_district.yml
+- test/data/vcr_cassettes/section_events.yml
 - test/data/vcr_cassettes/section_find_by_page.yml
 - test/data/vcr_cassettes/section_find_multiple.yml
 - test/data/vcr_cassettes/section_find_one.yml
+- test/data/vcr_cassettes/section_school.yml
+- test/data/vcr_cassettes/section_students.yml
+- test/data/vcr_cassettes/section_teacher.yml
 - test/data/vcr_cassettes/sections.yml
 - test/data/vcr_cassettes/student_count.yml
+- test/data/vcr_cassettes/student_district.yml
+- test/data/vcr_cassettes/student_events.yml
 - test/data/vcr_cassettes/student_find_by_page.yml
 - test/data/vcr_cassettes/student_find_multiple.yml
 - test/data/vcr_cassettes/student_find_one.yml
+- test/data/vcr_cassettes/student_school.yml
+- test/data/vcr_cassettes/student_sections.yml
+- test/data/vcr_cassettes/student_teacher.yml
+- test/data/vcr_cassettes/student_teachers.yml
 - test/data/vcr_cassettes/students.yml
 - test/data/vcr_cassettes/teacher_count.yml
+- test/data/vcr_cassettes/teacher_district.yml
+- test/data/vcr_cassettes/teacher_events.yml
 - test/data/vcr_cassettes/teacher_find_by_page.yml
 - test/data/vcr_cassettes/teacher_find_multiple.yml
 - test/data/vcr_cassettes/teacher_find_one.yml
+- test/data/vcr_cassettes/teacher_school.yml
+- test/data/vcr_cassettes/teacher_sections.yml
+- test/data/vcr_cassettes/teacher_students.yml
 - test/data/vcr_cassettes/teachers.yml
 - test/integration/api_operations/list_test.rb
 - test/integration/district_test.rb
 - test/integration/error_handling_test.rb
+- test/integration/nested_resource_test.rb
 - test/test_helper.rb
+- test/unit/api_resource_test.rb
 - test/unit/clever_test.rb
 - test/unit/configuration_test.rb
 - test/unit/event_test.rb
@@ -281,21 +305,20 @@ specification_version: 4
 summary: Ruby bindings to the Clever API.
 test_files:
 - test/data/vcr_cassettes/district_count.yml
+- test/data/vcr_cassettes/district_events.yml
 - test/data/vcr_cassettes/district_find_by_page.yml
 - test/data/vcr_cassettes/district_find_multiple.yml
 - test/data/vcr_cassettes/district_find_one.yml
+- test/data/vcr_cassettes/district_schools.yml
+- test/data/vcr_cassettes/district_sections.yml
+- test/data/vcr_cassettes/district_students.yml
+- test/data/vcr_cassettes/district_teachers.yml
 - test/data/vcr_cassettes/districts.yml
 - test/data/vcr_cassettes/districts_event_pages.yml
-- test/data/vcr_cassettes/districts_events.yml
 - test/data/vcr_cassettes/districts_school_pages.yml
-- test/data/vcr_cassettes/districts_schools.yml
 - test/data/vcr_cassettes/districts_section_pages.yml
-- test/data/vcr_cassettes/districts_sections.yml
 - test/data/vcr_cassettes/districts_student_pages.yml
-- test/data/vcr_cassettes/districts_students.yml
-- test/data/vcr_cassettes/districts_students_filtered.yml
 - test/data/vcr_cassettes/districts_teacher_pages.yml
-- test/data/vcr_cassettes/districts_teachers.yml
 - test/data/vcr_cassettes/error_handling.yml
 - test/data/vcr_cassettes/event_count.yml
 - test/data/vcr_cassettes/event_find_by_page.yml
@@ -303,30 +326,53 @@ test_files:
 - test/data/vcr_cassettes/event_find_one.yml
 - test/data/vcr_cassettes/events.yml
 - test/data/vcr_cassettes/school_count.yml
+- test/data/vcr_cassettes/school_district.yml
+- test/data/vcr_cassettes/school_events.yml
 - test/data/vcr_cassettes/school_find_by_page.yml
 - test/data/vcr_cassettes/school_find_multiple.yml
 - test/data/vcr_cassettes/school_find_one.yml
+- test/data/vcr_cassettes/school_sections.yml
+- test/data/vcr_cassettes/school_students.yml
+- test/data/vcr_cassettes/school_teachers.yml
 - test/data/vcr_cassettes/schools.yml
 - test/data/vcr_cassettes/schools_optional_attributes.yml
 - test/data/vcr_cassettes/section_count.yml
+- test/data/vcr_cassettes/section_district.yml
+- test/data/vcr_cassettes/section_events.yml
 - test/data/vcr_cassettes/section_find_by_page.yml
 - test/data/vcr_cassettes/section_find_multiple.yml
 - test/data/vcr_cassettes/section_find_one.yml
+- test/data/vcr_cassettes/section_school.yml
+- test/data/vcr_cassettes/section_students.yml
+- test/data/vcr_cassettes/section_teacher.yml
 - test/data/vcr_cassettes/sections.yml
 - test/data/vcr_cassettes/student_count.yml
+- test/data/vcr_cassettes/student_district.yml
+- test/data/vcr_cassettes/student_events.yml
 - test/data/vcr_cassettes/student_find_by_page.yml
 - test/data/vcr_cassettes/student_find_multiple.yml
 - test/data/vcr_cassettes/student_find_one.yml
+- test/data/vcr_cassettes/student_school.yml
+- test/data/vcr_cassettes/student_sections.yml
+- test/data/vcr_cassettes/student_teacher.yml
+- test/data/vcr_cassettes/student_teachers.yml
 - test/data/vcr_cassettes/students.yml
 - test/data/vcr_cassettes/teacher_count.yml
+- test/data/vcr_cassettes/teacher_district.yml
+- test/data/vcr_cassettes/teacher_events.yml
 - test/data/vcr_cassettes/teacher_find_by_page.yml
 - test/data/vcr_cassettes/teacher_find_multiple.yml
 - test/data/vcr_cassettes/teacher_find_one.yml
+- test/data/vcr_cassettes/teacher_school.yml
+- test/data/vcr_cassettes/teacher_sections.yml
+- test/data/vcr_cassettes/teacher_students.yml
 - test/data/vcr_cassettes/teachers.yml
 - test/integration/api_operations/list_test.rb
 - test/integration/district_test.rb
 - test/integration/error_handling_test.rb
+- test/integration/nested_resource_test.rb
 - test/test_helper.rb
+- test/unit/api_resource_test.rb
 - test/unit/clever_test.rb
 - test/unit/configuration_test.rb
 - test/unit/event_test.rb