nylas 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b0265bb93198dcc5494a819c68a5261703a143a4fe320a4662cc6c65aa2e94
-  data.tar.gz: ee107c7cacfb2b7e2b099fd675c20c02700def063e1ccdd6b46923448da9e25b
+  metadata.gz: 8ab5c418509c447497fbd6106eb6e01fb7c23af451bf8150584b9bcf4e1ce736
+  data.tar.gz: 6827492459317c848f6f89c748a1cf5f5858506b83a578f53dbb4169010779ad
 SHA512:
-  metadata.gz: 4e7aca3de25b0e2847011c4b190960405a214e8905429ba2743f9d3bd068d41e60cb36ad7365d298f685eb47979c30df0397996212d784c26e20e54f32b874aa
-  data.tar.gz: 8fc30003aa6609694e5f2a7aedf2c949e2f191c45a0edea6045669d918c3ff88cdfc837046ec409815f67c255b7a1184586532878988166cd39865c8517f00fe
+  metadata.gz: 593d58ed82147ee51b00f90ed0e619eb4a6680b07cc8bae04eeba0809026e2e24ecce2565292c026bd2d164fba8a6a76f67768bf362c35c8e50bc0efbbe61da1
+  data.tar.gz: 10ed94be5d4e2c785ef92d32495301857f6c193e85e5087e96e8c2826b379219833f6db07c669c38fb7be573f77376748a6b323c1af46952c10853bf50e04233

data/lib/nylas.rb

@@ -75,6 +75,19 @@ require_relative "nylas/raw_message"
 require_relative "nylas/thread"
 require_relative "nylas/webhook"
 
+# Neural specific types
+require_relative "nylas/neural"
+require_relative "nylas/neural_sentiment_analysis"
+require_relative "nylas/neural_ocr"
+require_relative "nylas/neural_categorizer"
+require_relative "nylas/neural_clean_conversation"
+require_relative "nylas/neural_contact_link"
+require_relative "nylas/neural_contact_name"
+require_relative "nylas/neural_signature_contact"
+require_relative "nylas/neural_signature_extraction"
+require_relative "nylas/neural_message_options"
+require_relative "nylas/categorize"
+
 require_relative "nylas/native_authentication"
 
 require_relative "nylas/http_client"
@@ -110,4 +123,9 @@ module Nylas
   Types.registry[:contact_group] = Types::ModelType.new(model: ContactGroup)
   Types.registry[:when] = Types::ModelType.new(model: When)
   Types.registry[:time_slot] = Types::ModelType.new(model: TimeSlot)
+  Types.registry[:neural] = Types::ModelType.new(model: Neural)
+  Types.registry[:categorize] = Types::ModelType.new(model: Categorize)
+  Types.registry[:neural_signature_contact] = Types::ModelType.new(model: NeuralSignatureContact)
+  Types.registry[:neural_contact_link] = Types::ModelType.new(model: NeuralContactLink)
+  Types.registry[:neural_contact_name] = Types::ModelType.new(model: NeuralContactName)
 end

data/lib/nylas/api.rb

@@ -126,6 +126,11 @@ module Nylas
       @room_resources ||= Collection.new(model: RoomResource, api: self)
     end
 
+    # @return[Neural] A {Neural} object that provides
+    def neural
+      @neural ||= Neural.new(api: self)
+    end
+
     # Revokes access to the Nylas API for the given access token
     # @return [Boolean]
     def revoke(access_token)

data/lib/nylas/categorize.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent the Neural Categorize object.
+  # @see https://developer.nylas.com/docs/intelligence/categorizer/#categorize-message-response
+  class Categorize
+    include Model::Attributable
+
+    attribute :category, :string
+    attribute :categorized_at, :unix_timestamp
+    attribute :model_version, :string
+    has_n_of_attribute :subcategories, :string
+  end
+end

data/lib/nylas/delta.rb

@@ -15,6 +15,8 @@ module Nylas
     attribute :namespace_id, :string
     attribute :account_id, :string
 
+    attribute :headers, :message_headers
+
     attribute :date, :unix_timestamp
     attribute :metadata, :hash
     attribute :object_attributes, :hash

data/lib/nylas/http_client.rb

@@ -5,7 +5,7 @@ module Nylas
 
   # Plain HTTP client that can be used to interact with the Nylas API sans any type casting.
   class HttpClient # rubocop:disable Metrics/ClassLength
-    HTTP_SUCCESS_CODES = [200, 302].freeze
+    HTTP_SUCCESS_CODES = [200, 201, 302].freeze
 
     HTTP_CODE_TO_EXCEPTIONS = {
       400 => InvalidRequest,
@@ -92,7 +92,12 @@ module Nylas
           content_type = response.headers[:content_type].downcase
         end
 
-        response = parse_response(response) if content_type == "application/json"
+        begin
+          response = parse_response(response) if content_type == "application/json"
+        rescue Nylas::JsonParseError
+          handle_failed_response(result: result, response: response)
+          raise
+        end
 
         handle_failed_response(result: result, response: response)
         response
@@ -139,7 +144,7 @@ module Nylas
         "X-Nylas-Client-Id" => @app_id,
         "Nylas-API-Version" => SUPPORTED_API_VERSION,
         "User-Agent" => "Nylas Ruby SDK #{Nylas::VERSION} - #{RUBY_VERSION}",
-        "Content-types" => "application/json"
+        "Content-type" => "application/json"
       }
     end
 
@@ -179,12 +184,12 @@ module Nylas
       return if HTTP_SUCCESS_CODES.include?(http_code)
 
       exception = HTTP_CODE_TO_EXCEPTIONS.fetch(http_code, APIError)
-      parsed_response = parse_response(response)
+      raise exception.new(http_code, response) unless response.is_a?(Hash)
 
       raise exception.new(
-        parsed_response[:type],
-        parsed_response[:message],
-        parsed_response.fetch(:server_error, nil)
+        response[:type],
+        response[:message],
+        response.fetch(:server_error, nil)
       )
     end
 

data/lib/nylas/model/attributable.rb

@@ -63,6 +63,21 @@ module Nylas
           end
         end
 
+        # Allows a class to inherit parent's attributes
+        def inherit_attributes
+          return if superclass.nil?
+
+          parent_attributes = superclass.attribute_definitions
+          parent_attributes.each do |parent_attribute|
+            name = parent_attribute[0]
+            attr = parent_attribute[1]
+            next if attribute_definitions.key?(name)
+
+            attribute_definitions[name] = attr
+            define_accessors(name)
+          end
+        end
+
         def attribute_definitions
           @attribute_definitions ||= Registry.new
         end

data/lib/nylas/neural.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Class containing methods for accessing Neural API features.
+  # @see https://developer.nylas.com/docs/intelligence/
+  class Neural
+    attr_accessor :api
+
+    def initialize(api:)
+      self.api = api
+    end
+
+    def sentiment_analysis_message(message_ids)
+      body = { message_id: message_ids }
+      response = request(NeuralSentimentAnalysis.resources_path, body)
+
+      collection = []
+      response.each do |sentiment|
+        collection.push(NeuralSentimentAnalysis.new(**sentiment.merge(api: api)))
+      end
+      collection
+    end
+
+    def sentiment_analysis_text(text)
+      body = { text: text }
+      NeuralSentimentAnalysis.new(**request(NeuralSentimentAnalysis.resources_path, body).merge(api: api))
+    end
+
+    def extract_signature(message_ids, options = nil)
+      body = { message_id: message_ids }
+      body = body.merge(options) unless options.nil?
+      response = request(NeuralSignatureExtraction.resources_path, body)
+
+      collection = []
+      response.each do |signature|
+        collection.push(NeuralSignatureExtraction.new(**signature.merge(api: api)))
+      end
+      collection
+    end
+
+    def ocr_request(file_id, pages = nil)
+      body = { file_id: file_id }
+      body[:pages] = pages unless pages.nil?
+
+      NeuralOcr.new(**request(NeuralOcr.resources_path, body).merge(api: api))
+    end
+
+    def categorize(message_ids)
+      body = { message_id: message_ids }
+      response = request(NeuralCategorizer.resources_path, body)
+
+      collection = []
+      response.each do |categorize|
+        collection.push(NeuralCategorizer.new(**categorize.merge(api: api)))
+      end
+      collection
+    end
+
+    def clean_conversation(message_ids, options = nil)
+      body = { message_id: message_ids }
+      body = body.merge(delete_from_hash(options.to_hash, :parse_contact)) unless options.nil?
+
+      response = request(NeuralCleanConversation.resources_path, body)
+      collection = []
+      response.each do |conversation|
+        collection.push(NeuralCleanConversation.new(**conversation.merge(api: api)))
+      end
+      collection
+    end
+
+    private
+
+    def request(path, body)
+      api.execute(
+        method: :put,
+        path: path,
+        payload: JSON.dump(body)
+      )
+    end
+
+    # For Ruby < 3.0 support, as it doesn't support Hash.except
+    def delete_from_hash(hash, to_delete)
+      hash.delete(to_delete)
+      hash
+    end
+  end
+end

data/lib/nylas/neural_categorizer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent a the Neural Categorizer object.
+  # @see https://developer.nylas.com/docs/intelligence/categorizer/#categorize-message-response
+  class NeuralCategorizer < Message
+    include Model
+    self.resources_path = "/neural/categorize"
+    allows_operations(listable: true)
+
+    attribute :categorizer, :categorize
+    # Overrides Message's label attribute as currently categorize returns
+    # list of strings for labels instead of label object types
+    has_n_of_attribute :labels, :string
+
+    inherit_attributes
+
+    def recategorize(category)
+      body = { message_id: id, category: category }
+      api.execute(
+        method: :post,
+        path: "#{resources_path}/feedback",
+        payload: JSON.dump(body)
+      )
+      list = api.neural.categorize([id])
+      list[0]
+    end
+  end
+end

data/lib/nylas/neural_clean_conversation.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent a the Neural Clean Conversations object.
+  # @see https://developer.nylas.com/docs/intelligence/clean-conversations/#clean-conversation-response
+  class NeuralCleanConversation < Message
+    include Model
+    self.resources_path = "/neural/conversation"
+    allows_operations(listable: true)
+    IMAGE_REGEX = /[(']cid:(.*?)[)']/.freeze
+
+    attribute :conversation, :string
+    attribute :model_version, :string
+
+    inherit_attributes
+
+    # Parses image file IDs found in the clean conversation object and returns
+    # an array of File objects returned from the File API
+    def extract_images
+      return if conversation.nil?
+
+      files = []
+      matches = conversation.scan(IMAGE_REGEX)
+      matches.each do |match|
+        # After applying the regex, if there are IDs found they would be
+        # in the form of => 'cid:xxxx' (including apostrophes), so we discard
+        # everything before and after the file ID (denoted as xxxx above)
+        files.push(api.files.find(match))
+      end
+      files
+    end
+  end
+end

data/lib/nylas/neural_contact_link.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent the "Link" object in the Neural API's Signature Extraction Contact object
+  # @see https://developer.nylas.com/docs/intelligence/signature-extraction/#parse-signature-response
+  class NeuralContactLink
+    include Model::Attributable
+    attribute :description, :string
+    attribute :url, :string
+  end
+end

data/lib/nylas/neural_contact_name.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent the "Name" object in the Neural API's Signature Extraction Contact object
+  # @see https://developer.nylas.com/docs/intelligence/signature-extraction/#parse-signature-response
+  class NeuralContactName
+    include Model::Attributable
+    attribute :first_name, :string
+    attribute :last_name, :string
+  end
+end

data/lib/nylas/neural_message_options.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent a the Neural Optical Character Recognition object.
+  # @see https://developer.nylas.com/docs/intelligence/optical-charecter-recognition/#ocr-response
+  class NeuralMessageOptions
+    attr_accessor :ignore_links, :ignore_images, :ignore_tables, :remove_conclusion_phrases,
+                  :images_as_markdown, :parse_contact
+
+    def initialize(ignore_links: nil,
+                   ignore_images: nil,
+                   ignore_tables: nil,
+                   remove_conclusion_phrases: nil,
+                   images_as_markdown: nil,
+                   parse_contact: nil)
+      @ignore_links = ignore_links
+      @ignore_images = ignore_images
+      @ignore_tables = ignore_tables
+      @remove_conclusion_phrases = remove_conclusion_phrases
+      @images_as_markdown = images_as_markdown
+      @parse_contact = parse_contact
+    end
+
+    def to_hash
+      hash = {}
+      hash[:ignore_links] = @ignore_links unless @ignore_links.nil?
+      hash[:ignore_images] = @ignore_images unless @ignore_images.nil?
+      hash[:ignore_tables] = @ignore_tables unless @ignore_tables.nil?
+      hash[:remove_conclusion_phrases] = @remove_conclusion_phrases unless @remove_conclusion_phrases.nil?
+      hash[:images_as_markdown] = @images_as_markdown unless @images_as_markdown.nil?
+      hash[:parse_contact] = @parse_contact unless @parse_contact.nil?
+      hash
+    end
+  end
+end

data/lib/nylas/neural_ocr.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent a the Neural Optical Character Recognition object.
+  # @see https://developer.nylas.com/docs/intelligence/optical-charecter-recognition/#ocr-response
+  class NeuralOcr < File
+    include Model
+    self.resources_path = "/neural/ocr"
+    allows_operations(listable: true)
+
+    has_n_of_attribute :ocr, :string
+    attribute :processed_pages, :integer
+
+    inherit_attributes
+  end
+end

data/lib/nylas/neural_sentiment_analysis.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent a the Neural Sentiment Analysis object.
+  # @see https://developer.nylas.com/docs/intelligence/sentiment-analysis/#sentiment-analysis-response-message
+  class NeuralSentimentAnalysis
+    include Model
+    self.resources_path = "/neural/sentiment"
+    allows_operations(listable: true)
+
+    attribute :account_id, :string
+    attribute :sentiment, :string
+    attribute :sentiment_score, :float
+    attribute :processed_length, :integer
+    attribute :text, :string
+  end
+end

data/lib/nylas/neural_signature_contact.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent the Neural API's Signature Extraction Contact object
+  # @see https://developer.nylas.com/docs/intelligence/signature-extraction/#parse-signature-response
+  class NeuralSignatureContact
+    include Model::Attributable
+    has_n_of_attribute :job_titles, :string
+    has_n_of_attribute :links, :neural_contact_link
+    has_n_of_attribute :phone_numbers, :string
+    has_n_of_attribute :emails, :string
+    has_n_of_attribute :names, :neural_contact_name
+
+    attr_accessor :api
+
+    # Creates a Nylas contact object compatible with the contact endpoints.
+    # Please note if multiple names or multiple job titles were parsed only
+    # the first set are used.
+    def to_contact_object
+      contact = merge_multiple_hashes([convert_names, convert_emails, convert_phone_numbers, convert_links])
+      contact[:job_title] = job_titles[0] unless job_titles.nil?
+      Contact.new(**contact.merge(api: api))
+    end
+
+    private
+
+    def convert_names
+      return {} if names.empty?
+
+      contact = {}
+      contact[:given_name] = names[0].first_name if names[0].first_name
+      contact[:surname] = names[0].last_name if names[0].last_name
+      contact
+    end
+
+    def convert_emails
+      return {} if emails.empty?
+
+      contact = {}
+      contact[:emails] = []
+      emails.each do |e|
+        contact[:emails].push(type: "personal", email: e)
+      end
+      contact
+    end
+
+    def convert_phone_numbers
+      return {} if phone_numbers.empty?
+
+      contact = {}
+      contact[:phone_numbers] = []
+      phone_numbers.each do |number|
+        contact[:phone_numbers].push(type: "mobile", number: number)
+      end
+      contact
+    end
+
+    def convert_links
+      return {} if links.empty?
+
+      contact = {}
+      contact[:web_pages] = []
+      links.each do |link|
+        type = "homepage"
+        type = link.description unless link.description.empty?
+        contact[:web_pages].push(type: type, url: link.url)
+      end
+      contact
+    end
+
+    # For Ruby 2.5 support as it doesn't support multiple hashes to merge at once
+    def merge_multiple_hashes(hashes_to_merge)
+      hash = {}
+      hashes_to_merge.each do |new_hash|
+        hash = hash.merge(new_hash)
+      end
+
+      hash
+    end
+  end
+end

data/lib/nylas/neural_signature_extraction.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent a the Signature Extraction Schema.
+  # @see https://developer.nylas.com/docs/intelligence/signature-extraction/#signature-feedback-response
+  class NeuralSignatureExtraction < Message
+    include Model
+    self.resources_path = "/neural/signature"
+
+    attribute :signature, :string
+    attribute :model_version, :string
+    attribute :contacts, :neural_signature_contact
+
+    inherit_attributes
+
+    transfer :api, to: %i[contacts]
+  end
+end

data/lib/nylas/new_message.rb

@@ -26,7 +26,7 @@ module Nylas
     attribute :tracking, :message_tracking
 
     def send!
-      Message.new(api.execute(method: :post, path: "/send", payload: to_json).merge(api: api))
+      Message.new(**api.execute(method: :post, path: "/send", payload: to_json).merge(api: api))
     end
   end
 end

data/lib/nylas/thread.rb

@@ -23,6 +23,7 @@ module Nylas
     has_n_of_attribute :labels, :label
     has_n_of_attribute :folders, :folder
     has_n_of_attribute :message_ids, :string
+    has_n_of_attribute :messages, :message
     has_n_of_attribute :participants, :participant
     attribute :snippet, :string
     attribute :starred, :boolean

data/lib/nylas/types.rb

@@ -144,5 +144,16 @@ module Nylas
       end
     end
     Types.registry[:boolean] = BooleanType.new
+
+    # Type for attributes represented as floats.
+    class FloatType < ValueType
+      # @param value [Object] Strictly casts the passed in value to a boolean (must be true, not "" or 1)
+      def cast(value)
+        return nil if value.nil?
+
+        value.to_f
+      end
+    end
+    Types.registry[:float] = FloatType.new
   end
 end

data/lib/nylas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Nylas, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -270,6 +270,7 @@ files:
 - lib/nylas/account.rb
 - lib/nylas/api.rb
 - lib/nylas/calendar.rb
+- lib/nylas/categorize.rb
 - lib/nylas/collection.rb
 - lib/nylas/constraints.rb
 - lib/nylas/contact.rb
@@ -302,6 +303,16 @@ files:
 - lib/nylas/model/list_attribute_definition.rb
 - lib/nylas/model/transferable.rb
 - lib/nylas/native_authentication.rb
+- lib/nylas/neural.rb
+- lib/nylas/neural_categorizer.rb
+- lib/nylas/neural_clean_conversation.rb
+- lib/nylas/neural_contact_link.rb
+- lib/nylas/neural_contact_name.rb
+- lib/nylas/neural_message_options.rb
+- lib/nylas/neural_ocr.rb
+- lib/nylas/neural_sentiment_analysis.rb
+- lib/nylas/neural_signature_contact.rb
+- lib/nylas/neural_signature_extraction.rb
 - lib/nylas/new_message.rb
 - lib/nylas/nylas_date.rb
 - lib/nylas/participant.rb