clever-ruby 0.0.4 → 0.0.5

data/lib/clever-ruby.rb

@@ -1,5 +1,6 @@
 require 'rest_client'
 require 'multi_json'
+require 'open-uri'
 
 require 'clever-ruby/version'
 
@@ -23,8 +24,11 @@ require 'clever-ruby/event'
 
 # Errors
 require 'clever-ruby/errors/clever_error'
-require 'clever-ruby/errors/authentication_error'
+
+require 'clever-ruby/errors/api_connection_error'
 require 'clever-ruby/errors/api_error'
+require 'clever-ruby/errors/authentication_error'
+require 'clever-ruby/errors/invalid_request_error'
 
 module Clever
   class << self
@@ -49,6 +53,16 @@ module Clever
     end
   end
 
+  def self.convert_to_query_string(params = nil)
+    if params && params.count
+      "?" + Util.flatten_params(params).collect { |p|
+        "#{URI::encode(p[0].to_s)}=#{URI::encode(p[1].to_s)}"
+      }.join('&')
+    else
+      ''
+    end
+  end
+
   def self.request(method, url, params=nil, headers={})
     raise AuthenticationError.new('No API key provided. (HINT: set your API key using "Clever.configure { |config| config.api_key = <API-KEY> }")') unless Clever.api_key
 
@@ -57,11 +71,7 @@ module Clever
 
     case method.to_s.downcase.to_sym
     when :get, :head, :delete
-      # Make params into GET parameters
-      if params && params.count
-        query_string = Util.flatten_params(params).collect{|p| "#{p[0]}=#{p[1]}"}.join('&')
-        url += "?#{query_string}"
-      end
+      url += convert_to_query_string(params)
       payload = nil
     else
       payload = params
@@ -123,7 +133,7 @@ module Clever
   def self.handle_restclient_error(e)
     case e
     when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
-      message = "Could not connect to Clever (#{@@api_base}). Please check your internet connection and try again."
+      message = "Could not connect to Clever (#{configuration.api_base}). Please check your internet connection and try again."
     when SocketError
       message = "Unexpected error communicating when trying to connect to Clever. HINT: You may be seeing this message because your DNS is not working. To check, try running 'host getclever.com' from the command line."
     else
@@ -153,7 +163,11 @@ module Clever
   end
 
   def self.invalid_request_error(error, rcode, rbody, error_obj)
-    InvalidRequestError.new(error[:message], error[:param], rcode, rbody, error_obj)
+    if error.is_a? Hash
+      InvalidRequestError.new(error[:message], error[:param], rcode, rbody, error_obj)
+    else
+      InvalidRequestError.new(error, '', rcode, rbody, error_obj)
+    end
   end
 
   def self.authentication_error(error, rcode, rbody, error_obj)

data/lib/clever-ruby/event.rb

@@ -3,7 +3,7 @@ module Clever
     include Clever::APIOperations::List
 
     def optional_attributes
-      [:previous_attributes]
+      []
     end
 
     def object
@@ -12,6 +12,10 @@ module Clever
       klass.construct_from(data[:object])
     end
 
+    def previous_attributes
+      data[:previous_attributes]
+    end
+
     def action
       type_pieces[1]
     end

data/lib/clever-ruby/version.rb

@@ -1,3 +1,3 @@
 module Clever
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/data/vcr_cassettes/error_handling.yml

@@ -0,0 +1,184 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.getclever.com/v1.1/districts?
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PUT,POST,DELETE
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Cache-Control:
+      - no-cache="set-cookie"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 26 Mar 2013 17:09:46 GMT
+      Server:
+      - nginx/1.2.7
+      Set-Cookie:
+      - AWSELB=A91137730E0ED0C3FE64858C01B7DE99906AE563A8CD7BD1CCF9B10870E96BC42024E91EFF14E7F99B23B8AEDFFF8573F9B41FB375FD4A8FC6C6CAF12129D54C280B596A87;PATH=/;MAX-AGE=300
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '174'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"data":[{"data":{"name":"Demo District","id":"4fd43cc56d11340000000005"},"uri":"/v1.1/districts/4fd43cc56d11340000000005"}],"links":[{"rel":"self","uri":"/v1.1/districts"}]}'
+    http_version: 
+  recorded_at: Tue, 26 Mar 2013 17:09:35 GMT
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.getclever.com/v1.1/districts/4fd43cc56d11340000000005
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PUT,POST,DELETE
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Cache-Control:
+      - no-cache="set-cookie"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 26 Mar 2013 17:09:46 GMT
+      Server:
+      - nginx/1.2.7
+      Set-Cookie:
+      - AWSELB=A91137730E0ED0C3FE64858C01B7DE99906AE563A8CD7BD1CCF9B10870E96BC42024E91EFF14E7F99B23B8AEDFFF8573F9B41FB375FD4A8FC6C6CAF12129D54C280B596A87;PATH=/;MAX-AGE=300
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '599'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"data":{"name":"Demo District","id":"4fd43cc56d11340000000005"},"links":[{"rel":"self","uri":"/v1.1/districts/4fd43cc56d11340000000005"},{"rel":"schools","uri":"/v1.1/districts/4fd43cc56d11340000000005/schools"},{"rel":"teachers","uri":"/v1.1/districts/4fd43cc56d11340000000005/teachers"},{"rel":"students","uri":"/v1.1/districts/4fd43cc56d11340000000005/students"},{"rel":"sections","uri":"/v1.1/districts/4fd43cc56d11340000000005/sections"},{"rel":"properties","uri":"/v1.1/districts/4fd43cc56d11340000000005/properties"},{"rel":"events","uri":"/v1.1/districts/4fd43cc56d11340000000005/events"}]}'
+    http_version: 
+  recorded_at: Tue, 26 Mar 2013 17:09:36 GMT
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.getclever.com/v1.1/districts/4fd43cc56d11340000000005
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PUT,POST,DELETE
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Cache-Control:
+      - no-cache="set-cookie"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 26 Mar 2013 17:09:46 GMT
+      Server:
+      - nginx/1.2.7
+      Set-Cookie:
+      - AWSELB=A91137730E0ED0C3FE64858C01B7DE99906AE563A8CD7BD1CCF9B10870E96BC42024E91EFF14E7F99B23B8AEDFFF8573F9B41FB375FD4A8FC6C6CAF12129D54C280B596A87;PATH=/;MAX-AGE=300
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '599'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"data":{"name":"Demo District","id":"4fd43cc56d11340000000005"},"links":[{"rel":"self","uri":"/v1.1/districts/4fd43cc56d11340000000005"},{"rel":"schools","uri":"/v1.1/districts/4fd43cc56d11340000000005/schools"},{"rel":"teachers","uri":"/v1.1/districts/4fd43cc56d11340000000005/teachers"},{"rel":"students","uri":"/v1.1/districts/4fd43cc56d11340000000005/students"},{"rel":"sections","uri":"/v1.1/districts/4fd43cc56d11340000000005/sections"},{"rel":"properties","uri":"/v1.1/districts/4fd43cc56d11340000000005/properties"},{"rel":"events","uri":"/v1.1/districts/4fd43cc56d11340000000005/events"}]}'
+    http_version: 
+  recorded_at: Tue, 26 Mar 2013 17:09:36 GMT
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.getclever.com//v1.1/districts/4fd43cc56d11340000000005/events?created_since=2013-02-15T%202:30:42%200000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PUT,POST,DELETE
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Cache-Control:
+      - no-cache="set-cookie"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 26 Mar 2013 17:09:47 GMT
+      Server:
+      - nginx/1.2.7
+      Set-Cookie:
+      - AWSELB=A91137730E0ED0C3FE64858C01B7DE99906AE563A8CD7BD1CCF9B10870E96BC42024E91EFF14E7F99B23B8AEDFFF8573F9B41FB375FD4A8FC6C6CAF12129D54C280B596A87;PATH=/;MAX-AGE=300
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '174'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"error":"Could not parse created_since ''2013-02-15T 2:30:42 0000''.
+        Please ensure it is either a valid ObjectID or a valid W3C datetime: http://www.w3.org/TR/NOTE-datetime."}'
+    http_version: 
+  recorded_at: Tue, 26 Mar 2013 17:09:36 GMT
+recorded_with: VCR 2.4.0

data/test/integration/error_handling_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class ErrorHandlingTest < Test::Unit::TestCase
+  def setup
+    Clever.configure do |config|
+      config.api_key = "DEMO_KEY"
+    end
+  end
+
+  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
+    end
+  end
+end

data/test/unit/clever_test.rb

@@ -14,4 +14,11 @@ class CleverTest < Test::Unit::TestCase
     assert_equal("https://api.getclever.com/v1.1/sections", Clever.resource_url("sections"))
     assert_equal("https://api.getclever.com/v1.1/teachers", Clever.resource_url("teachers"))
   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"
+  end
 end

data/test/unit/event_test.rb

@@ -11,6 +11,20 @@ class EventTest < Test::Unit::TestCase
       },
       id: "512bb9f2ca5e6fa775061340"
     })
+
+    @updated_event = Clever::Event.construct_from({
+      type: "sections.updated",
+      data: {
+        object: {
+          id: "510980c2923bcbba1f0ce5dd"
+        },
+        previous_attributes: {
+          teacher: "510980a6923bcbba1f0cb500",
+          last_modified: "2013-03-11T15:38:58.558Z"
+        }
+      },
+      id: "514767bf80833fb55b1c2dd7"
+    })
   end
 
   should "create a clever object for the object the event is about" do
@@ -20,4 +34,12 @@ class EventTest < Test::Unit::TestCase
   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
+    @event.previous_attributes.must_equal {}
+  end
+
+  should "have an event's previous attributes" do
+    @updated_event.previous_attributes[:teacher].must_equal "510980a6923bcbba1f0cb500"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clever-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -181,6 +181,7 @@ files:
 - test/data/vcr_cassettes/districts_students.yml
 - test/data/vcr_cassettes/districts_students_filtered.yml
 - test/data/vcr_cassettes/districts_teachers.yml
+- test/data/vcr_cassettes/error_handling.yml
 - test/data/vcr_cassettes/schools.yml
 - test/data/vcr_cassettes/schools_optional_attributes.yml
 - test/data/vcr_cassettes/sections.yml
@@ -188,6 +189,7 @@ files:
 - 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/test_helper.rb
 - test/unit/clever_test.rb
 - test/unit/configuration_test.rb
@@ -225,6 +227,7 @@ test_files:
 - test/data/vcr_cassettes/districts_students.yml
 - test/data/vcr_cassettes/districts_students_filtered.yml
 - test/data/vcr_cassettes/districts_teachers.yml
+- test/data/vcr_cassettes/error_handling.yml
 - test/data/vcr_cassettes/schools.yml
 - test/data/vcr_cassettes/schools_optional_attributes.yml
 - test/data/vcr_cassettes/sections.yml
@@ -232,6 +235,7 @@ test_files:
 - 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/test_helper.rb
 - test/unit/clever_test.rb
 - test/unit/configuration_test.rb