boxr 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cf35b1411c6c6798f2f415a2d825717096965e5
-  data.tar.gz: 3e142582aa2436842010086cbbd7dd3cfb647d27
+  metadata.gz: 494422846efc6e36fe295cb8dc4dd7bdf9114a6c
+  data.tar.gz: 55240e038b71694c743f95a12f76d0ddbb0c2a91
 SHA512:
-  metadata.gz: 14e361ab0e968bc98fb80f2448646f916829080aa609c96cb69c551b248c66e81ac681a44e8f47f306ecfa0bfb364be44cb55acec41aa8270c0e7db8983d0cf4
-  data.tar.gz: 70317eac3258db263123244e1ad57d955a2a1299330838f12c96b5906f0d3cc9b5418f40eb338696763930c30ea03ef7bb0b9d03f0edc503430e902fe34906c5
+  metadata.gz: 79e4e5e6423dab11ac3c7a4b67d4fd16027bdb32961a61537f1cdcf557f17fa1bb93e4964a084ad466b170b2c75abf9528c6cf10a97d287afa64abde0511751f
+  data.tar.gz: b5770b393db4da331af34a32b9a2454e7efb55c3ed0ffbfc3d67ac8e3ca6d52f0bb351013f69a7ac658699498affb05567523b05303e4aa5d3e98ce66255bf7d

data/README.md

@@ -221,9 +221,11 @@ pending_collaborations()
 ```
 #### [Events](https://developers.box.com/docs/#events)
 ```ruby
-user_events(stream_position: 0, stream_type: :all, limit: 100)
+user_events(stream_position, stream_type: :all, limit: 100)
       
-enterprise_events(created_after, created_before)
+enterprise_events(created_after: nil, created_before: nil, stream_position: 0, event_type: nil, limit: 100)
+
+enterprise_events_stream(initial_stream_position, event_type: nil, limit: 100, refresh_period: 5)
 ```
 #### [Shared Items](https://developers.box.com/docs/#shared-items)
 ```ruby

data/boxr.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.9"
   spec.add_development_dependency "dotenv", "~> 0.11"
   spec.add_development_dependency "awesome_print"
-  spec.add_development_dependency "lru_redux"
+  spec.add_development_dependency "lru_redux", "~> 0.8"
 
   spec.add_runtime_dependency "oj", "~> 2.11"
   spec.add_runtime_dependency "httpclient", "~> 2.5"

data/examples/enterprise_events.rb

@@ -8,6 +8,18 @@ now = Time.now
 start_date = now - (60*60*24) #one day ago
 end_date = now
 
-puts "fetching enterprise events..."
-events = client.enterprise_events(start_date.utc, end_date.utc)
-events.each{|event| ap event; puts;}
+puts "fetching historic enterprise events..."
+result = client.enterprise_events(created_after: start_date, created_before: end_date)
+
+ap result.events.each{|event| ap event; puts;}
+output={count: result.events.count, next_stream_position: result.next_stream_position}
+ap output
+
+#now that we have the latest stream position let's start monitoring in real-time
+puts "listening for new enterprise events..."
+client.enterprise_events_stream(result.next_stream_position) do |result|
+  result.events.each{|e| puts e.event_type}
+  output={count: result.events.count, next_stream_position: result.next_stream_position}
+  ap output
+  puts "waiting..."
+end

data/examples/user_events.rb

@@ -9,16 +9,15 @@ cache = LruRedux::Cache.new(1000)
 stream_position = :now
 loop do 
   puts "fetching events..."
-  event_response = client.user_events(stream_position: stream_position)
+  event_response = client.user_events(stream_position)
   event_response.events.each do |event|
-    key = "/box-event/id/#{event.event_id}"
-
-    #we need to de-dupe the events because we will receive multiple events with the same event_id; this is to ensure that we get the event
-    if (cache.fetch(event.event_id)==nil)
-      cache[event.event_id] = true
+    #we need to de-dupe the events because we will receive multiple events with the same event_id; Box does this to ensure that we get the event
+    key = "/box-event/#{event.event_id}"
+    if (cache.fetch(key)==nil)
+      cache[key] = true
       puts event.event_type
     end
   end
   stream_position = event_response.next_stream_position
-  sleep 2
+  sleep 5
 end

data/lib/boxr/events.rb

@@ -1,30 +1,41 @@
 module Boxr
   class Client
 
-    def user_events(stream_position: 0, stream_type: :all, limit: 100)
+    def user_events(stream_position, stream_type: :all, limit: 100)
       query = {stream_position: stream_position, stream_type: stream_type, limit: limit}
       
       events, response = get(EVENTS_URI, query: query)
       Hashie::Mash.new({events: events["entries"], chunk_size: events["chunk_size"], next_stream_position: events["next_stream_position"]})
     end
 
-    def enterprise_events(created_after, created_before, event_type: nil, limit: 100)
+    def enterprise_events(created_after: nil, created_before: nil, stream_position: 0, event_type: nil, limit: 100)
       events = []
-      stream_position = 0
       loop do
-        event_response = get_enterprise_events_for_date_range(stream_position, limit, created_after, created_before, event_type)
+        event_response = get_enterprise_events(created_after, created_before, stream_position, event_type, limit)
         event_response.events.each{|event| events << event}
         stream_position = event_response.next_stream_position
 
         break if event_response.events.empty?
       end
-      events
+      Hashie::Mash.new({events: events, next_stream_position: stream_position})
+    end
+
+    def enterprise_events_stream(initial_stream_position, event_type: nil, limit: 100, refresh_period: 5)
+      stream_position = initial_stream_position
+      loop do
+        response = enterprise_events(stream_position: stream_position, event_type: event_type, limit: limit)
+
+        yield(response) if block_given?
+        
+        stream_position = response.next_stream_position
+        sleep refresh_period
+      end
     end
 
 
     private
 
-    def get_enterprise_events_for_date_range(stream_position, limit, created_after, created_before, event_type)
+    def get_enterprise_events(created_after, created_before, stream_position, event_type, limit)
       query = {stream_position: stream_position, stream_type: :admin_logs, limit: limit}
       query['event_type'] = event_type unless event_type.nil?
       query['created_after'] = created_after.to_datetime.rfc3339 unless created_after.nil?

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.15.0"
+  VERSION = "0.16.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,16 +98,16 @@ dependencies:
   name: lru_redux
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement