griddler-sendgrid 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b568d22d80b71487ec2d7b13f4c454ce5795908
-  data.tar.gz: a7891f96d709940be229de73879869907a537a03
+SHA256:
+  metadata.gz: 65ae6c3ebf35cf02589f969037d6d460e1081283d0cf12eaef22870a5ac2578e
+  data.tar.gz: c3d1e54b5de5a4ddb9e2d37f44e78f80d32e25a7e2ce3ef0e6da24a302b8b793
 SHA512:
-  metadata.gz: 6250647638cd35e7c6cb4d4c2ad3268599f0ac2c8a0e5964bdf222b9085f9727f0368ffb47833bf8800b2232d87925881a99d575e44b98cfee5a8339beb27405
-  data.tar.gz: 5826f196ea5320f164c3a693f3795705e1748bddea5d64a1c5c67553b00fbc4b902fd24f39cad8ef7b8ad327383bc7075a2a45c0a75617178ee504f09c94fbd1
+  metadata.gz: 1989291c64a64e26680b7d0f0c1062405acc1e83046e00c62c62c372d1999a3710af0c0b2322de322d3ef4f1b232e49e42edc4a2dab015e0f16b28fa9b4d0ded
+  data.tar.gz: 467cefd0678c4f72db660121594da6d658f7885dd7273e59ec5f268513d5b28c0c604915d32dda867854d45ff216d6b0e9510c4db84aeb39fc379508d78aa20b

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## HEAD (unreleased)
+
+## 1.1.0
+* Expose charsets as Hash in normalized params ([#29](https://github.com/thoughtbot/griddler-sendgrid/pull/29/))
+* Add support for Sendgrid spam check ([#30](https://github.com/thoughtbot/griddler-sendgrid/pull/30))
+* Set minimum version of `mail` to be `2.7.0` so that UTF-8 encoded emails continue to work properly

data/griddler-sendgrid.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.5'
 
-  spec.add_dependency 'griddler'
+  spec.add_dependency 'griddler', '>= 1.5.2'
+  spec.add_dependency 'mail', '>= 2.7.0'
 end

data/lib/griddler/sendgrid/adapter.rb

@@ -16,6 +16,12 @@ module Griddler
           cc: recipients(:cc).map(&:format),
           bcc: get_bcc,
           attachments: attachment_files,
+          charsets: charsets,
+          spam_report: {
+            report: params[:spam_report],
+            score: params[:spam_score],
+          }
+
         )
       end
 
@@ -24,8 +30,7 @@ module Griddler
       attr_reader :params
 
       def recipients(key)
-        encoded = Mail::Encodings.address_encode(params[key] || '')
-        Mail::AddressList.new(encoded).addresses
+        Mail::AddressList.new(params[key] || '').addresses
       end
 
       def get_bcc
@@ -40,6 +45,14 @@ module Griddler
         JSON.parse(params[:envelope])["to"] if params[:envelope].present?
       end
 
+      def charsets
+        return {} unless params[:charsets].present?
+        JSON.parse(params[:charsets]).symbolize_keys
+      rescue JSON::ParserError
+        {}
+      end
+
+
       def attachment_files
         attachment_count.times.map do |index|
           extract_file_at(index)

data/lib/griddler/sendgrid/version.rb

@@ -1,5 +1,5 @@
 module Griddler
   module Sendgrid
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/spec/griddler/sendgrid/adapter_spec.rb

@@ -14,6 +14,7 @@ describe Griddler::Sendgrid::Adapter, '.normalize_params' do
       to: 'Hello World <hi@example.com>',
       cc: 'emily@example.com',
       from: 'There <there@example.com>',
+      charsets: { to: 'UTF-8', text: 'iso-8859-1' }.to_json
     }
 
   it 'changes attachments to an array of files' do
@@ -129,6 +130,35 @@ describe Griddler::Sendgrid::Adapter, '.normalize_params' do
     normalized_params[:bcc].should eq []
   end
 
+  it 'returns the charsets as a hash' do
+    normalized_params = normalize_params(default_params)
+    charsets = normalized_params[:charsets]
+
+    charsets.should be_present
+    charsets[:text].should eq 'iso-8859-1'
+    charsets[:to].should eq 'UTF-8'
+  end
+
+  it 'does not explode if charsets is not JSON-able' do
+    params = default_params.merge(charsets: 'This is not JSON')
+
+    normalize_params(params)[:charsets].should eq({})
+  end
+
+  it 'defaults charsets to an empty hash if it is not specified in params' do
+    params = default_params.except(:charsets)
+    normalize_params(params)[:charsets].should eq({})
+  end
+
+  it 'normalizes the spam report into a griddler friendly format' do
+    normalized_params = normalize_params(default_params)
+
+    normalized_params[:spam_report].should eq({
+      score: '1.234',
+      report: 'Some spam report',
+    })
+  end
+
   def default_params
     {
       text: 'hi',
@@ -136,6 +166,9 @@ describe Griddler::Sendgrid::Adapter, '.normalize_params' do
       cc: 'cc@example.com',
       from: 'there@example.com',
       envelope: "{\"to\":[\"johny@example.com\"], \"from\": [\"there@example.com\"]}",
+      charsets: { to: 'UTF-8', text: 'iso-8859-1' }.to_json,
+      spam_score: '1.234',
+      spam_report: 'Some spam report'
     }
   end
 end

data/spec/integration/email_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Griddler::Email, '#to_h' do
+  it 'accepts normalized params from Griddler::Sendgrid::Adapter' do
+    normalized_params = Griddler::Sendgrid::Adapter.normalize_params(default_params)
+    email = Griddler::Email.new(normalized_params)
+
+    email_properties = email.to_h
+
+    expect(email_properties[:subject]).to eq 'Some subject'
+    expect(email_properties[:spam_score]).to eq '1.234'
+  end
+
+  def default_params
+    {
+      subject: 'Some subject',
+      text: 'hi',
+      to: '"Mr Fugushima at Fugu, Inc" <hi@example.com>, Foo bar <foo@example.com>, Eichhörnchen <squirrel@example.com>, <no-name@example.com>',
+      cc: 'cc@example.com',
+      from: 'there@example.com',
+      envelope: "{\"to\":[\"johny@example.com\"], \"from\": [\"there@example.com\"]}",
+      spam_score: '1.234',
+      spam_report: 'Some spam report',
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: griddler-sendgrid
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Caleb Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
 description: Adapter to allow the use of SendGrid Parse API with Griddler
 email:
 - caleb@calebthompson.io
@@ -61,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -72,6 +87,7 @@ files:
 - spec/fixtures/photo1.jpg
 - spec/fixtures/photo2.jpg
 - spec/griddler/sendgrid/adapter_spec.rb
+- spec/integration/email_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/thoughtbot/griddler
 licenses:
@@ -93,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: SendGrid adapter for Griddler
@@ -101,4 +117,5 @@ test_files:
 - spec/fixtures/photo1.jpg
 - spec/fixtures/photo2.jpg
 - spec/griddler/sendgrid/adapter_spec.rb
+- spec/integration/email_spec.rb
 - spec/spec_helper.rb