heya 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aca23a8fecadfe7dbaef4abe9b38e8e1ec3d12f1caeff8d87fcf6d088b53f1b
-  data.tar.gz: a0dbebd018ae387f35658a8a87d31a358de7f98a0f66229d32d392fac81cacb7
+  metadata.gz: 6fd230aff6fc53ebfb1af3093b01c96b7c0480e0d67d6a3dee3ebb970009726d
+  data.tar.gz: 06aa85033434dfc827a6b341002c7da4e9f172340da0a2ff713e75085c1bffeb
 SHA512:
-  metadata.gz: 8f834ac3755b014a0535598b9059ea84bfadf40e0f0c3d3ceb86876d46b78389984ba508ef07a91e84c9f6a8ddbe27074dab4fa7462f5d52c8b76577f0fa7302
-  data.tar.gz: d468061ee32fe90aab855e8231314100cea6cf17aa31ab68d608c8f28e98c7c95fce72a4a1924ba87ce1fed2f6e4e0c3079df9ffdb701ec9eb3df6303fa24a85
+  metadata.gz: a044d5ade5c1cc36367a486982afa4e522f3c83407d86df71058176c5406d8e3901aaf420a70866b3146f71edf4af8dd4ac204bf5446b47d613ec5aa3163bc93
+  data.tar.gz: 2820502a0d9a141df3ac428d71aba1768576e90e56cd1e5b58fe7cfe970a5413409bf9e95a9c0decfbd73066a8d13ebfe12c6b6ee759b172c35ae460bf46afdc

data/CHANGELOG.md

@@ -6,6 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
+- Optional `layout` parameter for steps; allowing override from default `heya/campaign_mailer`
+
+## [0.5.3] - 2021-08-18
+### Added
+- Create `bcc:` optional parameter for steps; use case is quality control
+
+## [0.5.2] - 2021-08-11
+### Fixed
+- Fix typo in initializer (#139, @800a7b32)
+
+## [0.5.1] - 2021-07-13
+### Fixed
+- Fix compatibility with Rails 6.1.4 (introduced by [this change](https://github.com/rails/rails/commit/99049262d37fedcd25af91231423103b0d218694#diff-79b53b2602bf702bdd8ce677e096be6a6923a54236e17237c16068a510078683) to `build_arel`) (#137, @retsef)
+
+## [0.5.0] - 2021-06-17
+### Added
 - Create `@campaign_name` instance var accessible in email templates (#135)
 
 ## [0.4.0] - 2021-02-04

data/README.md

@@ -250,9 +250,29 @@ Heya uses the following additional options to build the message itself:
 | :---------- | :----------- | :------------------------- |
 | `subject`   | **required** | The email's subject        |
 | `from`      | Heya default | The sender's email address |
+| `layout`    | Heya default | The email's layout file    |
 
 You can change the default options using the `default` method at the top of the campaign. Heya applies default options to each step which doesn't supply its own:
 
+```ruby
+class OnboardingCampaign < ApplicationCampaign
+  default wait: 1.day,
+    queue: "onboarding",
+    from: "support@example.com",
+    layout: "onboarding"
+
+  # Will still be sent after one day from the
+  # email address support@example.com
+  step :welcome,
+    subject: "Welcome to my app!"
+end
+```
+
+#### Quality control option
+
+You may wish to apply quality control to individual steps of a campaign. For example, when adding a new step to an existing campaign it is
+a good idea to inspect real-time results in production. You can do this by using the `bcc:` step option, which would look like this:
+
 ```ruby
 class OnboardingCampaign < ApplicationCampaign
   default wait: 1.day,
@@ -263,6 +283,10 @@ class OnboardingCampaign < ApplicationCampaign
   # email address support@example.com
   step :welcome,
     subject: "Welcome to my app!"
+
+  step :added_two_months_later,
+    subject: "We now have something new to say!",
+    bcc: 'quality_control@example.com'
 end
 ```
 

data/app/mailers/heya/campaign_mailer.rb

@@ -1,6 +1,7 @@
 module Heya
   class CampaignMailer < ApplicationMailer
-    layout "heya/campaign_mailer"
+    DEFAULT_LAYOUT = "heya/campaign_mailer"
+    layout -> { params.fetch(:step).params.fetch("layout", DEFAULT_LAYOUT) }
 
     def build
       user = params.fetch(:user)
@@ -10,6 +11,7 @@ module Heya
       step_name = step.name.underscore
 
       from = step.params.fetch("from")
+      bcc = step.params.fetch("bcc", nil)
       reply_to = step.params.fetch("reply_to", nil)
 
       subject = step.params.fetch("subject") {
@@ -22,6 +24,7 @@ module Heya
 
       mail(
         from: from,
+        bcc: bcc,
         reply_to: reply_to,
         to: user.email,
         subject: subject,

data/lib/generators/heya/install/templates/initializer.rb.tt

@@ -8,7 +8,7 @@ Heya.configure do |config|
   # Campaign priority. When a user is added to multiple campaigns, they are
   # sent in this order. Campaigns are sent in the order that the users were
   # added if no priority is configured.
-  # config.campaings.priority = [
+  # config.campaigns.priority = [
   #   "FirstCampaign",
   #   "SecondCampaign",
   #   "ThirdCampaign"

data/lib/heya/active_record_extension.rb

@@ -6,7 +6,7 @@ module Heya
   module ActiveRecordRelationExtension
     TABLE_REGEXP = /heya_steps/
 
-    def build_arel(aliases)
+    def build_arel(aliases = nil)
       arel = super(aliases)
 
       if table_name == "heya_campaign_memberships" && arel.to_sql =~ TABLE_REGEXP

data/lib/heya/campaigns/actions/email.rb

@@ -4,7 +4,7 @@ module Heya
   module Campaigns
     module Actions
       class Email < Action
-        VALID_PARAMS = %w[subject from reply_to]
+        VALID_PARAMS = %w[subject from reply_to bcc layout]
 
         def self.validate_step(step)
           step.params.assert_valid_keys(VALID_PARAMS)

data/lib/heya/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Heya
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heya
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Joshua Wood
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: "Heya \U0001F44B"