nylas 6.0.0.beta.3 → 6.0.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5153fbe30a05d237c4e17da6ff51005ded6667ae710a50e349535079bfd5db91
-  data.tar.gz: 21e167b02e08cbf456ca45ffd94372fe6db8bf3fc7a1b5637ecf8bd5cde361bc
+  metadata.gz: 15031848530cb5f183abdfb133349ec89309ae8bfc723e1a3d3c52941035e5e0
+  data.tar.gz: 6d2924c481e0d971cbfcafd95168e75d5a45f9880535451083dbedd9ef9c18cd
 SHA512:
-  metadata.gz: 232c65750e5e6027cf4414519be4e91a497c48b394d779ac2500af8bf82f3bf5317ecb1ec94261f80eb0cd46b373e88727c2aed65b036950f9d239a4276d313c
-  data.tar.gz: ccb50fddee574741f2baf36d4f44b46e246b219e0cb9d764d1ee2f1307cf8bf1a45aaec3a3bbe363f471b98ecc646fd60b79643ab730262308e9914a199b4719
+  metadata.gz: 55891a3badca093a691e83d5422a4a913de488ea87ac62b60f3d5316879e18532249fe7d7ff3a286a02af82bc42bcad551b2fad96d8c69cf2a69347dcbada7b7
+  data.tar.gz: 91bbb29bed0d52991c53a6619064057dba815e52a16fb616127545aefa78caaa8745e03285fc6f5521f16faed61d0b8ee2dd6bc68f828a6dc65f73ba139d60b6

data/lib/nylas/client.rb

@@ -18,7 +18,7 @@ module Nylas
     #
     # @param api_key [String, nil] API key to use for the client session.
     # @param api_uri [String] Client session's host.
-    # @param timeout [String, nil] Timeout value to use for the client session.
+    # @param timeout [Integer, nil] Timeout value to use for the client session.
     def initialize(api_key:,
                    api_uri: Config::DEFAULT_REGION_URL,
                    timeout: nil)

data/lib/nylas/handler/http_client.rb

@@ -42,8 +42,8 @@ module Nylas
 
           parse_json_evaluate_error(result.code.to_i, response, path, content_type)
         end
-      rescue Timeout::Error => _e
-        raise Nylas::NylasSdkTimeoutError.new(request.path, timeout)
+      rescue RestClient::Exceptions::OpenTimeout, RestClient::Exceptions::ReadTimeout
+        raise Nylas::NylasSdkTimeoutError.new(request[:path], timeout)
       end
     end
 
@@ -92,8 +92,7 @@ module Nylas
     def build_request(
       method:, path: nil, headers: {}, query: {}, payload: nil, timeout: nil, api_key: nil
     )
-      url = path
-      url = add_query_params_to_url(url, query)
+      url = build_url(path, query)
       resulting_headers = default_headers.merge(headers).merge(auth_header(api_key))
       if !payload.nil? && !payload["multipart"]
         payload = payload&.to_json
@@ -206,33 +205,43 @@ module Nylas
     end
 
     # Adds query parameters to a URL.
-    #
+    # @param url [String] The base URL.
+    # @param query [Hash] The query parameters to add to the URL.
     # @return [String] Processed URL, including query params.
-    def add_query_params_to_url(url, query)
+    def build_url(url, query = nil)
       unless query.nil? || query.empty?
         uri = URI.parse(url)
-        query = custom_params(query)
-        params = URI.decode_www_form(uri.query || "") + query.to_a
-        uri.query = URI.encode_www_form(params)
+        uri = build_query(uri, query)
         url = uri.to_s
       end
 
       url
     end
 
-    # Defines custom parameters for a metadata_pair query.
-    #
-    # @return [String] Custom parameter in "<key>:<value>" format.
-    def custom_params(query)
-      # Convert hash to "<key>:<value>" form for metadata_pair query.
-      if query.key?(:metadata_pair)
-        pairs = query[:metadata_pair].map do |key, value|
-          "#{key}:#{value}"
+    # Build the query string for a URI.
+    # @param uri [URI] URL to add the query to.
+    # @param query [Hash] The query params to include in the query.
+    # @return [URI] The URI object with the query parameters included.
+    def build_query(uri, query)
+      query.each do |key, value|
+        case value
+        when Array
+          value.each do |item|
+            qs = "#{URI.encode_www_form_component(key)}=#{URI.encode_www_form_component(item)}"
+            uri.query = [uri.query, qs].compact.join("&")
+          end
+        when Hash
+          value.each do |k, v|
+            qs = "#{URI.encode_www_form_component(key)}=#{URI.encode_www_form_component("#{k}:#{v}")}"
+            uri.query = [uri.query, qs].compact.join("&")
+          end
+        else
+          qs = "#{URI.encode_www_form_component(key)}=#{URI.encode_www_form_component(value)}"
+          uri.query = [uri.query, qs].compact.join("&")
         end
-        query[:metadata_pair] = pairs
       end
 
-      query
+      uri
     end
 
     # Set the authorization header for an API query.

data/lib/nylas/resources/applications.rb

@@ -17,10 +17,10 @@ module Nylas
       @redirect_uris = RedirectUris.new(sdk_instance)
     end
 
-    # Gets the application object.
+    # Get application details.
     #
-    # @return [Array(Hash, String)] Application object and API Request ID.
-    def info
+    # @return [Array(Hash, String)] Application details and API Request ID.
+    def get_details
       get(path: "#{api_uri}/v3/applications")
     end
   end

data/lib/nylas/resources/auth.rb

@@ -59,7 +59,7 @@ module Nylas
     #   IMPORTANT: You must store the 'secret' returned to use it inside the CodeExchange flow.
     #
     # @param config [Hash] Configuration for building the URL.
-    # @return [OpenStruct] URL for hosted authentication with the secret and the hashed secret.
+    # @return [Hash] URL for hosted authentication with the secret and the hashed secret.
     def url_for_oauth2_pkce(config)
       url = url_auth_builder(config)
 
@@ -71,7 +71,7 @@ module Nylas
       url.query = build_query_with_pkce(config, secret_hash)
 
       # Returns the URL with secret and hashed secret.
-      OpenStruct.new(secret: secret, secret_hash: secret_hash, url: url.to_s)
+      { secret: secret, secret_hash: secret_hash, url: url.to_s }
     end
 
     # Builds the URL for admin consent authentication for Microsoft.
@@ -81,9 +81,7 @@ module Nylas
     def url_for_admin_consent(config)
       config_with_provider = config.merge("provider" => "microsoft")
       url = url_auth_builder(config_with_provider)
-
-      query_params = build_query_with_admin_consent(config)
-      url.query = URI.encode_www_form(query_params)
+      url.query = build_query_with_admin_consent(config)
 
       url.to_s
     end
@@ -102,47 +100,58 @@ module Nylas
       true
     end
 
+    # Detects the provider of an email address.
+    # @param params [Hash] Parameters to detect the provider.
+    # @return [Array(Hash, String)] Detected provider, if found and API Request ID.
+    def detect_provider(params)
+      post(
+        path: "#{api_uri}/v3/providers/detect",
+        query_params: params
+      )
+    end
+
     private
 
     # Builds the query with admin consent authentication for Microsoft.
     #
     # @param config [Hash] Configuration for the query.
-    # @return [Array(Hash, String)] Updated list of parameters, including those specific to admin
+    # @return [String] Updated list of parameters, including those specific to admin
     # consent.
     def build_query_with_admin_consent(config)
       params = build_query(config)
 
       # Appends new params specific for admin consent.
-      params["response_type"] = "adminconsent"
-      params["credential_id"] = config["credentialId"]
+      params[:provider] = "microsoft"
+      params[:response_type] = "adminconsent"
+      params[:credential_id] = config[:credential_id] if config[:credential_id]
 
-      params
+      URI.encode_www_form(params).gsub("+", "%20")
     end
 
     # Builds the query with PKCE.
     #
     # @param config [Hash] Configuration for the query.
     # @param secret_hash [Hash] Hashed secret.
-    # @return [Array(Hash, String)] Updated list of encoded parameters, including those specific
+    # @return [String] Updated list of encoded parameters, including those specific
     # to PKCE.
     def build_query_with_pkce(config, secret_hash)
       params = build_query(config)
 
       # Appends new PKCE specific params.
-      params["code_challenge_method"] = "s256"
-      params["code_challenge"] = secret_hash
+      params[:code_challenge_method] = "s256"
+      params[:code_challenge] = secret_hash
 
-      URI.encode_www_form(params)
+      URI.encode_www_form(params).gsub("+", "%20")
     end
 
     # Builds the authentication URL.
     #
     # @param config [Hash] Configuration for the query.
-    # @return [Array(Hash, String)] List of components for the authentication URL.
+    # @return [URI] List of components for the authentication URL.
     def url_auth_builder(config)
       builder = URI.parse(api_uri)
       builder.path = "/v3/connect/auth"
-      builder.query = build_query(config)
+      builder.query = URI.encode_www_form(build_query(config)).gsub!("+", "%20")
 
       builder
     end
@@ -150,40 +159,42 @@ module Nylas
     # Builds the query.
     #
     # @param config [Hash] Configuration for the query.
-    # @return [Array(Hash, String)] List of encoded parameters for the query.
+    # @return [Hash] List of parameters to encode in the query.
     def build_query(config)
       params = {
-        "client_id" => config[:client_id],
-        "redirect_uri" => config[:redirect_uri],
-        "access_type" => config[:access_type] || "online",
-        "response_type" => "code"
+        client_id: config[:client_id],
+        redirect_uri: config[:redirect_uri],
+        access_type: config[:access_type] || "online",
+        response_type: "code"
       }
-      params["provider"] = config[:provider] if config[:provider]
-      params["prompt"] = config[:prompt] if config[:prompt]
-      params["metadata"] = config[:metadata] if config[:metadata]
-      params["state"] = config[:state] if config[:state]
-      params["scope"] = config[:scope].join(" ") if config[:scope]
+      params[:provider] = config[:provider] if config[:provider]
+      params[:prompt] = config[:prompt] if config[:prompt]
+      params[:metadata] = config[:metadata] if config[:metadata]
+      params[:state] = config[:state] if config[:state]
+      params[:scope] = config[:scope].join(" ") if config[:scope]
       if config[:login_hint]
-        params["login_hint"] = config[:login_hint]
-        params["include_grant_scopes"] = config[:include_grant_scopes].to_s if config[:include_grant_scopes]
+        params[:login_hint] = config[:login_hint]
+        params[:include_grant_scopes] = config[:include_grant_scopes].to_s if config[:include_grant_scopes]
       end
 
-      URI.encode_www_form(params)
+      params
     end
 
-    # Hashes the secret for PKCE authentication.
+    # Hash a plain text secret for use in PKCE.
     #
-    # @param secret [String] Randomly-generated authentication secret.
-    # @return [Hash] Hashed authentication secret.
+    # @param secret [String] The plain text secret to hash.
+    # @return [String] The hashed secret with base64 encoding (without padding).
     def hash_pkce_secret(secret)
-      Digest::SHA256.digest(secret).unpack1("H*")
-      Base64.strict_encode64(Digest::SHA256.digest(secret))
+      sha256_hash = Digest::SHA256.hexdigest(secret)
+      Base64.urlsafe_encode64(sha256_hash, padding: false)
     end
 
     # Sends the token request to the Nylas API.
     #
     # @param request [Hash] Code exchange request.
     def execute_token_request(request)
+      request[:client_secret] = api_key if request[:client_secret].nil?
+
       execute(
         method: :post,
         path: "#{api_uri}/v3/connect/token",

data/lib/nylas/resources/connectors.rb

@@ -8,7 +8,7 @@ module Nylas
   class Connectors < Resource
     include ApiOperations::Get
     include ApiOperations::Post
-    include ApiOperations::Put
+    include ApiOperations::Patch
     include ApiOperations::Delete
 
     # Access the Credentials API
@@ -59,7 +59,7 @@ module Nylas
     # @param request_body [Hash] The values to update the connector with
     # @return [Array(Hash, String)] The updated connector and API Request ID.
     def update(provider:, request_body:)
-      put(
+      patch(
         path: "#{api_uri}/v3/connectors/#{provider}",
         request_body: request_body
       )

data/lib/nylas/resources/contacts.rb

@@ -79,7 +79,7 @@ module Nylas
     # @param identifier [String] Grant ID or email account to query.
     # @param query_params [Hash, nil] Query params to pass to the request.
     # @return [Array(Array(Hash), String)] The list of contact groups and API Request ID.
-    def contact_groups(identifier:, query_params: nil)
+    def list_groups(identifier:, query_params: nil)
       get(
         path: "#{api_uri}/v3/grants/#{identifier}/contacts/groups",
         query_params: query_params

data/lib/nylas/resources/credentials.rb

@@ -8,7 +8,7 @@ module Nylas
   class Credentials < Resource
     include ApiOperations::Get
     include ApiOperations::Post
-    include ApiOperations::Put
+    include ApiOperations::Patch
     include ApiOperations::Delete
 
     # Return all credentials.
@@ -53,7 +53,7 @@ module Nylas
     # @param request_body [Hash] The values to update the connector with
     # @return [Array(Hash, String)] The updated connector and API Request ID.
     def update(provider:, credential_id:, request_body:)
-      put(
+      patch(
         path: "#{api_uri}/v3/connectors/#{provider}/creds/#{credential_id}",
         request_body: request_body
       )

data/lib/nylas/resources/events.rb

@@ -86,7 +86,7 @@ module Nylas
     # @param event_id [String] The id of the event to respond to.
     # @param request_body [Hash] The status values to send the RSVP with.
     # @param query_params [Hash] The query parameters to include in the request
-    # @return [Hash] Response object with the API Request ID.
+    # @return [(Hash, String)] Response object with the API Request ID.
     def send_rsvp(identifier:, event_id:, request_body:, query_params:)
       post(
         path: "#{api_uri}/v3/grants/#{identifier}/events/#{event_id}/send-rsvp",

data/lib/nylas/resources/grants.rb

@@ -16,7 +16,7 @@ module Nylas
     # @return [Array(Array(Hash), String)] The list of grants and API Request ID.
     def list(query_params: nil)
       get(
-        path: "#{api_uri}/v3/grant",
+        path: "#{api_uri}/v3/grants",
         query_params: query_params
       )
     end
@@ -27,7 +27,7 @@ module Nylas
     # @return [Array(Hash, String)] The grant and API request ID.
     def find(grant_id:)
       get(
-        path: "#{api_uri}/v3/grant/#{grant_id}"
+        path: "#{api_uri}/v3/grants/#{grant_id}"
       )
     end
 
@@ -38,7 +38,7 @@ module Nylas
     # @return [Array(Hash, String)] The updated grant and API Request ID.
     def update(grant_id:, request_body:)
       put(
-        path: "#{api_uri}/v3/grant/#{grant_id}",
+        path: "#{api_uri}/v3/grants/#{grant_id}",
         request_body: request_body
       )
     end
@@ -49,7 +49,7 @@ module Nylas
     # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
     def destroy(grant_id:)
       _, request_id = delete(
-        path: "#{api_uri}/v3/grant/#{grant_id}"
+        path: "#{api_uri}/v3/grants/#{grant_id}"
       )
 
       [true, request_id]

data/lib/nylas/resources/messages.rb

@@ -94,21 +94,21 @@ module Nylas
     # Retrieve your scheduled messages.
     #
     # @param identifier [String] Grant ID or email account from which to find the scheduled message from.
-    # @param schedule_id [String] The id of the scheduled message to stop.
     # @return [Array(Hash, String)] The list of scheduled messages and the API Request ID.
-    def list_scheduled_messages(identifier:, schedule_id:)
+    def list_scheduled_messages(identifier:)
       get(
-        path: "#{api_uri}/v3/grants/#{identifier}/messages/schedules/#{schedule_id}"
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/schedules"
       )
     end
 
     # Retrieve your scheduled messages.
     #
     # @param identifier [String] Grant ID or email account from which to list the scheduled messages from.
+    # @param schedule_id [String] The id of the scheduled message to stop.
     # @return [Array(Hash, String)] The scheduled message and the API Request ID.
-    def find_scheduled_messages(identifier:)
+    def find_scheduled_messages(identifier:, schedule_id:)
       get(
-        path: "#{api_uri}/v3/grants/#{identifier}/messages/schedules"
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/schedules/#{schedule_id}"
       )
     end
 

data/lib/nylas/resources/webhooks.rb

@@ -84,5 +84,38 @@ module Nylas
 
       [true, request_id]
     end
+
+    # Update the webhook secret value for a destination.
+    # @param webhook_id [String] The ID of the webhook destination to update.
+    # @return [Array(Hash, String)] The updated webhook destination and API Request ID.
+    def rotate_secret(webhook_id:)
+      put(
+        path: "#{api_uri}/v3/webhooks/#{webhook_id}/rotate-secret",
+        request_body: {}
+      )
+    end
+
+    # Get the current list of IP addresses that Nylas sends webhooks from
+    # @return [Array(Hash, String)] List of IP addresses that Nylas sends webhooks from and API Request ID.
+    def ip_addresses
+      get(
+        path: "#{api_uri}/v3/webhooks/ip-addresses"
+      )
+    end
+
+    # Extract the challenge parameter from a URL
+    # @param url [String] The URL sent by Nylas containing the challenge parameter
+    # @return [String] The challenge parameter
+    def self.extract_challenge_parameter(url)
+      url_object = URI.parse(url)
+      query = CGI.parse(url_object.query || "")
+
+      challenge_parameter = query["challenge"]
+      if challenge_parameter.nil? || challenge_parameter.empty? || challenge_parameter.first.nil?
+        raise "Invalid URL or no challenge parameter found."
+      end
+
+      challenge_parameter.first
+    end
   end
 end

data/lib/nylas/test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "nylas"
+
+nylas = Nylas::Client.new(api_key: "abc123")
+config = {
+  client_id: ENV["V3_CLIENT"],
+  provider: "google",
+  redirect_uri: "http://localhost:4567/oauth/exchange",
+  login_hint: "atejada@gmail.com"
+}
+
+auth_data = nylas.auth.url_for_oauth2_pkce(config)
+puts auth_data

data/lib/nylas/utils/file_utils.rb

@@ -38,8 +38,12 @@ module Nylas
     # @return [Hash] The request that will attach the file to the message/draft
     def self.attach_file_request_builder(file_path)
       filename = File.basename(file_path)
-      content_type = MIME::Types.type_for(file_path).first.to_s
-      content_type = "application/octet-stream" if content_type.empty?
+      content_type = MIME::Types.type_for(file_path)
+      content_type = if !content_type.nil? && !content_type.empty?
+                       content_type.first.to_s
+                     else
+                       "application/octet-stream"
+                     end
       size = File.size(file_path)
       content = File.new(file_path, "rb")
 

data/lib/nylas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nylas
-  VERSION = "6.0.0.beta.3"
+  VERSION = "6.0.0.beta.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 6.0.0.beta.3
+  version: 6.0.0.beta.4
 platform: ruby
 authors:
 - Nylas, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -180,14 +180,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: simplecov-cobertura
   requirement: !ruby/object:Gem::Requirement
@@ -251,6 +251,7 @@ files:
 - lib/nylas/resources/smart_compose.rb
 - lib/nylas/resources/threads.rb
 - lib/nylas/resources/webhooks.rb
+- lib/nylas/test.rb
 - lib/nylas/utils/file_utils.rb
 - lib/nylas/version.rb
 homepage: