clever-ruby 0.6.1 → 0.6.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWYwYWY4NjMwMjdjYTY4MmIzNjE3ZDQ5NjkwMTNlYTQ5MTU5ZWQ2Mg==
+    NmI3NzcwOGI0ZjVjNTRmMDRiZTg5YjZiZjAyNWZjNzkzNTUxNTg2Yg==
   data.tar.gz: !binary |-
-    ZTVmYWMwZjFmZTRhZTQ2ZTc1ZGEwMDhmOGJmNTY2OTg3NThmYTFlZg==
+    MGViMmNhMjI2Mjg4MDc5Nzc1ZDFmNjM5OTc1ODhkMGIyMmZmMDFlZA==
 SHA512:
   metadata.gz: !binary |-
-    ZTE1ZTAyNGY5ZWJmMThlZWZmNzY5NjQxYTdmNzVmOGM4MTA4MThjMmRiY2E2
-    MjRhZDZiOWUxYzRjNDY5ZjYzZWEyMmM1ZjdjYjFiMjMzNWE1YWYyODQ4N2Q2
-    ZjVkMDk2YjlmZTk1ZjJhOGM1YTMyYTIyMDlkZjlmNmEyYmU3M2I=
+    YmJhMTU5OThjMWQ2ZDJhYmI0NDY4MmEyNmQ5NGY2YmI4NDQ3NTZmMjY5M2Ux
+    YjUwNzcwMGE5ZDEwOTA4YjcyMzA3OGY0OGYyYzlmZDJjNmI2NTgxOTE5NjRh
+    ZmNkN2U3YTUwYjMzNTA3OGM1N2NlNzEyNzE2MDYzZmZmODc3MzA=
   data.tar.gz: !binary |-
-    NmRkYmU3M2FjNDIzNmUyNzg1NzVhMTU5MTA4YTUxNTk0Y2U3YTlhNjliZGJj
-    OTdiNDVmMTM1N2RhNjI2MmE3ZGVkNjU0ZTNhOGE4OGViMTJhYWZmYTFkZGZk
-    NTYxMDFiY2M3M2Q0NTYwNGZiMzdmZmFkZDM0OGE2ZmVmNDhmODg=
+    OWJhZjIzMDVjNzlkODM4NmVhMjJiYzcxYTk5MTM3NmIyOWFhY2NkYTI3MzBl
+    ZWFhMWYxMTlhNzMxY2RhMzQ1YzQyMTc4NGVjOTQxMmFjZDM4NjczYWUwOWI4
+    MjY5Y2YyMzhmODNjNjFiOGE0MzYzY2JkODU1YmFhMjZlNmJkYmQ=

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.6.2 (2014-09-12)
+
+* Update dependencies
+* Add activesupport as dep
+* Refactor tests
+
 ## 0.6.1 (2014-09-10)
 
 * Add YARD documentation

data/clever-ruby.gemspec

@@ -21,16 +21,14 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'multi_json',    '~> 1.10.0'
   gem.add_runtime_dependency 'rest-client',   '~> 1.6.7'
+  gem.add_runtime_dependency 'activesupport', '~> 4.1.5'
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'minitest',      '~> 4.4.0'
-  gem.add_development_dependency 'shoulda',       '~> 3.3.2'
+  gem.add_development_dependency 'minitest',      '~> 5.4.1'
   gem.add_development_dependency 'yard',          '~> 0.8.7'
   gem.add_development_dependency 'yardstick',     '~> 0.9.9'
   gem.add_development_dependency 'redcarpet',     '~> 3.1.2'
   gem.add_development_dependency 'vcr',           '~> 2.4.0'
   gem.add_development_dependency 'webmock',       '~> 1.9.0'
-  gem.add_development_dependency 'pry',           '~> 0.10.1'
-  gem.add_development_dependency 'activesupport', '~> 3.2.11'
   gem.add_development_dependency 'rubocop',       '~> 0.26.0'
 end

data/lib/clever-ruby/version.rb

@@ -1,4 +1,4 @@
 # Clever Ruby library
 module Clever
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

data/test/integration/api_operations/list_test.rb

@@ -1,28 +1,38 @@
 require 'test_helper'
 
+def resource_name(resource)
+  resource.name.split('::')[-1].downcase
+end
+
+def resources
+  [Clever::District, Clever::School, Clever::Teacher,
+   Clever::Student, Clever::Section, Clever::Event]
+end
+
+module Minitest
+  # Extend default Minitest assertions
+  module Assertions
+    def assert_resource_type(resource, elem)
+      assert_instance_of resource, elem, "All elems of #{resource.url} should be of "\
+        "type #{resource.name}, instead got #{elem.class.name}. elem: #{elem.inspect}"
+    end
+  end
+end
+
 # Test api_operations/List
-class ListTest < Test::Unit::TestCase
-  def setup
+describe Clever::APIOperations::List do
+  before do
     Clever.configure do |config|
       config.api_key = 'DEMO_KEY'
     end
   end
 
-  def assert_type(resource, elem)
-    assert_instance_of resource, elem, "All elems of #{resource.url} should be of "\
-      "type #{resource.name}, instead got #{elem.class.name}. elem: #{elem.inspect}"
-  end
-
-  def self.resource_name(resource)
-    resource.name.split('::')[-1].downcase
-  end
-
   [[Clever::District, 1], [Clever::School, 3], [Clever::Teacher, 89],
    [Clever::Student, 1004], [Clever::Section, 379], [Clever::Event, 13]].each do |test_data|
     resource, expected = test_data
     name = resource_name resource
 
-    should "count #{name} properly" do
+    it "counts #{name} properly" do
       VCR.use_cassette "#{name}_count" do
         count = resource.count
         assert count.is_a?(Integer), "count should return an Integer. count: #{count}"
@@ -32,43 +42,30 @@ class ListTest < Test::Unit::TestCase
     end
   end
 
-  [Clever::District, Clever::School, Clever::Teacher,
-   Clever::Student, Clever::Section, Clever::Event].each do |resource|
+  resources.each do |resource|
     name = resource_name resource
 
-    should "reject invalid id for #{resource}.find one" do
+    it "rejects invalid id for #{resource}.find one" do
       id = 'invalid_id'
-      assert_raises ArgumentError do
-        resource.find id
-      end
+      assert_raises(ArgumentError) { resource.find id }
     end
 
-    should "reject invalid ids for #{resource}.find multiple" do
-      # one valid, one invalid
-      ids = %w(123412341234123412341234 invalid_id)
-      assert_raises ArgumentError do
-        resource.find ids
+    it "finds a single #{name}" do
+      VCR.use_cassette "#{name}_find_one" do
+        id = resource.find.take(20).last.id
+        elem = resource.find id
+        assert_resource_type resource, elem
+        assert_equal id, elem.id
       end
     end
 
-    should "find #{name}s by page" do
-      VCR.use_cassette "#{name}_find_by_page" do
-        result = resource.find
-        assert_instance_of Clever::APIOperations::ResultsList, result, 'Result should be '\
-          "a Clever::APIOperations::ResultsList, received #{result.inspect}"
-        count = 0
-        result.each do |elem|
-          count += 1
-          assert_type resource, elem
-        end
-
-        expected = resource.count
-        count.must_equal expected, "Expected #{expected} #{name}s to be "\
-          "retrieved but only #{count} were found. Perhaps the test data has changed?"
-      end
+    it 'rejects invalid ids for Clever::District.find multiple' do
+      # one valid, one invalid
+      ids = %w(123412341234123412341234 invalid_id)
+      assert_raises(ArgumentError) { Clever::District.find ids }
     end
 
-    should "find #{name}s with multiple ids" do
+    it "finds #{name}s with multiple ids" do
       VCR.use_cassette "#{name}_find_multiple" do
         to_query = []
         count = 0
@@ -85,16 +82,24 @@ class ListTest < Test::Unit::TestCase
       end
     end
 
-    should "find a single #{name}" do
-      VCR.use_cassette "#{name}_find_one" do
-        id = resource.find.take(20).last.id
-        elem = resource.find id
-        assert_type resource, elem
-        assert_equal id, elem.id
+    it "finds #{name}s by page" do
+      VCR.use_cassette "#{name}_find_by_page" do
+        result = resource.find
+        assert_instance_of Clever::APIOperations::ResultsList, result, 'Result should be '\
+          "a Clever::APIOperations::ResultsList, received #{result.inspect}"
+        count = 0
+        result.each do |elem|
+          count += 1
+          assert_resource_type resource, elem
+        end
+
+        expected = resource.count
+        count.must_equal expected, "Expected #{expected} #{name}s to be "\
+          "retrieved but only #{count} were found. Perhaps the test data has changed?"
       end
     end
 
-    should "retrieve all #{name}" do
+    it "retrieves all #{name}" do
       VCR.use_cassette("#{name}s") do
         elems = resource.all
         elems.each do |elem|

data/test/integration/district_test.rb

@@ -1,85 +1,87 @@
 require 'test_helper'
 
-# test district resource
-class DistrictTest < Test::Unit::TestCase
-  def setup
-    Clever.configure do |config|
-      config.api_key = 'DEMO_KEY'
+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
-  end
 
-  should "retrieve a district's schools" do
-    test_object_list 'schools', 3, Clever::School
-  end
-
-  should "page a district's schools" do
-    test_object_pages 'school', 2, 2
+    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
+        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|
+          pages += 1
+          objects = object_page.all
+          object_count_from_paging += objects.size
+        end
+
+        object_count_from_paging.must_equal object_count_from_list
+        pages.must_equal page_count
+      end
+    end
   end
+end
 
-  should "retrieve a district's teachers" do
-    test_object_list 'teachers', 89, Clever::Teacher
+describe Clever::District do
+  before do
+    Clever.configure do |config|
+      config.api_key = 'DEMO_KEY'
+    end
   end
 
-  should "page a district's teachers" do
-    test_object_pages 'teacher', 10, 9
+  it "retrieves a district's schools" do
+    assert_valid_object_list 'schools', 3, Clever::School
   end
 
-  should "retrieve a district's sections" do
-    test_object_list 'sections', 100, Clever::Section
+  it "retrieves a district's teachers" do
+    assert_valid_object_list 'teachers', 89, Clever::Teacher
   end
 
-  should "page a district's sections" do
-    test_object_pages 'section', 10, 38
+  it "retrieves a district's sections" do
+    assert_valid_object_list 'sections', 100, Clever::Section
   end
 
-  should "retrieve a district's students" do
-    test_object_list 'students', 100, Clever::Student
+  it "retrieves a district's students" do
+    assert_valid_object_list 'students', 100, Clever::Student
   end
 
-  should "page a district's students" do
-    test_object_pages 'student', 50, 21
+  it "retrieves a district's events" do
+    assert_valid_object_list 'events', 13, Clever::Event
   end
 
-  should "retrieve a district's students with a small filter" do
+  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
     end
   end
 
-  should "retrieve a district's events" do
-    test_object_list 'events', 13, Clever::Event
+  it "pages a district's schools" do
+    assert_valid_object_pages 'school', 2, 2
   end
 
-  should "page a district's events" do
-    test_object_pages 'event', 1, 14
+  it "pages a district's teachers" do
+    assert_valid_object_pages 'teacher', 10, 9
   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
-      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
+  it "pages a district's sections" do
+    assert_valid_object_pages 'section', 10, 38
   end
 
-  def test_object_pages(object_name, limit, page_count)
-    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: 100_000).size
-
-      object_count_from_paging = 0
-      pages = 0
-      district.send("#{object_name}_pages", limit: limit).each do |object_page|
-        pages += 1
-        objects = object_page.all
-        object_count_from_paging += objects.size
-      end
+  it "pages a district's students" do
+    assert_valid_object_pages 'student', 50, 21
+  end
 
-      object_count_from_paging.must_equal object_count_from_list
-      pages.must_equal page_count
-    end
+  it "pages a district's events" do
+    assert_valid_object_pages 'event', 1, 14
   end
 end

data/test/integration/error_handling_test.rb

@@ -1,14 +1,14 @@
 require 'test_helper'
 
 # Test error handling
-class ErrorHandlingTest < Test::Unit::TestCase
-  def setup
+describe 'Error handling' do
+  before do
     Clever.configure do |config|
       config.api_key = 'DEMO_KEY'
     end
   end
 
-  should 'raise an InvalidRequestError when given a bad created_since' do
+  it 'raises an InvalidRequestError when given a bad created_since' do
     VCR.use_cassette('error_handling') do
       @district = Clever::District.all.first
       lambda do

data/test/test_helper.rb

@@ -1,10 +1,8 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'minitest/autorun'
-require 'shoulda'
 require 'vcr'
 require 'clever-ruby'
-require 'pry'
 
 VCR.configure do |c|
   c.cassette_library_dir = 'test/data/vcr_cassettes'

data/test/unit/clever_test.rb

@@ -2,14 +2,14 @@ require 'test_helper'
 
 # basic clever-ruby tests
 # TODO: organize better
-class CleverTest < Test::Unit::TestCase
-  def setup
+describe Clever do
+  before do
     Clever.configure do |config|
       config.api_key = 'DEMO_KEY'
     end
   end
 
-  should 'returns correct urls for Resources' do
+  it '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
@@ -18,7 +18,7 @@ class CleverTest < Test::Unit::TestCase
     assert_equal 'v1.1/events', Clever::Event.url
   end
 
-  should 'uri-encode params' do
+  it 'uri-encodes 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

data/test/unit/configuration_test.rb

@@ -1,19 +1,31 @@
 require 'test_helper'
 
 # test api configuraton
-class CleverConfigurationTest < Test::Unit::TestCase
-  should 'set the api key' do
+describe Clever::Configuration do
+  it 'raises an error if no api key is set' do
+    Clever.configure do |config|
+      config.api_key = nil
+      config.token = nil
+    end
+
+    -> { Clever.request(:get, 'a') }.must_raise Clever::AuthenticationError
+  end
+
+  it 'sets the api key' do
     Clever.configure do |config|
       config.api_key = 'DEMO_KEY'
     end
     assert_equal 'DEMO_KEY', Clever.api_key
   end
 
-  should 'raise an error if no api key is set' do
-    -> { Clever.request(stub, stub) }.must_raise Clever::AuthenticationError
+  it 'sets the api token' do
+    Clever.configure do |config|
+      config.token = 'DEMO_TOKEN'
+    end
+    assert_equal 'DEMO_TOKEN', Clever.token
   end
 
-  should 'set a default for the api base' do
+  it 'sets 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,8 +1,8 @@
 require 'test_helper'
 
 # test events resource
-class EventTest < Test::Unit::TestCase
-  def setup
+describe Clever::Event do
+  before do
     @event = Clever::Event.construct_from(
       type: 'sections.created',
       data: {
@@ -24,19 +24,19 @@ class EventTest < Test::Unit::TestCase
     )
   end
 
-  should 'create a clever object for the object the event is about' do
+  it 'creates 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
+  it 'knows 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
+  it "returns an empty hash if there aren't previous attributes" do
     @event.previous_attributes.must_equal {}
   end
 
-  should "have an event's previous attributes" do
+  it "has an event's previous attributes" do
     @updated_event.previous_attributes[:teacher].must_equal '510980a6923bcbba1f0cb500'
   end
 end

data/test/unit/optional_attributes_test.rb

@@ -1,8 +1,8 @@
 require 'test_helper'
 
 # Test optional attributes functionality
-class OptionalAttributesTest < Test::Unit::TestCase
-  def setup
+describe 'Optional attributes' do
+  before do
     Clever.configure do |config|
       config.api_key = 'DEMO_KEY'
     end
@@ -12,7 +12,7 @@ class OptionalAttributesTest < Test::Unit::TestCase
     end
   end
 
-  should 'return nil for an optional attribute that isnt present' do
+  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
@@ -27,14 +27,13 @@ class OptionalAttributesTest < Test::Unit::TestCase
     school.legit_attribute.must_equal nil
   end
 
-  should 'have the expected value for an optional attribute that is present' do
+  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'
   end
 
-  should 'raise a NoMethodError for an invalid attribute' do
+  it 'raises a NoMethodError for an invalid attribute' do
     school = @schools.find { |s| s.id == '530e595026403103360ff9fd' }
-
     -> { 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.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Clever Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 4.1.5
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.1.5
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 4.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 4.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 5.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 5.4.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -150,34 +150,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.9.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.10.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.10.1
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  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