nylas 5.13.0 → 5.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c270504996973ab93d5c1cac213a194f776fb27302010be6eee1a41570204ff
-  data.tar.gz: 01a2bcc7473080a9fad5c39bd1851487ed1d20f81fab68277a37c6fd5e31c195
+  metadata.gz: b432f464fcd9fec327a4aa014c499cadcf34aa8c4626ae1585d32b4aff9c7b21
+  data.tar.gz: 5c62a00ba6e2f1de70346aa7fe4cdb7d7a129c6b91c76a35c6349e9597ab51c0
 SHA512:
-  metadata.gz: '0485d5539c28e6626cef26ee3b34a3f61eab8c0436f6abddb017ead7034b644efac6502f32fc40236446d04fa7562d615c1fcfc732afbeeee852118874281492'
-  data.tar.gz: 63229ee0942e29703d6a4a2fd6feafd3f7ce639f13e5fd7387c01c195cd549e6b6cd6a6d931fa2ccf98871c1929b4c3c7cacfe46e1fa3d22ed454c8978f8810f
+  metadata.gz: 5220e063570324c94c8baf4e01645017510e497619382e2f872f110d9fbfa9f7c454b50bd87098382f0339cb6da2208eb45e3e6b622c92db330c978a85887f5e
+  data.tar.gz: 0e9388e8c5b7931212bbcdc1b21d324b4025634665aff3a3c3be7bf08f823d08c9b2b820d203287e4dfabaf3b95737a070cc8cb6957b86b80f0dd45dc5e3711d

data/lib/nylas/api.rb

@@ -36,18 +36,15 @@ module Nylas
     end
 
     def authentication_url(redirect_uri:, scopes:, response_type: "code", login_hint: nil, state: nil,
-                           provider: nil, redirect_on_error: nil)
-      params = {
-        client_id: app_id,
-        redirect_uri: redirect_uri,
-        response_type: response_type,
-        login_hint: login_hint
-      }
+                           provider: nil, redirect_on_error: nil, disable_provider_selection: nil)
+      params = { client_id: app_id, redirect_uri: redirect_uri, response_type: response_type,
+                 login_hint: login_hint }
 
       params[:state] = state if state
       params[:scopes] = scopes.join(",") if scopes
       params[:provider] = provider if provider
       params[:redirect_on_error] = redirect_on_error if redirect_on_error
+      params[:disable_provider_selection] = disable_provider_selection if disable_provider_selection
 
       "#{api_server}/oauth/authorize?#{URI.encode_www_form(params)}"
     end

data/lib/nylas/errors.rb

@@ -45,7 +45,54 @@ module Nylas
       self.message = message
       self.server_error = server_error
     end
+
+    def self.parse_error_response(response)
+      new(
+        response["type"],
+        response["message"],
+        response["server_error"]
+      )
+    end
+  end
+
+  # Error class representing a 429 error response, with details on the rate limit
+  class RateLimitError < APIError
+    attr_accessor :rate_limit
+    attr_accessor :rate_limit_reset
+
+    RATE_LIMIT_LIMIT_HEADER = "x_ratelimit_limit"
+    RATE_LIMIT_RESET_HEADER = "x_ratelimit_reset"
+
+    def initialize(type, message, server_error = nil, rate_limit = nil, rate_limit_reset = nil)
+      super(type, message, server_error)
+      self.rate_limit = rate_limit
+      self.rate_limit_reset = rate_limit_reset
+    end
+
+    def self.parse_error_response(response)
+      rate_limit, rate_limit_rest = extract_rate_limit_details(response)
+
+      new(
+        response["type"],
+        response["message"],
+        response["server_error"],
+        rate_limit,
+        rate_limit_rest
+      )
+    end
+
+    def self.extract_rate_limit_details(response)
+      return nil, nil unless response.respond_to?(:headers)
+
+      rate_limit = response.headers[RATE_LIMIT_LIMIT_HEADER.to_sym].to_i
+      rate_limit_rest = response.headers[RATE_LIMIT_RESET_HEADER.to_sym].to_i
+
+      [rate_limit, rate_limit_rest]
+    end
+
+    private_class_method :extract_rate_limit_details
   end
+
   AccessDenied = Class.new(APIError)
   ResourceNotFound = Class.new(APIError)
   MethodNotAllowed = Class.new(APIError)
@@ -55,7 +102,7 @@ module Nylas
   TeapotError = Class.new(APIError)
   RequestTimedOut = Class.new(APIError)
   MessageRejected = Class.new(APIError)
-  SendingQuotaExceeded = Class.new(APIError)
+  SendingQuotaExceeded = Class.new(RateLimitError)
   ServiceUnavailable = Class.new(APIError)
   BadGateway = Class.new(APIError)
   InternalError = Class.new(APIError)

data/lib/nylas/http_client.rb

@@ -189,8 +189,7 @@ module Nylas
     def parse_response(response)
       return response if response.is_a?(Enumerable)
 
-      json = StringIO.new(response)
-      Yajl::Parser.new(symbolize_names: true).parse(json)
+      Yajl::Parser.new(symbolize_names: true).parse(response)
     rescue Yajl::ParseError
       raise Nylas::JsonParseError
     end
@@ -222,9 +221,18 @@ module Nylas
       return if HTTP_SUCCESS_CODES.include?(http_code)
 
       exception = HTTP_CODE_TO_EXCEPTIONS.fetch(http_code, APIError)
-      raise exception.new(http_code, response) unless response.is_a?(Hash)
+      case response
+      when Hash
+        raise error_hash_to_exception(exception, response)
+      when RestClient::Response
+        raise exception.parse_error_response(response)
+      else
+        raise exception.new(http_code, response)
+      end
+    end
 
-      raise exception.new(
+    def error_hash_to_exception(exception, response)
+      exception.new(
         response[:type],
         response[:message],
         response.fetch(:server_error, nil)

data/lib/nylas/services/tunnel.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "faye/websocket"
+require "eventmachine"
+
+module Nylas
+  # Class containing methods to spin up a developmental websocket connection to test webhooks
+  class Tunnel
+    # Open a webhook tunnel and register it with the Nylas API
+    # 1. Creates a UUID
+    # 2. Opens a websocket connection to Nylas' webhook forwarding service, with the UUID as a header
+    # 3. Creates a new webhook pointed at the forwarding service with the UUID as the path
+    # When an event is received by the forwarding service, it will push directly to this websocket connection
+    #
+    # @param api [Nylas::API] The configured Nylas API client
+    # @param config [Hash] Configuration for the webhook tunnel, including callback functions, region, and
+    #   events to subscribe to
+    def self.open_webhook_tunnel(api, config = {})
+      tunnel_id = SecureRandom.uuid
+      triggers = config[:triggers] || WebhookTrigger.constants(false).map { |c| WebhookTrigger.const_get c }
+      region = config[:region] || "us"
+      websocket_domain = "tunnel.nylas.com"
+      callback_domain = "cb.nylas.com"
+
+      EM.run do
+        setup_websocket_client(websocket_domain, api, tunnel_id, region, config)
+        register_webhook_callback(api, callback_domain, tunnel_id, triggers)
+      end
+    end
+
+    # Register callback with the Nylas forwarding service which will pass messages to the websocket
+    # @param api [Nylas::API] The configured Nylas API client
+    # @param callback_domain [String] The domain name of the callback
+    # @param tunnel_path [String] The path to the tunnel
+    # @param triggers [Array<WebhookTrigger>] The list of triggers to subscribe to
+    # @return [Nylas::Webhook] The webhook details response from the API
+    def self.register_webhook_callback(api, callback_domain, tunnel_path, triggers)
+      callback_url = "https://#{callback_domain}/#{tunnel_path}"
+
+      api.webhooks.create(
+        callback_url: callback_url,
+        state: WebhookState::ACTIVE,
+        triggers: triggers
+      )
+    end
+
+    # Setup the websocket client and register the callbacks
+    # @param websocket_domain [String] The domain of the websocket to connect to
+    # @param api [Nylas::API] The configured Nylas API client
+    # @param tunnel_id [String] The ID of the tunnel
+    # @param region [String] The Nylas region to configure for
+    # @param config [Hash] The object containing all the callback methods
+    # @return [WebSocket::Client] The configured websocket client
+    def self.setup_websocket_client(websocket_domain, api, tunnel_id, region, config)
+      ws = Faye::WebSocket::Client.new(
+        "wss://#{websocket_domain}",
+        [],
+        {
+          headers: {
+            "Client-Id" => api.client.app_id,
+            "Client-Secret" => api.client.app_secret,
+            "Tunnel-Id" => tunnel_id,
+            "Region" => region
+          }
+        }
+      )
+
+      ws.on :open do |event|
+        config[:on_open].call(event) if callable(config[:on_open])
+      end
+
+      ws.on :close do |close|
+        config[:on_close].call(close) if callable(config[:on_close])
+        EM.stop
+      end
+
+      ws.on :error do |error|
+        config[:on_error].call(error) if callable(config[:on_error])
+      end
+
+      ws.on :message do |message|
+        deltas = parse_deltas_from_message(message)
+        next if deltas.nil?
+
+        deltas.each do |delta|
+          delta = merge_and_create_delta(delta)
+          config[:on_message].call(delta) if callable(config[:on_message])
+        end
+      end
+
+      ws
+    end
+
+    # Check if the object is a method
+    # @param obj [Any] The object to check
+    # @return [Boolean] True if the object is a method
+    def self.callable(obj)
+      !obj.nil? && obj.respond_to?(:call)
+    end
+
+    # Parse deltas from the message object
+    # @param message [Any] The message object containing the deltas
+    # @return [Hash] The parsed list of deltas
+    def self.parse_deltas_from_message(message)
+      return unless message.data
+
+      json = JSON.parse(message.data)
+      JSON.parse(json["body"])["deltas"]
+    end
+
+    # Clean up and create the delta object
+    # @param delta [Hash] The hash containing the delta attributes from the API
+    # @return [Nylas::Delta] The delta object
+    def self.merge_and_create_delta(delta)
+      object_data = delta.delete("object_data")
+      attributes = object_data.delete("attributes")
+      object_data["object_attributes"] = attributes
+      delta = delta.merge(object_data).transform_keys(&:to_sym)
+      Delta.new(**delta)
+    end
+
+    private_class_method :setup_websocket_client,
+                         :callable,
+                         :parse_deltas_from_message,
+                         :merge_and_create_delta
+  end
+end

data/lib/nylas/version.rb

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

data/lib/nylas.rb

@@ -116,6 +116,8 @@ require_relative "nylas/scheduler_booking_confirmation"
 require_relative "nylas/native_authentication"
 
 require_relative "nylas/filter_attributes"
+
+require_relative "nylas/services/tunnel"
 # an SDK for interacting with the Nylas API
 # @see https://docs.nylas.com/reference
 module Nylas

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 5.13.0
+  version: 5.15.0
 platform: ruby
 authors:
 - Nylas, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2023-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.7.0
-- !ruby/object:Gem::Dependency
-  name: tzinfo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9
+        version: 0.4.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9
+        version: 0.4.9.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +234,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -268,6 +282,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -373,6 +401,7 @@ files:
 - lib/nylas/scheduler_time_slot.rb
 - lib/nylas/search_collection.rb
 - lib/nylas/send_grid_verified_status.rb
+- lib/nylas/services/tunnel.rb
 - lib/nylas/thread.rb
 - lib/nylas/time_slot.rb
 - lib/nylas/time_slot_capacity.rb