sendwithus_ruby_action_mailer 0.1.2 → 0.2.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzUwYzU2NmY1ZGQ1YWNkZTVmZGU4ODcwNDM4NjNjYzQ5MDQxY2VhOQ==
-  data.tar.gz: !binary |-
-    NDU4Zjc5OWU0YmRkMTM3N2U2YmRkZGMxZTIyZTM1ZmI5OGI3ZWMyZg==
+SHA1:
+  metadata.gz: 4836500f0c202f57c8c1af9703690e488b999fa0
+  data.tar.gz: 198d34d6fcaff0e0ce4d466de087d5d0feaa72bb
 SHA512:
-  metadata.gz: !binary |-
-    YWRiNDQ4Y2QwNzRkYzAxOTAyZDY2ODlkMzExNzQ3ZTc0MzAwOTc5YzU3ZjAx
-    NGFkOTViNDY2ODc2ODY1NGE4ZWQxZDgxNTM0ZGJiMmQzOGRjZjM2MWJlODQy
-    ZWQ2MmNhMDk4ZjFiMjY3ODQ0OTY3NDZhNWJhMjQxMTBhNGM2MmM=
-  data.tar.gz: !binary |-
-    MWUxYjg0N2MwNzEwYmFmZjMxZWFhZGM0NTYwYzdkN2Y1YTY1ODQwNmUxYjc3
-    Zjk5OWRmOTY1YTQ2MzBhYzZhNmIzMzkwMmIxNTE0ODViOTI4NDMwY2Y3NWQ1
-    YjFhY2MzN2NmZTIzNjAzMWNmYWJkOWZhMjZiMTM3ZDM3ZDBmMzk=
+  metadata.gz: 098832db5ddc29570bcff1e7b7d2bf8e96eabd8447eedddc3e72d41ceaf8c2d58b4b8d22c30b41893e4890fd6f437f22696ea562d1f55b62a2fa7f4cdc390ee2
+  data.tar.gz: 43ddb9c5bdab56aca888348984fb9bcf6841e0ce7cb2f52a22ba77338eeae2e9efcfdc5a5a35d09f8a7808a9fe1cfb7187dc71ee542bfd5665bfca5e983e0ca5

data/README.md

@@ -59,8 +59,11 @@ class Notifier < SendWithUsMailer::Base
             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')
+            bcc: [{:address => "name@example.com"}, {:address => "name2@example.com"}],
+            version_name: 'version-A',
+            locale: 'en-US',
+            files: ["/path/to/file"]
+        )
     end
 end
 `````
@@ -98,6 +101,16 @@ class Notifier < SendWithUsMailer::Base
 end
 `````
 
+## Using Sidekiq
+
+Because SendWithUsMailer is not a subclass of ActionMailer (`SendWithUsMailer.is_a? ActionMailer` returns `false`), [Sidekiq's delayed ActionMailer extension](https://github.com/mperham/sidekiq/wiki/Delayed-extensions) will not automatically be included in the SendWithUsMailer, meaning that `YourMailer.delay.your_email` will not work without additional configuration. You can include Sidekiq's delayed ActionMailer in the SendWithUsMailer by putting the following line in `config/initializers/send_with_us.rb` along with your API config:
+
+`````Ruby
+::SendWithUsMailer::Base.extend(Sidekiq::Extensions::ActionMailer)
+`````
+
+That will cause Sidekiq to actually deliver the emails for jobs it processes offline. Relevant code in [Sidekiq::Extensions::ActionMailer](https://github.com/mperham/sidekiq/blob/master/lib/sidekiq/extensions/action_mailer.rb) and [SendWithUsMailer::Base](https://github.com/sendwithus/sendwithus_ruby_action_mailer/blob/master/lib/sendwithus_ruby_action_mailer/base.rb) should help explain why this is necessary.
+
 ## Contributing
 
 1. Fork it

data/lib/sendwithus_ruby_action_mailer/base.rb

@@ -77,6 +77,11 @@ module SendWithUsMailer
           super
         end
       end
+
+      # Add our mailer_methods to the set of methods the mailer responds to.
+      def respond_to?(method_name, include_all = false)
+        mailer_methods.include?(method_name.to_sym) || super
+      end
     end
 
     #----------------------- Instance methods ----------------------------
@@ -141,4 +146,4 @@ module SendWithUsMailer
       @message.assign(key, value)
     end
   end
-end
+end

data/lib/sendwithus_ruby_action_mailer/mail_params.rb

@@ -11,6 +11,8 @@ module SendWithUsMailer
       @cc = []
       @bcc = []
       @version_name = ""
+      @locale = ""
+      @files = []
     end
 
     def assign(key, value) #:nodoc:
@@ -38,6 +40,10 @@ module SendWithUsMailer
           @bcc.concat(value)
         when :version_name
           @version_name = value
+        when :locale
+          @locale = value
+        when :files
+          @files.concat(value)
         end
       end
     end
@@ -49,7 +55,18 @@ 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, @cc, @bcc, [], "", @version_name)
+      SendWithUs::Api.new.send_email(
+        @email_id,
+        @to,
+        data: @email_data,
+        from: @from,
+        cc: @cc,
+        bcc: @bcc,
+        esp_account: "",
+        version_name: @version_name,
+        locale: @locale,
+        files: @files
+      )
     end
   end
 end

data/lib/sendwithus_ruby_action_mailer/version.rb

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

data/sendwithus_ruby_action_mailer.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'send_with_us'
+  gem.add_runtime_dependency 'send_with_us', '>= 1.9.0'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest-colorize'
   gem.add_development_dependency 'mocha'

data/test/lib/sendwithus_ruby_action_mailer/mail_params_test.rb

@@ -58,8 +58,8 @@ describe SendWithUsMailer::MailParams do
     end
 
     it "calls the send_with_us gem" do
-      SendWithUs::Api.any_instance.expects(:send_with)
+      SendWithUs::Api.any_instance.expects(:send_email)
       subject.deliver
     end
   end
-end
+end

metadata

@@ -1,74 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: sendwithus_ruby_action_mailer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Nicholas Rempel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2015-04-07 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'
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.9.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\n    service with a
-  Ruby on Rails app. SendWilthUsMailer implements a\n    mailer API similar to the
-  ActionMailer railtie."
+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.
 email:
 - nick@sendwithus.com
 executables: []
@@ -99,17 +100,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.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: An ActionMailer look alike for Send With Us.