sendgrid-actionmailer 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68926bb0db0f0f622282b8429b3df0f86911ca0d72c0146bcaf181966130e290
-  data.tar.gz: '048ca01e72420c6f88be723ada69126d31c831f300b0aa539f8f7d236e3c500f'
+  metadata.gz: bb577847afaccad306f73fa0c34b928298b8dda4de873f8d0459dd96f41bee34
+  data.tar.gz: 9e9fa4dc9d9301aa0473f90ce3c1ae683a91d4313945333c636fc302dcb0f624
 SHA512:
-  metadata.gz: 5999a6b88c2eb27869872a42c0f7300198cb9870f20087a9c38c68909b0bdcd6a960d0adc2eb01dfa39c530ff6eabee727e0ad9762b19294d57be8fd26e598f0
-  data.tar.gz: a26c201d0a9466684796371b82d2cb3d2aaad48efd1fc6a5c1ffd22b410bcdb71203379c498c8ae504653d0a2692206003ac3176ecfd32025e555fb38ebc0d2e
+  metadata.gz: f387f4d44937198fcbbad709ec316b27d0e8bbbbd87b997fbeb5fdb5ec6a26a8f1b72f226bbae55b6e23692711b6dabcce9ea6aa240c7789a55ca776a7761cdf
+  data.tar.gz: 309ea7246ece21e445746f2faab91ad30b6f37392da0db1c00ec51e4033362cee300b86e546ee2c6e6cd18d4b2012454fa50d2fee31d43dcf1f9b6ee50b5062f

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 3.2.0 - 2020-02-16
+- #107 Feature/sendgrid api settings, expand settings/options to allow for other SendGrid::Api client settings
+- #106 The SendGrid API simple error handling
+- #105 Github Actions CI
+- #102 Add http_options to configurable in mailer settings
+- #101 Railtie should use ActiveSupport.on_load
+
 ## 3.1.1 - 2020-11-06
 - #92 globally configured mail_settings
 - #95 add_mail_settings - support global settings

data/lib/sendgrid_actionmailer.rb

@@ -14,13 +14,14 @@ module SendGridActionMailer
       raise_delivery_errors: false
     }.freeze
 
-    attr_accessor :settings, :api_key
+    attr_accessor :settings, :options
 
     def initialize(params = {})
       self.settings = DEFAULTS.merge(params)
     end
 
     def deliver!(mail)
+      self.options = {}
       sendgrid_mail = Mail.new.tap do |m|
         m.from = to_email(mail.from)
         m.reply_to = to_email(mail.reply_to)
@@ -28,7 +29,7 @@ module SendGridActionMailer
       end
 
       add_personalizations(sendgrid_mail, mail)
-      add_api_key(sendgrid_mail, mail)
+      add_options(sendgrid_mail, mail)
       add_content(sendgrid_mail, mail)
       add_send_options(sendgrid_mail, mail)
       add_mail_settings(sendgrid_mail, mail)
@@ -45,8 +46,14 @@ module SendGridActionMailer
 
     private
 
+    def client_options
+      options.dup
+      .select { |key, value| key.to_s.match(/(api_key|host|request_headers|version|impersonate_subuser)/) }
+      .merge(http_options: settings.fetch(:http_options, {}))
+    end
+
     def client
-      @client = SendGrid::API.new(api_key: api_key).client
+      @client = SendGrid::API.new(**client_options).client
     end
 
     # type should be either :plain or :html
@@ -146,10 +153,10 @@ module SendGridActionMailer
       content_disp.disposition_type
     end
 
-    def add_api_key(sendgrid_mail, mail)
-      self.api_key = settings.fetch(:api_key)
-      if mail['delivery-method-options'] && mail['delivery-method-options'].value.include?('api_key')
-        self.api_key = mail['delivery-method-options'].unparsed_value['api_key']
+    def add_options(sendgrid_mail, mail)
+      self.options.merge!(**self.class.transform_keys(self.settings, &:to_sym))
+      if !!(mail['delivery-method-options'])
+        self.options.merge!(**self.class.transform_keys(mail['delivery-method-options'].unparsed_value , &:to_sym))
       end
     end
 
@@ -286,9 +293,7 @@ module SendGridActionMailer
       result = client.mail._('send').post(request_body: email.to_json) # ლ(ಠ益ಠლ) that API
 
       if result.status_code && result.status_code.start_with?('4')
-        message = !(result.body.empty?) ? JSON.parse(result.body).fetch('errors').pop.fetch('message') : 'Sendgrid API Error'
-        full_message = "Sendgrid delivery failed with #{result.status_code} #{message}"
-
+        full_message = "Sendgrid delivery failed with #{result.status_code}: #{result.body}"
         settings[:raise_delivery_errors] ? raise(SendgridDeliveryError, full_message) : warn(full_message)
       end
 

data/lib/sendgrid_actionmailer/railtie.rb

@@ -1,7 +1,9 @@
 module SendGridActionMailer
   class Railtie < Rails::Railtie
     initializer 'sendgrid_actionmailer.add_delivery_method', before: 'action_mailer.set_configs' do
-      ActionMailer::Base.add_delivery_method(:sendgrid_actionmailer, SendGridActionMailer::DeliveryMethod)
+      ActiveSupport.on_load(:action_mailer) do
+        ActionMailer::Base.add_delivery_method(:sendgrid_actionmailer, SendGridActionMailer::DeliveryMethod)
+      end
     end
   end
 end

data/lib/sendgrid_actionmailer/version.rb

@@ -1,3 +1,3 @@
 module SendGridActionMailer
-  VERSION = '3.1.1'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/sendgrid-actionmailer.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'mail', '~> 2.7'
-  spec.add_dependency 'sendgrid-ruby', '~> 6.0'
+  spec.add_dependency 'sendgrid-ruby', '~> 6.4'
 
   spec.add_development_dependency 'appraisal', '~> 2.1.0'
   spec.add_development_dependency 'bundler'

data/spec/lib/sendgrid_actionmailer_spec.rb

@@ -40,6 +40,11 @@ module SendGridActionMailer
         expect(m.settings[:api_key]).to eq('ABCDEFG')
       end
 
+      it 'has correct host' do
+        m = DeliveryMethod.new(host: 'example.com')
+        expect(m.settings[:host]).to eq('example.com')
+      end
+
       it 'default raise_delivery_errors' do
         m = DeliveryMethod.new()
         expect(m.settings[:raise_delivery_errors]).to eq(false)
@@ -64,6 +69,11 @@ module SendGridActionMailer
         m = DeliveryMethod.new(perform_send_request: false)
         expect(m.settings[:perform_send_request]).to eq(false)
       end
+
+      it 'sets http_options' do
+        m = DeliveryMethod.new(http_options: {open_timeout: 40})
+        expect(m.settings[:http_options]).to eq({open_timeout: 40})
+      end
     end
 
     describe '#deliver!' do
@@ -106,11 +116,11 @@ module SendGridActionMailer
         end
 
         it 'sets dynamic api_key, but should revert to default settings api_key' do
-          expect(SendGrid::API).to receive(:new).with(api_key: 'key')
+          expect(SendGrid::API).to receive(:new).with(api_key: 'key', http_options: {})
           mailer.deliver!(default)
-          expect(SendGrid::API).to receive(:new).with(api_key: 'test_key')
+          expect(SendGrid::API).to receive(:new).with(api_key: 'test_key', http_options: {})
           mailer.deliver!(mail)
-          expect(SendGrid::API).to receive(:new).with(api_key: 'key')
+          expect(SendGrid::API).to receive(:new).with(api_key: 'key', http_options: {})
           mailer.deliver!(default)
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-actionmailer
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Eddie Zaneski
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -119,9 +119,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile

data/.travis.yml

@@ -1,13 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.7.1
-  - 2.6.5
-  - 2.5.7
-  - 2.4.9
-  - 2.3.8
-before_install:
-  - gem update --system
-  - gem install bundler
-gemfile:
-  - gemfiles/mail_2.7.gemfile