inbox 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3768cff4f9314c27d94cba1ab7cce94e481c8e2
-  data.tar.gz: b79094f6a174bd27ba868c9c02520e46703a08f0
+  metadata.gz: 5086b79c08f4d42025a25eba333f19d44fe21280
+  data.tar.gz: 6dbee9a11674e8a9a3edd2dc9d70b75f82b39b17
 SHA512:
-  metadata.gz: 4a8631bbd3c531ad0b0a92933de4d7ccd291187ffbe138b0074ce86f2002c02a2d4f7799f17724187984583cdbd284b6edad568d98c3af7695d28e380204944a
-  data.tar.gz: cec71ec9c4861c3b311924c4808b1178f542a7be35f2cdc889de0b219ee0fb35fd05bfddb95e7a9b5d8f90bc82024e1eaaeff278d117a976bd86d3ac82ec0491
+  metadata.gz: 184cd8fb0c44ce22e996feb18aedbfab81ac9ab5d1c4833d1048bbe6ddd7debb03cd667576f0ecc1b3a4a7340c01d682337b07317bb89995096aaa07a96091af
+  data.tar.gz: 77acb364d13cedba5eb124e4fc0a401a5d8419948ee8c4de0e50e2061d643cc565f3375bcc1daa38438ffc7c2b230f9798f2c73814cab312d4b7bed8d6398a77

data/README.md

@@ -19,7 +19,7 @@ You don't need to use this repo unless you're planning to modify the gem. If you
 
 - Ruby 1.8.7 or above. (Ruby 1.8.6 may work if you load ActiveSupport.)
 
-- rest-client, json
+- rest-client, json, yajl-ruby, em-http-request
 
 
 ## Example Rails App
@@ -278,6 +278,39 @@ end
 save_to_db(last_cursor)
 ```
 
+### Using the Delta sync streaming API
+
+The streaming API will receive deltas in real time, without needing to repeatedly poll. It uses EventMachine for async IO.
+
+````ruby
+# Get all the messages starting from timestamp
+#
+# we first need to get a cursor object a cursor is simply the id of
+# an individual change.
+cursor = inbox.namespaces.first.get_cursor(1407543195)
+
+last_cursor = nil
+inbox.namespaces.first.delta_stream(cursor) do |event, object|
+    if event == "create" or event == "modify"
+        if object.is_a?(Inbox::Contact)
+            puts "#{object.name} - #{object.email}"
+        elsif object.is_a?(Inbox::Event)
+            puts "Event!"
+        end
+    elsif event == "delete"
+        # In the case of a deletion, the API only returns the ID of the object.
+        # In this case, the Ruby SDK returns a dummy object with only the id field
+        # set.
+        puts "Deleting from collection #{object.class.name}, id: #{object}"
+    end
+    last_cursor = object.cursor
+
+    # This will loop indefintely
+end
+
+```
+
+
 ### Exclude changes from a specific type --- get only messages
 ````ruby
 nylas.namespaces.first.deltas(cursor, exclude=[Nylas::Contact,

data/lib/inbox.rb

@@ -36,7 +36,7 @@ module Inbox
 
     # Handle content expectation errors
     raise UnexpectedResponse.new if options[:expected_class] && result_content.empty?
-    json = JSON.parse(result_content)
+    json = options[:result_parsed]? result_content : JSON.parse(result_content)
     if json.is_a?(Hash) && (json['type'] == 'api_error' or json['type'] == 'invalid_request_error')
       if result.code.to_i == 400
         exc = InvalidRequest

data/lib/namespace.rb

@@ -7,6 +7,9 @@ require 'contact'
 require 'file'
 require 'calendar'
 require 'event'
+require 'yajl'
+require 'em-http'
+require 'ostruct'
 
 # Rather than saying require 'thread', we need to explicitly force
 # the thread model to load. Otherwise, we can't reference it below.
@@ -87,24 +90,28 @@ module Inbox
       "tag" => Inbox::Tag,
     }
 
+    def _build_exclude_types(exclude_types)
+      exclude_string = "&exclude_types="
+
+      exclude_types.each do |value|
+        count = 0
+        if OBJECTS_TABLE.has_value?(value)
+          param_name = OBJECTS_TABLE.key(value)
+          exclude_string += "#{param_name},"
+        end
+      end
+
+      exclude_string = exclude_string[0..-2]
+    end
+
     def deltas(cursor, exclude_types=[])
       raise 'Please provide a block for receiving the delta objects' if !block_given?
       exclude_string = ""
 
       if exclude_types.any?
-        exclude_string = "&exclude_types="
-
-        exclude_types.each do |value|
-          count = 0
-          if OBJECTS_TABLE.has_value?(value)
-            param_name = OBJECTS_TABLE.key(value)
-            exclude_string += "#{param_name},"
-          end
-        end
+        exclude_string = _build_exclude_types(exclude_types)
       end
 
-      exclude_string = exclude_string[0..-2]
-
       # loop and yield deltas until we've come to the end.
       loop do
         path = @_api.url_for_path("/n/#{@namespace_id}/delta?cursor=#{cursor}#{exclude_string}")
@@ -143,5 +150,47 @@ module Inbox
       end
     end
 
+    def delta_stream(cursor, exclude_types=[], timeout=0)
+      raise 'Please provide a block for receiving the delta objects' if !block_given?
+
+      exclude_string = ""
+
+      if exclude_types.any?
+        exclude_string = _build_exclude_types(exclude_types)
+      end
+
+      # loop and yield deltas indefinitely.
+      path = @_api.url_for_path("/n/#{@namespace_id}/delta/streaming?cursor=#{cursor}#{exclude_string}")
+
+      parser = Yajl::Parser.new(:symbolize_keys => false)
+      parser.on_parse_complete = proc do |data|
+        delta = Inbox.interpret_response(OpenStruct.new(:code => '200'), data, {:expected_class => Object, :result_parsed => true})
+
+        cls = OBJECTS_TABLE[delta['object']]
+        obj = cls.new(@_api, @namespace_id)
+
+        case delta["event"]
+          when 'create', 'modify'
+            obj.inflate(delta['attributes'])
+            obj.cursor = delta["cursor"]
+            yield delta["event"], obj
+          when 'delete'
+            obj.id = delta["id"]
+            obj.cursor = delta["cursor"]
+            yield delta["event"], obj
+        end
+      end
+
+      EventMachine.run do
+        http = EventMachine::HttpRequest.new(path, :connect_timeout => 0, :inactivity_timeout => timeout).get(:keepalive => true)
+        http.stream do |chunk|
+          parser << chunk
+        end
+        http.errback do
+          raise UnexpectedResponse.new http.error
+        end
+      end
+    end
+
   end
 end

data/lib/nylas.rb

@@ -36,7 +36,7 @@ module Inbox
 
     # Handle content expectation errors
     raise UnexpectedResponse.new if options[:expected_class] && result_content.empty?
-    json = JSON.parse(result_content)
+    json = options[:result_parsed]? result_content : JSON.parse(result_content)
     if json.is_a?(Hash) && (json['type'] == 'api_error' or json['type'] == 'invalid_request_error')
       if result.code.to_i == 400
         exc = InvalidRequest

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Inbox
-  VERSION = "0.16.1"
+  VERSION = "0.17.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inbox
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Ben Gotow
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -26,6 +26,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement