Fix HTTParty content type for nil request bodies (#536)

- Default POST, PUT, PATCH, DELETE payload to {} when request_body is nil
  to ensure Content-Type: application/json is sent
- Add request_body support to DELETE (e.g. cancellation_reason for bookings)

Author: AaronDDM

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### Unreleased
+* Fixed HTTParty content type issue when request body is nil - POST, PUT, PATCH, and DELETE now default to empty object to ensure Content-Type: application/json is sent (#536)
+* Added support for request_body parameter on DELETE (e.g. cancellation_reason for bookings) (#536)
+
 ### [6.7.0]
 * Added access to response headers
 

examples/.env.example

@@ -14,6 +14,12 @@ NYLAS_API_URI=https://api.us.nylas.com
 # You can get this from your Nylas Dashboard after connecting an account
 NYLAS_GRANT_ID=your_grant_id_here
 
-# Send email - Optionl 
+# Send email - Optional
 # Used for send examples
-NYLAS_TEST_EMAIL=your@email.com
+NYLAS_TEST_EMAIL=your@email.com
+
+# Content-Type fix example (examples/httparty_content_type_fix/)
+# NYLAS_EMAIL=user@gmail.com
+# NYLAS_ACCESS_TOKEN=token_to_revoke
+# NYLAS_BOOKING_ID=booking_id
+# NYLAS_CONFIGURATION_ID=configuration_id

examples/README.md

@@ -7,6 +7,8 @@ This directory contains example applications and scripts that demonstrate how to
 ```
 examples/
 ├── README.md                 # This file
+├── httparty_content_type_fix/  # HTTParty Content-Type fix verification
+│   └── content_type_fix_example.rb   # Verifies POST/DELETE with no body send Content-Type
 ├── events/                   # Event-related examples
 │   └── event_notetaker_example.rb    # Example of creating events with Notetaker
 ├── messages/                 # Message-related examples
@@ -38,6 +40,18 @@ Before running any example, make sure to:
 
 ## Available Examples
 
+### HTTParty Content-Type Fix
+- `httparty_content_type_fix/content_type_fix_example.rb`: Verifies the fix for POST/PUT/PATCH/DELETE requests that previously failed with 422 when no body was provided (HTTParty migration in v6.5.0). Demonstrates:
+  - Auth#detect_provider (POST with query params only)
+  - Auth#revoke (POST with query params only)
+  - Drafts#send (POST with no body)
+  - Bookings#destroy (DELETE with optional cancellation_reason)
+
+  Run all: `ruby examples/httparty_content_type_fix/content_type_fix_example.rb`
+  Run one: `ruby examples/httparty_content_type_fix/content_type_fix_example.rb detect_provider`
+
+  Environment variables: NYLAS_API_KEY (required), NYLAS_EMAIL (for detect_provider), NYLAS_GRANT_ID and NYLAS_TEST_EMAIL (for drafts_send), NYLAS_ACCESS_TOKEN (for revoke), NYLAS_BOOKING_ID and NYLAS_CONFIGURATION_ID (for bookings).
+
 ### Events
 - `events/event_notetaker_example.rb`: Demonstrates how to create calendar events with Notetaker integration, including:
   - Creating an event with a Notetaker bot

lib/nylas/handler/api_operations.rb

@@ -58,19 +58,20 @@ module Post
       protected
 
       include HttpClient
-      # Performs a POST call to the Nylas API.
-      #
-      # @param path [String] Destination path for the call.
-      # @param query_params [Hash, {}] Query params to pass to the call.
-      # @param request_body [Hash, nil] Request body to pass to the call.
-      # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
+    # Performs a POST call to the Nylas API.
+    #
+    # @param path [String] Destination path for the call.
+    # @param query_params [Hash, {}] Query params to pass to the call.
+    # @param request_body [Hash, nil] Request body to pass to the call.
+    #   Defaults to {} when nil to ensure Content-Type: application/json is sent.
+    # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
       # @return [Array(Hash, String, Hash)] Nylas data object, API Request ID, and response headers.
       def post(path:, query_params: {}, request_body: nil, headers: {})
         response = execute(
           method: :post,
           path: path,
           query: query_params,
-          payload: request_body,
+          payload: request_body || {},
           headers: headers,
           api_key: api_key,
           timeout: timeout
@@ -85,19 +86,20 @@ module Put
       protected
 
       include HttpClient
-      # Performs a PUT call to the Nylas API.
-      #
-      # @param path [String] Destination path for the call.
-      # @param query_params [Hash, {}] Query params to pass to the call.
-      # @param request_body [Hash, nil] Request body to pass to the call.
-      # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
+    # Performs a PUT call to the Nylas API.
+    #
+    # @param path [String] Destination path for the call.
+    # @param query_params [Hash, {}] Query params to pass to the call.
+    # @param request_body [Hash, nil] Request body to pass to the call.
+    #   Defaults to {} when nil to ensure Content-Type: application/json is sent.
+    # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
       # @return Nylas data object and API Request ID.
       def put(path:, query_params: {}, request_body: nil, headers: {})
         response = execute(
           method: :put,
           path: path,
           query: query_params,
-          payload: request_body,
+          payload: request_body || {},
           headers: headers,
           api_key: api_key,
           timeout: timeout
@@ -112,19 +114,20 @@ module Patch
       protected
 
       include HttpClient
-      # Performs a PATCH call to the Nylas API.
-      #
-      # @param path [String] Destination path for the call.
-      # @param query_params [Hash, {}] Query params to pass to the call.
-      # @param request_body [Hash, nil] Request body to pass to the call.
-      # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
+    # Performs a PATCH call to the Nylas API.
+    #
+    # @param path [String] Destination path for the call.
+    # @param query_params [Hash, {}] Query params to pass to the call.
+    # @param request_body [Hash, nil] Request body to pass to the call.
+    #   Defaults to {} when nil to ensure Content-Type: application/json is sent.
+    # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
       # @return Nylas data object and API Request ID.
       def patch(path:, query_params: {}, request_body: nil, headers: {})
         response = execute(
           method: :patch,
           path: path,
           query: query_params,
-          payload: request_body,
+          payload: request_body || {},
           headers: headers,
           api_key: api_key,
           timeout: timeout
@@ -139,25 +142,27 @@ module Delete
       protected
 
       include HttpClient
-      # Performs a DELETE call to the Nylas API.
-      #
-      # @param path [String] Destination path for the call.
-      # @param query_params [Hash, {}] Query params to pass to the call.
-      # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
-      # @return Nylas data object and API Request ID.
-      def delete(path:, query_params: {}, headers: {})
-        response = execute(
-          method: :delete,
-          path: path,
-          query: query_params,
-          headers: headers,
-          payload: nil,
-          api_key: api_key,
-          timeout: timeout
-        )
-
-        [response[:data], response[:request_id]]
-      end
+    # Performs a DELETE call to the Nylas API.
+    #
+    # @param path [String] Destination path for the call.
+    # @param query_params [Hash, {}] Query params to pass to the call.
+    # @param request_body [Hash, nil] Optional request body (e.g. cancellation_reason for bookings).
+    #   Defaults to {} to ensure Content-Type: application/json is sent.
+    # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
+    # @return Nylas data object and API Request ID.
+    def delete(path:, query_params: {}, request_body: nil, headers: {})
+      response = execute(
+        method: :delete,
+        path: path,
+        query: query_params,
+        headers: headers,
+        payload: request_body || {},
+        api_key: api_key,
+        timeout: timeout
+      )
+
+      [response[:data], response[:request_id]]
+    end
     end
   end
 end

lib/nylas/resources/bookings.rb

@@ -64,11 +64,13 @@ def confirm(booking_id:, request_body:, query_params: nil)
     # Delete a booking.
     # @param booking_id [String] The id of the booking to delete.
     # @param query_params [Hash, nil] Query params to pass to the request.
+    # @param request_body [Hash, nil] Optional body params (e.g. cancellation_reason).
     # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
-    def destroy(booking_id:, query_params: nil)
+    def destroy(booking_id:, query_params: nil, request_body: nil)
       _, request_id = delete(
         path: "#{api_uri}/v3/scheduling/bookings/#{booking_id}",
-        query_params: query_params
+        query_params: query_params,
+        request_body: request_body
       )
 
       [true, request_id]

spec/nylas/handler/api_operations_spec.rb

@@ -143,7 +143,7 @@ def initialize(api_key, api_uri, timeout)
           method: :post,
           path: path,
           query: {},
-          payload: nil,
+          payload: {},
           headers: {},
           api_key: api_key,
           timeout: timeout
@@ -164,7 +164,7 @@ def initialize(api_key, api_uri, timeout)
           method: :post,
           path: path,
           query: {},
-          payload: nil,
+          payload: {},
           headers: {},
           api_key: api_key,
           timeout: timeout
@@ -174,6 +174,22 @@ def initialize(api_key, api_uri, timeout)
 
         expect(response).to eq([mock_response[:data], mock_response[:request_id], nil])
       end
+
+      it "passes request_body to execute when provided" do
+        path = "#{api_uri}/path"
+        request_body = { foo: "bar" }
+        allow(api_operations).to receive(:execute).with(
+          method: :post,
+          path: path,
+          query: {},
+          payload: request_body,
+          headers: {},
+          api_key: api_key,
+          timeout: timeout
+        ).and_return(mock_response)
+
+        api_operations.send(:post, path: path, request_body: request_body)
+      end
     end
   end
 
@@ -206,7 +222,7 @@ def initialize(api_key, api_uri, timeout)
           method: :put,
           path: path,
           query: {},
-          payload: nil,
+          payload: {},
           headers: {},
           api_key: api_key,
           timeout: timeout
@@ -216,6 +232,22 @@ def initialize(api_key, api_uri, timeout)
 
         expect(response).to eq([mock_response[:data], mock_response[:request_id]])
       end
+
+      it "passes request_body to execute when provided" do
+        path = "#{api_uri}/path"
+        request_body = { foo: "bar" }
+        allow(api_operations).to receive(:execute).with(
+          method: :put,
+          path: path,
+          query: {},
+          payload: request_body,
+          headers: {},
+          api_key: api_key,
+          timeout: timeout
+        ).and_return(mock_response)
+
+        api_operations.send(:put, path: path, request_body: request_body)
+      end
     end
   end
 
@@ -248,7 +280,7 @@ def initialize(api_key, api_uri, timeout)
           method: :patch,
           path: path,
           query: {},
-          payload: nil,
+          payload: {},
           headers: {},
           api_key: api_key,
           timeout: timeout
@@ -258,6 +290,22 @@ def initialize(api_key, api_uri, timeout)
 
         expect(response).to eq([mock_response[:data], mock_response[:request_id]])
       end
+
+      it "passes request_body to execute when provided" do
+        path = "#{api_uri}/path"
+        request_body = { foo: "bar" }
+        allow(api_operations).to receive(:execute).with(
+          method: :patch,
+          path: path,
+          query: {},
+          payload: request_body,
+          headers: {},
+          api_key: api_key,
+          timeout: timeout
+        ).and_return(mock_response)
+
+        api_operations.send(:patch, path: path, request_body: request_body)
+      end
     end
   end
 
@@ -271,7 +319,7 @@ def initialize(api_key, api_uri, timeout)
           method: :delete,
           path: path,
           query: query_params,
-          payload: nil,
+          payload: {},
           headers: headers,
           api_key: api_key,
           timeout: timeout
@@ -288,7 +336,7 @@ def initialize(api_key, api_uri, timeout)
           method: :delete,
           path: path,
           query: {},
-          payload: nil,
+          payload: {},
           headers: {},
           api_key: api_key,
           timeout: timeout
@@ -298,6 +346,22 @@ def initialize(api_key, api_uri, timeout)
 
         expect(response).to eq([mock_response[:data], mock_response[:request_id]])
       end
+
+      it "passes request_body to execute when provided" do
+        path = "#{api_uri}/path"
+        request_body = { cancellation_reason: "Meeting cancelled" }
+        allow(api_operations).to receive(:execute).with(
+          method: :delete,
+          path: path,
+          query: {},
+          payload: request_body,
+          headers: {},
+          api_key: api_key,
+          timeout: timeout
+        ).and_return(mock_response)
+
+        api_operations.send(:delete, path: path, request_body: request_body)
+      end
     end
   end
 end

spec/nylas/handler/http_client_integration_spec.rb

@@ -75,6 +75,46 @@ class TestHttpClientIntegration
     end
   end
 
+  describe "Integration Tests - Content-Type for body-less requests (HTTParty fix)" do
+    it "sends Content-Type: application/json for POST with empty payload" do
+      stub_request(:post, "https://test.api.nylas.com/v3/connect/revoke")
+        .with(
+          body: "{}",
+          headers: { "Content-Type" => "application/json" }
+        )
+        .to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/json" })
+
+      http_client.send(:execute,
+                       method: :post,
+                       path: "https://test.api.nylas.com/v3/connect/revoke",
+                       timeout: 30,
+                       payload: {},
+                       api_key: "fake-key")
+
+      expect(WebMock).to have_requested(:post, "https://test.api.nylas.com/v3/connect/revoke")
+        .with(headers: { "Content-Type" => "application/json" }, body: "{}")
+    end
+
+    it "sends Content-Type: application/json for DELETE with empty payload" do
+      stub_request(:delete, "https://test.api.nylas.com/v3/scheduling/bookings/booking-123")
+        .with(
+          body: "{}",
+          headers: { "Content-Type" => "application/json" }
+        )
+        .to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/json" })
+
+      http_client.send(:execute,
+                       method: :delete,
+                       path: "https://test.api.nylas.com/v3/scheduling/bookings/booking-123",
+                       timeout: 30,
+                       payload: {},
+                       api_key: "fake-key")
+
+      expect(WebMock).to have_requested(:delete, "https://test.api.nylas.com/v3/scheduling/bookings/booking-123")
+        .with(headers: { "Content-Type" => "application/json" }, body: "{}")
+    end
+  end
+
   describe "Integration Tests - backwards compatibility" do
     it "maintains the same response format as rest-client" do
       response_json = { "data" => { "id" => "123", "name" => "test" } }