createsend-rails 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d957ab4e6a2b9d26a77774ffac12a887024561dedffb6b12090c8d810e48c6b0
+  data.tar.gz: 547f4cd34f582ae2a3236dec69b275c435a06ab4521710ffb30478903f2532c5
+SHA512:
+  metadata.gz: 74fefa0cb13865e050a7cd2915762b256f8f98ab770612b997f569ccb3f7fdc9676c51b990ba1e61975a520e772f40cbbb2c349521a0f302bbe3e138b4c47876
+  data.tar.gz: 9be01324754baa6069ca682765b50a5b8c1d629a54fcf8f28be58ecfd24bf4fd649840d5d59fef200dd3d32f3f52347e2dff4cad05764c5c38969031b234fd88

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Made Tech Ltd
+
+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,51 @@
+# Campaign Monitor - Smart Transactional Emails for Rails
+
+[![Build Status](https://travis-ci.org/madetech/createsend-rails.svg?branch=master)](https://travis-ci.org/madetech/createsend-rails)
+
+
+The `create_send_rails` Gem drops into ActionMailer and sends transactional emails via the [Campaign Monitor API](https://www.campaignmonitor.com/api/), using its [Smart Email](https://www.campaignmonitor.com/api/transactional/#send_a_smart_email) feature.
+
+It updates ActionMailer so it defaults to JSON mailer views and allows you to define the data required for each of your mailers.
+
+## Getting Started
+
+To get started, add the following line to your applications `Gemfile`:
+
+```ruby
+gem 'createsend-rails'
+```
+Then update your environment files and set `delivery_method` to `create_send` and include your CampaignMonitor `api_key` within the settings block.
+
+```ruby
+config.action_mailer.delivery_method = :create_send
+config.action_mailer.create_send_settings = {
+    api_key: 'INSERT_API_KEY'
+}
+```
+Now go into your `views/*_mailer/` and add a `.json` view, which defines the data attributes required by your Smart Email template. Below is an example of a password reset email.
+
+```json
+{
+    "smart_email_id": "SMART_EMAIL_ID",
+    "consent_to_track: "yes|no|unchanged",
+    "language": "<%= @user.language %>",
+    "name": "<%= @user.name %>",
+    "reset_url": "<%= @edit_password_reset_url %>"
+}
+```
+
+## Credits
+
+![made](https://s3-eu-west-1.amazonaws.com/made-assets/googleapps/google-apps.png)
+
+Developed and maintained by [Made Tech Ltd](https://www.madetech.com/). Key contributions:
+
+
+* [Andrew Scott](https://github.com/askl56)
+* [Rory MacDonald](https://github.com/rorymacdonald)
+* [Seb Ashton](https://github.com/SebAshton)
+* [Martin Vandersteen](https://github.com/MartinVandersteen)
+
+
+## License
+Copyright © 2016 [Made Tech Ltd](https://www.madetech.com/). It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/lib/createsend-rails/deliverer.rb

@@ -0,0 +1,29 @@
+module CreatesendRails
+  class Deliverer
+    attr_accessor :settings
+
+    def initialize(values)
+      self.settings = {}.merge(values)
+    end
+
+    def deliver!(mail)
+      @mail = mail
+      smart_email = ::CreateSend::Transactional::SmartEmail.new(auth, smart_email_id)
+      smart_email.send(mail_data)
+    end
+
+    private
+
+    def auth
+      settings.dup
+    end
+
+    def mail_data
+      SmartEmailFormatter.new(@mail).format
+    end
+
+    def smart_email_id
+      mail_data[:data][:smart_email_id]
+    end
+  end
+end

data/lib/createsend-rails/ext/action_mailer.rb

@@ -0,0 +1,10 @@
+module CreatesendRails
+  module SmartEmailer
+    def smart_mail(headers = {}, &block)
+      mail(headers, block)
+    end
+  end
+
+  module ViewDefaults
+  end
+end

data/lib/createsend-rails/ext/hash.rb

@@ -0,0 +1,16 @@
+module CreatesendRails
+  module Hash
+    def deep_reject(&block)
+      dup.deep_reject!(&block)
+    end
+
+    def deep_reject!(&block)
+      each do |key, value|
+        value.deep_reject!(&block) if value.is_a?(Hash)
+        delete(key) if yield(key, value)
+      end
+    end
+  end
+end
+
+Hash.include(CreatesendRails::Hash)

data/lib/createsend-rails/railtie.rb

@@ -0,0 +1,5 @@
+module CreatesendRails
+  class Railtie < Rails::Railtie
+    CreatesendRails.install
+  end
+end

data/lib/createsend-rails/smart_email_formatter.rb

@@ -0,0 +1,31 @@
+module CreatesendRails
+  class SmartEmailFormatter
+    def format
+      request_body.deep_reject! { |_k, v| v.blank? }
+    end
+
+    private
+
+    def initialize(message)
+      @message = message
+    end
+
+    def request_body
+      recipients.merge!(data: values)
+    end
+
+    def recipients
+      {
+        to: @message.to,
+        cc: @message.cc,
+        bcc: @message.bcc,
+        ConsentToTrack: values.try(:[], :consent_to_track) || 'Yes' # That's not clean, should find better way?
+      }.symbolize_keys!
+    end
+
+    def values
+      return if @message.try(:body).empty?
+      JSON.parse(@message.try(:body).try(:raw_source)).symbolize_keys!
+    end
+  end
+end

data/lib/createsend-rails/version.rb

@@ -0,0 +1,3 @@
+module CreatesendRails
+  VERSION = '0.3.4'
+end

data/lib/createsend-rails.rb

@@ -0,0 +1,19 @@
+require 'action_mailer'
+require 'createsend-rails/deliverer'
+require 'createsend-rails/ext/action_mailer'
+require 'createsend-rails/ext/hash'
+require 'createsend-rails/smart_email_formatter'
+
+module CreatesendRails
+  def self.install
+    ActionMailer::Base.include(CreatesendRails::SmartEmailer)
+    ActionMailer::Base.include(CreatesendRails::ViewDefaults)
+    ActionMailer::Base.add_delivery_method :create_send, CreatesendRails::Deliverer
+  end
+end
+
+if defined?(Rails)
+  require 'createsend-rails/railtie'
+else
+  CreatesendRails.install
+end

data/spec/createsend_rails/deliverer_spec.rb

@@ -0,0 +1,39 @@
+describe CreatesendRails::Deliverer do
+  before(:all) do
+    ActionMailer::Base.create_send_settings = { api_key: 'ABCDEFG' }
+  end
+
+  describe 'action_mailer' do
+    it 'allows configuration settings' do
+      expect(ActionMailer::Base.create_send_settings[:api_key]).to eq('ABCDEFG')
+    end
+  end
+
+  describe 'delivery' do
+    context 'valid delivery attributes' do
+      subject { described_class.new(request).deliver!(message) }
+      let(:request) { double(api: 'abcdef') }
+      let(:message) { double }
+
+      xit 'sends a request to the create_send API' do
+        expect(subject).to eq(eukdlx)
+      end
+
+      xit 'return successfully' do
+         expect(subject).to eq(true)
+      end
+    end
+
+    context 'missing API credentials' do
+      subject { described_class.new(request).deliver!(message) }
+      let(:request) { double }
+      let(:message) { double }
+    end
+
+    context 'missing API credentials' do
+      subject { described_class.new(request).deliver!(message) }
+      let(:request) { double }
+      let(:message) { double }
+    end
+  end
+end

data/spec/createsend_rails/hash_spec.rb

@@ -0,0 +1,16 @@
+describe CreatesendRails::Hash do
+  let(:simple_hash) { { a: 1, d: 2, e: nil } }
+  let(:multi_hash) { { a: 5, d: 6, e: nil, f: { a: 1, b: '' } } }
+
+  describe 'deep_reject!' do
+    it 'removes empty objects from the top level' do
+      simple_hash.deep_reject! { |_key, value| value.blank? }
+      expect(simple_hash).to eq({ a: 1, d: 2 })
+    end
+
+    it 'removes empty objects from multidimensional levels' do
+      multi_hash.deep_reject! { |_key, value| value.blank? }
+      expect(multi_hash).to eq({ a: 5, d: 6, f: { a: 1 } })
+    end
+  end
+end

data/spec/createsend_rails/smart_email_formatter_spec.rb

@@ -0,0 +1,40 @@
+describe CreatesendRails::SmartEmailFormatter do
+  subject { described_class.new(message).format }
+  let(:template) { { reset_url: 'http:://localhost/en/reset' }.to_json }
+  let(:message) {
+    Mail::Message.new(to: 'user@example.com',
+                      body: '',
+                      cc: ['joe@bloggs.com', 'john@bloggs.com'],
+                      subject: 'subject')
+  }
+
+  it 'include the message recipients' do
+    expected_recipients = { to: ['user@example.com'],
+                            cc: ['joe@bloggs.com', 'john@bloggs.com'] }
+
+    expect(subject).to include(expected_recipients)
+  end
+
+  context 'include message body' do
+    let(:message) {
+      Mail::Message.new(to: 'user@example.com',
+                        body: template,
+                        cc: ['joe@bloggs.com', 'john@bloggs.com'],
+                        subject: 'subject')
+    }
+
+    it { expect(subject[:data]).to include(:reset_url) }
+  end
+
+  context 'remove empty key values' do
+    let(:message) {
+      Mail::Message.new(to: 'user@example.com',
+                        body: template,
+                        subject: 'subject')
+    }
+
+    it { expect(subject).to_not include(:cc) }
+    it { expect(subject).to_not include(:bcc) }
+    it { expect(subject).to_not include(:subject) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'createsend-rails'

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: createsend-rails
+version: !ruby/object:Gem::Version
+  version: 0.3.4
+platform: ruby
+authors:
+- Andrew Scott
+- Rory MacDonald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: createsend
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.2.1
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: ''
+email:
+- andrew@madetech.co.uk
+- rory@madetech.co.uk
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/createsend-rails.rb
+- lib/createsend-rails/deliverer.rb
+- lib/createsend-rails/ext/action_mailer.rb
+- lib/createsend-rails/ext/hash.rb
+- lib/createsend-rails/railtie.rb
+- lib/createsend-rails/smart_email_formatter.rb
+- lib/createsend-rails/version.rb
+- spec/createsend_rails/deliverer_spec.rb
+- spec/createsend_rails/hash_spec.rb
+- spec/createsend_rails/smart_email_formatter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/MartinVandersteen/createsend-rails
+licenses: []
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Campaign Monitor transactional email adapter for ActionMailer
+test_files: []