nylas 4.5.0 → 4.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72b0b5b40c724d24dd8d99451898cfc20d75a42fdd82bfcce813fe8140089e06
-  data.tar.gz: 14867a09357e52cd3db00cf160706083b3b83c95b7733e45916ec466ca207e68
+  metadata.gz: eac1943c9596d6042676b8c5eb3356e6986a5f41088b419fd6dcd8295ef41fd7
+  data.tar.gz: a6207a0b0004fcfcaf251675fe6ad9d70c0c3cd57bcb9b7ca6e83d95decdb8e6
 SHA512:
-  metadata.gz: 222769968940045ccdee01eb2f650a90d362a051495618afc72b9b21e92923677502346a58edbde0b01fa4588fdb188de85bffea2899784a2723272d5633133d
-  data.tar.gz: 47ddda2725604b3c188403ed4f5359ad0382f8455b9fea4ccffef6f9e0e12042bfbb312cfecd7ef0c51b936cf55d21dc0c77ba73899324e12eb4cc9d4ece18a1
+  metadata.gz: '018f5931707cc9bbb8ab43908619fd7fabb9eea0992cbcc486bc35c2d67ff9ae8ffb52a49a9bfa0beecf4eca4897849e4e2bcd1c33878a89f06756de24f60c59'
+  data.tar.gz: 0a215f1bcc5e9b19bbd5229ed350fefe07bfb415f7e1118f451f2e31998604fa1b730d325d68083cfe09fb9a9efc84a18a247f8a85ad41b48231732f37c57c81

data/lib/nylas.rb

@@ -35,6 +35,7 @@ require_relative "nylas/rsvp"
 require_relative "nylas/timespan"
 require_relative "nylas/web_page"
 require_relative "nylas/nylas_date"
+require_relative "nylas/when"
 
 # Custom collection types
 require_relative "nylas/search_collection"
@@ -60,6 +61,7 @@ require_relative "nylas/native_authentication"
 require_relative "nylas/http_client"
 require_relative "nylas/api"
 
+require_relative "nylas/filter_attributes"
 # an SDK for interacting with the Nylas API
 # @see https://docs.nylas.com/reference
 module Nylas
@@ -86,4 +88,5 @@ module Nylas
   Types.registry[:web_page] = Types::ModelType.new(model: WebPage)
   Types.registry[:nylas_date] = NylasDateType.new
   Types.registry[:contact_group] = Types::ModelType.new(model: ContactGroup)
+  Types.registry[:when] = Types::ModelType.new(model: When)
 end

data/lib/nylas/api.rb

@@ -36,11 +36,28 @@ module Nylas
       )
     end
 
+    def exchange_code_for_token(code)
+      data = {
+        "client_id" => app_id,
+        "client_secret" => client.app_secret,
+        "grant_type" => "authorization_code",
+        "code" => code
+      }
+
+      response_json = execute(method: :post, path: "/oauth/token", payload: data)
+      response_json[:access_token]
+    end
+
     # @return [Collection<Contact>] A queryable collection of Contacts
     def contacts
       @contacts ||= Collection.new(model: Contact, api: self)
     end
 
+    # @return [Collection<ContactGroup>] A queryable collection of Contact Groups
+    def contact_groups
+      @contact_groups ||= Collection.new(model: ContactGroup, api: self)
+    end
+
     # @return [CurrentAccount] The account details for whomevers access token is set
     def current_account
       prevent_calling_if_missing_access_token(:current_account)

data/lib/nylas/calendar.rb

@@ -15,6 +15,9 @@ module Nylas
 
     attribute :name, :string
     attribute :description, :string
+    attribute :is_primary, :boolean
+    attribute :location, :string
+    attribute :timezone, :string
 
     attribute :read_only, :boolean
 
@@ -22,6 +25,10 @@ module Nylas
       read_only == true
     end
 
+    def primary?
+      is_primary
+    end
+
     def events
       api.events.where(calendar_id: id)
     end

data/lib/nylas/contact.rb

@@ -29,7 +29,6 @@ module Nylas
     attribute :manager_name, :string
     attribute :office_location, :string
     attribute :notes, :string
-    attribute :web_page, :web_page
     attribute :source, :string
 
     has_n_of_attribute :groups, :contact_group

data/lib/nylas/contact_group.rb

@@ -4,7 +4,16 @@ module Nylas
   # Structure to represent the Contact Group schema
   # @see https://docs.nylas.com/reference#contactsid
   class ContactGroup
-    include Model::Attributable
+    include Model
+    self.resources_path = "/contacts/groups"
+
+    self.creatable = false
+    self.destroyable = false
+    self.filterable = false
+    self.listable = true
+    self.showable = false
+    self.updatable = false
+
     attribute :id, :string
     attribute :object, :string
     attribute :account_id, :string

data/lib/nylas/draft.rb

@@ -33,7 +33,13 @@ module Nylas
     attribute :folder, :folder
     has_n_of_attribute :labels, :label
 
+    attribute :tracking, :message_tracking
+
+    transfer :api, to: %i[events files folder labels]
+
     def send!
+      return execute(method: :post, path: "/send", payload: to_json) if tracking
+
       save
       execute(method: :post, path: "/send", payload: JSON.dump(draft_id: id, version: version))
     end

data/lib/nylas/errors.rb

@@ -14,6 +14,8 @@ module Nylas
   class ModelNotUpdatableError < ModelActionError; end
   class ModelNotDestroyableError < ModelActionError; end
 
+  class JsonParseError < Error; end
+
   # Raised when attempting to set a field that is not on a model with mass assignment
   class ModelMissingFieldError < ModelActionError
     def initialize(field, model)
@@ -48,6 +50,10 @@ module Nylas
   ResourceNotFound = Class.new(APIError)
   MethodNotAllowed = Class.new(APIError)
   InvalidRequest = Class.new(APIError)
+  UnauthorizedRequest = Class.new(APIError)
+  ResourceRemoved = Class.new(APIError)
+  TeapotError = Class.new(APIError)
+  RequestTimedOut = Class.new(APIError)
   MessageRejected = Class.new(APIError)
   SendingQuotaExceeded = Class.new(APIError)
   ServiceUnavailable = Class.new(APIError)

data/lib/nylas/event.rb

@@ -15,6 +15,7 @@ module Nylas
     attribute :calendar_id, :string
     attribute :master_event_id, :string
     attribute :message_id, :string
+    attribute :ical_uid, :string
 
     attribute :busy, :boolean
     attribute :description, :string
@@ -25,7 +26,7 @@ module Nylas
     attribute :read_only, :boolean
     attribute :status, :string
     attribute :title, :string
-    attribute :when, :timespan
+    attribute :when, :when
     attribute :original_start_time, :unix_timestamp
 
     def busy?

data/lib/nylas/file.rb

@@ -56,7 +56,9 @@ module Nylas
     def retrieve_file
       response = api.get(path: "#{resource_path}/download")
       filename = response.headers.fetch(:content_disposition, "").gsub("attachment; filename=", "")
-      temp_file = Tempfile.new(filename)
+      # The returned filename can be longer than 256 chars which isn't supported by rb_sysopen.
+      # 128 chars here is more than enough given that TempFile ensure the filename will be unique.
+      temp_file = Tempfile.new(filename[0..127], encoding: "ascii-8bit")
       temp_file.write(response.body)
       temp_file.seek(0)
       temp_file

data/lib/nylas/filter_attributes.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Methods to check and raise error if extra attributes are present
+  class FilterAttributes
+    def initialize(attributes:, allowed_attributes:)
+      @attributes = attributes
+      @allowed_attributes = allowed_attributes
+    end
+
+    def check
+      return if extra_attributes.empty?
+
+      raise ArgumentError, "Only #{allowed_attributes} are allowed to be sent"
+    end
+
+    private
+
+    attr_reader :attributes, :allowed_attributes
+
+    def extra_attributes
+      attributes - allowed_attributes
+    end
+  end
+end

data/lib/nylas/http_client.rb

@@ -1,20 +1,26 @@
 # frozen_string_literal: true
 
 module Nylas
+  require "yajl"
+
   # Plain HTTP client that can be used to interact with the Nylas API sans any type casting.
   class HttpClient # rubocop:disable Metrics/ClassLength
     HTTP_CODE_TO_EXCEPTIONS = {
       400 => InvalidRequest,
+      401 => UnauthorizedRequest,
       402 => MessageRejected,
       403 => AccessDenied,
       404 => ResourceNotFound,
       405 => MethodNotAllowed,
+      410 => ResourceRemoved,
+      418 => TeapotError,
       422 => MailProviderError,
       429 => SendingQuotaExceeded,
       500 => InternalError,
       501 => EndpointNotYetImplemented,
       502 => BadGateway,
-      503 => ServiceUnavailable
+      503 => ServiceUnavailable,
+      504 => RequestTimedOut
     }.freeze
 
     ENDPOINT_TIMEOUTS = {
@@ -80,7 +86,14 @@ module Nylas
         timeout: timeout
       )
       rest_client_execute(**request) do |response, _request, result|
-        response = parse_response(response)
+        content_type = nil
+
+        if response.headers && response.headers[:content_type]
+          content_type = response.headers[:content_type].downcase
+        end
+
+        response = parse_response(response) if content_type == "application/json"
+
         handle_failed_response(result: result, response: response)
         response
       end
@@ -130,9 +143,12 @@ module Nylas
     end
 
     def parse_response(response)
-      response.is_a?(Enumerable) ? response : JSON.parse(response, symbolize_names: true)
-    rescue JSON::ParserError
-      response
+      return response if response.is_a?(Enumerable)
+
+      json = StringIO.new(response)
+      Yajl::Parser.new(symbolize_names: true).parse(json)
+    rescue Yajl::ParseError
+      raise Nylas::JsonParseError
     end
     inform_on :parse_response, level: :debug, also_log: { result: true }
 

data/lib/nylas/message.rb

@@ -8,6 +8,7 @@ module Nylas
     self.raw_mime_type = "message/rfc822"
     self.resources_path = "/messages"
     allows_operations(showable: true, listable: true, filterable: true, searchable: true, updatable: true)
+    UPDATABLE_ATTRIBUTES = %i[label_ids folder_id starred unread].freeze
 
     attribute :id, :string
     attribute :object, :string
@@ -34,7 +35,12 @@ module Nylas
     has_n_of_attribute :events, :event
     has_n_of_attribute :files, :file
     attribute :folder, :folder
-    has_n_of_attribute :labels, :label
+    attribute :folder_id, :string
+
+    has_n_of_attribute :labels, :label, exclude_when: [:saving]
+    has_n_of_attribute :label_ids, :string
+
+    transfer :api, to: %i[events files folder labels]
 
     def starred?
       starred
@@ -44,11 +50,42 @@ module Nylas
       unread
     end
 
+    def update(payload)
+      FilterAttributes.new(
+        attributes: payload.keys,
+        allowed_attributes: UPDATABLE_ATTRIBUTES
+      ).check
+
+      super(payload)
+    end
+
+    def update_folder(folder_id)
+      update(folder_id: folder_id)
+    end
+
     def expanded
       return self unless headers.nil?
 
       assign(api.execute(method: :get, path: resource_path, query: { view: "expanded" }))
       self
     end
+
+    def save_call
+      handle_folder
+
+      execute(
+        method: :put,
+        payload: attributes.serialize(keys: allowed_keys_for_save),
+        path: resource_path
+      )
+    end
+
+    def handle_folder
+      return if folder.nil?
+
+      self.folder_id = folder.id if folder_id.nil? && !self.to_h.dig(:folder, :id).nil?
+
+      self.folder = nil
+    end
   end
 end

data/lib/nylas/model.rb

@@ -4,6 +4,7 @@ require_relative "model/attribute_definition"
 require_relative "model/list_attribute_definition"
 require_relative "model/attributable"
 require_relative "model/attributes"
+require_relative "model/transferable"
 module Nylas
   # Include this to define a class to represent an object returned from the API
   module Model
@@ -15,6 +16,7 @@ module Nylas
 
     def self.included(model)
       model.include(Attributable)
+      model.include(Transferable)
       model.extend(ClassMethods)
       model.extend(Forwardable)
       model.def_delegators :model_class, :creatable?, :filterable?, :listable?, :searchable?, :showable?,
@@ -26,7 +28,7 @@ module Nylas
       result = if persisted?
                  raise ModelNotUpdatableError, self unless updatable?
 
-                 execute(method: :put, payload: attributes.serialize, path: resource_path)
+                 save_call
                else
                  create
                end
@@ -81,6 +83,22 @@ module Nylas
       JSON.dump(to_h)
     end
 
+    private
+
+    def allowed_keys_for_save
+      attributes.attribute_definitions.to_h.reject do |_k, v|
+        v.exclude_when.include?(:saving)
+      end.keys
+    end
+
+    def save_call
+      execute(
+        method: :put,
+        payload: attributes.serialize(keys: allowed_keys_for_save),
+        path: resource_path
+      )
+    end
+
     # Allows you to narrow in exactly what kind of model you're working with
     module ClassMethods
       attr_accessor :raw_mime_type, :creatable, :showable, :filterable, :searchable, :listable, :updatable,

data/lib/nylas/model/attributable.rb

@@ -2,7 +2,7 @@
 
 module Nylas
   module Model
-    # Allows defining of tyypecastable attributes on a model
+    # Allows defining of typecastable attributes on a model
     module Attributable
       def self.included(model)
         model.extend(ClassMethods)
@@ -12,16 +12,6 @@ module Nylas
         assign(**initial_data)
       end
 
-      protected def assign(**data) # rubocop:disable Style/AccessModifierDeclarations
-        data.each do |attribute_name, value|
-          if respond_to?(:"#{attribute_name}=")
-            send(:"#{attribute_name}=", value)
-          else
-            Logging.logger.warn("#{attribute_name} is not defined as an attribute on #{self.class.name}")
-          end
-        end
-      end
-
       def attributes
         @attributes ||= Attributes.new(self.class.attribute_definitions)
       end
@@ -31,6 +21,16 @@ module Nylas
         attributes.to_h
       end
 
+      protected
+
+      def assign(**data)
+        data.each do |attribute_name, value|
+          if respond_to?(:"#{attribute_name}=")
+            send(:"#{attribute_name}=", value)
+          end
+        end
+      end
+
       # Methods to call when tweaking Attributable classes
       module ClassMethods
         # rubocop:disable Naming/PredicateName

data/lib/nylas/model/attributes.rb

@@ -17,6 +17,8 @@ module Nylas
 
       def []=(key, value)
         data[key] = cast(key, value)
+      rescue Nylas::Registry::MissingKeyError
+        # Don't crash when a new attribute is added
       end
 
       # Merges data into the registry while casting input types correctly

data/lib/nylas/model/transferable.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Nylas
+  module Model
+    # Allows definition of attributes, which should transfer to other dependent attributes
+    module Transferable
+      def self.included(model)
+        model.extend(ClassMethods)
+        model.init_attribute_recipients
+      end
+
+      def initialize(**initial_data)
+        assign(**initial_data)
+        transfer_attributes
+      end
+
+      private
+
+      def transfer_attributes
+        self.class.attribute_recipients.each_pair do |name, recipient_names|
+          value = send(:"#{name}")
+          next if value.nil?
+
+          recipient_names.each do |recipient_name|
+            recipient = send(:"#{recipient_name}")
+            transfer_to_recipient(name, value, recipient) unless recipient.nil?
+          end
+        end
+      end
+
+      def transfer_to_recipient(name, value, recipient)
+        if recipient.respond_to?(:each)
+          recipient.each { |item| item.send(:"#{name}=", value) }
+        else
+          recipient.send(:"#{name}=", value)
+        end
+      end
+
+      # Methods to call when tweaking Transferable classes
+      module ClassMethods
+        attr_accessor :attribute_recipients
+        def init_attribute_recipients
+          self.attribute_recipients ||= {}
+        end
+
+        def transfer(*attributes, **opts)
+          attributes.each { |name| self.attribute_recipients[name] = opts[:to] }
+        end
+      end
+    end
+  end
+end

data/lib/nylas/new_message.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nylas
-  # Data structure for seending a message via the Nylas API
+  # Data structure for sending a message via the Nylas API
   class NewMessage
     include Model
     self.creatable = false
@@ -15,6 +15,7 @@ module Nylas
     has_n_of_attribute :from, :email_address
     has_n_of_attribute :cc, :email_address
     has_n_of_attribute :bcc, :email_address
+    has_n_of_attribute :reply_to, :email_address
 
     attribute :subject, :string
     attribute :body, :string

data/lib/nylas/physical_address.rb

@@ -12,5 +12,6 @@ module Nylas
     attribute :state, :string
     attribute :city, :string
     attribute :country, :string
+    attribute :secondary_address, :string
   end
 end

data/lib/nylas/thread.rb

@@ -33,6 +33,8 @@ module Nylas
 
     has_n_of_attribute :label_ids, :string
 
+    transfer :api, to: %i[labels folders]
+
     UPDATABLE_ATTRIBUTES = %i[label_ids folder_id starred unread].freeze
     def update(data)
       unupdatable_attributes = data.keys.reject { |name| UPDATABLE_ATTRIBUTES.include?(name) }
@@ -43,6 +45,10 @@ module Nylas
       super(data)
     end
 
+    def update_folder(folder_id)
+      update(folder_id: folder_id)
+    end
+
     def starred?
       starred
     end

data/lib/nylas/types.rb

@@ -86,6 +86,7 @@ module Nylas
       end
 
       def serialize(object)
+        return nil if object.nil?
         object.to_i
       end
     end

data/lib/nylas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nylas
-  VERSION = "4.5.0"
+  VERSION = "4.6.4"
 end

data/lib/nylas/when.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent all the Nylas time types.
+  # @see https://docs.nylas.com/reference#section-time
+  class When
+    extend Forwardable
+
+    include Model::Attributable
+
+    attribute :object, :string
+
+    # when object == 'date'
+    attribute :date, :date
+
+    # when object == 'datespan'
+    attribute :start_date, :date
+    attribute :end_date, :date
+
+    # when object == 'time'
+    attribute :time, :unix_timestamp
+
+    # when object == 'timespan'
+    attribute :start_time, :unix_timestamp
+    attribute :end_time, :unix_timestamp
+
+    def_delegators :range, :cover?
+
+    def as_timespan
+      return unless object == "timespan"
+
+      Timespan.new(object: object, start_time: start_time, end_time: end_time)
+    end
+
+    def range
+      case object
+      when "timespan"
+        Range.new(start_time, end_time)
+      when "datespan"
+        Range.new(start_date, end_date)
+      when "date"
+        Range.new(date, date)
+      when "time"
+        Range.new(time, time)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.4
 platform: ruby
 authors:
 - Nylas, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-15 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -240,7 +240,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -250,10 +250,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 description: Gem for interacting with the Nylas API.
 email: support@nylas.com
 executables: []
@@ -278,6 +298,7 @@ files:
 - lib/nylas/event.rb
 - lib/nylas/event_collection.rb
 - lib/nylas/file.rb
+- lib/nylas/filter_attributes.rb
 - lib/nylas/folder.rb
 - lib/nylas/http_client.rb
 - lib/nylas/im_address.rb
@@ -291,6 +312,7 @@ files:
 - lib/nylas/model/attribute_definition.rb
 - lib/nylas/model/attributes.rb
 - lib/nylas/model/list_attribute_definition.rb
+- lib/nylas/model/transferable.rb
 - lib/nylas/native_authentication.rb
 - lib/nylas/new_message.rb
 - lib/nylas/nylas_date.rb
@@ -308,6 +330,7 @@ files:
 - lib/nylas/version.rb
 - lib/nylas/web_page.rb
 - lib/nylas/webhook.rb
+- lib/nylas/when.rb
 homepage: 
 licenses:
 - MIT
@@ -333,7 +356,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Gem for interacting with the Nylas API