customerio 5.5.1 → 6.0.0

data/lib/customerio/version.rb

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

data/lib/customerio.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "customerio/version"
 
 module Customerio
@@ -8,6 +10,8 @@ module Customerio
   require "customerio/requests/send_push_request"
   require "customerio/requests/send_sms_request"
   require "customerio/requests/send_inbox_message_request"
+  require "customerio/requests/send_in_app_request"
+  require "customerio/requests/trigger_broadcast_request"
   require "customerio/api"
   require "customerio/param_encoder"
 end

metadata

@@ -1,29 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 5.5.1
+  version: 6.0.0
 platform: ruby
 authors:
 - John Allison
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-04-20 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
@@ -44,70 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
   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
-    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
-  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'
+        version: '0.3'
 description: A ruby client for the Customer.io event API.
 email:
 - john@customer.io
@@ -115,15 +44,9 @@ 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
@@ -131,19 +54,21 @@ files:
 - 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/blob/main/CHANGELOG.markdown
+  homepage_uri: https://customer.io
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/customerio/customerio-ruby
 rdoc_options: []
 require_paths:
 - lib
@@ -151,19 +76,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.0.3.1
-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
+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', '3.3', '3.4']
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_PATH: ${{ github.workspace }}/vendor/bundle
-    steps:
-    - uses: actions/checkout@v4
-    - uses: ruby/setup-ruby@354a1ad156761f5ee2b7b13fa8e09943a5e8d252 # v1.229.0
-      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/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,27 +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.9')
-  gem.add_dependency('base64', '~> 0.3.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/spec/api_client_spec.rb

@@ -1,373 +0,0 @@
-require 'spec_helper'
-require 'multi_json'
-require 'base64'
-require 'tempfile'
-
-describe Customerio::APIClient do
-  let(:app_key) { "appkey" }
-
-  let(:client) { Customerio::APIClient.new(app_key) }
-  let(:response) { double("Response", code: 200) }
-
-  def api_uri(path)
-    "https://api.customer.io#{path}"
-  end
-
-  def request_headers
-    { 'Authorization': "Bearer #{app_key}", 'Content-Type': 'application/json', 'User-Agent': 'Customer.io Ruby Client/' + Customerio::VERSION }
-  end
-
-  def json(data)
-    MultiJson.dump(data)
-  end
-
-  it "the base client is initialised with the correct values when no region is passed in" do
-    app_key = "appkey"
-
-    expect(Customerio::BaseClient).to(
-      receive(:new)
-        .with(
-          { app_key: app_key },
-          {
-            region: Customerio::Regions::US,
-            url: Customerio::Regions::US.api_url
-          }
-        )
-    )
-
-    client = Customerio::APIClient.new(app_key)
-  end
-
-  it "raises an error when an incorrect region is passed in" do
-    expect {
-      Customerio::APIClient.new("appkey", region: :au)
-    }.to raise_error /region must be an instance of Customerio::Regions::Region/
-  end
-
-  [Customerio::Regions::US, Customerio::Regions::EU].each do |region|
-    it "the base client is initialised with the correct values when the region \"#{region}\" is passed in" do
-      app_key = "appkey"
-
-      expect(Customerio::BaseClient).to(
-        receive(:new)
-          .with(
-            { app_key: app_key },
-            {
-              region: region,
-              url: region.api_url
-            }
-          )
-      )
-
-      client = Customerio::APIClient.new(app_key, { region: region })
-    end
-  end
-
-  describe "#send_email" do
-    it "sends a POST request to the /api/send/email path" do
-      req = Customerio::SendEmailRequest.new(
-        identifiers: {
-          id: 'c1',
-        },
-        transactional_message_id: 1,
-      )
-
-      stub_request(:post, api_uri('/v1/send/email'))
-        .with(headers: request_headers, body: req.message)
-        .to_return(status: 200, body: { delivery_id: 1 }.to_json, headers: {})
-
-      client.send_email(req).should eq({ "delivery_id" => 1 })
-    end
-
-    it "handles validation failures (400)" do
-      req = Customerio::SendEmailRequest.new(
-        identifiers: {
-          id: 'c1',
-        },
-        transactional_message_id: 1,
-      )
-
-      err_json = { meta: { error: "example error" } }.to_json
-
-      stub_request(:post, api_uri('/v1/send/email'))
-        .with(headers: request_headers, body: req.message)
-        .to_return(status: 400, body: err_json, headers: {})
-
-      lambda { client.send_email(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::SendEmailRequest.new(
-        identifiers: {
-          id: 'c1',
-        },
-        transactional_message_id: 1,
-      )
-
-      stub_request(:post, api_uri('/v1/send/email'))
-        .with(headers: request_headers, body: req.message)
-        .to_return(status: 500, body: "Server unavailable", headers: {})
-
-      lambda { client.send_email(req) }.should(
-        raise_error(Customerio::InvalidResponse) { |error|
-          error.message.should eq "Server unavailable"
-          error.code.should eq "500"
-        }
-      )
-    end
-
-    it "allows attaching file content without encoding" do
-      content = 'sample content'
-
-      req = Customerio::SendEmailRequest.new(
-        customer_id: 'c1',
-        transactional_message_id: 1,
-      )
-
-      req.attach('test', content, encode: false)
-      req.message[:attachments]['test'].should eq content
-
-      stub_request(:post, api_uri('/v1/send/email'))
-        .with(headers: request_headers, body: req.message)
-        .to_return(status: 200, body: { delivery_id: 1 }.to_json, headers: {})
-
-      client.send_email(req)
-    end
-
-    it "allows attaching files with encoding (default)" do
-      content = 'sample content'
-
-      req = Customerio::SendEmailRequest.new(
-        customer_id: 'c1',
-        transactional_message_id: 1,
-      )
-
-      req.attach('test', content)
-      req.message[:attachments]['test'].should eq Base64.strict_encode64(content)
-
-      stub_request(:post, api_uri('/v1/send/email'))
-        .with(headers: request_headers, body: req.message)
-        .to_return(status: 200, body: { delivery_id: 1 }.to_json, headers: {})
-
-      client.send_email(req)
-    end
-
-    it "raises error when attaching the same key again" do
-      req = Customerio::SendEmailRequest.new(
-        customer_id: 'c1',
-        transactional_message_id: 1,
-      )
-
-      req.attach('test', 'test-content')
-
-      lambda { req.attach('test', '') }.should raise_error(/attachment test already exists/)
-      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
-
-  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
-
-  describe "#send_inbox_message" do
-    it "sends a POST request to the /api/send/inbox_message path" do
-      req = Customerio::SendInboxMessageRequest.new(
-        identifiers: {
-          id: 'c1',
-        },
-        transactional_message_id: 1,
-      )
-
-      stub_request(:post, api_uri('/v1/send/inbox_message'))
-        .with(headers: request_headers, body: req.message)
-        .to_return(status: 200, body: { delivery_id: 1 }.to_json, headers: {})
-
-      client.send_inbox_message(req).should eq({ "delivery_id" => 1 })
-    end
-
-    it "handles validation failures (400)" do
-      req = Customerio::SendInboxMessageRequest.new(
-        identifiers: {
-          id: 'c1',
-        },
-        transactional_message_id: 1,
-      )
-
-      err_json = { meta: { error: "example error" } }.to_json
-
-      stub_request(:post, api_uri('/v1/send/inbox_message'))
-        .with(headers: request_headers, body: req.message)
-        .to_return(status: 400, body: err_json, headers: {})
-
-      lambda { client.send_inbox_message(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::SendInboxMessageRequest.new(
-        identifiers: {
-          id: 'c1',
-        },
-        transactional_message_id: 1,
-      )
-
-      stub_request(:post, api_uri('/v1/send/inbox_message'))
-        .with(headers: request_headers, body: req.message)
-        .to_return(status: 500, body: "Server unavailable", headers: {})
-
-      lambda { client.send_inbox_message(req) }.should(
-        raise_error(Customerio::InvalidResponse) { |error|
-          error.message.should eq "Server unavailable"
-          error.code.should eq "500"
-        }
-      )
-    end
-  end
-end