griddler-sendgrid 0.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: be5d9a9db3c7daa2c8becdb06c09410bfeea98e1
-  data.tar.gz: bf3746c3b5e995637e8e54c8e2839ccd281823fb
+SHA256:
+  metadata.gz: d317e0fd7a30052cf0ff5c61a647cdcb6e07bd75955b3c166e20c1f9cd1b0447
+  data.tar.gz: fb6919536c21963cccd1635fcda3af024d1a05a84ecb6bd8289db76b2c7502e5
 SHA512:
-  metadata.gz: 52805795500e3655a05eb660069a094348f767e44940a4182f1ec110b5a0c5793607dbbebcb1ce27d1ce5b6947fbf530327233f2604aa6eabb0dd8cd6a3bd170
-  data.tar.gz: 46432b91937362c31bc53aa4b62609d823bb7812e2f396c4ec38da585dac8d78bb360c699d99de6f799aeb996e8cf8422bc641221b405f38a3e2871b0ffcf816
+  metadata.gz: 68f28a1cd5877623bcb53df9b7971abf68e3b319552166c977f967f08761d948ce91e423666341fd3586114eee56cfcea9b50cdf9974f37aa06b0d39b70388c1
+  data.tar.gz: b78f00363bb1975a2f7519c1af8abc804167ac19982a9daf42de47932fa4c9a3a10e75098c8c197bafdd72f30f0a88a1063b214b56eb4c51351ab4028b9ab839

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## HEAD (unreleased)
+
+## 1.2.0
+
+- Rescue `Mail::AddressList` parse errors ([#34](https://github.com/thoughtbot/griddler-sendgrid/pull/34))
+- Update SendGrid API links ([#32](https://github.com/thoughtbot/griddler-sendgrid/pull/32) and [#33](https://github.com/thoughtbot/griddler-sendgrid/pull/33))
+
+## 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/README.md

@@ -1,10 +1,10 @@
 Griddler::Sendgrid
 ==================
 
-This is an adapter that allows [Griddler](/thoughtbot/griddler) to be used with
+This is an adapter that allows [Griddler](https://github.com/thoughtbot/griddler) to be used with
 [SendGrid's Parse API].
 
-[SendGrid's Parse API]: http://sendgrid.com/docs/API%20Reference/Webhooks/parse.html
+[SendGrid's Parse API]: https://sendgrid.com/docs/for-developers/parsing-email/setting-up-the-inbound-parse-webhook/
 
 Installation
 ------------
@@ -12,7 +12,6 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'griddler'
 gem 'griddler-sendgrid'
 ```
 
@@ -20,16 +19,17 @@ Usage
 -----
 
 * SendGrid has done a [great
-  tutorial](http://blog.sendgrid.com/receiving-email-in-your-rails-app-with-griddler/)
+  tutorial](https://sendgrid.com/blog/receiving-email-in-your-rails-app-with-griddler/)
   on integrating Griddler with your application.
 * And of course, view our own blog post on the subject over at [Giant
   Robots](http://robots.thoughtbot.com/handle-incoming-email-with-griddler).
+* *Note:* Make sure to uncheck the "Spam Check" and "Send Raw" checkboxes on the [Parse Webhook settings page](http://sendgrid.com/developer/reply), otherwise the returned parsed email will have the body stripped out.
 
 More Information
 ----------------
 
 * [SendGrid](http://www.sendgrid.com)
-* [SendGrid Parse API](http://www.sendgrid.com/docs/API Reference/Webhooks/parse.html)
+* [SendGrid Parse API](https://sendgrid.com/docs/for-developers/parsing-email/setting-up-the-inbound-parse-webhook/)
 
 Credits
 -------

data/griddler-sendgrid.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  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

@@ -12,9 +12,16 @@ module Griddler
 
       def normalize_params
         params.merge(
-          to: recipients(:to),
-          cc: recipients(:cc),
+          to: recipients(:to).map(&:format),
+          cc: recipients(:cc).map(&:format),
+          bcc: get_bcc,
           attachments: attachment_files,
+          charsets: charsets,
+          spam_report: {
+            report: params[:spam_report],
+            score: params[:spam_score],
+          }
+
         )
       end
 
@@ -23,17 +30,58 @@ module Griddler
       attr_reader :params
 
       def recipients(key)
-        ( params[key] || '' ).split(',')
+        Mail::AddressList.new(params[key] || '').addresses
+      rescue Mail::Field::IncompleteParseError
+        []
       end
 
-      def attachment_files
-        params.delete('attachment-info')
-        attachment_count = params[:attachments].to_i
+      def get_bcc
+        if bcc = bcc_from_envelope
+          bcc - recipients(:to).map(&:address) - recipients(:cc).map(&:address)
+        else
+          []
+        end
+      end
+
+      def bcc_from_envelope
+        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|
-          params.delete("attachment#{index + 1}".to_sym)
+          extract_file_at(index)
         end
       end
+
+      def attachment_count
+        params[:attachments].to_i
+      end
+
+      def extract_file_at(index)
+        filename = attachment_filename(index)
+
+        params.delete("attachment#{index + 1}".to_sym).tap do |file|
+          if filename.present?
+            file.original_filename = filename
+          end
+        end
+      end
+
+      def attachment_filename(index)
+        attachment_info.fetch("attachment#{index + 1}", {})["filename"]
+      end
+
+      def attachment_info
+        @attachment_info ||= JSON.parse(params.delete("attachment-info") || "{}")
+      end
     end
   end
 end

data/lib/griddler/sendgrid/version.rb

@@ -1,5 +1,5 @@
 module Griddler
   module Sendgrid
-    VERSION = "0.0.1"
+    VERSION = "1.2.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
@@ -23,15 +24,15 @@ describe Griddler::Sendgrid::Adapter, '.normalize_params' do
       attachment2: upload_2,
      'attachment-info' => <<-eojson
         {
-          'attachment2': {
-            'filename': 'photo2.jpg',
-            'name': 'photo2.jpg',
-            'type': 'image/jpeg'
+          "attachment2": {
+            "filename": "photo2.jpg",
+            "name": "photo2.jpg",
+            "type": "image/jpeg"
           },
-          'attachment1': {
-            'filename': 'photo1.jpg',
-            'name': 'photo1.jpg',
-            'type': 'image/jpeg'
+          "attachment1": {
+            "filename": "photo1.jpg",
+            "name": "photo1.jpg",
+            "type": "image/jpeg"
           }
         }
       eojson
@@ -44,6 +45,33 @@ describe Griddler::Sendgrid::Adapter, '.normalize_params' do
     normalized_params.should_not have_key(:attachment_info)
   end
 
+  it "uses sendgrid attachment info for filename" do
+    params = default_params.merge(
+      attachments: "2",
+      attachment1: upload_1,
+      attachment2: upload_2,
+      "attachment-info" => <<-eojson
+        {
+          "attachment2": {
+            "filename": "sendgrid-filename2.jpg",
+            "name": "photo2.jpg",
+            "type": "image/jpeg"
+          },
+          "attachment1": {
+            "filename": "sendgrid-filename1.jpg",
+            "name": "photo1.jpg",
+            "type": "image/jpeg"
+          }
+        }
+      eojson
+    )
+
+    attachments = normalize_params(params)[:attachments]
+
+    attachments.first.original_filename.should eq "sendgrid-filename1.jpg"
+    attachments.second.original_filename.should eq "sendgrid-filename2.jpg"
+  end
+
   it 'has no attachments' do
     params = default_params.merge(attachments: '0')
 
@@ -51,10 +79,15 @@ describe Griddler::Sendgrid::Adapter, '.normalize_params' do
     normalized_params[:attachments].should be_empty
   end
 
-  it 'wraps to in an array' do
+  it 'splits to into an array' do
     normalized_params = normalize_params(default_params)
 
-    normalized_params[:to].should eq [default_params[:to]]
+    normalized_params[:to].should eq [
+      '"Mr Fugushima at Fugu, Inc" <hi@example.com>',
+      'Foo bar <foo@example.com>',
+      '"Eichhörnchen" <squirrel@example.com>',
+      'no-name@example.com',
+    ]
   end
 
   it 'wraps cc in an array' do
@@ -70,12 +103,78 @@ describe Griddler::Sendgrid::Adapter, '.normalize_params' do
     normalized_params[:cc].should eq []
   end
 
+  it 'returns an array even if bcc is an empty string' do
+    params = default_params.merge(envelope: '')
+    normalized_params = normalize_params(params)
+
+    normalized_params[:bcc].should eq []
+  end
+
+  it 'wraps bcc in an array' do
+    normalized_params = normalize_params(default_params)
+
+    normalized_params[:bcc].should eq ["johny@example.com"]
+  end
+
+  it 'returns an array even if bcc is empty' do
+    params = default_params.merge(envelope: nil)
+    normalized_params = normalize_params(params)
+
+    normalized_params[:bcc].should eq []
+  end
+
+  it 'returns an empty array when the envelope to is the same as the base to' do
+    params = default_params.merge(envelope: "{\"to\":[\"hi@example.com\"]}")
+    normalized_params = normalize_params(params)
+
+    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 'does not explode if address is not parseable' do
+    params = default_params.merge(cc: '"Closing Bracket Missing For Some Reason" <hi@example.com')
+
+    normalize_params(params)[:cc].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',
-      to: 'hi@example.com',
+      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\"]}",
+      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

data/spec/spec_helper.rb

@@ -3,8 +3,10 @@ require 'griddler/sendgrid'
 require 'action_dispatch'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.order = 'random'
   config.include Griddler::Testing
+  config.expect_with(:rspec) do |c|
+    c.syntax = [:should, :expect]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: griddler-sendgrid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Caleb Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2019-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,30 +28,44 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: griddler
   requirement: !ruby/object:Gem::Requirement
     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.2.2
+rubygems_version: 2.7.6.2
 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