ruby-box 1.1.0 → 1.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTI2NDAyOTY0NGNlZmE0MjdjMGI0MTEyZmI0MjgwYmYyODY0YzFhNg==
+    YzdhOWY3MTVjMjU3ZDA1YzIwYmUyNGViNzBmNzM2NTNmM2I4MmI5MQ==
   data.tar.gz: !binary |-
-    MDExZTg4NTcyZjYyNWUyMDk0MDM1ZDk4NzQ2MmVhMDZkNDBlYWQ5Yg==
+    YjkzMGYyMDIzMTdhYjNlOGRlYWQxMjAxODI2YjM5YjY5ZjczZTBhYQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDYwZTM1ZjYwNWNlY2JjMDc2MWEwZDlhNzBlY2MwOGFlZThhNmE2MmNhMTg1
-    N2M4YmY0YTVmYjZhMTk1ZDNiMDNlMjIyZGNiM2VjMDBlYzBmZDJiYTBhMzAw
-    MjcxMjljYmUzY2FmNzQwNWY1ZTc5YTBjNzE4ZTk3N2U2YzgyNmM=
+    Mjg1NjViNGRlNWZhYjgxNzY2ZTcxZGU2MDQ3YjFmYzQ3OTBjMjY5NTkzZDcz
+    YWFmNzYzMjViZWQxNmYwMWQzNTM5NDliYjUxNTEyMjYwM2Y1YmJmMjIyMGVh
+    M2Y2YWE2ZTAxZGVlY2JiNzg2Y2EwNmQ4MTY4OTY3OWY4OWZiMWQ=
   data.tar.gz: !binary |-
-    YjA2M2NkY2Y4Nzc3Yzk3NTRlMjJjZGU3YTVlZmRjMDA0NjFlMWFmNDQ1ZDc3
-    ZDk0OWJlYjZjYTVkZjZmNTIwNDZlMzU2ZTAxNzY4OGQ5M2YwMWU2NTQwOTJm
-    ODExOGJiYWJiYjhjNWYyMGJjZTAyMjJmMzZhOGFkMzY4N2FlOTY=
+    NWI0MjIyMDkyZTdjNjViY2NjMjRhNTMxNmQ3MzQxZGJhZDI4ZWJlNjA2NTY1
+    ODdiNWQwOGJkZTBiYTY1YjQyOTBiMTdlNzQwY2M2ZTg4NzIxNmEzYmE3NTc1
+    N2ViZjRhZGM1YmNkMzE3ZGU4ZDdmMDE1MmY3OTllMTBlYTljMmI=

data/README.markdown

@@ -138,6 +138,22 @@ items.each do |item|
 end
 ```
 
+Events
+======
+
+You can use RubyBox's event_response method to return an EventResponse that can be used to process any incoming events.
+
+```ruby
+eresp = client.event_response
+eresp.chunk_size
+eresp.next_stream_position
+eresp.events.each do |ev|
+  p "type=#{ev.event_id} type=#{ev.event_type} user=#{ev.created_by.name}"
+end
+```
+
+
+
 Contributors
 ------------
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/lib/ruby-box.rb

@@ -8,6 +8,8 @@ require 'ruby-box/user'
 require 'ruby-box/comment'
 require 'ruby-box/discussion'
 require 'ruby-box/exceptions'
+require 'ruby-box/event_response'
+require 'ruby-box/event'
 
 module RubyBox
   API_URL = 'https://api.box.com/2.0'

data/lib/ruby-box/client.rb

@@ -89,6 +89,13 @@ module RubyBox
       path.split('/')
     end
 
+    def event_response(stream_position=0, stream_type=:all, limit=100)
+      q = fmt_events_args stream_position, stream_type, limit
+      url = "#{RubyBox::API_URL}/events?#{q}"
+      resp = @session.get( url )
+      EventResponse.new(@session, resp)
+    end
+
     private
 
     def folder_from_split_path(path)
@@ -99,6 +106,13 @@ module RubyBox
       end
       folder
     end
+
+    def fmt_events_args(stream_position, stream_type, limit)
+      stream_position = stream_position.kind_of?(Numeric) ? stream_position : 0
+      stream_type = [:all, :changes, :sync].include?(stream_type) ? stream_type : :all
+      limit = limit.kind_of?(Fixnum) ? limit : 100
+      "stream_position=#{stream_position}&stream_type=#{stream_type}&limit=#{limit}"
+    end
     
   end
-end
+end

data/lib/ruby-box/event.rb

@@ -0,0 +1,11 @@
+module RubyBox
+  class Event < Item
+
+    private
+
+    def has_mini_format?
+      false
+    end
+
+  end
+end

data/lib/ruby-box/event_response.rb

@@ -0,0 +1,21 @@
+module RubyBox
+  class EventResponse < Item
+
+    def events
+      @events ||= entries.collect {|ev|
+        RubyBox::Event.new(@session, ev)
+      }
+    end
+
+    private
+
+    def resource_name
+      'events'
+    end
+
+    def has_mini_format?
+      false
+    end
+
+  end
+end

data/lib/ruby-box/item.rb

@@ -59,7 +59,7 @@ module RubyBox
       @raw_item[key] = args[0] if setter and update_fields.include?(key)
       
       # we may have a mini version of the object loaded, fix this.
-      reload_meta if @raw_item[key].nil?
+      reload_meta if @raw_item[key].nil? and has_mini_format?
 
       if @raw_item[key].kind_of?(Hash)
         return RubyBox::Item.factory(@session, @raw_item[key])
@@ -81,13 +81,17 @@ module RubyBox
       when 'comment'
         return RubyBox::Comment.new(session, entry)        
       when 'user'
-        return RubyBox::User.new(session, entry)        
+        return RubyBox::User.new(session, entry)
       when 'discussion'
         return RubyBox::Discussion.new(session, entry)
       end
       entry
     end
 
+    def has_mini_format?
+      true
+    end
+
     private
 
     def many(key)

data/ruby-box.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ruby-box"
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Attachments.me"]
-  s.date = "2013-04-19"
+  s.date = "2013-04-23"
   s.description = "ruby gem for box.com 2.0 api"
   s.email = "ben@attachments.me"
   s.extra_rdoc_files = [
@@ -28,6 +28,8 @@ Gem::Specification.new do |s|
     "lib/ruby-box/client.rb",
     "lib/ruby-box/comment.rb",
     "lib/ruby-box/discussion.rb",
+    "lib/ruby-box/event.rb",
+    "lib/ruby-box/event_response.rb",
     "lib/ruby-box/exceptions.rb",
     "lib/ruby-box/file.rb",
     "lib/ruby-box/folder.rb",
@@ -36,7 +38,9 @@ Gem::Specification.new do |s|
     "lib/ruby-box/user.rb",
     "ruby-box.gemspec",
     "spec/client_spec.rb",
+    "spec/event_spec.rb",
     "spec/file_spec.rb",
+    "spec/fixtures/events.json",
     "spec/fixtures/遠志教授.jpg",
     "spec/folder_spec.rb",
     "spec/helper/account.example",

data/spec/event_spec.rb

@@ -0,0 +1,65 @@
+#encoding: UTF-8
+
+require 'ruby-box'
+require 'webmock/rspec'
+
+describe RubyBox::EventResponse do
+  before do
+    @session = RubyBox::Session.new
+    @client  = RubyBox::Client.new(@session)
+    @events_json  = File.read 'spec/fixtures/events.json'
+    @events = JSON.load @events_json
+    stub_request(:get, /#{RubyBox::API_URL}\/events.*/).to_return(body: @events_json, :status => 200)
+  end
+
+  it 'returns an EventResponse with a chunk_size and next_stream_position' do
+    eresp = @client.event_response
+    eresp.instance_of?(RubyBox::EventResponse).should be_true
+    eresp.events.instance_of?(Array).should be_true
+    eresp.chunk_size.should eq(@events['chunk_size'])
+    eresp.events.length.should eq(@events['chunk_size'])
+    eresp.next_stream_position.should eq(@events['next_stream_position'])
+  end
+
+  it "should not try to reload_meta since has_mini_format? is false" do
+    # request is called once when reload_meta is automatically executed.
+    RubyBox::Session.any_instance.should_not_receive(:request)
+    response = @client.event_response
+    event = response.events.first
+    event.missing_key
+  end
+
+  describe '#event_response' do
+    before do
+      @response = @client.event_response
+      @event = @response.events.first
+    end
+
+    it 'should return Event objects in the event response' do
+      @event.instance_of?(RubyBox::Event).should be_true
+    end
+
+    it 'should return an #event_id' do
+      @event.event_id.should eq(@events['entries'][0]['event_id'])
+    end
+
+    it 'should return a User for #created_by' do
+      @event.created_by.instance_of?(RubyBox::User).should be_true
+    end
+
+    it 'should return an #event_type' do
+      @event.event_type.should eq(@events['entries'][0]['event_type'])
+    end
+
+    it 'should return a #session_id' do
+      @event.session_id.should eq(@events['entries'][0]['session_id'])
+    end
+
+    it 'should return an instantiated #source' do
+      @event.source.instance_of?(RubyBox::Folder).should be_true
+    end
+
+  end
+
+end
+

data/spec/fixtures/events.json

@@ -0,0 +1,161 @@
+{
+  "chunk_size": 3,
+  "next_stream_position": 1366038336000,
+  "entries": [
+    {
+      "type": "event",
+      "event_id": "dd4cba8afb2acb3cc0ecc43c81e565e78886494b",
+      "created_by": {
+        "type": "user",
+        "id": "000000000",
+        "name": "Example User",
+        "login": "test@example.com"
+      },
+      "created_at": "2013-04-12T13:53:52-07:00",
+      "recorded_at": "2013-04-12T13:53:52-07:00",
+      "event_type": "ITEM_CREATE",
+      "session_id": "d223c5ba4f4eb1d0b4fb55a",
+      "source": {
+        "type": "folder",
+        "id": "805142927",
+        "sequence_id": "0",
+        "etag": "0",
+        "name": "Test Folder",
+        "created_at": "2013-04-12T13:53:52-07:00",
+        "modified_at": "2013-04-12T13:53:52-07:00",
+        "description": "",
+        "size": 0,
+        "path_collection": {
+          "total_count": 1,
+          "entries": [
+            {
+              "type": "folder",
+              "id": "0",
+              "sequence_id": null,
+              "etag": null,
+              "name": "All Files"
+            }
+          ]
+        },
+        "created_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "modified_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "trashed_at": null,
+        "purged_at": null,
+        "content_created_at": "2013-04-12T13:53:52-07:00",
+        "content_modified_at": "2013-04-12T13:53:52-07:00",
+        "owned_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "shared_link": null,
+        "folder_upload_email": null,
+        "parent": {
+          "type": "folder",
+          "id": "0",
+          "sequence_id": null,
+          "etag": null,
+          "name": "All Files"
+        },
+        "item_status": "active",
+        "synced": false
+      }
+    },
+    {
+      "type": "event",
+      "event_id": "dd4cba8afb2acb3cc0ecc43c81e565e78886494c",
+      "created_by": {
+        "type": "user",
+        "id": "000000000",
+        "name": "Example User",
+        "login": "test@example.com"
+      },
+      "created_at": "2013-04-12T13:54:25-07:00",
+      "recorded_at": "2013-04-12T13:54:26-07:00",
+      "event_type": "ITEM_RENAME",
+      "session_id": "d223c5ba4f4eb1d0b4fb55a",
+      "source": {
+        "type": "folder",
+        "id": "805142927",
+        "sequence_id": "1",
+        "etag": "1",
+        "name": "Test Folder",
+        "created_at": "2013-04-12T13:53:52-07:00",
+        "modified_at": "2013-04-12T13:54:25-07:00",
+        "description": "Project: Test",
+        "size": 0,
+        "path_collection": {
+          "total_count": 1,
+          "entries": [
+            {
+              "type": "folder",
+              "id": "0",
+              "sequence_id": null,
+              "etag": null,
+              "name": "All Files"
+            }
+          ]
+        },
+        "created_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "modified_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "trashed_at": null,
+        "purged_at": null,
+        "content_created_at": "2013-04-12T13:53:52-07:00",
+        "content_modified_at": "2013-04-12T13:54:25-07:00",
+        "owned_by": {
+          "type": "user",
+          "id": "000000000",
+          "name": "Example User",
+          "login": "test@example.com"
+        },
+        "shared_link": null,
+        "folder_upload_email": null,
+        "parent": {
+          "type": "folder",
+          "id": "0",
+          "sequence_id": null,
+          "etag": null,
+          "name": "All Files"
+        },
+        "item_status": "active",
+        "synced": false
+      }
+    },
+    {
+      "type": "event",
+      "event_id": "dd4cba8afb2acb3cc0ecc43c81e565e78886494d",
+      "created_by": {
+        "type": "user",
+        "id": "000000000",
+        "name": "Example User",
+        "login": "test@example.com"
+      },
+      "created_at": "2013-04-12T14:02:06-07:00",
+      "recorded_at": "2013-04-12T14:02:06-07:00",
+      "event_type": "TAG_ITEM_CREATE",
+      "session_id": "d223c5ba4f4eb1d0b4fb55a",
+      "source": null
+    }
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-box
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Attachments.me
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -113,6 +113,8 @@ files:
 - lib/ruby-box/client.rb
 - lib/ruby-box/comment.rb
 - lib/ruby-box/discussion.rb
+- lib/ruby-box/event.rb
+- lib/ruby-box/event_response.rb
 - lib/ruby-box/exceptions.rb
 - lib/ruby-box/file.rb
 - lib/ruby-box/folder.rb
@@ -121,7 +123,9 @@ files:
 - lib/ruby-box/user.rb
 - ruby-box.gemspec
 - spec/client_spec.rb
+- spec/event_spec.rb
 - spec/file_spec.rb
+- spec/fixtures/events.json
 - spec/fixtures/遠志教授.jpg
 - spec/folder_spec.rb
 - spec/helper/account.example