sendable_rails 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dd6f9a2111c569b2e00393a14810d6135ea27af
-  data.tar.gz: d4b5197e66c5257c2e5aff86ba48a5d400ed2d1b
+  metadata.gz: d9e9e521042a8bf3db008f622668562847b2ba2c
+  data.tar.gz: 0cc6c5805c2481df347ae0ba19e4d5ff62cb8a31
 SHA512:
-  metadata.gz: 9cd77b0c7d80629b36b64dc67bea00d8979cbc8c24a79f33cc42d5353852618a0c1b74dae4a266fc4160d183e2b650432823dfa9ad015d055cfc32757b906a49
-  data.tar.gz: 66bdf6b00ffbff2bcf928d6f7d1b9ac92114cdc4807ee83516d435f0496e36019b534a80c4da648f098551f83fffb0b10fab43f7dac989e622ad9c8c80787e1a
+  metadata.gz: 359a6138c45b2b09389cc8fa60838fa4158ac36da381b09e6b172fe7ee1e57f27dec7dbf73744220e4fc012c2e22762ef43e4bf0cf765973a4c72952baa0a6dc
+  data.tar.gz: d6ea909e2967eb27f41d77b43c7052bedbdf1508ef0ed62b0d53c9675f960a7dd5d3f8df8feacb158f299bc9935e60d06b5b9359cabb21c8d977bf14a5dcf076

data/README.md

@@ -1,10 +1,11 @@
-# SendableRails
-Short description and motivation.
+# Sendable Rails ActionMailer Client
 
-## Usage
-How to use my plugin.
+[Sendable](https://sendable.io) is a service that makes it simpler to design, manage and optimize your Transactional Emails. Sendable has created a Ruby gem `sendable` that communicates with our REST API for sending your transactional emails.
+
+Ruby on Rails developers use the ActionMailer interface for sending emails. This gem, `sendable_rails` implements a small layer over the `sendable` gem that provides an API similar to ActionMailer.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,9 +21,70 @@ Or install it yourself as:
 ```bash
 $ gem install sendable_rails
 ```
+## Setup
+
+There are 2 ways to set up Sendable. You can either set the API key in an environment variable, or pass it in an initializer.
+
+### Option 1 - Environment Variable
+
+Add the following environment variable to your application. You can get your API key from the settings page of your Sendable project dashboard.
+
+`SENDABLE_API_KEY`=`YOUR API KEY`
+
+### Option 2 - Initializer
+
+If you don't want to set an environment variable, create a file `config/initializers/sendable.rb` and put this in there:
+
+```ruby
+Sendable.config do |config|
+  config.api_key = 'YOUR API KEY'
+end
+```
+
+## Usage
+
+The only changes required in your existing `mail` method are:
+
+- Replace `mail` with `sendable_mail`
+- Pass a `template` key that you can get from your Sendable project dashboard
+- Instance variables will be available in your templates as `mustache` attributes
+
+Everything else will work as expected. Here is a before and after comparison:
+
+### Before (Without Sendable)
+
+```ruby
+class UserMailer < ActionMailer::Base
+  default from: 'no-reply@example.com'
+
+  def welcome(user)
+    @user = user
+    mail( to: @user.email, subject: "Welcome to My Awesome Site!" )
+  end
+end
+```
+
+
+### After (Using Sendable)
+
+```ruby
+class UserMailer < ActionMailer::Base
+  default from: 'no-reply@example.com'
+
+  def welcome(user)
+    @user = user
+    sendable_mail to: @user.email, template: 1
+  end
+end
+```
 
 ## Contributing
-Contribution directions go here.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/sendable_rails/action_mailer_ext.rb

@@ -3,17 +3,15 @@ require 'sendable'
 module SendableRails
   module ActionMailerWithSendable
     def sendable_mail(params = {})
-      template_id = params.delete(:template_id)
-
-      assigns = {}
+      data = {}
       instance_variables.each do |key|
         if key[0..1] != '@_'
           name = key[1..-1]
-          assigns[name] = instance_variable_get(key)
+          data[name] = instance_variable_get(key)
         end
       end
 
-      Sendable.client.email(template_id, params.merge(default_params).merge(assigns: assigns))
+      Sendable.client.email(params.merge(default_params).merge(data: data))
     end
   end
 end

data/lib/sendable_rails/version.rb

@@ -1,3 +1,3 @@
 module SendableRails
-  VERSION = '0.4.5'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendable_rails
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Umair Siddique
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sendable
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement