sendwithus_ruby_action_mailer 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 6d06e247bf9a5f38c03ca54eaf637f4ef84b20df
-  data.tar.gz: 3b4ad12f18f15b8f88d94c1163e82d62310db2af
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzUwYzU2NmY1ZGQ1YWNkZTVmZGU4ODcwNDM4NjNjYzQ5MDQxY2VhOQ==
+  data.tar.gz: !binary |-
+    NDU4Zjc5OWU0YmRkMTM3N2U2YmRkZGMxZTIyZTM1ZmI5OGI3ZWMyZg==
 SHA512:
-  metadata.gz: 6c9aeec5161a07751d70800ee8372c441005805f9902fe3953933e965f16ddc02f2fac96e05bc7723ad6ec475f52cca4744bb74ab0fa7ddc6bd4080059ea55c1
-  data.tar.gz: 0d308e69cded6fb90de75727f02748c0add55fb120ab7b97a3259aab67e2bd2b94cb0647f971dd7aef5f5ad1f6f9760043ed25d3cbdf24d817519ebaf456dc41
+  metadata.gz: !binary |-
+    YWRiNDQ4Y2QwNzRkYzAxOTAyZDY2ODlkMzExNzQ3ZTc0MzAwOTc5YzU3ZjAx
+    NGFkOTViNDY2ODc2ODY1NGE4ZWQxZDgxNTM0ZGJiMmQzOGRjZjM2MWJlODQy
+    ZWQ2MmNhMDk4ZjFiMjY3ODQ0OTY3NDZhNWJhMjQxMTBhNGM2MmM=
+  data.tar.gz: !binary |-
+    MWUxYjg0N2MwNzEwYmFmZjMxZWFhZGM0NTYwYzdkN2Y1YTY1ODQwNmUxYjc3
+    Zjk5OWRmOTY1YTQ2MzBhYzZhNmIzMzkwMmIxNTE0ODViOTI4NDMwY2Y3NWQ1
+    YjFhY2MzN2NmZTIzNjAzMWNmYWJkOWZhMjZiMTM3ZDM3ZDBmMzk=

data/README.md

@@ -1,8 +1,8 @@
-# SendWithUsMailer
+# sendwithus Ruby Action Mailer
 
-[Send With Us](http://sendwithus.com) is a service that provides a convenient way for non-developers to create and edit
-the email content from your app.  Send With Us created a gem, `send_with_us`, that communicates to
-their service using their low-level RESTful API.
+[sendwithus](http://sendwithus.com) is a service that provides a convenient way for non-developers
+to create and edit the email content from your app. sendwithus has created a gem, `send_with_us`,
+that communicates with our REST API for sending templated emails.
 
 Ruby on Rails developers are familiar with the ActionMailer interface for sending email.  This
 gem implements a small layer over the `send_with_us` gem that provides and ActionMailer-like API.
@@ -23,7 +23,17 @@ Or install it yourself as:
 
 ## Setup
 
-(TODO)
+### Rails
+
+For a Rails app, create `send_with_us.rb` in `/config/initializers/`
+with the following:
+
+```ruby
+SendWithUs::Api.configure do |config|
+    config.api_key = 'YOUR API KEY'
+    config.debug = true
+end
+```
 
 ## Usage
 
@@ -37,7 +47,20 @@ class Notifier < SendWithUsMailer::Base
 
     def welcome(recipient)
         assign(:account, recipient)
-        mail(email_id: 'ID-CODE-FROM-SEND-WITH-US', recipient_address: recipient.email)
+
+        assign(:captain_name, recipient.name)
+        #=> in sendwithus email template {{ captain_name }}
+        assign :team, {team_name: recipient.team_name, captain: recipient.name}
+        #=> in sendwithus email template {{ team.team_name }} and {{ team.captain }} 
+
+        mail(
+            email_id: 'ID-CODE-FROM-SEND-WITH-US',
+            recipient_address: recipient.email,
+            from_name: 'Billing',
+            from_address: 'billing@example.com',
+            reply_to: 'support@example.com',
+            bcc: [{:address => "name@example.com"},{:address => "name2@example.com"}],
+            version_name: 'en-US')
     end
 end
 `````
@@ -55,7 +78,7 @@ Once a mailer action is defined, you can deliver your message or create it and s
 for delivery later:
 
 `````Ruby
-Notifier.welcome(david).deliver # sends the email
+Notifier.welcome(nick).deliver # sends the email
 
 mail = Notifier.welcome(david)  # => a SendWithUsMailer::MailParams object
 mail.deliver                    # sends the email

data/lib/sendwithus_ruby_action_mailer/mail_params.rb

@@ -8,6 +8,9 @@ module SendWithUsMailer
       @email_data = {}
       @to = {}
       @from = {}
+      @cc = []
+      @bcc = []
+      @version_name = ""
     end
 
     def assign(key, value) #:nodoc:
@@ -29,6 +32,12 @@ module SendWithUsMailer
           @from.merge!(address: value)
         when :reply_to
           @from.merge!(reply_to: value)
+        when :cc
+          @cc.concat(value)
+        when :bcc
+          @bcc.concat(value)
+        when :version_name
+          @version_name = value
         end
       end
     end
@@ -40,7 +49,7 @@ module SendWithUsMailer
     # In particular, the +api_key+ must be set (following the guidelines in the
     # +send_with_us+ documentation).
     def deliver
-      SendWithUs::Api.new.send_with(@email_id, @to, @email_data, @from)
+      SendWithUs::Api.new.send_with(@email_id, @to, @email_data, @from, @cc, @bcc, [], "", @version_name)
     end
   end
 end

data/lib/sendwithus_ruby_action_mailer/version.rb

@@ -1,3 +1,3 @@
 module SendWithUsMailer
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/lib/sendwithus_ruby_action_mailer/integration_test.rb

@@ -23,11 +23,12 @@ describe SendWithUsMailer do
   describe "more mail options" do
     class MoreOptionsMailer < SendWithUsMailer::Base
       def example_email
-        mail email_id: 'a4bBEddKbhKBu5xsU2p58KX',
+        mail email_id: 'tem_9YvYsaLW2Mw4tmPiLcVvpC',
              to: 'adave@example.com',
              from_address: 'asender@company.com',
              from_name: 'asender',
-             reply_to: 'ano-reply@company.com'
+             reply_to: 'ano-reply@company.com',
+             version_name: 'v2'
       end
     end
 
@@ -109,4 +110,4 @@ describe SendWithUsMailer do
       })
     end
   end
-end
+end

metadata

@@ -1,75 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: sendwithus_ruby_action_mailer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nicholas Rempel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-15 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: send_with_us
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '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: minitest-colorize
   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: mocha
   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'
-description: |-
-  A convenient way to use the Send With Us email
-      service with a Ruby on Rails app. SendWilthUsMailer implements a
-      mailer API similar to the ActionMailer railtie.
+description: ! "A convenient way to use the Send With Us email\n    service with a
+  Ruby on Rails app. SendWilthUsMailer implements a\n    mailer API similar to the
+  ActionMailer railtie."
 email:
 - nick@sendwithus.com
 executables: []
@@ -100,17 +99,17 @@ 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.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An ActionMailer look alike for Send With Us.