inbox 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4572727f15af142648617ef23c2d02cfbaeb829a
-  data.tar.gz: 11dc0cb420be765146e33679ca143f4ccd798a16
+  metadata.gz: c7b981bac4d48b5e42697e01bc5080501cce8044
+  data.tar.gz: 2216e4f1ccd3d4ca90e55af103fd42cdc84d9c6e
 SHA512:
-  metadata.gz: 37b247c67eeff634a5f215810ea8b60e54a59c49282e0bbab16302b28fd1ac1d808e760891e208f4fd6e35a23228db5a26bf1addbb9c0d0a5c208eaf77dd386c
-  data.tar.gz: 573a0525f28d8c219be3df6863846f29b8ee4148b87c7ef9c4f47be79768abb65928c8e9d986b9234c234ec29ece20b608b8a9cf0fc6ec0451bb54544f2222fe
+  metadata.gz: 68c06d2bd7b77151eeac8839b49bbdedc6151fb1c624abf8f5ceb8447d5d25b985e34c7dd65bf18d59a39a1ba9d253b259561c21a60a9a0c73814691617d27cd
+  data.tar.gz: 8b400a8fb07608af169f6019b45cbf1a4b024b3141d8e30670a25a86913e40ac9b8f0f8dbcf28a38991855c490281364e017adf4c8b5dd13ddc2dfa6e1cbe017

data/README.md

@@ -105,10 +105,10 @@ If you're using the open-source version of the Nylas Sync Engine or have fewer t
   # Query the status of every account linked to the app
   nylas = Nylas::API.new(config.nylas_app_id, config.nylas_app_secret, nylas_token)
   accounts = nylas.accounts
-  accounts.each { |a| [a.account_id, a.sync_state] } # Available fields are: account_id, sync_state, trial, trial_expires, billing_state and namespace_id. See lib/account.rb for more details.
+  accounts.each { |a| [a.account_id, a.sync_state] } # Available fields are: account_id, sync_state, trial, trial_expires and billing_state. See lib/account.rb for more details.
 ```
 
-### Fetching Namespaces
+### Fetching Accounts
 
 ```ruby
 nylas = Nylas::API.new(config.nylas_app_id, config.nylas_app_secret, nylas_token)
@@ -206,6 +206,9 @@ end
 # Create a new file
 file = nylas.files.build(:file => File.new("./public/favicon.ico", 'rb'))
 file.save!
+
+# Download a file's contents
+content = file.download
 ```
 
 ### Working with Labels/Folders
@@ -249,6 +252,19 @@ messages = nylas.messages.where(:to => 'ben@nylas.com`).all
 
 The `where` method accepts a hash of filters, as documented in the [Filters Documentation](https://nylas.com/docs/platform#filters).
 
+### Getting a message's Message-Id, References and In-Reply-To headers
+
+If you've building your own threading solution, you'll probably need access to a handful of headers like
+`Message-Id`, `In-Reply-To` and `References`. Here's how to access them:
+
+```ruby
+msg = nylas.messages.first
+expanded_message = msg.expanded
+puts expanded_message.message_id
+puts expanded_message.references
+puts expanded_message.in_reply_to
+```
+
 ### Getting the raw contents of a message
 
 It's possible to access the unprocessed contents of a message using the raw method:
@@ -279,6 +295,17 @@ draft.save!
 
 # Send the draft.
 draft.send!
+
+# Sometimes sending isn't possible --- handle the exception and
+# print the error message returned by the SMTP server:
+begin
+    draft.send!
+rescue Nylas::APIError => e
+    puts "Failed with error: #{e.message}"
+    if not e.server_error.nil?
+        puts "The SMTP server replied: #{e.server_error}"
+    end
+end
 ```
 
 ### Creating an event
@@ -379,6 +406,22 @@ if event == 'create' or event == 'modify'
 end
 ```
 
+### Expand Messages from the Delta stream
+
+It's possible to ask the Deltas and delta stream API to return [expanded messages](https://nylas.com/docs/platform#expanded_message_view) directly:
+````ruby
+nylas.deltas(cursor, exclude=[Nylas::Contact,
+                              Nylas::Event,
+                              Nylas::File,
+                              Nylas::Tag,
+                              Nylas::Thread], expanded_view=true) do |event, object|
+if event == 'create' or event == 'modify'
+  if obj.is_a?(Inbox::Message)
+      puts obj.subject
+      puts obj.message_id
+  end
+end
+```
 
 ### Handling Errors
 The Nylas API uses conventional HTTP response codes to indicate success or failure of an API request. The ruby gem raises these as native exceptions.

data/lib/api_thread.rb

@@ -37,11 +37,11 @@ module Inbox
     end
 
     def messages
-      @messages ||= RestfulModelCollection.new(Message, @_api, @namespace_id, {:thread_id=>@id})
+      @messages ||= RestfulModelCollection.new(Message, @_api, {:thread_id=>@id})
     end
 
     def drafts
-      @drafts ||= RestfulModelCollection.new(Draft, @_api, @namespace_id, {:thread_id=>@id})
+      @drafts ||= RestfulModelCollection.new(Draft, @_api, {:thread_id=>@id})
     end
 
     def update_tags!(tags_to_add = [], tags_to_remove = [])

data/lib/calendar.rb

@@ -9,7 +9,7 @@ module Inbox
     parameter :read_only
 
     def events
-      @events ||= RestfulModelCollection.new(Event, @_api, @namespace_id, {:calendar_id=>@id})
+      @events ||= RestfulModelCollection.new(Event, @_api, {:calendar_id=>@id})
     end
 
   end

data/lib/draft.rb

@@ -6,9 +6,11 @@ module Inbox
     parameter :thread_id
     parameter :version
     parameter :reply_to_message_id
+    parameter :file_ids
 
     def attach(file)
       file.save! unless file.id
+      @file_ids ||= []
       @file_ids.push(file.id)
     end
 
@@ -30,7 +32,20 @@ module Inbox
       end
 
       ::RestClient.post(url, data.to_json, :content_type => :json) do |response, request, result|
-        json = Inbox.interpret_response(result, response, :expected_class => Object)
+
+        # This is mostly lifted from Inbox#interpret_response. We're not using the original function
+        # because we need to pass an additional error message to the Exception constructor.
+        Inbox.interpret_http_status(result)
+        json = JSON.parse(response)
+        if json.is_a?(Hash) && (json['type'] == 'api_error' or json['type'] == 'invalid_request_error')
+          exc = Inbox.http_code_to_exception(result.code.to_i)
+          exc_type = json['type']
+          exc_message = json['message']
+          exc_server_error = json['server_error']
+          raise exc.new(exc_type, exc_message, server_error=exc_server_error)
+        end
+        raise UnexpectedResponse.new(result.msg) if result.is_a?(Net::HTTPClientError)
+
         self.inflate(json)
       end
 

data/lib/file.rb

@@ -5,6 +5,7 @@ module Inbox
 
     parameter :size
     parameter :filename
+    parameter :content_id
     parameter :content_type
     parameter :is_embedded
     parameter :message_id
@@ -26,6 +27,14 @@ module Inbox
       self
     end
 
+    def download
+      download_url = self.url('download')
+      ::RestClient.get(download_url) do |response, request, result|
+        Inbox.interpret_http_status(result)
+        response
+      end
+    end
+
   end
 end
 

data/lib/inbox.rb

@@ -31,9 +31,12 @@ module Inbox
   class UnexpectedResponse < StandardError; end
   class APIError < StandardError
     attr_accessor :error_type
-    def initialize(type, error)
+    attr_accessor :server_error
+
+    def initialize(type, error, server_error = nil)
       super(error)
       self.error_type = type
+      self.server_error = server_error
     end
   end
   class InvalidRequest < APIError; end
@@ -47,6 +50,26 @@ module Inbox
     raise AccessDenied.new if result.code.to_i == 403
   end
 
+  def self.http_code_to_exception(http_code)
+      if http_code == 400
+        exc = InvalidRequest
+      elsif http_code == 402
+        exc = MessageRejected
+      elsif http_code == 403
+        exc = AccessDenied
+      elsif http_code == 404
+        exc = ResourceNotFound
+      elsif http_code == 429
+        exc = SendingQuotaExceeded
+      elsif http_code == 503
+        exc = ServiceUnavailable
+      else
+        exc = APIError
+      end
+
+      exc
+  end
+
   def self.interpret_response(result, result_content, options = {})
     # Handle HTTP errors
     Inbox.interpret_http_status(result)
@@ -55,17 +78,7 @@ module Inbox
     raise UnexpectedResponse.new if options[:expected_class] && result_content.empty?
     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
-      elsif result.code.to_i == 402
-        exc = MessageRejected
-      elsif result.code.to_i == 429
-        exc = SendingQuotaExceeded
-      elsif result.code.to_i == 503
-        exc = ServiceUnavailable
-      else
-        exc = APIError
-      end
+      exc = Inbox.http_code_to_exception(result.code.to_i)
       raise exc.new(json['type'], json['message'])
     end
     raise UnexpectedResponse.new(result.msg) if result.is_a?(Net::HTTPClientError)
@@ -248,6 +261,13 @@ module Inbox
       "label" => Inbox::Label,
     }
 
+    # It's possible to ask the API to expand objects.
+    # In this case, we do the right thing and return
+    # an expanded object.
+    EXPANDED_OBJECTS_TABLE = {
+      "message" => Inbox::ExpandedMessage,
+    }
+
     def _build_exclude_types(exclude_types)
       exclude_string = "&exclude_types="
 
@@ -262,7 +282,7 @@ module Inbox
       exclude_string = exclude_string[0..-2]
     end
 
-    def deltas(cursor, exclude_types=[])
+    def deltas(cursor, exclude_types=[], expanded_view=false)
       raise 'Please provide a block for receiving the delta objects' if !block_given?
       exclude_string = ""
 
@@ -273,6 +293,10 @@ module Inbox
       # loop and yield deltas until we've come to the end.
       loop do
         path = self.url_for_path("/delta?cursor=#{cursor}#{exclude_string}")
+        if expanded_view
+          path += '&view=expanded'
+        end
+
         json = nil
 
         RestClient.get(path) do |response,request,result|
@@ -288,6 +312,10 @@ module Inbox
           end
 
           cls = OBJECTS_TABLE[delta['object']]
+          if EXPANDED_OBJECTS_TABLE.has_key?(delta['object']) and expanded_view
+            cls = EXPANDED_OBJECTS_TABLE[delta['object']]
+          end
+
           obj = cls.new(self)
 
           case delta["event"]
@@ -307,7 +335,7 @@ module Inbox
       end
     end
 
-    def delta_stream(cursor, exclude_types=[], timeout=0)
+    def delta_stream(cursor, exclude_types=[], timeout=0, expanded_view=false)
       raise 'Please provide a block for receiving the delta objects' if !block_given?
 
       exclude_string = ""
@@ -318,6 +346,9 @@ module Inbox
 
       # loop and yield deltas indefinitely.
       path = self.url_for_path("/delta/streaming?cursor=#{cursor}#{exclude_string}")
+      if expanded_view
+        path += '&view=expanded'
+      end
 
       parser = Yajl::Parser.new(:symbolize_keys => false)
       parser.on_parse_complete = proc do |data|
@@ -328,6 +359,10 @@ module Inbox
         end
 
         cls = OBJECTS_TABLE[delta['object']]
+        if EXPANDED_OBJECTS_TABLE.has_key?(delta['object']) and expanded_view
+          cls = EXPANDED_OBJECTS_TABLE[delta['object']]
+        end
+
         obj = cls.new(self)
 
         case delta["event"]

data/lib/message.rb

@@ -75,8 +75,36 @@ module Inbox
       model = nil
       collection = RestfulModelCollection.new(Message, @_api, {:message_id=>@id})
       RestClient.get("#{collection.url}/#{id}/", :accept => 'message/rfc822'){ |response,request,result|
+        Inbox.interpret_http_status(result)
         response
       }
     end
+
+    def expanded
+      expanded_url = url(action='?view=expanded')
+
+      RestClient.get(expanded_url){ |response,request,result|
+        json = Inbox.interpret_response(result, response, :expected_class => Object)
+        expanded_message = Inbox::ExpandedMessage.new(@_api)
+        expanded_message.inflate(json)
+        expanded_message
+      }
+
+    end
+  end
+
+  class ExpandedMessage < Message
+    # override inflate because expanded messages have some special parameters
+    # like In-Reply-To and Message-Id.
+    attr_reader :message_id
+    attr_reader :in_reply_to
+    attr_reader :references
+
+    def inflate(json)
+      super
+      @message_id = json['headers']['Message-Id']
+      @in_reply_to = json['headers']['In-Reply-To']
+      @references = json['headers']['References']
+    end
   end
 end

data/lib/nylas.rb

@@ -31,9 +31,12 @@ module Inbox
   class UnexpectedResponse < StandardError; end
   class APIError < StandardError
     attr_accessor :error_type
-    def initialize(type, error)
+    attr_accessor :server_error
+
+    def initialize(type, error, server_error = nil)
       super(error)
       self.error_type = type
+      self.server_error = server_error
     end
   end
   class InvalidRequest < APIError; end
@@ -47,6 +50,26 @@ module Inbox
     raise AccessDenied.new if result.code.to_i == 403
   end
 
+  def self.http_code_to_exception(http_code)
+      if http_code == 400
+        exc = InvalidRequest
+      elsif http_code == 402
+        exc = MessageRejected
+      elsif http_code == 403
+        exc = AccessDenied
+      elsif http_code == 404
+        exc = ResourceNotFound
+      elsif http_code == 429
+        exc = SendingQuotaExceeded
+      elsif http_code == 503
+        exc = ServiceUnavailable
+      else
+        exc = APIError
+      end
+
+      exc
+  end
+
   def self.interpret_response(result, result_content, options = {})
     # Handle HTTP errors
     Inbox.interpret_http_status(result)
@@ -55,17 +78,7 @@ module Inbox
     raise UnexpectedResponse.new if options[:expected_class] && result_content.empty?
     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
-      elsif result.code.to_i == 402
-        exc = MessageRejected
-      elsif result.code.to_i == 429
-        exc = SendingQuotaExceeded
-      elsif result.code.to_i == 503
-        exc = ServiceUnavailable
-      else
-        exc = APIError
-      end
+      exc = Inbox.http_code_to_exception(result.code.to_i)
       raise exc.new(json['type'], json['message'])
     end
     raise UnexpectedResponse.new(result.msg) if result.is_a?(Net::HTTPClientError)
@@ -248,6 +261,13 @@ module Inbox
       "label" => Inbox::Label,
     }
 
+    # It's possible to ask the API to expand objects.
+    # In this case, we do the right thing and return
+    # an expanded object.
+    EXPANDED_OBJECTS_TABLE = {
+      "message" => Inbox::ExpandedMessage,
+    }
+
     def _build_exclude_types(exclude_types)
       exclude_string = "&exclude_types="
 
@@ -262,7 +282,7 @@ module Inbox
       exclude_string = exclude_string[0..-2]
     end
 
-    def deltas(cursor, exclude_types=[])
+    def deltas(cursor, exclude_types=[], expanded_view=false)
       raise 'Please provide a block for receiving the delta objects' if !block_given?
       exclude_string = ""
 
@@ -273,6 +293,10 @@ module Inbox
       # loop and yield deltas until we've come to the end.
       loop do
         path = self.url_for_path("/delta?cursor=#{cursor}#{exclude_string}")
+        if expanded_view
+          path += '&view=expanded'
+        end
+
         json = nil
 
         RestClient.get(path) do |response,request,result|
@@ -288,6 +312,10 @@ module Inbox
           end
 
           cls = OBJECTS_TABLE[delta['object']]
+          if EXPANDED_OBJECTS_TABLE.has_key?(delta['object']) and expanded_view
+            cls = EXPANDED_OBJECTS_TABLE[delta['object']]
+          end
+
           obj = cls.new(self)
 
           case delta["event"]
@@ -307,7 +335,7 @@ module Inbox
       end
     end
 
-    def delta_stream(cursor, exclude_types=[], timeout=0)
+    def delta_stream(cursor, exclude_types=[], timeout=0, expanded_view=false)
       raise 'Please provide a block for receiving the delta objects' if !block_given?
 
       exclude_string = ""
@@ -318,6 +346,9 @@ module Inbox
 
       # loop and yield deltas indefinitely.
       path = self.url_for_path("/delta/streaming?cursor=#{cursor}#{exclude_string}")
+      if expanded_view
+        path += '&view=expanded'
+      end
 
       parser = Yajl::Parser.new(:symbolize_keys => false)
       parser.on_parse_complete = proc do |data|
@@ -328,6 +359,10 @@ module Inbox
         end
 
         cls = OBJECTS_TABLE[delta['object']]
+        if EXPANDED_OBJECTS_TABLE.has_key?(delta['object']) and expanded_view
+          cls = EXPANDED_OBJECTS_TABLE[delta['object']]
+        end
+
         obj = cls.new(self)
 
         case delta["event"]

data/lib/restful_model.rb

@@ -10,6 +10,7 @@ module Inbox
     parameter :account_id
     parameter :cursor  # Only used by the delta sync API
     time_attr_accessor :created_at
+    attr_reader :raw_json
 
     def self.collection_name
       "#{self.to_s.downcase}s".split('::').last
@@ -26,6 +27,7 @@ module Inbox
     end
 
     def inflate(json)
+      @raw_json = json
       parameters.each do |property_name|
         send("#{property_name}=", json[property_name]) if json.has_key?(property_name)
       end
@@ -70,8 +72,8 @@ module Inbox
       self
     end
 
-    def destroy
-      ::RestClient.send('delete', self.url) do |response, request|
+    def destroy(params = {})
+      ::RestClient.send('delete', self.url, :params => params) do |response, request|
         Inbox.interpret_http_status(response)
       end
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Inbox
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inbox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ben Gotow
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client