inbox 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 618ad62529f730da5f0097aaba2b3af2e0756368
-  data.tar.gz: 70a5b740506e3160c231d7a52cb2250262864efa
+  metadata.gz: e0b6984a5e605532a22d7f884478155114856e0c
+  data.tar.gz: 387c6b20f67ae5e836f4ad20fb791f85c1c43b79
 SHA512:
-  metadata.gz: b26bac41d70e09821cd640ddcd50d47814d227ebf56905bdd7a2055689b892a9ee995d797699f2fb5b8ff550aa25c755e11033832cea5cf377c00da2a1e311df
-  data.tar.gz: cb8248ff8c10f93f811ab8b98df7b2c2bd4bd805a4d1551b8cf64ffb57b9626df6f1e7b2ecc9801054c647f68d411bd88a32e6be6c4c838567fdb09d91b58267
+  metadata.gz: 399247811e80bc82d7934b19073cd37f4acb54593608b6992cb8394fea1f34a9e9480d9b389809daa7177fb7872a427a601b63a5df6caca8ba58928e681b9727
+  data.tar.gz: 9a6493e1b86fef9772faaf72621043f9a121308a415bd7f9bf5dbf20307cdba266e1edab53f0f42659152b880050c6f8024b21d94e2aa395351be1f4874b6d2c

data/README.md

@@ -142,14 +142,14 @@ thread = nylas.threads.first
 # Fetch a specific thread
 thread = nylas.threads.find('ac123acd123ef123')
 
-# List all threads tagged `inbox`
+# List all threads in the inbox
 # (paginating 50 at a time until no more are returned.)
-nylas.threads.where(:tag => 'inbox').each do |thread|
+nylas.threads.where(:in => 'inbox').each do |thread|
   puts thread.subject
 end
 
 # List the 5 most recent unread threads
-nylas.threads.where(:tag => 'unread').range(0,4).each do |thread|
+nylas.threads.where(:unread => true).range(0,4).each do |thread|
   puts thread.subject
 end
 
@@ -180,23 +180,35 @@ end
 # Mark as read
 thread.mark_as_read!
 
-# Archive
-thread.archive!
+# Mark as unread
+thread.mark_as_unread!
 
-# Add or remove arbitrary tags (DEPRECATED --- you should use the new labels and folders API)
-tagsToAdd = ['inbox', 'cfa1233ef123acd12']
-tagsToRemove = []
-thread.update_tags!(tagsToAdd, tagsToRemove)
+# Star
+thread.star!
 
-# Add a new label to a message
+# Remove star
+thread.unstar!
 
+# Adding a new label to a thread
+
+# First, find the id of the important label.
+#
+# A note here: all labels have a display_name
+# property, which contains a label's name.
+# Some very specific labels (e.g: Inbox, Trash, etc.)
+# also have a name property, which is a canonical name
+# for the label. This is important because folder names
+# can change depending the user's locale (e.g: "Boîte de réception"
+# means "Inbox" in french). See https://nylas.com/docs/platform#labels
+# for more details.
 important = nil
 nylas.labels.each do |label|
-  if label.display_name == 'Important'
+  if label.name == 'important'
     important = label
   end
 end
 
+# Then, add it to the thread.
 thread = nylas.threads.where(:from => "helena@nylas.com").first
 thread.labels.push(important)
 thread.save!
@@ -257,7 +269,26 @@ fld.display_name = 'Renamed folder'
 fld.save!
 ```
 
-### Working with Messages, Contacts, etc.
+### Working with Messages
+
+```ruby
+puts msg.subject
+puts msg.from
+
+# Mark as read
+msg.mark_as_read!
+
+# Mark as unread
+msg.mark_as_unread!
+
+# Star
+msg.star!
+
+# Remove star
+msg.unstar!
+```
+
+### Working with API Objects
 
 #### Filtering
 
@@ -284,7 +315,7 @@ The `#where` method accepts a hash of filters, as documented in the [Filters Doc
 #### Enumerator methods
 
 Every object API object has an `each` method which returns an `Enumerator` if you don't pass it a block.
-This allows you to do leverage all that Ruby's `Enumerable` has to offer.
+This allows you to leverage all that Ruby's `Enumerable` has to offer.
 For example, this is the previous example rewritten to use an `Enumerator`:
 
 ```ruby

data/lib/api_thread.rb

@@ -1,5 +1,6 @@
 require 'restful_model'
 require 'time_attr_accessor'
+require 'mixins'
 
 module Inbox
   class Thread < RestfulModel
@@ -8,14 +9,18 @@ module Inbox
     parameter :subject
     parameter :participants
     parameter :snippet
-    parameter :tags
     parameter :message_ids
     parameter :draft_ids
     parameter :labels
     parameter :folder
+    parameter :starred
+    parameter :unread
+    parameter :has_attachments
     time_attr_accessor :last_message_timestamp
     time_attr_accessor :first_message_timestamp
 
+    include ReadUnreadMethods
+
     def inflate(json)
       super
       @labels ||= []
@@ -44,37 +49,6 @@ module Inbox
       @drafts ||= RestfulModelCollection.new(Draft, @_api, {:thread_id=>@id})
     end
 
-    def update_tags!(tags_to_add = [], tags_to_remove = [])
-      update('PUT', '', {
-        :add_tags => tags_to_add,
-        :remove_tags => tags_to_remove
-      })
-    end
-
-    def mark_as_read!
-      update_tags!([], ['unread'])
-    end
-
-    def mark_as_seen!
-      update_tags!([], ['unseen'])
-    end
-
-    def archive!
-      update_tags!(['archive'], ['inbox'])
-    end
-
-    def unarchive!
-      update_tags!(['inbox'], ['archive'])
-    end
-
-    def star!
-      update_tags!(['starred'], [''])
-    end
-
-    def unstar!
-      update_tags!([], ['starred'])
-    end
-
     def as_json(options = {})
       hash = {}
 

data/lib/inbox.rb

@@ -9,7 +9,6 @@ require 'api_account'
 require 'api_thread'
 require 'calendar'
 require 'account'
-require 'tag'
 require 'message'
 require 'draft'
 require 'contact'
@@ -149,10 +148,6 @@ module Inbox
       @threads ||= RestfulModelCollection.new(Thread, self)
     end
 
-    def tags
-      @tags ||= RestfulModelCollection.new(Tag, self)
-    end
-
     def messages
       @messages ||= RestfulModelCollection.new(Message, self)
     end
@@ -248,7 +243,6 @@ module Inbox
       "event" => Inbox::Event,
       "file" => Inbox::File,
       "message" => Inbox::Message,
-      "tag" => Inbox::Tag,
       "folder" => Inbox::Folder,
       "label" => Inbox::Label,
     }

data/lib/message.rb

@@ -1,5 +1,6 @@
 require 'restful_model'
 require 'file'
+require 'mixins'
 
 module Inbox
   class Message < RestfulModel
@@ -18,6 +19,8 @@ module Inbox
     parameter :folder
     parameter :labels
 
+    include Inbox::ReadUnreadMethods
+
     def inflate(json)
       super
       @to ||= []

data/lib/mixins.rb

@@ -0,0 +1,26 @@
+module Inbox
+  module ReadUnreadMethods
+    def update_param!(param, value)
+      update('PUT', '', {
+        param => value,
+      })
+    end
+
+    def mark_as_read!
+      update_param!(:unread, false)
+    end
+
+    def mark_as_unread!
+      update_param!(:unread, true)
+    end
+
+    def star!
+      update_param!(:starred, true)
+    end
+
+    def unstar!
+      update_param!(:starred, false)
+    end
+  end
+end
+

data/lib/nylas.rb

@@ -9,7 +9,6 @@ require 'api_account'
 require 'api_thread'
 require 'calendar'
 require 'account'
-require 'tag'
 require 'message'
 require 'draft'
 require 'contact'
@@ -149,10 +148,6 @@ module Inbox
       @threads ||= RestfulModelCollection.new(Thread, self)
     end
 
-    def tags
-      @tags ||= RestfulModelCollection.new(Tag, self)
-    end
-
     def messages
       @messages ||= RestfulModelCollection.new(Message, self)
     end
@@ -248,7 +243,6 @@ module Inbox
       "event" => Inbox::Event,
       "file" => Inbox::File,
       "message" => Inbox::Message,
-      "tag" => Inbox::Tag,
       "folder" => Inbox::Folder,
       "label" => Inbox::Label,
     }

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Inbox
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inbox
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Ben Gotow
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -214,11 +214,11 @@ files:
 - lib/inbox.rb
 - lib/label.rb
 - lib/message.rb
+- lib/mixins.rb
 - lib/nylas.rb
 - lib/parameters.rb
 - lib/restful_model.rb
 - lib/restful_model_collection.rb
-- lib/tag.rb
 - lib/time_attr_accessor.rb
 - lib/version.rb
 - LICENSE.txt

data/lib/tag.rb

@@ -1,9 +0,0 @@
-require 'restful_model'
-
-module Inbox
-  class Tag < RestfulModel
-
-    parameter :name
-
-  end
-end