loops_sdk 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eeddad6948c305215fe8efe6bd218550fad021aaa12615f6e32b8d69d552fda
-  data.tar.gz: b4632c42a4762b587fc5a96b05c8aa25f734823bb2fe5de31a181556a6ac976d
+  metadata.gz: cef2e34971e3c98b0ceaf334bb80415ab912b3b3c384f9bc0f3daee486af3137
+  data.tar.gz: 43bd7500763bdc8eec606220a122cd5c2acb9ce24e3fa7070917fb13ffa0c541
 SHA512:
-  metadata.gz: e9cff4116be11b5c86aa25137b0fe832ee1dd1875a33a3625554a094048781b2637388ed6065c8cd23be28d6b1771567f1fd5704c63f2f985aae4f3abd5b9f1f
-  data.tar.gz: fc376fc43f139688c1e76bbe5a06cad0c39e6b3762f481636438a33e1548fa9af6eb1ea90f228384cccad162acb88aec927f50cf1487d35e88e18cdba1abc893
+  metadata.gz: 99dffd773f4da8f24ea7679433c8e1c239d96f2b8df98b8fbf7d93cd732b6ca241fe6e1380864a0c74439a31b756b4671d908d8dd2c2cffec43c88347938772f
+  data.tar.gz: '0128fc22eac586c9c3500283493b5519ab279cf5d46fcc46ea92e15c2d057eb106a75fdd9322413ae101d4b460fe0dd33ec6cc244ea8c9751b3cc76903b217c8'

data/README.md

@@ -1,5 +1,7 @@
 # Loops Ruby SDK
 
+[![Gem Total Downloads](https://img.shields.io/gem/dt/loops_sdk?style=social)](https://rubygems.org/gems/loops_sdk)
+
 ## Introduction
 
 This is the official Ruby SDK for [Loops](https://loops.so), an email platform for modern software companies.
@@ -537,6 +539,7 @@ Send an event to trigger an email in Loops. [Read more about events](https://loo
 | `contact_properties` | object | No       | An object containing contact properties, which will be updated or added to the contact when the event is received.<br />Please [add custom properties](https://loops.so/docs/contacts/properties#custom-contact-properties) in your Loops account before using them with the SDK.<br />Values can be of type `string`, `number`, `nil` (to reset a value), `boolean` or `date` ([see allowed date formats](https://loops.so/docs/contacts/properties#dates)). |
 | `event_properties`   | object | No       | An object containing event properties, which will be made available in emails that are triggered by this event.<br />Values can be of type `string`, `number`, `boolean` or `date` ([see allowed date formats](https://loops.so/docs/events/properties#important-information-about-event-properties)).                                                                                                                                                        |
 | `mailing_lists`      | object | No       | An object of mailing list IDs and boolean subscription statuses.                                                                                                                                                                                                                                                                                                                                                                                              |
+| `headers`            | object | No       | Additional headers to send with the request.                                                                                                                                                                                                                                                                                                                                                                                                                  |
 
 #### Examples
 
@@ -573,6 +576,15 @@ response = LoopsSdk::Events.send(
     plan: "pro",
   },
 )
+
+# Example with Idempotency-Key header
+response = LoopsSdk::Events.send(
+  event_name: "signup",
+  email: "hello@gmail.com",
+  headers: {
+    "Idempotency-Key" => "550e8400-e29b-41d4-a716-446655440000"
+  },
+)
 ```
 
 #### Response
@@ -606,12 +618,13 @@ Send a transactional email to a contact. [Learn about sending transactional emai
 | ---------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `transactional_id`           | string   | Yes      | The ID of the transactional email to send.                                                                                                                                                       |
 | `email`                      | string   | Yes      | The email address of the recipient.                                                                                                                                                              |
-| `add_to_audience`            | boolean  | No       | If `true`, a contact will be created in your audience using the `email` value (if a matching contact doesn’t already exist).                                                                     |
+| `add_to_audience`            | boolean  | No       | If `true`, a contact will be created in your audience using the `email` value (if a matching contact doesn't already exist).                                                                     |
 | `data_variables`             | object   | No       | An object containing data as defined by the data variables added to the transactional email template.<br />Values can be of type `string` or `number`.                                           |
 | `attachments`                | object[] | No       | A list of attachments objects.<br />**Please note**: Attachments need to be enabled on your account before using them with the API. [Read more](https://loops.so/docs/transactional/attachments) |
 | `attachments[].filename`     | string   | No       | The name of the file, shown in email clients.                                                                                                                                                    |
 | `attachments[].content_type` | string   | No       | The MIME type of the file.                                                                                                                                                                       |
 | `attachments[].data`         | string   | No       | The base64-encoded content of the file.                                                                                                                                                          |
+| `headers`                    | object   | No       | Additional headers to send with the request.                                                                                                                                                     |
 
 #### Examples
 
@@ -624,6 +637,18 @@ response = LoopsSdk::Transactional.send(
   },
 )
 
+# Example with Idempotency-Key header
+response = LoopsSdk::Transactional.send(
+  transactional_id: "clfq6dinn000yl70fgwwyp82l",
+  email: "hello@gmail.com",
+  data_variables: {
+    loginUrl: "https://myapp.com/login/",
+  },
+  headers: {
+    "Idempotency-Key" => "550e8400-e29b-41d4-a716-446655440000"
+  },
+)
+
 # Please contact us to enable attachments on your account.
 response = LoopsSdk::Transactional.send(
   transactional_id: "clfq6dinn000yl70fgwwyp82l",
@@ -736,6 +761,12 @@ response = LoopsSdk::Transactional.list(perPage: 15)
 
 ---
 
+## Testing
+
+Run tests with `bundle exec rspec`.
+
+---
+
 ## Contributing
 
 Bug reports and pull requests are welcome. Please read our [Contributing Guidelines](CONTRIBUTING.md).

data/lib/loops_sdk/api_key.rb

@@ -4,7 +4,7 @@ module LoopsSdk
   class ApiKey < Base
     class << self
       def test
-        make_request(:get, "v1/api-key")
+        make_request(method: :get, path: "v1/api-key")
       end
     end
   end

data/lib/loops_sdk/base.rb

@@ -20,10 +20,16 @@ module LoopsSdk
         end
       end
 
-      def make_request(method, path, params = {}, body = nil)
-        response = LoopsSdk.configuration.connection.send(method, path, params) do |req|
-          req.body = body.to_json if body
+      def make_request(method:, path:, headers: {}, params: {}, body: nil)
+        merged_headers = LoopsSdk.configuration.connection.headers.merge(headers)
+
+        response = LoopsSdk.configuration.connection.send(method) do |req|
+          req.url path
+          req.headers = merged_headers
+          req.params = params
+          req.body = body ? body.to_json : nil
         end
+
         handle_response(response)
       end
     end

data/lib/loops_sdk/contact_properties.rb

@@ -8,11 +8,11 @@ module LoopsSdk
           name: name,
           type: type
         }
-        make_request(:post, "v1/contacts/properties", {}, body)
+        make_request(method: :post, path: "v1/contacts/properties", body: body)
       end
       def list(list: nil)
         raise ArgumentError, "List value must be nil, 'custom' or 'all'." unless [nil, "custom", "all"].include?(list)
-        make_request(:get, "v1/contacts/properties", {list: list || "all"})
+        make_request(method: :get, path: "v1/contacts/properties", params: { list: list || "all" })
       end
     end
   end

data/lib/loops_sdk/contacts.rb

@@ -8,7 +8,7 @@ module LoopsSdk
           email: email,
           mailingLists: mailing_lists
         }.merge(properties)
-        make_request(:post, "v1/contacts/create", {}, contact_data)
+        make_request(method: :post, path: "v1/contacts/create", body: contact_data)
       end
 
       def update(email:, properties: {}, mailing_lists: {})
@@ -16,7 +16,7 @@ module LoopsSdk
           email: email,
           mailingLists: mailing_lists
         }.merge(properties)
-        make_request(:put, "v1/contacts/update", {}, contact_data)
+        make_request(method: :put, path: "v1/contacts/update", body: contact_data)
       end
 
       def find(email: nil, user_id: nil)
@@ -24,7 +24,7 @@ module LoopsSdk
         raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
 
         params = email ? { email: email } : { userId: user_id }
-        make_request(:get, "v1/contacts/find", params)
+        make_request(method: :get, path: "v1/contacts/find", params: params)
       end
 
       def delete(email: nil, user_id: nil)
@@ -32,7 +32,7 @@ module LoopsSdk
         raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
 
         body = email ? { email: email } : { userId: user_id }
-        make_request(:post, "v1/contacts/delete", {}, body)
+        make_request(method: :post, path: "v1/contacts/delete", body: body)
       end
     end
   end

data/lib/loops_sdk/events.rb

@@ -3,7 +3,7 @@
 module LoopsSdk
   class Events < Base
     class << self
-      def send(event_name:, email: nil, user_id: nil, contact_properties: {}, event_properties: {}, mailing_lists: {})
+      def send(event_name:, email: nil, user_id: nil, contact_properties: {}, event_properties: {}, mailing_lists: {}, headers: {})
         raise ArgumentError, "You must provide an email or user_id value." if email.nil? && user_id.nil?
 
         event_data = {
@@ -13,7 +13,7 @@ module LoopsSdk
           eventProperties: event_properties.compact,
           mailingLists: mailing_lists.compact
         }.merge(contact_properties)
-        make_request(:post, "v1/events/send", {}, event_data)
+        make_request(method: :post, path: "v1/events/send", headers: headers, body: event_data)
       end
     end
   end

data/lib/loops_sdk/mailing_lists.rb

@@ -4,7 +4,7 @@ module LoopsSdk
   class MailingLists < Base
     class << self
       def list
-        make_request(:get, "v1/lists")
+        make_request(method: :get, path: "v1/lists")
       end
     end
   end

data/lib/loops_sdk/transactional.rb

@@ -4,9 +4,9 @@ module LoopsSdk
   class Transactional < Base
     class << self
       def list(perPage: 20, cursor: nil)
-        make_request(:get, "v1/transactional", { perPage: perPage, cursor: cursor })
+        make_request(method: :get, path: "v1/transactional", params: { perPage: perPage, cursor: cursor })
       end
-      def send(transactional_id:, email:, add_to_audience: false, data_variables: {}, attachments: [])
+      def send(transactional_id:, email:, add_to_audience: false, data_variables: {}, attachments: [], headers: {})
         attachments = attachments.map do |attachment|
           attachment.transform_keys { |key| key == :content_type ? :contentType : key }
         end
@@ -17,7 +17,7 @@ module LoopsSdk
           dataVariables: data_variables,
           attachments: attachments
         }.compact
-        make_request(:post, "v1/transactional", {}, email_data)
+        make_request(method: :post, path: "v1/transactional", headers: headers, body: email_data)
       end
     end
   end

data/lib/loops_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoopsSdk
-  VERSION = "1.1.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loops_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Dan Rowden
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-27 00:00:00.000000000 Z
+date: 2025-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday