mail-ses 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6828265477b50de02b28a33e6d7e6c2454489e1874a9ef4a877d5c9da2798c19
-  data.tar.gz: b170ccac0a3decfc335bade3929bbabea31553b11f21f26abbf9af3d953bc083
+  metadata.gz: 91f1a759b15653521f07851f6706c4b9ed80eca19856e80033cb2052b42c0780
+  data.tar.gz: 923dacd96e29ca65e552214e8113e1ab56da0f5d27d0a0e28792a6d6e980eee4
 SHA512:
-  metadata.gz: 4501f1de2cacc24c08c3a2f398ef1865c38661f6878f694db809e6cba04621f8e379a76e8c5d66770a10566f2ce5549571016fafe11681836bd70696a2519134
-  data.tar.gz: f7c0310010dcdab52f961441b7c1c7f957bbaa815abe280e0bf90e36e2c42e3399d374d29f675e0af3507f8946ef5cdcef283c4085c0b847f409b1f03cc63de8
+  metadata.gz: 1b7321575bb49c5da7599a7c79e2db8f74cb18a5536eb78f40e49b774bec91c638dd59d91ef64a757b18fe879b65f90c6bb3b64038e9514fb881b419262dc475
+  data.tar.gz: 4e5c2cf40f609d9fe5ecfceb47b43f83a7c25a58d20c978ae4d26f5393f5c7a6688bb90a25fabd2222cb2f41e6d6e2064137c9c33a3ac08276a9d7a404233519

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.1.2
+
+- Fix: Add #settings method for conformity with other Mail delivery methods.
+
 # 0.1.1
 
 - Fix: Remove Base64 encoding from message body.

data/README.md

@@ -1,121 +1,123 @@
-[![Gem Version](https://badge.fury.io/rb/mail-ses.svg)](http://badge.fury.io/rb/mail-ses)
-[![Travis Status](https://travis-ci.org/tablecheck/mail-ses.svg?branch=master)](https://travis-ci.org/tablecheck/mail-ses)
-
-# Mail::SES
-
-Mail::SES is a mail delivery method handler for Amazon SES (Simple Email Service) which can be used with Rails' [Action Mailer](https://guides.rubyonrails.org/action_mailer_basics.html).
-
-This gem is inspired by [Drew Blas' AWS::SES gem](https://github.com/drewblas/aws-ses),
-but uses the official [AWS SDK v3 for SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-using-sdk-ruby.html) under-the-hood.
-By passing parameters through to the SDK, this gem supports greater flexibility with less code (including IAM instance profiles, retry parameters, etc.)
-
-### Compatibility
-
-* TBD
-
-### Shameless Plug
-
-ActionMailer::SES is sponsored by [TableCheck](http://corp.tablecheck.com/), Japan's leading restaurant management app. If **you** are a ninja-level Javascript/Ruby coder, designer, project manager, etc. and are eager to work in Tokyo with other ninjas, Japan in a dynamic environment, please get in touch at [careers@tablecheck.com](mailto:careers@tablecheck.com).
-
-## Getting Started
-
-In your `Gemfile`:
-
-```ruby
-gem 'mail-ses'
-```
-
-Next, make a new initializer at `config/initializers/mail_ses.rb`:
-
-```ruby
-ActionMailer::Base.add_delivery_method :ses, Mail::SES,
-    region: 'us-east-1',
-    access_key_id: 'abc',
-    secret_access_key: '123'
-```
-
-Finally, in the appropriate `config/environments/*.rb`:
-
-```ruby
-config.action_mailer.delivery_method = :ses
-```
-
-## Advanced Usage
-
-### AWS SES Client Options
-
-Any options supported by the `Aws::SES::Client` class can be passed into the initializer, for example:
-
-```ruby
-ActionMailer::Base.add_delivery_method :ses, Mail::SES,
-    region: 'us-east-1',
-    session_token: 'foobar',
-    retry_limit: 5,
-    retry_max_delay: 10
-```
-
-In addition, the shortcut option `:use_iam_profile (Boolean)` which activates the IAM instance profile.
-
-```ruby
-ActionMailer::Base.add_delivery_method :ses, Mail::SES,
-    region: 'us-east-1',
-    use_iam_profile: true
-```
-
-### Default Mail Options
-
-In the initializer you can set `:mail_options (Hash)` which are default options to pass-through to each mail sent:
-
-```ruby
-ActionMailer::Base.add_delivery_method :ses, Mail::SES,
-    # ...
-    mail_options: {
-      source_arn: 'arn:aws:ses:us-east-1:123456789012:identity/example.com',
-      tags: [
-        { name: 'MessageTagName', value: 'MessageTagValue' },
-      ],
-    }
-```
-
-### AWS Error Handling
-
-To handle errors from AWS API, in the initializer you can set `:error_handler (Proc)` which takes two args:
-the error which was raised, and the raw_email options hash. This is useful for notifying your bug tracking service.
-Setting `:error_handler` causes the error to be swallowed unless it is raised again in the handler itself.
-
-```ruby
-ActionMailer::Base.add_delivery_method :ses, Mail::SES,
-    # ...
-    error_handler: ->(error, raw_email) do
-      Bugsnag.notify(error){|r| r.add_tab('email', { email: raw_email })}
-      raise error    
-    end
-```
-
-### Send Email as a Standalone
-
-You can send one-off mails using the `Mail::SES` object and `#deliver` method.
-
-```ruby
-mail = Mail.new(args)
-
-ses  = Mail::SES.new(region: 'us-east-1',
-                     access_key_id: 'abc',
-                     secret_access_key: '123')
-
-options = { source_arn: 'arn:aws:ses:us-east-1:123456789012:identity/example.com' }
-
-ses.deliver!(mail, options) #=> returns AWS API response
-
-mail.message_id #=> "00000138111222aa-33322211-cccc-cccc-cccc-ddddaaaa0680-000000@email.amazonses.com"
-```
-
-Please also see the [AWS SDK v3 for SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-using-sdk-ruby.html) for alternate approaches.
-
-## Statistics, Verified Addresses, Bounce Rate, etc.
-
-Please use the official [AWS SDK v3 for SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-using-sdk-ruby.html).
-
-## Copyright
-
-Copyright (c) 2018 TableCheck Inc. See LICENSE for further details.
+[![Gem Version](https://badge.fury.io/rb/mail-ses.svg)](http://badge.fury.io/rb/mail-ses)
+[![Travis Status](https://travis-ci.org/tablecheck/mail-ses.svg?branch=master)](https://travis-ci.org/tablecheck/mail-ses)
+
+# Mail::SES
+
+Mail::SES is a mail delivery method handler for Amazon SES (Simple Email Service) which can be used with Rails' [Action Mailer](https://guides.rubyonrails.org/action_mailer_basics.html).
+
+This gem is inspired by [Drew Blas' AWS::SES gem](https://github.com/drewblas/aws-ses),
+but uses the official [AWS SDK v3 for SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-using-sdk-ruby.html) under-the-hood.
+By passing parameters through to the SDK, this gem supports greater flexibility with less code (including IAM instance profiles, retry parameters, etc.)
+
+### Compatibility
+
+* Ruby 2.1+
+* Ruby on Rails 3.2+
+* AWS SDK v3
+
+### Shameless Plug
+
+ActionMailer::SES is sponsored by [TableCheck](http://corp.tablecheck.com/), Japan's leading restaurant management app. If **you** are a ninja-level Javascript/Ruby coder, designer, project manager, etc. and are eager to work in Tokyo with other ninjas, Japan in a dynamic environment, please get in touch at [careers@tablecheck.com](mailto:careers@tablecheck.com).
+
+## Getting Started
+
+In your `Gemfile`:
+
+```ruby
+gem 'mail-ses'
+```
+
+Next, make a new initializer at `config/initializers/mail_ses.rb`:
+
+```ruby
+ActionMailer::Base.add_delivery_method :ses, Mail::SES,
+    region: 'us-east-1',
+    access_key_id: 'abc',
+    secret_access_key: '123'
+```
+
+Finally, in the appropriate `config/environments/*.rb`:
+
+```ruby
+config.action_mailer.delivery_method = :ses
+```
+
+## Advanced Usage
+
+### AWS SES Client Options
+
+Any options supported by the `Aws::SES::Client` class can be passed into the initializer, for example:
+
+```ruby
+ActionMailer::Base.add_delivery_method :ses, Mail::SES,
+    region: 'us-east-1',
+    session_token: 'foobar',
+    retry_limit: 5,
+    retry_max_delay: 10
+```
+
+In addition, the shortcut option `:use_iam_profile (Boolean)` which activates the IAM instance profile.
+
+```ruby
+ActionMailer::Base.add_delivery_method :ses, Mail::SES,
+    region: 'us-east-1',
+    use_iam_profile: true
+```
+
+### Default Mail Options
+
+In the initializer you can set `:mail_options (Hash)` which are default options to pass-through to each mail sent:
+
+```ruby
+ActionMailer::Base.add_delivery_method :ses, Mail::SES,
+    # ...
+    mail_options: {
+      source_arn: 'arn:aws:ses:us-east-1:123456789012:identity/example.com',
+      tags: [
+        { name: 'MessageTagName', value: 'MessageTagValue' },
+      ],
+    }
+```
+
+### AWS Error Handling
+
+To handle errors from AWS API, in the initializer you can set `:error_handler (Proc)` which takes two args:
+the error which was raised, and the raw_email options hash. This is useful for notifying your bug tracking service.
+Setting `:error_handler` causes the error to be swallowed unless it is raised again in the handler itself.
+
+```ruby
+ActionMailer::Base.add_delivery_method :ses, Mail::SES,
+    # ...
+    error_handler: ->(error, raw_email) do
+      Bugsnag.notify(error){|r| r.add_tab('email', { email: raw_email })}
+      raise error    
+    end
+```
+
+### Send Email as a Standalone
+
+You can send one-off mails using the `Mail::SES` object and `#deliver` method.
+
+```ruby
+mail = Mail.new(args)
+
+ses  = Mail::SES.new(region: 'us-east-1',
+                     access_key_id: 'abc',
+                     secret_access_key: '123')
+
+options = { source_arn: 'arn:aws:ses:us-east-1:123456789012:identity/example.com' }
+
+ses.deliver!(mail, options) #=> returns AWS API response
+
+mail.message_id #=> "00000138111222aa-33322211-cccc-cccc-cccc-ddddaaaa0680-000000@email.amazonses.com"
+```
+
+Please also see the [AWS SDK v3 for SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-using-sdk-ruby.html) for alternate approaches.
+
+## Statistics, Verified Addresses, Bounce Rate, etc.
+
+Please use the official [AWS SDK v3 for SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-using-sdk-ruby.html).
+
+## Copyright
+
+Copyright (c) 2018 TableCheck Inc. See LICENSE for further details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/mail/ses.rb

@@ -11,6 +11,7 @@ module Mail
                           tags
                           configuration_set_name ].freeze
 
+    attr_accessor :settings
     attr_reader :client
 
     # Initializes the Mail::SES object.
@@ -23,6 +24,7 @@ module Mail
     def initialize(options = {})
       @mail_options = options.delete(:mail_options) || {}
       @error_handler = options.delete(:error_handler)
+      @settings = { return_response: options.delete(:return_response) }
       self.class.validate_error_handler(@error_handler)
       options = self.class.build_client_options(options)
       @client = Aws::SES::Client.new(options)
@@ -41,7 +43,7 @@ module Mail
       begin
         response = client.send_raw_email(raw_email_options)
         mail.message_id = "#{response.to_h[:message_id]}@email.amazonses.com"
-        response
+        settings[:return_response] ? response : self
       rescue StandardError => e
         @error_handler ? @error_handler.call(e, raw_email_options.dup) : raise(e)
       end

data/spec/mail_ses_spec.rb

@@ -22,6 +22,13 @@ RSpec.describe Mail::SES do
     it { expect(described_class::VERSION).to match(/\A\d+\.\d+\.\d+/) }
   end
 
+  describe '#settings' do
+    it do
+      expect(ses).to respond_to(:settings, :settings=)
+      expect(ses.settings).to eq(return_response: nil)
+    end
+  end
+
   describe '#initialize' do
     it 'accepts valid :error_handler' do
       expect(described_class.new(ses_options)).to be_a(Mail::SES)
@@ -91,7 +98,15 @@ RSpec.describe Mail::SES do
     end
 
     it 'returns the AWS response' do
-      expect(ses.deliver!(mail)).to be_a(Seahorse::Client::Response)
+      expect(ses.deliver!(mail)).to be_a(Mail::SES)
+    end
+
+    context 'when :return_response set' do
+      let(:ses_options) { { stub_responses: true, return_response: true } }
+
+      it 'returns the AWS response' do
+        expect(ses.deliver!(mail)).to be_a(Seahorse::Client::Response)
+      end
     end
 
     context 'error handling' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail-ses
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Johnny Shields
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-18 00:00:00.000000000 Z
+date: 2018-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ses