customerio 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 558909b4f1cd8c6701f8c8fcce3796ab9d7321eb19038514ac9432f728035104
-  data.tar.gz: 5787b196ae97f8ded6122dbe83ccc9f9d363b86181b4e2144595a13b1772111b
+  metadata.gz: 8ad688e060a453d3f02dfcdacc1407a4376fd355deb6feb6a531d4f2b9ebbad6
+  data.tar.gz: ea3401fa18f031f4ecb70fc79ee8817b0278294debe53f2f78adb403873f32a5
 SHA512:
-  metadata.gz: 8105a2cd41265da49055b42e9eff7db0c0548d930a4a91871edd2458db2c0389e5c5a2e095e79f1fd453994a55614c6f621960d30ab36d5c31e2cb5fc552a6b1
-  data.tar.gz: 74eef21394ff63ce7305a5241e23a4a74248e12a7486f268280d74bc72d8b50ec1bdf8b72717ade273b6d4dcb7d152bb49d8861c16bce5d5385eb743c899b65a
+  metadata.gz: 8b708a8aba7b91c3a270b2829cc7ba24cad4d72e8030f04cc266dcf97adcb9de8579f0fe159eeed5c95669890dd30376f05c28b43540894feb8dd15f25a516d4
+  data.tar.gz: 128500f502747de7b3d4e92a201ebcf23fa2ebe731f529fb57d72f2919f95f81f3cb8e59917a621e9e475c957c234302641581415d21cfa2189d3aa994889557

data/.github/workflows/main.yml

@@ -6,7 +6,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: ['2.5', '2.6', '2.7']
+        ruby: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
     runs-on: ubuntu-latest
     env:
       BUNDLE_PATH: ${{ github.workspace }}/vendor/bundle

data/CHANGELOG.markdown

@@ -1,3 +1,11 @@
+## 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.
+
+## Customerio 5.1.0 - May 5, 2023
+### Added
+- Added `send_push` to `APIClient` and `SendPushRequest` to support sending transactional push notifications.
+
 ## Customerio 4.3.1 - January 5, 2023
 ### Added
 - Added the `disable_css_preprocessing` and `language` optional fields to send request

data/README.md

@@ -77,7 +77,7 @@ if you pass along the current subscription plan (free / basic / premium) for you
 set up triggers which are only sent to customers who have subscribed to a
 particular plan (e.g. "premium").
 
-You'll want to indentify your customers when they sign up for your app and any time their
+You'll want to identify your customers when they sign up for your app and any time their
 key information changes. This keeps [Customer.io](https://customer.io) up to date with your customer information.
 
 ```ruby
@@ -95,6 +95,24 @@ $customerio.identify(
 )
 ```
 
+### Updating customers
+
+You can use the identify operation to update customers.
+If you need to change the `id` or `email` identifiers for a customer,
+you will need to pass in the `cio_id` identifier.
+`cio_id` is a unique identifier set by Customer.io, used to reference a person,
+and cannot be changed.
+
+E.g.: if the customer created in the identify operation above was given the `cio_id` of `"f000000d"`, you could change its ID and email address using:
+
+```ruby
+$customerio.identify(
+  :cio_id => "f000000d",
+  :id => 1005,
+  :email => "bob.fullname@example.com"
+)
+```
+
 ### Deleting customers
 
 Deleting a customer will remove them, and all their information from
@@ -217,7 +235,9 @@ $customerio.unsuppress(5)
 
 ### Send Transactional Messages
 
-To use the Customer.io [Transactional API](https://customer.io/docs/transactional-api), create an instance of the API client using an [app key](https://customer.io/docs/managing-credentials#app-api-keys).
+To use the Customer.io [Transactional API](https://customer.io/docs/transactional-api), create an instance of the API client using an [app key](https://customer.io/docs/managing-credentials#app-api-keys) and create a request object of your message type.
+
+#### Email
 
 Create a new `SendEmailRequest` object containing:
 
@@ -262,6 +282,44 @@ rescue Customerio::InvalidResponse => e
 end
 ```
 
+#### Push
+
+Create a new `SendPushRequest` object containing:
+
+* `transactional_message_id`: the ID or trigger name of the transactional message you want to send.
+* an `identifiers` object containing the `id` or `email` of your recipient. If the profile does not exist, Customer.io creates it.
+
+Use `send_push` referencing your request to send a transactional message. [Learn more about transactional messages and `SendPushRequest` properties](https://customer.io/docs/transactional-api).
+
+
+```ruby
+require "customerio"
+
+client = Customerio::APIClient.new("your API key", region: Customerio::Regions::US)
+
+request = Customerio::SendPushRequest.new(
+  transactional_message_id: "3",
+  message_data: {
+    name: "Person",
+    items: {
+      name: "shoes",
+      price: "59.99",
+    },
+    products: [],
+  },
+  identifiers: {
+    id: "2",
+  },
+)
+
+begin
+  response = client.send_push(request)
+  puts response
+rescue Customerio::InvalidResponse => e
+  puts e.code, e.message
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/customerio/api.rb

@@ -26,10 +26,29 @@ module Customerio
       end
     end
 
+    def send_push(req)
+      raise "request must be an instance of Customerio::SendPushRequest" unless req.is_a?(Customerio::SendPushRequest)
+      response = @client.request(:post, send_push_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
       "/v1/send/email"
     end
+
+    def send_push_path
+      "/v1/send/push"
+    end
   end
 end

data/lib/customerio/client.rb

@@ -151,9 +151,17 @@ module Customerio
 
     def create_or_update(attributes = {})
       attributes = Hash[attributes.map { |(k,v)| [ k.to_sym, v ] }]
-      raise MissingIdAttributeError.new("Must provide a customer id") if is_empty?(attributes[:id])
+      if is_empty?(attributes[:id]) && is_empty?(attributes[:cio_id])
+        raise MissingIdAttributeError.new("Must provide a customer id")
+      end
 
-      url = customer_path(attributes[:id])
+      # Use cio_id as the identifier, if present,
+      # to allow the id and email identifiers to be updated.
+      customer_id = attributes[:id]
+      if !is_empty?(attributes[:cio_id])
+        customer_id = "cio_" + attributes[:cio_id]
+      end
+      url = customer_path(customer_id)
       @client.request_and_verify_response(:put, url, attributes)
     end
 

data/lib/customerio/param_encoder.rb

@@ -55,7 +55,7 @@ module Customerio
       param
     end
 
-    # Prefer ERB::Util.url_encode, fall baack to deprecation URI.encode for
+    # Prefer ERB::Util.url_encode, fall back to deprecation URI.encode for
     # old Ruby support
     def self.escape_value(value)
       if ERB::Util.respond_to? :url_encode

data/lib/customerio/requests/send_push_request.rb

@@ -0,0 +1,36 @@
+module Customerio
+  class SendPushRequest
+    attr_reader :message
+
+    def initialize(opts)
+      @message = opts.delete_if { |field| invalid_field?(field) }
+      @message[:custom_device] = opts[:device] if opts[:device]
+    end
+
+    private
+
+    REQUIRED_FIELDS = %i(transactional_message_id identifiers)
+
+    OPTIONAL_FIELDS = %i(
+      to
+      title
+      message
+      disable_message_retention
+      send_to_unsubscribed
+      queue_draft
+      message_data
+      send_at
+      language
+      image_url
+      link
+      sound
+      custom_data
+      device
+      custom_device
+    )
+
+    def invalid_field?(field)
+      !REQUIRED_FIELDS.include?(field) && !OPTIONAL_FIELDS.include?(field)
+    end
+  end
+end

data/lib/customerio/version.rb

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

data/lib/customerio.rb

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

data/spec/api_client_spec.rb

@@ -6,7 +6,7 @@ require 'tempfile'
 describe Customerio::APIClient do
   let(:app_key) { "appkey" }
 
-  let(:client)   { Customerio::APIClient.new(app_key) }
+  let(:client) { Customerio::APIClient.new(app_key) }
   let(:response) { double("Response", code: 200) }
 
   def api_uri(path)
@@ -169,4 +169,87 @@ describe Customerio::APIClient do
       req.message[:attachments].should eq({ "test" => Base64.strict_encode64("test-content") })
     end
   end
+
+  describe "#send_push" do
+    it "sends a POST request to the /api/send/push path" do
+      req = Customerio::SendPushRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+      )
+
+      stub_request(:post, api_uri('/v1/send/push'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 200, body: { delivery_id: 1 }.to_json, headers: {})
+
+      client.send_push(req).should eq({ "delivery_id" => 1 })
+    end
+
+    it "handles validation failures (400)" do
+      req = Customerio::SendPushRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+      )
+
+      err_json = { meta: { error: "example error" } }.to_json
+
+      stub_request(:post, api_uri('/v1/send/push'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 400, body: err_json, headers: {})
+
+      lambda { client.send_push(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::SendPushRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+      )
+
+      stub_request(:post, api_uri('/v1/send/push'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 500, body: "Server unavailable", headers: {})
+
+      lambda { client.send_push(req) }.should(
+        raise_error(Customerio::InvalidResponse) { |error|
+          error.message.should eq "Server unavailable"
+          error.code.should eq "500"
+        }
+      )
+    end
+
+    it "sets custom_device correctly if device present in req" do
+      req = Customerio::SendPushRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+        device: {
+          platform: 'ios',
+          token: 'sample-token',
+        }
+      )
+
+      req.message[:custom_device].should eq({
+        platform: 'ios',
+        token: 'sample-token',
+      })
+
+      stub_request(:post, api_uri('/v1/send/push'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 200, body: { delivery_id: 2 }.to_json, headers: {})
+
+      client.send_push(req).should eq({ "delivery_id" => 2 })
+    end
+  end
 end

data/spec/client_spec.rb

@@ -172,6 +172,7 @@ describe Customerio::Client do
     it "requires an id attribute" 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)
     end
 
     it 'should not raise errors when attribute keys are strings' do
@@ -183,6 +184,45 @@ describe Customerio::Client do
 
       lambda { client.identify(attributes) }.should_not raise_error()
     end
+
+    it 'uses cio_id for customer id, when present, for id updates' do
+      stub_request(:put, api_uri('/api/v1/customers/cio_347f00d')).with(
+        body: {
+          cio_id: "347f00d",
+          id: 5
+        }).to_return(status: 200, body: "", headers: {})
+
+      client.identify({
+        cio_id: "347f00d",
+        id: 5
+      })
+    end
+
+    it 'uses cio_id for customer id, when present, for email updates' do
+      stub_request(:put, api_uri('/api/v1/customers/cio_347f00d')).with(
+        body: {
+          cio_id: "347f00d",
+          email: "different.customer@example.com"
+        }).to_return(status: 200, body: "", headers: {})
+
+      client.identify({
+        cio_id: "347f00d",
+        email: "different.customer@example.com"
+      })
+    end
+
+    it 'allows updates with cio_id as the only id' do
+      stub_request(:put, api_uri('/api/v1/customers/cio_347f00d')).with(
+        body: {
+          cio_id: "347f00d",
+          location: "here"
+        }).to_return(status: 200, body: "", headers: {})
+
+      client.identify({
+        cio_id: "347f00d",
+        location: "here"
+      })
+    end
   end
 
   describe "#delete" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - John Allison
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -117,6 +117,7 @@ files:
 - lib/customerio/param_encoder.rb
 - lib/customerio/regions.rb
 - lib/customerio/requests/send_email_request.rb
+- lib/customerio/requests/send_push_request.rb
 - lib/customerio/version.rb
 - spec/api_client_spec.rb
 - spec/base_client_spec.rb
@@ -126,7 +127,7 @@ homepage: http://customer.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: A ruby client for the Customer.io event API.
 test_files: