clever-ruby 0.0.3 → 0.0.4

data/lib/clever-ruby.rb

@@ -19,6 +19,7 @@ require 'clever-ruby/school'
 require 'clever-ruby/student'
 require 'clever-ruby/section'
 require 'clever-ruby/teacher'
+require 'clever-ruby/event'
 
 # Errors
 require 'clever-ruby/errors/clever_error'

data/lib/clever-ruby/district.rb

@@ -23,6 +23,10 @@ module Clever
       get_linked_resources 'students', filters
     end
 
+    def events(filters={})
+      get_linked_resources 'events', filters
+    end
+
     private
 
     def get_linked_resources(resource_type, filters={})

data/lib/clever-ruby/event.rb

@@ -0,0 +1,25 @@
+module Clever
+  class Event < APIResource
+    include Clever::APIOperations::List
+
+    def optional_attributes
+      [:previous_attributes]
+    end
+
+    def object
+      klass = Util.types_to_clever_class(type_pieces[0])
+      klass ||= CleverObject
+      klass.construct_from(data[:object])
+    end
+
+    def action
+      type_pieces[1]
+    end
+
+    private
+
+    def type_pieces
+      type.split(".")
+    end
+  end
+end

data/lib/clever-ruby/util.rb

@@ -15,14 +15,19 @@ module Clever
       end
     end
 
-    def self.convert_to_clever_object(resp)
+    def self.types_to_clever_class(type)
       types = {
-          'students' => Student,
-          'sections' => Section,
-          'teachers' => Teacher,
-          'districts' => District,
-          'schools' => School
+        'students'  => Student,
+        'sections'  => Section,
+        'teachers'  => Teacher,
+        'districts' => District,
+        'schools'   => School,
+        'push'      => Event
       }
+      types.fetch(type)
+    end
+
+    def self.convert_to_clever_object(resp)
       case resp
       when Array
         resp.map { |i| convert_to_clever_object(i) }
@@ -31,7 +36,7 @@ module Clever
         # match = /\/v1.1\/([a-z]+)\/\S+$/.match(resp[:uri])
         # puts match[1].inspect
         if klass_name = /\/v1.1\/([a-z]+)\/\S+$/.match(resp[:uri])[1]
-          klass = types[klass_name]
+          klass = types_to_clever_class(klass_name)
         end
         klass ||= CleverObject
         klass.construct_from(resp[:data])

data/lib/clever-ruby/version.rb

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

data/test/data/vcr_cassettes/districts_events.yml

@@ -0,0 +1,138 @@
+---
+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:
+      - Wed, 13 Mar 2013 13:50:06 GMT
+      Server:
+      - nginx/1.2.7
+      Set-Cookie:
+      - AWSELB=A91137730E0ED0C3FE64858C01B7DE99906AE563A8E925E576645DC25B200EBF95B82D57D3F5C679B21661A8DECDD5707A5ACD5D114CAD14B5229AFB824566522F545F7D62;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: Wed, 13 Mar 2013 13:50:11 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:
+      - Wed, 13 Mar 2013 13:50:07 GMT
+      Server:
+      - nginx/1.2.7
+      Set-Cookie:
+      - AWSELB=A91137730E0ED0C3FE64858C01B7DE99906AE563A8E925E576645DC25B200EBF95B82D57D3F5C679B21661A8DECDD5707A5ACD5D114CAD14B5229AFB824566522F545F7D62;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: Wed, 13 Mar 2013 13:50:11 GMT
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.getclever.com//v1.1/districts/4fd43cc56d11340000000005/events?
+    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:
+      - Wed, 13 Mar 2013 13:50:08 GMT
+      Server:
+      - nginx/1.2.7
+      Set-Cookie:
+      - AWSELB=A91137730E0ED0C3FE64858C01B7DE99906AE563A8E925E576645DC25B200EBF95B82D57D3F5C679B21661A8DECDD5707A5ACD5D114CAD14B5229AFB824566522F545F7D62;PATH=/;MAX-AGE=300
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '92'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"data":[{"data": {"type": "sections.created","data": {"object": {"school": "51278c814f766d0765015e2a","teacher": "510980a5923bcbba1f0cb4f0","sis_id": "1034","grade": "8","course_name": "Calculus I","course_number": "801","name": "Gregs class of math","subject": "math","district": "510976d3a0f6dd9842000006","students": ["512bb9ccca5e6fa77505fe7f"],"last_modified": "2013-02-25T19:22:26.624Z","created": "2013-02-25T19:22:26.624Z","id": "512bb9f2ca5e6fa77506133f"}},"created": "2013-02-25T19:22:26.706Z","id": "512bb9f2ca5e6fa775061340"},"uri": "/v1.1/push/events/512bb9f2ca5e6fa775061340"}],"links":[{"rel":"self","uri":"/v1.1/districts/4fd43cc56d11340000000005/events"}]}'
+    http_version:
+  recorded_at: Tue, 12 Mar 2013 15:38:16 GMT
+recorded_with: VCR 2.4.0

data/test/integration/district_test.rb

@@ -41,4 +41,13 @@ class ListTest < Test::Unit::TestCase
       @district.students({limit: 2}).size.must_equal 2
     end
   end
+
+  should "retrieve a district's events" do
+    VCR.use_cassette("districts_events", :allow_playback_repeats => true) do
+      @district = Clever::District.all.first
+      @district.events.size.must_equal 1
+      event = @district.events.first
+      event.must_be_instance_of Clever::Event
+    end
+  end
 end

data/test/unit/event_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class EventTest < Test::Unit::TestCase
+  def setup
+    @event = Clever::Event.construct_from({
+      type: "sections.created",
+      data: {
+        object: {
+          id: "512bb9f2ca5e6fa77506133f"
+        }
+      },
+      id: "512bb9f2ca5e6fa775061340"
+    })
+  end
+
+  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"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clever-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -166,6 +166,7 @@ files:
 - lib/clever-ruby/errors/authentication_error.rb
 - lib/clever-ruby/errors/clever_error.rb
 - lib/clever-ruby/errors/invalid_request_error.rb
+- lib/clever-ruby/event.rb
 - lib/clever-ruby/json.rb
 - lib/clever-ruby/school.rb
 - lib/clever-ruby/section.rb
@@ -174,6 +175,7 @@ files:
 - lib/clever-ruby/util.rb
 - lib/clever-ruby/version.rb
 - test/data/vcr_cassettes/districts.yml
+- test/data/vcr_cassettes/districts_events.yml
 - test/data/vcr_cassettes/districts_schools.yml
 - test/data/vcr_cassettes/districts_sections.yml
 - test/data/vcr_cassettes/districts_students.yml
@@ -189,6 +191,7 @@ files:
 - test/test_helper.rb
 - test/unit/clever_test.rb
 - test/unit/configuration_test.rb
+- test/unit/event_test.rb
 - test/unit/optional_attributes_test.rb
 homepage: http://github.com/Clever/clever-ruby
 licenses: []
@@ -216,6 +219,7 @@ specification_version: 3
 summary: Ruby bindings to the Clever API.
 test_files:
 - test/data/vcr_cassettes/districts.yml
+- test/data/vcr_cassettes/districts_events.yml
 - test/data/vcr_cassettes/districts_schools.yml
 - test/data/vcr_cassettes/districts_sections.yml
 - test/data/vcr_cassettes/districts_students.yml
@@ -231,4 +235,5 @@ test_files:
 - test/test_helper.rb
 - test/unit/clever_test.rb
 - test/unit/configuration_test.rb
+- test/unit/event_test.rb
 - test/unit/optional_attributes_test.rb