customerio 5.3.0 → 6.1.0

metadata

@@ -1,133 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 6.1.0
 platform: ruby
 authors:
 - John Allison
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.5'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
+        version: '0.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.6.0
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A ruby client for the Customer.io event API.
+        version: '0.3'
+description: A ruby client for the Customer.io Journeys Track API and Transactional
+  API.
 email:
 - john@customer.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".gitpod.yml"
-- CHANGELOG.markdown
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- customerio.gemspec
 - 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
+- lib/customerio/requests/send_inbox_message_request.rb
 - lib/customerio/requests/send_push_request.rb
+- lib/customerio/requests/send_sms_request.rb
+- lib/customerio/requests/trigger_broadcast_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: https://customer.io
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  bug_tracker_uri: https://github.com/customerio/customerio-ruby/issues
+  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
 rdoc_options: []
 require_paths:
 - lib
@@ -135,19 +75,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: A ruby client for the Customer.io event API.
-test_files:
-- spec/api_client_spec.rb
-- spec/base_client_spec.rb
-- spec/client_spec.rb
-- spec/spec_helper.rb
+summary: A ruby client for the Customer.io Journeys Track API and Transactional API.
+test_files: []

data/.github/workflows/main.yml

@@ -1,21 +0,0 @@
-name: ci
-
-on: [push,pull_request]
-
-jobs:
-  test:
-    strategy:
-      matrix:
-        ruby: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_PATH: ${{ github.workspace }}/vendor/bundle
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    
-    - name: Unit Test w/ RSpec
-      run: bundle exec rspec

data/.gitignore

@@ -1,20 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-Gemfile.lock
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-vendor
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/

data/.gitpod.yml

@@ -1,10 +0,0 @@
-tasks:
-  - init: |
-      bundle config set --local path 'vendor/bundle'
-      bundle install
-
-vscode:
-  extensions:
-    - connorshea.vscode-ruby-test-adapter
-    - hbenl.vscode-test-explorer
-    - hbenl.test-adapter-converter

data/CHANGELOG.markdown

@@ -1,181 +0,0 @@
-## 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/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in customerio.gemspec
-gemspec

data/Rakefile

@@ -1,8 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-require "rspec/core"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/customerio.gemspec

@@ -1,26 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/customerio/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["John Allison"]
-  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      = "https://customer.io"
-  gem.license       = "MIT"
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "customerio"
-  gem.require_paths = ["lib"]
-  gem.version       = Customerio::VERSION
-
-  gem.add_dependency('multi_json', "~> 1.0")
-  gem.add_dependency('addressable', '~> 2.8.0')
-
-  gem.add_development_dependency('rake', '~> 10.5')
-  gem.add_development_dependency('rspec', '~> 3.10')
-  gem.add_development_dependency('webmock', '3.6.0')
-  gem.add_development_dependency('json')
-end

data/lib/customerio/param_encoder.rb

@@ -1,68 +0,0 @@
-# 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'
-require 'uri'
-
-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&address[phones][]=111-111-1111&address[phones][]=222-222-2222&address[street]=111 Ruby Ave."
-    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 = ''
-      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
-
-    # 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
-        ERB::Util.url_encode(value.to_s)
-      else
-        URI.encode(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-      end
-    end
-  end
-end