clever-ruby 0.3.1 → 0.4.0

data/test/integration/api_operations/list_test.rb

@@ -1,46 +1,47 @@
 require 'test_helper'
 
+# Test api_operations/List
 class ListTest < Test::Unit::TestCase
   def setup
     Clever.configure do |config|
-      config.api_key = "DEMO_KEY"
+      config.api_key = 'DEMO_KEY'
     end
   end
 
-  should "retrieve districts" do
-    VCR.use_cassette("districts") do
+  should 'retrieve districts' do
+    VCR.use_cassette('districts') do
       @districts = Clever::District.all
     end
 
     @districts.count.must_equal 1
   end
 
-  should "retrieve schools" do
-    VCR.use_cassette("schools") do
+  should 'retrieve schools' do
+    VCR.use_cassette('schools') do
       @schools = Clever::School.all
     end
 
-    @schools.count.must_equal 4
+    @schools.count.must_equal 3
   end
 
-  should "retrieve students" do
-    VCR.use_cassette("students") do
+  should 'retrieve students' do
+    VCR.use_cassette('students') do
       @students = Clever::Student.all
     end
 
-    @students.count.must_equal 100
+    @students.count.must_equal 1004
   end
 
-  should "retrieve sections" do
-    VCR.use_cassette("sections") do
+  should 'retrieve sections' do
+    VCR.use_cassette('sections') do
       @sections = Clever::Section.all
     end
 
-    @sections.count.must_equal 44
+    @sections.count.must_equal 379
   end
 
-  should "retrieve teachers" do
-    VCR.use_cassette("teachers") do
+  should 'retrieve teachers' do
+    VCR.use_cassette('teachers') do
       @teachers = Clever::Teacher.all
 
       @teachers.each do |teacher|
@@ -51,4 +52,4 @@ class ListTest < Test::Unit::TestCase
       end
     end
   end
-end
+end

data/test/integration/district_test.rb

@@ -1,34 +1,35 @@
 require 'test_helper'
 
-class ListTest < Test::Unit::TestCase
+# test district resource
+class DistrictTest < Test::Unit::TestCase
   def setup
     Clever.configure do |config|
-      config.api_key = "DEMO_KEY"
+      config.api_key = 'DEMO_KEY'
     end
   end
 
   should "retrieve a district's schools" do
-    test_object_list 'schools', 4, Clever::School
+    test_object_list 'schools', 3, Clever::School
   end
 
   should "page a district's schools" do
-    test_object_pages('school', 2, 2)
+    test_object_pages 'school', 2, 2
   end
 
   should "retrieve a district's teachers" do
-    test_object_list 'teachers', 48, Clever::Teacher
+    test_object_list 'teachers', 89, Clever::Teacher
   end
 
   should "page a district's teachers" do
-    test_object_pages('teacher', 10, 5)
+    test_object_pages 'teacher', 10, 9
   end
 
   should "retrieve a district's sections" do
-    test_object_list 'sections', 44, Clever::Section
+    test_object_list 'sections', 100, Clever::Section
   end
 
   should "page a district's sections" do
-    test_object_pages('section', 10, 5)
+    test_object_pages 'section', 10, 38
   end
 
   should "retrieve a district's students" do
@@ -36,28 +37,28 @@ class ListTest < Test::Unit::TestCase
   end
 
   should "page a district's students" do
-    test_object_pages('student', 50, 18)
+    test_object_pages 'student', 50, 21
   end
 
   should "retrieve a district's students with a small filter" do
-    VCR.use_cassette("districts_students_filtered") do
+    VCR.use_cassette('districts_students_filtered') do
       @district = Clever::District.all.first
-      @district.students({limit: 2}).size.must_equal 2
+      @district.students(limit: 2).size.must_equal 2
     end
   end
 
   should "retrieve a district's events" do
-    test_object_list 'events', 1, Clever::Event
+    test_object_list 'events', 13, Clever::Event
   end
 
   should "page a district's events" do
-    test_object_pages('event', 1, 1)
+    test_object_pages 'event', 1, 13
   end
 
   private
 
   def test_object_list(plural_object_name, object_count, instance_name)
-    VCR.use_cassette("districts_#{plural_object_name}", :allow_playback_repeats => true) do
+    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
@@ -65,13 +66,13 @@ class ListTest < Test::Unit::TestCase
   end
 
   def test_object_pages(object_name, limit, page_count)
-    VCR.use_cassette("districts_#{object_name}_pages", :allow_playback_repeats => true) do
+    VCR.use_cassette("districts_#{object_name}_pages", allow_playback_repeats: true) do
       district = Clever::District.all.first
-      object_count_from_list = district.send("#{object_name}s", {limit: 100000}).size
+      object_count_from_list = district.send("#{object_name}s", limit: 100_000).size
 
       object_count_from_paging = 0
       pages = 0
-      district.send("#{object_name}_pages", { limit: limit }).each do |object_page|
+      district.send("#{object_name}_pages", limit: limit).each do |object_page|
         pages += 1
         objects = object_page.all
         object_count_from_paging += objects.size

data/test/integration/error_handling_test.rb

@@ -1,18 +1,19 @@
 require 'test_helper'
 
+# Test error handling
 class ErrorHandlingTest < Test::Unit::TestCase
   def setup
     Clever.configure do |config|
-      config.api_key = "DEMO_KEY"
+      config.api_key = 'DEMO_KEY'
     end
   end
 
-  should "raise an InvalidRequestError when given a bad created_since" do
-    VCR.use_cassette("error_handling") do
+  should 'raise an InvalidRequestError when given a bad created_since' do
+    VCR.use_cassette('error_handling') do
       @district = Clever::District.all.first
-      lambda {
-        @district.events(created_since: '2013-02-15T 2:30:42 0000')
-      }.must_raise Clever::InvalidRequestError
+      lambda do
+        @district.events created_since: '2013-02-15T 2:30:42 0000'
+      end.must_raise Clever::InvalidRequestError
     end
   end
-end
+end

data/test/test_helper.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),"..","lib"))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'minitest/autorun'
 require 'shoulda'
@@ -9,4 +9,4 @@ require 'pry'
 VCR.configure do |c|
   c.cassette_library_dir = 'test/data/vcr_cassettes'
   c.hook_into :webmock
-end
+end

data/test/unit/clever_test.rb

@@ -1,25 +1,25 @@
 require 'test_helper'
 
+# basic clever-ruby tests
+# TODO: organize better
 class CleverTest < Test::Unit::TestCase
   def setup
     Clever.configure do |config|
-      config.api_key = "DEMO_KEY"
+      config.api_key = 'DEMO_KEY'
     end
   end
 
-  should "returns correct urls for Resources" do
-    assert_equal("v1.1/districts", Clever::District.url)
-    assert_equal("v1.1/schools", Clever::School.url)
-    assert_equal("v1.1/students", Clever::Student.url)
-    assert_equal("v1.1/sections", Clever::Section.url)
-    assert_equal("v1.1/teachers", Clever::Teacher.url)
-    assert_equal("v1.1/events", Clever::Event.url)
+  should 'returns correct urls for Resources' do
+    assert_equal 'v1.1/districts', Clever::District.url
+    assert_equal 'v1.1/schools', Clever::School.url
+    assert_equal 'v1.1/students', Clever::Student.url
+    assert_equal 'v1.1/sections', Clever::Section.url
+    assert_equal 'v1.1/teachers', Clever::Teacher.url
+    assert_equal 'v1.1/events', Clever::Event.url
   end
 
-  should "uri-encode params" do
-    query_string = Clever.convert_to_query_string({
-      created_at: '2013-02-15T 2:30:42Z'
-    })
-    query_string.must_equal "?created_at=2013-02-15T%202:30:42Z"
+  should 'uri-encode params' do
+    query_string = Clever.convert_to_query_string created_at: '2013-02-15T 2:30:42Z'
+    query_string.must_equal '?created_at=2013-02-15T%202:30:42Z'
   end
 end

data/test/unit/configuration_test.rb

@@ -1,22 +1,19 @@
 require 'test_helper'
 
+# test api configuraton
 class CleverConfigurationTest < Test::Unit::TestCase
-
-  should "set the api key" do
+  should 'set the api key' do
     Clever.configure do |config|
-      config.api_key = "DEMO_KEY"
+      config.api_key = 'DEMO_KEY'
     end
-    assert_equal("DEMO_KEY", Clever.api_key)
+    assert_equal 'DEMO_KEY', Clever.api_key
   end
 
-  should "raise an error if no api key is set" do
-    lambda {
-      Clever.request(stub, stub)
-    }.must_raise Clever::AuthenticationError
+  should 'raise an error if no api key is set' do
+    -> { Clever.request(stub, stub) }.must_raise Clever::AuthenticationError
   end
 
-  should "set a default for the api base" do
-    Clever.configuration.api_base.must_equal('https://api.clever.com/')
+  should 'set a default for the api base' do
+    Clever.configuration.api_base.must_equal 'https://api.clever.com/'
   end
-
 end

data/test/unit/event_test.rb

@@ -1,38 +1,35 @@
 require 'test_helper'
 
+# test events resource
 class EventTest < Test::Unit::TestCase
   def setup
-    @event = Clever::Event.construct_from({
-      type: "sections.created",
+    @event = Clever::Event.construct_from(
+      type: 'sections.created',
       data: {
-        object: {
-          id: "512bb9f2ca5e6fa77506133f"
-        }
+        object: { id: '512bb9f2ca5e6fa77506133f' }
       },
-      id: "512bb9f2ca5e6fa775061340"
-    })
+      id: '512bb9f2ca5e6fa775061340'
+    )
 
-    @updated_event = Clever::Event.construct_from({
-      type: "sections.updated",
+    @updated_event = Clever::Event.construct_from(
+      type: 'sections.updated',
       data: {
-        object: {
-          id: "510980c2923bcbba1f0ce5dd"
-        },
+        object: { id: '510980c2923bcbba1f0ce5dd' },
         previous_attributes: {
-          teacher: "510980a6923bcbba1f0cb500",
-          last_modified: "2013-03-11T15:38:58.558Z"
+          teacher: '510980a6923bcbba1f0cb500',
+          last_modified: '2013-03-11T15:38:58.558Z'
         }
       },
-      id: "514767bf80833fb55b1c2dd7"
-    })
+      id: '514767bf80833fb55b1c2dd7'
+    )
   end
 
-  should "create a clever object for the object the event is about" do
+  should 'create a clever object for the object the event is about' do
     @event.object.must_be_instance_of Clever::Section
   end
 
-  should "know what action the event is about (created/updated/deleted)" do
-    @event.action.must_equal "created"
+  should 'know what action the event is about (created/updated/deleted)' do
+    @event.action.must_equal 'created'
   end
 
   should "have an empty hash if there aren't previous attributes" do
@@ -40,6 +37,6 @@ class EventTest < Test::Unit::TestCase
   end
 
   should "have an event's previous attributes" do
-    @updated_event.previous_attributes[:teacher].must_equal "510980a6923bcbba1f0cb500"
+    @updated_event.previous_attributes[:teacher].must_equal '510980a6923bcbba1f0cb500'
   end
-end
+end

data/test/unit/optional_attributes_test.rb

@@ -1,33 +1,40 @@
 require 'test_helper'
 
+# Test optional attributes functionality
 class OptionalAttributesTest < Test::Unit::TestCase
   def setup
     Clever.configure do |config|
-      config.api_key = "DEMO_KEY"
+      config.api_key = 'DEMO_KEY'
     end
 
-    VCR.use_cassette("schools_optional_attributes") do
+    VCR.use_cassette('schools_optional_attributes') do
       @schools = Clever::School.all
     end
   end
 
-  should "return nil for an optional attribute that isnt present" do
-    clever_academy = @schools.detect{ |s| s.id == "4fee004cca2e43cf27000001"}
+  should 'return 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"
 
     # Must not raise a NoMethodError.
-    clever_academy.state_id.must_equal nil
+    school.legit_attribute.must_equal nil
   end
 
-  should "have the expected value for an optional attribute that is present" do
-    clever_prep = @schools.detect{ |s| s.id == "4fee004cca2e43cf27000002"}
-    clever_prep.state_id.must_equal "23"
+  should 'have the expected value for an optional attribute that is present' do
+    school = @schools.find { |s| s.id == '530e595026403103360ff9fd' }
+    school.state_id.must_equal '712345'
   end
 
-  should "raise a NoMethodError for an invalid attribute" do
-    clever_academy = @schools.detect{ |s| s.id == "4fee004cca2e43cf27000001"}
+  should 'raise a NoMethodError for an invalid attribute' do
+    school = @schools.find { |s| s.id == '530e595026403103360ff9fd' }
 
-    lambda {
-      clever_academy.some_attribute_that_doesnt_exist
-    }.must_raise NoMethodError
+    -> { school.some_attribute_that_doesnt_exist }.must_raise NoMethodError
   end
-end
+end

metadata

@@ -1,126 +1,169 @@
 --- !ruby/object:Gem::Specification
 name: clever-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Clever Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-07 00:00:00.000000000 Z
+date: 2014-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &21797060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *21797060
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &21796160 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *21796160
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21795440 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21795440
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &21786180 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.4.0
   type: :development
   prerelease: false
-  version_requirements: *21786180
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &21785240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.2
   type: :development
   prerelease: false
-  version_requirements: *21785240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.2
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &21784700 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *21784700
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &21784140 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *21784140
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &21783220 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.9.0
   type: :development
   prerelease: false
-  version_requirements: *21783220
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &21782160 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.9.6
+        version: 0.10.1
   type: :development
   prerelease: false
-  version_requirements: *21782160
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &21781480 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.0
   type: :development
   prerelease: false
-  version_requirements: *21781480
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.0
 description: Ruby bindings to the Clever API.
 email:
 - tech-support@clever.com
@@ -128,11 +171,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .travis.yml
+- ".document"
+- ".drone.yml"
+- ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -186,27 +231,26 @@ files:
 - test/unit/optional_attributes_test.rb
 homepage: http://github.com/Clever/clever-ruby
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby bindings to the Clever API.
 test_files:
 - test/data/vcr_cassettes/districts.yml