createsend-rails 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0742b57d7f6f0e6d955fbcfd3d18211dde6d7b8e475b0a621131afea61d182bd
-  data.tar.gz: 1191de843ecab00ded84e2acf137df5b2b3cf47618b2d232485c2054d6f85935
+  metadata.gz: d58e0513321a67781e305704a3dc01d5bb2c6e92f254035c1677d142147b8049
+  data.tar.gz: 2516a66290fdb2b4c21d73b4fdb511996e7fa6d88cb0c1cfec1abcd1de121e72
 SHA512:
-  metadata.gz: f2cac7d5029608c66affc4db3b667e7122bcfb2df3aa53a8aa10d6e8c2f54eb415707b7c62ed01f3a06924a13c78383fa09ef7a869947f768bb0f68d3d947f36
-  data.tar.gz: e2b283a15be906085b3b2c8ed85adcc99927196af90128deb8e0f0afb71e60e3e1d1dff448746e3aa2c78e196ce40a5788f4b133a2dbc5b75e52420bf5c0921c
+  metadata.gz: e73d6ee3225d6025e16a06062fc057baffc28ad7ea4be36aeacb0077549d628750cc82f0b85f59ddfcb26578a8babc328e02474c7bc45dfa63e27ea060560563
+  data.tar.gz: 353d27149bee6df0c6c0192ee1bfaaeee9979052f159dead47d7a2ebad749d66322e371274e88a08527ecaaf869abaacb5985992fc91e0bc67b2eba964f63323

data/README.md

@@ -22,30 +22,54 @@ config.action_mailer.create_send_settings = {
     api_key: 'INSERT_API_KEY'
 }
 ```
-Now go into your `views/*_mailer/` and add a `.json.erb` view, which defines the data attributes required by your Smart Email template. Below is an example of a password reset email. (Don't forget to declare the appropriate instance variables in your mailer)
+
+Once that's done, you can create a simple example Mailer :
+```ruby
+class UserMailer < ApplicationMailer
+  def user_registered
+    @user = params[:user]
+    mail to: @user.email
+  end
+end
+
+```
+
+Now go into your `views/user_mailer/` and add a `user_registered.json.erb` view, which defines the data attributes required by your Smart Email template. Below is an example of a user activation email. Here, `@user` references the instance variable of the UserMailer we created.
 
 ```json
 {
     "smart_email_id": "SMART_EMAIL_ID",
-    "consent_to_track: "yes|no|unchanged",
+    "consent_to_track: "yes/no/unchanged",
     "language": "<%= @user.language %>",
     "name": "<%= @user.name %>",
-    "reset_url": "<%= @edit_password_reset_url %>"
+    "token": "<%= @user.confirmation_token %>"
 }
 ```
 
+You can now trigger the email from anywhere you want, for example in an `after_create` callback on your User model :
+```ruby
+  class User < ApplicationRecord 
+    after_create :send_activation_mail
+    ...
+
+    def send_activation_mail # The user we pass with the method 'with' is the one we receive in the mailer through params[:user]
+      UserMailer.with(user: self).user_registered.deliver_later
+    end
+  end
+```
+
 ## 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:
+Initialy developed 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)
+* [Martin Vandersteen](https://github.com/MartinVandersteen) from [Koalect](https://www.koalect.com/)
 
 
 ## 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.
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/lib/createsend-rails/version.rb

@@ -1,3 +1,3 @@
 module CreatesendRails
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: createsend-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Andrew Scott
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -189,7 +189,8 @@ files:
 - spec/createsend_rails/smart_email_formatter_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/MartinVandersteen/createsend-rails
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: