customerio-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67c845f6f2c71391044755e3412a1674f24a129dab76f841455eeebf135fc897
+  data.tar.gz: 21785d8a8cd965fa463ce6ebbc2ca8c3336bff9cd1b195a923ebebf129025bd8
+SHA512:
+  metadata.gz: f07811ee4d2cc6e212327f39537ce20a7ac681af323dd0b249d8fcd5cf185ca40d4b4e03f94599b413ff706e10e807b59d303755c5aac5296952ce1527233a66
+  data.tar.gz: 30664d979cba3887204f723ecccd2506360b871061f8d6f31a23dfb0ccc4cc97981ff0789092100610aa92c6c5a7ecaf03fe2cbab94723b92f1ffdf1cbfd01f2

data/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+= Changelog
+
+== 0.1.0
+* Initial release, inspired by https://github.com/ActiveCampaign/postmark-rails

data/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Customer.io Rails Gem
+
+[![License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://www.opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/customerio-rails.svg)](https://badge.fury.io/rb/customerio-rails)
+
+The `customerio-rails` gem is a drop-in ActionMailer adapter to send emails via [Customer.io](https://customer.io).
+The gem has been created for fast implementation and targets Customer.io’s transactional email capabilities.
+
+## Usage
+
+## Requirements
+
+You will need a [Customer.io](https://customer.io/) account set up to use it.
+
+### Supported Rails Versions
+
+- Rails 8.0
+- Rails 7.0
+
+### App API Key
+
+Generate an **App API Key** (this is different than the pair _Site ID_ / _API Key_) from your _Workspace Settings_ > Your Workspace > _Manage API Credentials_ > _App API Keys_.
+
+## Installation
+
+Add `customerio-rails` to your Gemfile and run `bundle install`.
+
+```ruby
+gem 'customerio-rails'
+```
+
+Set Customer.io as your preferred mail delivery method via `config/application.rb`:
+
+```ruby
+config.action_mailer.delivery_method = :customerio
+config.action_mailer.customerio_settings = { app_api_key: '<Your APP API Key>', region: Customerio::Regions::US }
+```
+
+## Usage
+
+Use it as you would usually:
+
+```ruby
+class MyMailer < ApplicationMailer
+  def whatever # whatever.{html,text}.erb will be used as body
+    mail to: 'someone@somewhere.com', subject: 'Hello from Rails!'
+  end
+end
+```
+
+Or rely on Customer.io's templated messages with:
+
+```ruby
+class MyMailer < ApplicationMailer
+  def whatever_with_template
+    mail to: 'someone@somewhere.com', subject: 'Hello from Rails!', transactional_message_id: 3, message_data: { myvar: 'a value', another_one: 42x }
+  end
+end
+```
+
+## License
+
+The Customer.io Rails gem is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php) license.
+Refer to the [LICENSE](./LICENSE) file for more information.

data/lib/customerio-rails/mail.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CustomerioRails
+  module Mail
+    class Customerio
+      attr_accessor :settings
+  
+      def initialize(values)
+        self.settings = {
+          region: ENV['CUSTOMERIO_REGION'] || ::Customerio::Regions::US,
+          app_api_key: ENV['CUSTOMERIO_APP_API_KEY']
+        }.merge(values)
+      end
+  
+      def deliver!(mail)
+        (Array.wrap(mail.to) + Array.wrap(mail.cc)).compact.each do |to|
+          params = {
+            to: to,
+            from: Array.wrap(mail.from).first,
+            subject: mail.subject,
+            reply_to: mail.reply_to,
+            bcc: mail.bcc,
+            headers: mail.headers,
+            identifiers: { email: to } 
+          }
+          if mail[:transactional_message_id]
+            params[:transactional_message_id] = mail[:transactional_message_id].unparsed_value
+            params[:message_data] = mail[:message_data]&.unparsed_value || {}
+          else
+            params[:body] = mail.html_part&.body&.to_s || mail.body.to_s
+            params[:body_plain] = mail.text_part&.body&.to_s
+          end
+          request = ::Customerio::SendEmailRequest.new(params.compact)
+          mail.attachments.each do |attachment|
+            request.attach(attachment.filename, attachment.read)
+          end
+          api_client.send_email(request)
+        end
+      end
+  
+      def api_client
+        ::Customerio::APIClient.new(settings[:app_api_key], region: settings[:region])
+      end
+    end
+  end
+end

data/lib/customerio-rails/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CustomerioRails
+  class Railtie < Rails::Railtie
+    initializer 'customerio-rails', :before => 'action_mailer.set_configs' do
+      ActiveSupport.on_load :action_mailer do
+        CustomerioRails.install
+      end
+    end
+  end
+end

data/lib/customerio-rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CustomerioRails
+  VERSION = '0.1.0'
+end

data/lib/customerio-rails.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'active_support/rescuable'
+require 'action_mailer'
+require 'customerio'
+
+module CustomerioRails
+  module WithTemplatedMessageMailer
+    def mail(*args, **kwargs)
+      if kwargs[:transactional_message_id].present?
+        # force a blank body to avoid looking for a template locally
+        kwargs[:body] = ''
+      end
+      super
+    end
+  end
+
+  def self.install
+    require 'customerio-rails/mail'
+    ActionMailer::Base.add_delivery_method :customerio, CustomerioRails::Mail::Customerio
+    ActionMailer::Base.prepend(WithTemplatedMessageMailer)
+  end
+end
+
+if defined?(Rails)
+  require 'customerio-rails/railtie'
+else
+  CustomerioRails.install
+end

data/spec/customerio-rails_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe "CustomerioRails" do
+  let!(:api_client) { Customerio::APIClient.new('app-api-token') }
+
+  def deliver(message)
+    if message.respond_to?(:deliver_now)
+      message.deliver_now
+    else
+      message.deliver
+    end
+  end
+
+  before do
+    allow(Customerio::APIClient).to receive(:new) { api_client }
+  end
+
+  it 'should allow setting an app api key' do
+    ActionMailer::Base.customerio_settings = {:app_api_key => 'app-api-token'}
+    expect(ActionMailer::Base.customerio_settings[:app_api_key]).to eq('app-api-token')
+  end
+
+  it "should use customerio for delivery" do
+    allow(api_client).to receive(:send_email) do |message|
+      expect(message.message[:subject]).to eq("hello")
+    end
+    deliver(TestMailer.simple_message)
+  end
+
+  it "should work with multipart messages" do
+    allow(api_client).to receive(:send_email) do |message|
+      expect(message.message[:body].strip).to eq("<b>hello</b>")
+      expect(message.message[:body_plain].strip).to eq("hello")
+    end
+    deliver(TestMailer.multipart_message)
+  end
+
+  it 'should work with messages containing attachments' do
+    allow(api_client).to receive(:send_email) do |message|
+      expect(message.message[:attachments]).not_to be_empty
+    end
+    deliver(TestMailer.message_with_attachment)
+  end
+end

data/spec/delivery_spec.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Delivering messages with customerio-rails' do
+  let(:app_api_key) { 'CUSTOMERIO_APP_API_KEY' }
+
+  before do
+    ActionMailer::Base.customerio_settings = { app_api_key: app_api_key }
+    response = Net::HTTPSuccess.new(1.0, 200, '{}')
+    allow(response).to receive(:body).and_return('{}')
+    mocked_http = double('mocked_http')
+    allow(mocked_http).to receive(:request).with(satisfy { |request|
+      expect(Array.wrap(expected_body)).to include(JSON.parse(request.body))
+    }).and_return(response)
+    allow_any_instance_of(Net::HTTP).to receive(:start).and_yield(mocked_http)
+  end
+
+  context 'when delivering a simple message' do
+    let(:expected_body) do
+      { 'to' => 'sheldon@bigbangtheory.com', 'from' => 'leonard@bigbangtheory.com', 'subject' => 'hello',
+        'body' => "hello\n", 'headers' => {}, 'identifiers' => { 'email' => 'sheldon@bigbangtheory.com' }, 'attachments' => {} }
+    end
+
+    let(:message) { TestMailer.simple_message }
+
+    it do
+      message.deliver!
+    end
+
+    context 'with a reply-to address' do
+      let(:expected_body) do
+        super().merge('reply_to' => ['raj@bigbangtheory.com'])
+      end
+
+      it do
+        message.reply_to = 'raj@bigbangtheory.com'
+        message.deliver!
+      end
+    end
+
+    context 'with a bcc address' do
+      let(:expected_body) do
+        super().merge('bcc' => ['raj@bigbangtheory.com'])
+      end
+      
+      it do
+        message.bcc = 'raj@bigbangtheory.com'
+        message.deliver!
+      end
+    end
+
+    context 'with a cc address' do
+      let(:expected_body) do
+        [super(), super().merge('to' => 'raj@bigbangtheory.com', 'identifiers' => { 'email' => 'raj@bigbangtheory.com' })]
+      end
+      
+      it do
+        message.cc = 'raj@bigbangtheory.com'
+        message.deliver!
+      end
+    end
+  end
+
+  context 'when delivering a multipart message' do
+    let(:expected_body) do
+      { 'to' => 'sheldon@bigbangtheory.com', 'from' => 'leonard@bigbangtheory.com',
+        'subject' => 'Your invitation to join Mixlr.', 'body' => "<b>hello</b>\n", "body_plain" => "hello\n", 'headers' => {}, 'identifiers' => { 'email' => 'sheldon@bigbangtheory.com' }, 'attachments' => {} }
+    end
+
+    it do
+      message = TestMailer.multipart_message
+      message.deliver!
+    end
+  end
+
+  context 'when delivering a message with attachments' do
+    let(:expected_body) do
+      { 'to' => 'sheldon@bigbangtheory.com', 'from' => 'leonard@bigbangtheory.com',
+        'subject' => 'Message with attachment.', 'body' => 'attachments?', 'headers' => {}, 'identifiers' => { 'email' => 'sheldon@bigbangtheory.com' }, 'attachments' => { 'empty.gif' => 'R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==' } }
+    end
+
+    it do
+      message = TestMailer.message_with_attachment
+      message.deliver!
+    end
+  end
+
+  context 'when delivering a message with inline image' do
+    let(:message) { TestMailer.message_with_inline_image }
+
+    let(:expected_body) do
+      { 'to' => 'sheldon@bigbangtheory.com', 'from' => 'leonard@bigbangtheory.com',
+        'subject' => 'Message with inline image.', 'body' => message.html_part.body.to_s, 'headers' => {}, 'identifiers' => { 'email' => 'sheldon@bigbangtheory.com' }, 'attachments' => { 'empty.gif' => 'R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==' } }
+    end
+
+    it do
+      message.deliver!
+    end
+  end
+
+  context 'when delivering a message with templated message' do
+    let(:message) { TestMailer.message_with_template }
+
+    let(:expected_body) do
+      { 'to' => 'sheldon@bigbangtheory.com', 'from' => 'leonard@bigbangtheory.com', 'message_data' => { 'foo' => 'bar' },
+        'subject' => 'Message with template.', 'transactional_message_id' => '123', 'headers' => {}, 'identifiers' => { 'email' => 'sheldon@bigbangtheory.com' }, 'attachments' => {} }
+    end
+
+    it do
+      message.deliver!
+    end
+  end
+end

data/spec/fixtures/models/test_mailer.rb

@@ -0,0 +1,42 @@
+class TestMailer < ActionMailer::Base
+  default subject: 'hello',
+          to: 'sheldon@bigbangtheory.com',
+          from: 'leonard@bigbangtheory.com'
+
+  def simple_message
+    mail
+  end
+
+  def multipart_message
+    mail(subject: "Your invitation to join Mixlr.") do |format|
+      format.text
+      format.html
+    end
+  end
+
+  def message_with_attachment
+    attachments['empty.gif'] = File.read(image_file)
+    mail(subject: "Message with attachment.")
+  end
+
+  def message_with_inline_image
+    attachments.inline['empty.gif'] = File.read(image_file)
+    mail(subject: "Message with inline image.")
+  end
+
+  def message_with_metadata
+    metadata['foo'] = 'bar'
+    mail(subject: 'Message with metadata.')
+  end
+
+  def message_with_template
+    mail(subject: 'Message with template.', transactional_message_id: '123', message_data: { foo: 'bar' })
+  end
+
+  protected
+
+  def image_file
+    File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'empty.gif')
+  end
+
+end

data/spec/fixtures/views/test_mailer/message_with_attachment.erb

@@ -0,0 +1 @@
+attachments?

data/spec/fixtures/views/test_mailer/message_with_inline_image.html.erb

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
+  </head>
+  <body text="#000000" bgcolor="#FFFFFF">
+    <img alt="empty" src="<%= attachments['empty.gif'].url %>">
+  </body>
+</html>

data/spec/fixtures/views/test_mailer/multipart_message.html.erb

@@ -0,0 +1 @@
+<b>hello</b>

data/spec/fixtures/views/test_mailer/multipart_message.text.erb

@@ -0,0 +1 @@
+hello

data/spec/fixtures/views/test_mailer/simple_message.erb

@@ -0,0 +1 @@
+hello

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'customerio'
+require 'customerio-rails'
+require 'json'
+
+ActionMailer::Base.delivery_method = :customerio
+ActionMailer::Base.prepend_view_path(File.join(File.dirname(__FILE__), "fixtures", "views"))
+
+Dir["#{File.dirname(__FILE__)}/fixtures/models/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  def make_mailer(base, &block)
+    mailer = Class.new(base, &block)
+    @mailer_number = 0
+    stub_const("Mailer#{@mailer_number += 1}", mailer)
+    mailer
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: customerio-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sylvain Utard
+bindir: bin
+cert_chain: []
+date: 2025-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: customerio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Drop-in ActionMailer adapter to send emails via Customer.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- CHANGELOG.rdoc
+- LICENSE
+- README.md
+- lib/customerio-rails.rb
+- lib/customerio-rails/mail.rb
+- lib/customerio-rails/railtie.rb
+- lib/customerio-rails/version.rb
+- spec/customerio-rails_spec.rb
+- spec/delivery_spec.rb
+- spec/fixtures/empty.gif
+- spec/fixtures/models/test_mailer.rb
+- spec/fixtures/views/test_mailer/message_with_attachment.erb
+- spec/fixtures/views/test_mailer/message_with_inline_image.html.erb
+- spec/fixtures/views/test_mailer/multipart_message.html.erb
+- spec/fixtures/views/test_mailer/multipart_message.text.erb
+- spec/fixtures/views/test_mailer/simple_message.erb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/altertable-ai/customerio-rails
+licenses: []
+metadata: {}
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Customer.io adapter for ActionMailer
+test_files:
+- spec/customerio-rails_spec.rb
+- spec/delivery_spec.rb
+- spec/fixtures/empty.gif
+- spec/fixtures/models/test_mailer.rb
+- spec/fixtures/views/test_mailer/message_with_attachment.erb
+- spec/fixtures/views/test_mailer/message_with_inline_image.html.erb
+- spec/fixtures/views/test_mailer/multipart_message.html.erb
+- spec/fixtures/views/test_mailer/multipart_message.text.erb
+- spec/fixtures/views/test_mailer/simple_message.erb
+- spec/spec.opts
+- spec/spec_helper.rb