customerio 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9563849000bf5d39f2e0f02aebe93072d42f6eb02343d7d444f964fc86ee3a3f
-  data.tar.gz: 3f4e966503aa9526546a1767580f141da91f06c3ab539c5ee796bedce550d15d
+  metadata.gz: 901ad05a932585330dd1455f401b1a281b2a3390d2618d0623de62cdd4458988
+  data.tar.gz: 93f962b44d651e177407a68de2ed555fd6fb0a711a3180afda823eee6973b5a7
 SHA512:
-  metadata.gz: 7230e937323c875bc45e6dbd5a3d499f68ca6df4bf7fc414b0e425f8c0ea1b85bab5315e56887f11f184ee013c33d2d5b0d7d6373069a5a8a17ae397a980a9ff
-  data.tar.gz: 6742e5db8afbd888ce0eef0e9667f96578307142564f70b2151663fa4e17dc00df1b09b4db667fb8294a235ed92d1059af08ad84498136fce91739415cba4524
+  metadata.gz: 9b787fe471290dd64811543d77f24bced641762d894824ffb1d43d671ed0179a6fb536477040bbceb797ca6ccb5f8c6164b085477dfea58db1cac311fd492be3
+  data.tar.gz: e6c251d418be193333c26d07b78f78c61fa61cb3800f5e89dfef9a8c4680a3fcea9a67db09fa793a843172c6daf9ad800a222d6ce2bc0c9c2a2e99e1b633df21

data/lib/customerio/client.rb

@@ -141,6 +141,7 @@ module Customerio
       raise ParamError, "delivery_id must be a non-empty string" if empty?(attributes[:delivery_id])
 
       body = { delivery_id: attributes[:delivery_id], metric: metric_name }
+      validate_timestamp!(attributes[:timestamp])
       body[:timestamp] = attributes[:timestamp] if valid_timestamp?(attributes[:timestamp])
       body[:recipient] = attributes[:recipient] unless empty?(attributes[:recipient])
       body[:reason] = attributes[:reason] unless empty?(attributes[:reason])
@@ -271,8 +272,11 @@ module Customerio
 
     def create_event(url:, event_name:, anonymous_id: nil, event_type: nil, attributes: {}, id: nil, timestamp: nil) # rubocop:disable Metrics/ParameterLists
       body = { name: event_name, data: attributes }
-      body[:timestamp] = timestamp if valid_timestamp?(timestamp)
-      body[:timestamp] = attributes[:timestamp] if body[:timestamp].nil? && valid_timestamp?(attributes[:timestamp])
+      effective_timestamp = timestamp || attributes[:timestamp]
+      if effective_timestamp
+        validate_timestamp!(effective_timestamp)
+        body[:timestamp] = effective_timestamp
+      end
       body[:anonymous_id] = anonymous_id unless empty?(anonymous_id)
       body[:type] = event_type unless empty?(event_type)
       body[:id] = id unless empty?(id)
@@ -284,6 +288,13 @@ module Customerio
       timestamp.is_a?(Integer) && timestamp > 999_999_999 && timestamp < 100_000_000_000
     end
 
+    def validate_timestamp!(timestamp)
+      return if timestamp.nil?
+      return if valid_timestamp?(timestamp)
+
+      raise ParamError, "timestamp must be a valid integer (seconds since epoch, 10-digit range)"
+    end
+
     def empty?(val)
       val.nil? || (val.is_a?(String) && val.strip.empty?)
     end

data/lib/customerio/requests/send_push_request.rb

@@ -18,7 +18,6 @@ module Customerio
       link
       sound
       custom_data
-      device
       custom_device
     ].freeze
 

data/lib/customerio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Customerio
-  VERSION = "6.0.0"
+  VERSION = "6.1.0"
 end

data/lib/customerio.rb

@@ -13,5 +13,4 @@ module Customerio
   require "customerio/requests/send_in_app_request"
   require "customerio/requests/trigger_broadcast_request"
   require "customerio/api"
-  require "customerio/param_encoder"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - John Allison
@@ -37,21 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
-description: A ruby client for the Customer.io event API.
+description: A ruby client for the Customer.io Journeys Track API and Transactional
+  API.
 email:
 - john@customer.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.markdown
 - LICENSE
 - README.md
 - lib/customerio.rb
 - lib/customerio/api.rb
 - lib/customerio/base_client.rb
 - lib/customerio/client.rb
-- lib/customerio/param_encoder.rb
 - lib/customerio/regions.rb
 - lib/customerio/requests/send_email_request.rb
 - lib/customerio/requests/send_in_app_request.rb
@@ -65,7 +64,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/customerio/customerio-ruby/issues
-  changelog_uri: https://github.com/customerio/customerio-ruby/blob/main/CHANGELOG.markdown
+  changelog_uri: https://github.com/customerio/customerio-ruby/releases
   homepage_uri: https://customer.io
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/customerio/customerio-ruby
@@ -85,5 +84,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: A ruby client for the Customer.io event API.
+summary: A ruby client for the Customer.io Journeys Track API and Transactional API.
 test_files: []

data/CHANGELOG.markdown

@@ -1,190 +0,0 @@
-## Customerio 5.7.0 - Unreleased
-### Added
-- Added `track_delivery_metric` to `Client` for reporting delivery metrics via the `/api/v1/metrics` endpoint, replacing the deprecated `/push/events` endpoint. Supports metrics: opened, clicked, converted, delivered, bounced, deferred, dropped, and spammed.
-- Added `DELIVERY_*` constants and `VALID_DELIVERY_METRICS` to `Customerio::Client`.
-
-## 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.
-
-## 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
-
-## Customerio 4.3.0 - April 26, 2022
-### Added
-- Support for [anonymous invite events](https://customer.io/docs/anonymous-invite-emails/) by setting `anonymous_id` to `nil`. 
-
-## Customerio 4.1.0 - Sep 27, 2021
-### Added
-- Added support for [merge customers](https://customer.io/docs/api/#operation/merge) API
-
-## Customerio 4.0.1 - July 13, 2021
-### Changed
-- Update addressable gem dependency to v2.8.0
-
-## Customerio 4.0.0 - July 6, 2021
-### Removed
-- The `anonymous_track` method.
-
-### Added
-- The `track_anonymous` method replaces `anonymous_track`. This method requires an `anonymous_id` parameter and will no longer trigger campaigns. If you previously used anonymous events to trigger campaigns, you can still do so [directly through the API](https://customer.io/docs/api/#operation/trackAnonymous). We now refer to anonymous events that trigger campaigns as ["invite events"](https://customer.io/docs/anonymous-events/#anonymous-or-invite). 
-
-## Customerio 3.1.0 - March 25, 2021
-### Added
-- Support for EU region
-
-### Removed
-### Changed
-- `Customerio::Client` and `CustomerIO::APIClient`  have a new parameter `region` that can be set to either `Customerio::Regions::EU` or `Customerio::Regions::US` (defaults to `Customerio::Regions::US`)
-
-## Customerio 3.0.0 - Dec 2, 2020
-
-### Added
-- Support for the Transactional API
-
-### Removed
-- `add_to_segment` and `remove_from_segment` methods
-- Support for non-JSON data
-
-### Changed
-- IDs in the URLs are now escaped.
-- Improved validations for data that's passed in.
-- Earlier, if you passed in an event name without a customer ID to the `track` method, we would create an anonymous event. That is now removed. To create an anonymous event, use the `anonymous_track` method.
-
-
-## Customerio 3.0.0 - Dec 2, 2020
-
-### Added
-- Support for the Transactional API
-
-### Removed
-- `add_to_segment` and `remove_from_segment` methods
-- Support for non-JSON data
-
-### Changed
-- IDs in the URLs are now escaped.
-- Improved validations for data that's passed in.
-- Earlier, if you passed in an event name without a customer ID to the `track` method, we would create an anonymous event. That is now removed. To create an anonymous event, use the `anonymous_track` method.
-
-## Customerio 2.2.1 - Mar 23, 2020
-
-- Add license to gemspec [#55](https://github.com/customerio/customerio-ruby/pull/55)
-- Bubble up error message [#51](https://github.com/customerio/customerio-ruby/pull/51)
-
-## Customerio 2.2.0 - Oct 18, 2018
-
-Add support for manual segments [#52](https://github.com/customerio/customerio-ruby/pull/52)
-
-## Customerio 2.1.0 - May 22, 2018
-
-Added support for the suppress / unsuppress methods [#49](https://github.com/customerio/customerio-ruby/pull/49)
-
-## Customerio 2.0.0 - Apr 10, 2018
-
-With this release we have dropped the support for ruby 1.8.7.
-
-- Support new add and remove device endpoints for push notifications [#47](https://github.com/customerio/customerio-ruby/pull/47)
-
-## Customerio 1.0.0 - Mar 15, 2016
-
-There is a slight breaking change in this release. If you are depending on the HTTP response object included in the InvalidResponse exception (introduced in 0.6.1), note that it is now a `Net::HTTPBadRequest`.
-
-- Remove HTTParty dependency, use Net::HTTP instead. [#42](https://github.com/customerio/customerio-ruby/pull/42)
-
-- Update test suite to use webmock, to increase confidence that we're not changing our HTTP requests [#41](https://github.com/customerio/customerio-ruby/pull/41)
-
-## Customerio 0.7.0 - Mar 2, 2016
-
-- Add new method for tracking anonymous events: `anonymous_track`. See README for more details. Many thanks to @sdawson for this contribution! [#36](https://github.com/customerio/customerio-ruby/pull/36)
-
-- Use JSON encoding by default. [#37](https://github.com/customerio/customerio-ruby/pull/37)
-
-  If you want to stick with form-encoding for your integration, you must add `:json => false` to your Customerio::Client initializer. Like this:
-
-  ```ruby
-  customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", :json => false)
-  ```
-
-## Customerio 0.6.1 - Oct 8, 2015
-
-- Include HTTP response as an attribute on the InvalidResponse exception to help with debugging failed API requests. For example:
-
-  ```ruby
-  begin
-    $customerio.track(1, 'event', { :test => 'testing' })
-  rescue => e
-    puts e.message
-    puts e.response.status
-    puts e.response.body
-  end
-  ```
-
-## Customerio 0.6.0 - Oct 6, 2015
-
-Deprecation warning: we are going to switch to JSON encoding by default for the next release. The current default is form-encoding. This will probably not affect you, unless you rely on how form-encoding arrays work.
-
-If you want to stick with form-encoding for your integration, you must add `:json => false` to your Customerio::Client initializer. Like this:
-
-```ruby
-customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", :json => false)
-```
-
-Other fixes and improvements, with many thanks to the community contributors:
-
-- Added HTTP timeout of 10 seconds (@stayhero)
-- Added JSON support for events (@kemper)
-- Convert attribute keys to symbols (@joshnabbott)
-
-## Customerio 0.5.0 - Mar 28, 2014
-
-- Added flag to send body encoded as JSON, rather than the default form encoding.
-
-## Customerio 0.5.0 - Apr 8, 2013
-
-- Removed deprecated methods around using a customer object. All calls simply take a hash of attributes now.
-- Added ability to set a timestamp on a tracked event. Useful for backfilling past events.
-
-## Customerio 0.4.1 - Feb 18, 2013
-
-- Bug fixes related to the 4.0 change.
-
-## Customerio 0.4.0 - Feb 18, 2013
-
-- Added support for deleting customers.
-
-## Customerio 0.3.0 - Dec 28, 2012
-
-- Now raise an error if an API call doesn't respond with a 200 response code
-- Removed dependency on ActiveSupport
-
-## Customerio 0.2.0 - Nov 21, 2012
-
-- Allow raw hashes to be passed into `identify` and `track` methods rather than a customer object.
-- Passing a customer object has been depreciated.
-- Customizing ids with `Customerio::Client.id` block is deprecated.
-
-## Customerio 0.1.0 - Nov 15, 2012
-
-- Allow tracking of anonymous events.
-
-## Customerio 0.0.3 - Nov 5, 2012
-
-- Bump httparty dependency to the latest version.
-
-## Customerio 0.0.2 - May 22, 2012
-
-- First release.

data/lib/customerio/param_encoder.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-# Based on HTTParty's HashConversions:
-#
-# https://github.com/jnunemaker/httparty/blob/master/lib/httparty/hash_conversions.rb
-#
-# License: MIT https://github.com/jnunemaker/httparty/blob/master/MIT-LICENSE
-
-require "erb"
-
-module Customerio
-  class ParamEncoder
-    # @return <String> This hash as a query string
-    #
-    # @example
-    #   { name: "Bob",
-    #     address: {
-    #       street: '111 Ruby Ave.',
-    #       city: 'Ruby Central',
-    #       phones: ['111-111-1111', '222-222-2222']
-    #     }
-    #   }.to_params
-    #     #=> "name=Bob&address[city]=Ruby Central&..."
-    def self.to_params(hash)
-      hash.to_hash.map { |k, v| normalize_param(k, v) }.join.chop
-    end
-
-    # @param key<Object> The key for the param.
-    # @param value<Object> The value for the param.
-    #
-    # @return <String> This key value pair as a param
-    #
-    # @example normalize_param(:name, "Bob Jones") #=> "name=Bob%20Jones&"
-    def self.normalize_param(key, value)
-      param = String.new
-      stack = []
-
-      if value.respond_to?(:to_ary)
-        param << value.to_ary.map { |element| normalize_param("#{key}[]", element) }.join
-      elsif value.respond_to?(:to_hash)
-        stack << [key, value.to_hash]
-      else
-        param << "#{key}=#{escape_value(value)}&"
-      end
-
-      stack.each do |parent, hash|
-        hash.each do |k, v|
-          if v.respond_to?(:to_hash)
-            stack << ["#{parent}[#{k}]", v.to_hash]
-          else
-            param << normalize_param("#{parent}[#{k}]", v)
-          end
-        end
-      end
-
-      param
-    end
-
-    def self.escape_value(value)
-      ERB::Util.url_encode(value.to_s)
-    end
-  end
-end