customerio 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 558909b4f1cd8c6701f8c8fcce3796ab9d7321eb19038514ac9432f728035104
-  data.tar.gz: 5787b196ae97f8ded6122dbe83ccc9f9d363b86181b4e2144595a13b1772111b
+  metadata.gz: 18279a486386052aa99a48c56652ac566bf6abc973a6428af4d5886ec2ac3b85
+  data.tar.gz: dcaef6f328effd4cf6dc820e81b27661e440ce79d2af33b6736da544be30a0e7
 SHA512:
-  metadata.gz: 8105a2cd41265da49055b42e9eff7db0c0548d930a4a91871edd2458db2c0389e5c5a2e095e79f1fd453994a55614c6f621960d30ab36d5c31e2cb5fc552a6b1
-  data.tar.gz: 74eef21394ff63ce7305a5241e23a4a74248e12a7486f268280d74bc72d8b50ec1bdf8b72717ade273b6d4dcb7d152bb49d8861c16bce5d5385eb743c899b65a
+  metadata.gz: bad65a5e1d2097aa9db014e71d2c1c310546ec57ce4efa002484a28d6a9031fd5db48a221659d74861ce7a7ff07489b4b8ac956ba11b7b7cadab4eabed730a98
+  data.tar.gz: ce94e157fd6145afdaf303b1a6a91a5f2eeb9e8ea581d60acad95834e39bba788489c50e164070e83d4232bdb4c692315772bc52c0220676c216d26eeb217f1a

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+## 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

@@ -217,7 +217,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 +264,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/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.1.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - John Allison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-05-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