customerio 5.2.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ad688e060a453d3f02dfcdacc1407a4376fd355deb6feb6a531d4f2b9ebbad6
-  data.tar.gz: ea3401fa18f031f4ecb70fc79ee8817b0278294debe53f2f78adb403873f32a5
+  metadata.gz: 315eb46a7117b5e0408a57f896c49bf7336003db16439780d119ddc8e4015a1a
+  data.tar.gz: 41ddd049e7978bb75e8c792dda18090e9ffe7e64a85079a2e4d56cbc097feb48
 SHA512:
-  metadata.gz: 8b708a8aba7b91c3a270b2829cc7ba24cad4d72e8030f04cc266dcf97adcb9de8579f0fe159eeed5c95669890dd30376f05c28b43540894feb8dd15f25a516d4
-  data.tar.gz: 128500f502747de7b3d4e92a201ebcf23fa2ebe731f529fb57d72f2919f95f81f3cb8e59917a621e9e475c957c234302641581415d21cfa2189d3aa994889557
+  metadata.gz: 895cf3b64c4f57ed636a2a80c7c356eb4387edd2f5c5c65d1d46b0a418330333f84f66407ef8d844adeeda13d6089ee00d3ce60d22790d17fa246622c291f9d9
+  data.tar.gz: f213766bfb67f9ad8d570292816bba51e7c6863fbcc15d98e4f1f75d80953b00813e9c531c5b84d013f5531e23f4f623dbe77e5d054ea1ccc125608ef00a343b

data/.github/workflows/main.yml

@@ -6,13 +6,13 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
+        ruby: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4']
     runs-on: ubuntu-latest
     env:
       BUNDLE_PATH: ${{ github.workspace }}/vendor/bundle
     steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@354a1ad156761f5ee2b7b13fa8e09943a5e8d252 # v1.229.0
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true

data/CHANGELOG.markdown

@@ -1,3 +1,12 @@
+## Customerio 5.4.0 - June 13, 2025
+### Changed
+- Added `send_sms` to `APIClient` and `SendSMSRequest` to support sending transactional push notifications.
+
+## Customerio 5.3.0 - December 8, 2023
+### Changed
+- The `identify` method has been updated to allow the customer ID to be specified separately from the attributes, using the `customer_id` attribute. This allows a person to be updated by identifying them by e.g.: their email address. Thanks to trwalzer, jrbeck and jeremyw for the original changes that this is based on.
+- It is no longer possible to set the `customer_id` attribute on a person. This is a side-effect of the changes to the `identify` method.
+
 ## Customerio 5.2.0 - December 8, 2023
 ### Changed
 - The `identify` method will now automatically use the `cio_id` attribute as the customer ID when calling the track service. This allows a customer to be updated using `identify` to modify the `id` and `email` attributes.

data/README.md

@@ -1,16 +1,15 @@
-<p align="center">
+<p align=center>
   <a href="https://customer.io">
-    <img src="https://files.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LSFjPaMQn1zKdYh6i89%2F-LU6OglGKqQfqMd5Zl-V%2F-LU6OzOLnOvy8VLwfgdg%2FLogo-Color-Horizontal.png?alt=media&token=add29dd0-cabb-4440-b46b-aed21350ae90" height="60">
+    <img src="https://avatars.githubusercontent.com/u/1152079?s=200&v=4" height="60">
   </a>
-  <p align="center">Power automated communication that people like to receive.</p>
 </p>
 
 [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blueviolet?logo=gitpod)](https://gitpod.io/#https://github.com/customerio/customerio-ruby/)
 [![ci](https://github.com/customerio/customerio-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/customerio/customerio-ruby/actions/workflows/main.yml)
 
-# Customer.io Ruby
+# Customer.io Ruby 
 
-A ruby client for the [Customer.io Track API](https://customer.io/docs/api/#tag/trackOverview).
+A ruby client for the [Customer.io Journeys Track API](https://customer.io/docs/api/track/).
 
 ## Installation
 
@@ -95,7 +94,7 @@ $customerio.identify(
 )
 ```
 
-### Updating customers
+### Updating customers: Changing identifiers
 
 You can use the identify operation to update customers.
 If you need to change the `id` or `email` identifiers for a customer,
@@ -113,6 +112,35 @@ $customerio.identify(
 )
 ```
 
+This method requires either the `id` or `cio_id` for the person. It does not work with email addresses.
+
+You can also use this method to make other updates to the person using the `cio_id`.
+
+### Updating customers: Using email address
+
+If you need to identify a person using their email address, then you can do so
+by passing in a customer ID to the `identify` method. This allows you to specify
+a customer ID that is different than the one used in the `id` attribute. E.g.:
+
+```ruby
+# Arguments
+# customer_id (required) - the customer ID to use for this customer, may be an id, email address, or the cio_id.
+#                         This will be used to construct the URL but not sent in the body attributes.
+# attributes (required) - a hash of information about the customer. You can pass any
+#                         information that would be useful in your triggers. You
+#                         must at least pass in an id, email, and created_at timestamp.
+
+$customerio.identify(
+  :customer_id => "bob@example.com",
+  :location => "Australia"
+)
+```
+
+Note:
+
+ * If you want to use the `cio_id` in the `customer_id` field of `identify_customer_id`, you will need to prefix it with `"cio_"`. E.g.: `"cio_f000000d"` for a `cio_id` of `f000000d`.
+ * The `identify` method can identify the person using one of `customer_id`, `cio_id` or `id`. The order of precedence is `customer_id` > `cio_id` > `id`.
+
 ### Deleting customers
 
 Deleting a customer will remove them, and all their information from

data/customerio.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["john@customer.io"]
   gem.description   = "A ruby client for the Customer.io event API."
   gem.summary       = "A ruby client for the Customer.io event API."
-  gem.homepage      = "http://customer.io"
+  gem.homepage      = "https://customer.io"
   gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($\)
@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('multi_json', "~> 1.0")
   gem.add_dependency('addressable', '~> 2.8.0')
+  gem.add_dependency('base64', '~> 0.3.0')
 
   gem.add_development_dependency('rake', '~> 10.5')
   gem.add_development_dependency('rspec', '~> 3.10')

data/lib/customerio/api.rb

@@ -41,6 +41,21 @@ module Customerio
       end
     end
 
+    def send_sms(req)
+      raise "request must be an instance of Customerio::SendSMSRequest" unless req.is_a?(Customerio::SendSMSRequest)
+      response = @client.request(:post, send_sms_path, req.message)
+
+      case response
+      when Net::HTTPSuccess then
+        JSON.parse(response.body)
+      when Net::HTTPBadRequest then
+        json = JSON.parse(response.body)
+        raise Customerio::InvalidResponse.new(response.code, json['meta']['error'], response)
+      else
+        raise InvalidResponse.new(response.code, response.body)
+      end
+    end
+
     private
 
     def send_email_path
@@ -50,5 +65,9 @@ module Customerio
     def send_push_path
       "/v1/send/push"
     end
+
+    def send_sms_path
+      "/v1/send/sms"
+    end
   end
 end

data/lib/customerio/client.rb

@@ -151,16 +151,33 @@ module Customerio
 
     def create_or_update(attributes = {})
       attributes = Hash[attributes.map { |(k,v)| [ k.to_sym, v ] }]
-      if is_empty?(attributes[:id]) && is_empty?(attributes[:cio_id])
+      if is_empty?(attributes[:id]) && is_empty?(attributes[:cio_id]) && is_empty?(attributes[:customer_id])
         raise MissingIdAttributeError.new("Must provide a customer id")
       end
 
       # Use cio_id as the identifier, if present,
       # to allow the id and email identifiers to be updated.
+      # The person is identified by a customer ID, which is included
+      # in the path to the Track v1 API. Choose the ID in this order
+      # from highest to lowest precedence:
+      #
+      # 1. customer_id: "id", an email address, or "cio_id" value.
+      #    Any "cio_id" values need to be prefixed "cio_"
+      #    so that the Track v1 API knows it's a cio_id.
+      #
+      # 2. cio_id: The cio_id value (no prefix required).
+      #
+      # 3. id: The id value.
       customer_id = attributes[:id]
       if !is_empty?(attributes[:cio_id])
         customer_id = "cio_" + attributes[:cio_id]
       end
+      if !is_empty?(attributes[:customer_id])
+        customer_id = attributes[:customer_id]
+      end
+      # customer_id is not an attribute, so remove it.
+      attributes.delete(:customer_id)
+
       url = customer_path(customer_id)
       @client.request_and_verify_response(:put, url, attributes)
     end

data/lib/customerio/requests/send_sms_request.rb

@@ -0,0 +1,42 @@
+require 'base64'
+
+module Customerio
+  class SendSMSRequest
+    attr_reader :message
+
+    def initialize(opts)
+      @message = opts.delete_if { |field| invalid_field?(field) }
+      @message[:attachments] = {}
+      @message[:headers] = {}
+    end
+
+    def attach(name, data, encode: true)
+      raise "attachment #{name} already exists" if @message[:attachments].has_key?(name)
+      @message[:attachments][name] = encode ? Base64.strict_encode64(data) : data
+    end
+
+    private
+
+    REQUIRED_FIELDS = %i(identifiers transactional_message_id)
+
+    OPTIONAL_FIELDS = %i(
+      message_data
+      from
+      to
+      disable_message_retention
+      send_to_unsubscribed
+      tracked
+      queue_draft
+      send_at
+      language
+    )
+
+    def invalid_field?(field)
+      !REQUIRED_FIELDS.include?(field) && !OPTIONAL_FIELDS.include?(field)
+    end
+
+    def encode(data)
+      Base64.strict_encode64(data)
+    end
+  end
+end

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "5.2.0"
+  VERSION = "5.4.0"
 end

data/lib/customerio.rb

@@ -6,6 +6,7 @@ module Customerio
   require "customerio/client"
   require "customerio/requests/send_email_request"
   require "customerio/requests/send_push_request"
+  require "customerio/requests/send_sms_request"
   require "customerio/api"
   require "customerio/param_encoder"
 end

data/spec/api_client_spec.rb

@@ -252,4 +252,63 @@ describe Customerio::APIClient do
       client.send_push(req).should eq({ "delivery_id" => 2 })
     end
   end
+
+  describe "#send_sms" do
+    it "sends a POST request to the /api/send/sms path" do
+      req = Customerio::SendSMSRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+      )
+
+      stub_request(:post, api_uri('/v1/send/sms'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 200, body: { delivery_id: 1 }.to_json, headers: {})
+
+      client.send_sms(req).should eq({ "delivery_id" => 1 })
+    end
+
+    it "handles validation failures (400)" do
+      req = Customerio::SendSMSRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+      )
+
+      err_json = { meta: { error: "example error" } }.to_json
+
+      stub_request(:post, api_uri('/v1/send/sms'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 400, body: err_json, headers: {})
+
+      lambda { client.send_sms(req) }.should(
+        raise_error(Customerio::InvalidResponse) { |error|
+          error.message.should eq "example error"
+          error.code.should eq "400"
+        }
+      )
+    end
+
+    it "handles other failures (5xx)" do
+      req = Customerio::SendSMSRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+      )
+
+      stub_request(:post, api_uri('/v1/send/sms'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 500, body: "Server unavailable", headers: {})
+
+      lambda { client.send_sms(req) }.should(
+        raise_error(Customerio::InvalidResponse) { |error|
+          error.message.should eq "Server unavailable"
+          error.code.should eq "500"
+        }
+      )
+    end
+  end
 end

data/spec/client_spec.rb

@@ -173,6 +173,7 @@ describe Customerio::Client do
       lambda { client.identify(email: "customer@example.com") }.should raise_error(Customerio::Client::MissingIdAttributeError)
       lambda { client.identify(id: "") }.should raise_error(Customerio::Client::MissingIdAttributeError)
       lambda { client.identify(cio_id: "") }.should raise_error(Customerio::Client::MissingIdAttributeError)
+      lambda { client.identify(customer_id: "") }.should raise_error(Customerio::Client::MissingIdAttributeError)
     end
 
     it 'should not raise errors when attribute keys are strings' do
@@ -223,6 +224,39 @@ describe Customerio::Client do
         location: "here"
       })
     end
+
+    it "uses provided id rather than id" do
+      stub_request(:put, api_uri('/api/v1/customers/1234')).
+        with(body: json(id: "5")).
+        to_return(status: 200, body: "", headers: {})
+
+      client.identify(
+        customer_id: "1234",
+        id: "5"
+      )
+    end
+
+    it "uses provided cio_id rather than id" do
+      stub_request(:put, api_uri('/api/v1/customers/cio_5')).
+        with(body: json(id: "5")).
+        to_return(status: 200, body: "", headers: {})
+
+      client.identify(
+        customer_id: "cio_5",
+        id: "5"
+      )
+    end
+
+    it "uses provided email rather than id" do
+      stub_request(:put, api_uri('/api/v1/customers/customer@example.com')).
+        with(body: json(id: "5")).
+        to_return(status: 200, body: "", headers: {})
+
+      client.identify(
+        customer_id: "customer@example.com",
+        id: "5"
+      )
+    end
   end
 
   describe "#delete" do
@@ -650,7 +684,7 @@ describe Customerio::Client do
       }.to raise_error(Customerio::Client::ParamError, 'timestamp must be a valid timestamp')
     end
   end
-  
+
   describe "#merge_customers" do
     before(:each) do
       @client = Customerio::Client.new("SITE_ID", "API_KEY", :json => true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.4.0
 platform: ruby
 authors:
 - John Allison
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2025-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,16 +132,17 @@ files:
 - lib/customerio/regions.rb
 - lib/customerio/requests/send_email_request.rb
 - lib/customerio/requests/send_push_request.rb
+- lib/customerio/requests/send_sms_request.rb
 - lib/customerio/version.rb
 - spec/api_client_spec.rb
 - spec/base_client_spec.rb
 - spec/client_spec.rb
 - spec/spec_helper.rb
-homepage: http://customer.io
+homepage: https://customer.io
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A ruby client for the Customer.io event API.
 test_files: