heya 0.4.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df7378738941dc37dce872a4365c3b97f03e0f53ee9e89854367e73fad24efb
-  data.tar.gz: cae2fde9c57c5a6a1aacf22d9b2f9256fb5a49a1eb0aaed0ac5a6647b6f60249
+  metadata.gz: 971ee7f9d958554bbed7093180fd8af86e12f24c00a526be4e0361ab07657fe3
+  data.tar.gz: f0d0f2e54f9bea9f93f095a14f19844213347989f19b881e30fa3f46cc76825c
 SHA512:
-  metadata.gz: 74e3bd2771b93945877b05af5a09cde7a7ea7ccd2f0d51f90c141d85387a3e093c63f6a72baa1e2c8038a49a3a9b5cdfb9ed4c9326d2e684ca2333804f43ec4c
-  data.tar.gz: a04b7890247085d044d56af4774f7d208d169fce32a61921c8162d2dde7a244a7235c828234fec04a44dcb599e9a2bc33332beec909617f3395dec6606ff4507
+  metadata.gz: b8da212577467f530326619471c1deb418bb71ed7109a105c47005a409ce008e1c211baa5e2e6b718dbda009efae940d282ddfb0b151d9ddb951c4dc732728a8
+  data.tar.gz: a6d53345cde9565b492dd7a99621db3e5762c1fd2ae8af8e565c3b69b19d887561dbb7fba32fafb74c7500c29e249e3e9f96ceb664e69cb8e5521f6693a5ae79

data/CHANGELOG.md

@@ -5,6 +5,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### 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
 ### Changed

data/README.md

@@ -266,6 +266,28 @@ class OnboardingCampaign < ApplicationCampaign
 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,
+    queue: "onboarding",
+    from: "support@example.com"
+
+  # Will still be sent after one day from the
+  # 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
+```
+
 #### Customizing email subjects for each user
 
 The subject can be customized for each user by using a `lambda` instead of a `String`:

data/app/mailers/heya/campaign_mailer.rb

@@ -10,6 +10,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") {
@@ -18,9 +19,11 @@ module Heya
       subject = subject.call(user) if subject.respond_to?(:call)
 
       instance_variable_set(:"@#{user.model_name.element}", user)
+      instance_variable_set(:@campaign_name, campaign_name)
 
       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]
 
         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.4.0"
+  VERSION = "0.5.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heya
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Joshua Wood
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-08-18 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.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: "Heya \U0001F44B"