griddler-cloudmailin 0.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: fedb235f9299777b382940abbebbdecb9ef76f48
-  data.tar.gz: 10cd44cd4cc53fd480d48df5dc49a562a21fe676
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yjk1MmZiNTExNTBjZTQwNTdhOWEzYzU3NGI5ZDMwYWJkZDI1Yzk0OA==
+  data.tar.gz: !binary |-
+    MGRjZjRmY2MyMTY1MGEzNDYzZWQyYTJiZTM1MDk4ZmZjOGM1OTc2OA==
 SHA512:
-  metadata.gz: 346ae7e46d5fcbec5a80da8a01acbf9acace8d883103b45b4550f8228cf8c5951c886565c4f2fa034a00fd89553bf80a00e38811998644656a1e04d2b735dd79
-  data.tar.gz: a2e66410901a3c7056a0e692a2d7fe821a7e2a59b08fc490940d993ec7631883b1651db592c23dda197b9f9d853da1205a496cbaead507c8ec8036fce1bbec11
+  metadata.gz: !binary |-
+    YTBiNDBiNTljNGRkY2EyNTUwNGFhMjhkOTI1NjMwMDE2ZTlhMWQ4YTM2NTZh
+    NTUxMTI4NDgzMDZjNmRmOTFiMzhkYTQ3OTMwNzUxZTAyZjgwYmMyZmVlNTM5
+    ZjU1YjFmMGJiOWQyMTZiYmVkODQ4YTdhYTcwYWJkZDVhMTgzMjc=
+  data.tar.gz: !binary |-
+    NjM5MzRlMjY4ZmZlZjhhNDM5M2NjNzM0M2E2Yzc5MWFkNWFlYjgwZWI1ZDBj
+    ZWEwMDNmY2M3NmY1ODFhMWViNTQ5NjhlM2M3OGU0YTMzYTAxZjk4MDExMDk5
+    MzEyNzNkMGY0NmZiODViOTVlMjY5M2NmYTAwMzA4ZTYyNTc4MDA=

data/.gitignore

@@ -1,3 +1,6 @@
+.ruby-gemset
+.ruby-version
+.rspec
 *.gem
 *.rbc
 .bundle

data/.hound.yml

@@ -0,0 +1,4 @@
+---
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,53 @@
+---
+AllCops:
+  TargetRubyVersion: 1.9
+  DisplayCopNames: true
+  Exclude:
+    - 'tmp/**/*'
+
+Metrics/BlockLength:
+  CountComments: false  # count full line comments?
+  Exclude:
+    - '**/*_spec.rb'
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+  Enabled: true
+
+DotPosition:
+  Description: 'Checks the position of the dot in multi-line method calls.'
+  EnforcedStyle: leading
+  Enabled: true
+
+ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  EnforcedStyle: nested
+  Enabled: true
+
+Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+FileName:
+  Description: 'Use snake_case for source file names.'
+  Enabled: true
+
+LineLength:
+  Max: 120
+  Enabled: true
+
+Style/ExtraSpacing:
+  Description: 'Do not use unnecessary spacing.'
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Description: 'Avoid interpolating literals in strings'
+  AutoCorrect: true
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: no_comma
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+dist: trusty
+rvm:
+  - 2.4.0
+  - 2.3
+  - 2.2
+  - 1.9
+  - jruby
+
+before_install:
+  - gem update bundler
+
+script: bundle exec rspec

data/Gemfile

@@ -1,5 +1,22 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "griddler", github: "thoughtbot/griddler"
+gem 'griddler', github: 'thoughtbot/griddler' # So as to include the spec folder
+gem 'nokogiri', (RUBY_VERSION < '2' ? '< 1.7' : '> 0') # Nokogiri >= 1.7 requires Ruby 2+
 
 gemspec
+
+group :development do
+  gem 'bundler'
+  gem 'gem-release'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+end
+
+group :test do
+  gem 'coveralls'
+  gem 'fuubar'
+  gem 'rspec'
+  gem 'rspec_junit_formatter'
+  gem 'simplecov', '~> 0.13'
+end

data/LICENSE.txt

@@ -1,5 +1,4 @@
-Copyright (c) 2014
-Portions copyright (c) 2014 Caleb Thompson, Joel Oliveira and thoughtbot, inc.
+Copyright (c) 2017 Dominic Sayers and Caleb Thompson
 
 MIT License
 

data/README.md

@@ -1,4 +1,11 @@
 # Griddler::Cloudmailin
+[![Gem Version](https://badge.fury.io/rb/griddler-cloudmailin.svg)](https://rubygems.org/gems/griddler-cloudmailin)
+[![Gem downloads](https://img.shields.io/gem/dt/griddler-cloudmailin.svg)](https://rubygems.org/gems/griddler-cloudmailin)
+[![Code quality](http://img.shields.io/codeclimate/github/thoughtbot/griddler-cloudmailin.svg?style=flat)](https://codeclimate.com/github/thoughtbot/griddler-cloudmailin)
+[![Dependency Status](https://gemnasium.com/badges/github.com/thoughtbot/griddler-cloudmailin.svg)](https://gemnasium.com/github.com/thoughtbot/griddler-cloudmailin)
+[![Security](https://hakiri.io/github/thoughtbot/griddler-cloudmailin/master.svg)](https://hakiri.io/github/thoughtbot/griddler-cloudmailin/master)
+[![Build status](https://img.shields.io/travis/thoughtbot/griddler-cloudmailin/master.svg)](https://travis-ci.org/thoughtbot/griddler-cloudmailin)
+[![Coverage Status](https://coveralls.io/repos/github/thoughtbot/griddler-cloudmailin/badge.svg?branch=master)](https://coveralls.io/github/thoughtbot/griddler-cloudmailin?branch=master)
 
 An adapter for [Griddler](https://github.com/thoughtbot/griddler) to allow
 [Cloudmailin](http://cloudmailin.com) to be used with the gem.
@@ -8,14 +15,25 @@ An adapter for [Griddler](https://github.com/thoughtbot/griddler) to allow
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'griddler'
 gem 'griddler-cloudmailin'
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+See the [Griddler](https://github.com/thoughtbot/griddler) gem for usage instructions
+
+## Upgrading from version 0.0.1
+
+Griddler::Cloudmailin now includes all details of the recipients of the email in the `to` array of a `Griddler::Email`
+object. In version 0.0.1 this method returned the bare address of the Cloudmailin recipient only.
+
+The email `date` is now returned as well.
+
+There is an additional `bcc` array which contains the Cloudmailin recipient if it was BCCed on the email.
+
+Attachments are now returned in the `attachments` array.
 
 ## More Information
 
-* [Cloudmailin Docs](http://docs.cloudmailin.com/)
+* [Griddler](https://github.com/thoughtbot/griddler)
+* [Cloudmailin documentation](http://docs.cloudmailin.com/)

data/Rakefile

@@ -1,2 +1 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'

data/griddler-cloudmailin.gemspec

@@ -4,23 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'griddler/cloudmailin/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "griddler-cloudmailin"
+  spec.name          = 'griddler-cloudmailin'
   spec.version       = Griddler::Cloudmailin::VERSION
-  spec.authors       = ["calebthompson"]
-  spec.email         = ["caleb@calebthompson.io"]
-  spec.summary       = %q{Griddler Cloudmailin}
-  spec.description   = %q{Griddler Cloudmailin}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Dominic Sayers & Caleb Thompson']
+  spec.email         = ['dominic@sayers.cc']
+  spec.summary       = 'Griddler Plugin for cloudmailin'
+  spec.description   = 'Griddler Plugin for cloudmailin email parsing service'
+  spec.homepage      = 'https://github.com/thoughtbot/griddler-cloudmailin'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features|coverage)\/})
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-
-  spec.add_dependency "griddler"
+  spec.add_dependency 'griddler'
 end

data/lib/griddler/cloudmailin.rb

@@ -1,5 +1,5 @@
-require "griddler"
-require "griddler/cloudmailin/version"
-require "griddler/cloudmailin/adapter"
+require 'griddler'
+require 'griddler/cloudmailin/version'
+require 'griddler/cloudmailin/adapter'
 
 Griddler.adapter_registry.register(:cloudmailin, Griddler::Cloudmailin::Adapter)

data/lib/griddler/cloudmailin/adapter.rb

@@ -1,35 +1,76 @@
-require 'active_support/core_ext/string/strip'
-
 module Griddler
   module Cloudmailin
     class Adapter
-      def initialize(params)
-        @params = params
-      end
-
       def self.normalize_params(params)
         adapter = new(params)
         adapter.normalize_params
       end
 
       def normalize_params
-        {
-          to: params[:envelope][:to].split(','),
-          cc: ccs,
-          from: params[:envelope][:from],
-          subject: params[:headers][:Subject],
-          text: params[:plain],
-          attachments: params.fetch(:attachments) { [] },
-        }
+        normalized_params = base_params
+        normalized_params[:bcc] = bcc unless bcc.empty?
+        normalized_params
+      end
+
+      def legacy?
+        @legacy ||= headers.key? :From
       end
 
       private
 
       attr_reader :params
 
+      def initialize(params)
+        @params = params
+      end
+
+      def recipients(field)
+        headers[field].to_s.split(',').map(&:strip)
+      end
+
       def ccs
-        params[:headers][:Cc].to_s.split(',').map(&:strip)
+        @ccs ||= recipients(header_keys[:cc])
+      end
+
+      def tos
+        @tos ||= recipients(header_keys[:to])
+      end
+
+      def envelope_to
+        @envelope_to ||= params[:envelope][:to]
+      end
+
+      def header_emails
+        @header_emails ||= (tos | ccs).map { |addressee| Griddler::EmailParser.parse_address(addressee)[:email] }
+      end
+
+      def bcc
+        @bcc ||= header_emails.include?(envelope_to) ? [] : [envelope_to]
+      end
+
+      def headers
+        @headers ||= params[:headers]
       end
+
+      def base_params # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        @base_params ||= {
+          to: tos,
+          cc: ccs,
+          from: headers[header_keys[:from]],
+          date: headers[header_keys[:date]].try(:to_datetime),
+          subject: headers[header_keys[:subject]],
+          text: params[:plain],
+          html: params[:html],
+          attachments: params.fetch(:attachments) { {} }.values,
+          headers: headers
+        }
+      end
+
+      def header_keys
+        @header_keys ||= Hash[legacy? ? KEY_LIST.map { |s| [s, s.capitalize] } : KEY_LIST.map { |s| [s, s] }]
+      end
+
+      KEY_LIST = [:from, :to, :cc, :date, :subject].freeze
     end
   end
 end

data/lib/griddler/cloudmailin/version.rb

@@ -1,5 +1,5 @@
 module Griddler
   module Cloudmailin
-    VERSION = "0.0.1"
+    VERSION = '1.1.0'.freeze
   end
 end

data/spec/griddler/cloudmailin/adapter_spec.rb

@@ -1,50 +1,165 @@
 require 'spec_helper'
 
+describe Griddler::Cloudmailin::Adapter do
+  it 'registers itself with griddler' do
+    expect(Griddler.adapter_registry[:cloudmailin]).to be(
+      Griddler::Cloudmailin::Adapter
+    )
+  end
+end
+
 describe Griddler::Cloudmailin::Adapter, '.normalize_params' do
-  it_should_behave_like 'Griddler adapter', :cloudmailin, {
-    envelope: {
-      to: 'Hello World <hi@example.com>',
-      from: 'There <there@example.com>',
-    },
-    plain: 'hi',
-    headers: { Cc: 'emily@example.com' },
-  }
+  context 'without bcc' do
+    it_should_behave_like(
+      'Griddler adapter',
+      :cloudmailin,
+      envelope: {
+        to: 'hi@example.com',
+        from: 'there@example.com'
+      },
+      plain: 'hi',
+      headers: {
+        From: 'there@example.com',
+        To: 'Hello World <hi@example.com>',
+        Cc: 'emily@example.com'
+      }
+    )
+  end
+
+  context 'with bcc' do
+    it_should_behave_like(
+      'Griddler adapter',
+      :cloudmailin,
+      envelope: {
+        to: 'sandra@example.com',
+        from: 'there@example.com'
+      },
+      plain: 'hi',
+      headers: {
+        From: 'there@example.com',
+        To: 'Hello World <hi@example.com>',
+        Cc: 'emily@example.com'
+      }
+    )
+  end
 
   it 'normalizes parameters' do
-    expect(Griddler::Cloudmailin::Adapter.normalize_params(default_params)).to be_normalized_to({
+    expect(normalized).to be_normalized_to(
+      to: ['Some Identifier <some-identifier@example.com>'],
+      cc: ['emily@example.com'],
+      from: 'Joe User <joeuser@example.com>',
+      subject: 'Re: [ThisApp] That thing',
+      text: /Dear bob/
+    )
+  end
+
+  it 'normalizes parameters where the recipient has been BCCed' do
+    expect(normalized(bcc_params)).to be_normalized_to(
       to: ['Some Identifier <some-identifier@example.com>'],
       cc: ['emily@example.com'],
+      bcc: ['sandra@example.com'],
       from: 'Joe User <joeuser@example.com>',
       subject: 'Re: [ThisApp] That thing',
       text: /Dear bob/
-    })
+    )
   end
 
-  it 'passes the received array of files' do
-    params = default_params.merge({ attachments: [upload_1, upload_2] })
+  it 'normalizes parameters where the recipient has been CCed' do
+    expect(normalized(cc_params)).to be_normalized_to(
+      cc: ['Some Identifier <some-identifier@example.com>'],
+      to: ['emily@example.com'],
+      from: 'Joe User <joeuser@example.com>',
+      subject: 'Re: [ThisApp] That thing',
+      text: /Dear bob/
+    )
+  end
+
+  it 'changes attachments to an array of files' do
+    params = BASE_PARAMS.merge(attachments: { '0' => upload_1, '1' => upload_2 })
 
-    normalized_params = Griddler::Cloudmailin::Adapter.normalize_params(params)
-    expect(normalized_params[:attachments]).to eq [upload_1, upload_2]
+    normalized_params = normalized(params)
+    expect(normalized_params[:attachments]).to include(upload_1, upload_2)
+    expect(normalized_params[:attachments]).not_to include('0')
+    expect(normalized_params[:attachments]).not_to include('1')
   end
 
   it 'has no attachments' do
-    params = default_params
+    expect(normalized[:attachments]).to be_empty
+  end
 
-    normalized_params = Griddler::Cloudmailin::Adapter.normalize_params(params)
-    expect(normalized_params[:attachments]).to be_empty
+  it 'wraps to in an array' do
+    expect(normalized[:to]).to eq([BASE_PARAMS[:headers][:to]])
   end
 
-  def default_params
-    {
-      envelope: { to: 'Some Identifier <some-identifier@example.com>', from: 'Joe User <joeuser@example.com>' },
-      headers: { Subject: 'Re: [ThisApp] That thing', Cc: 'emily@example.com' },
-      plain: <<-EOS.strip_heredoc.strip
-        Dear bob
+  it 'wraps cc in an array' do
+    expect(normalized[:cc]).to eq([BASE_PARAMS[:headers][:cc]])
+  end
 
-        Reply ABOVE THIS LINE
+  it 'returns the date' do
+    expect(normalized[:date]).to eq(BASE_PARAMS[:headers][:date].to_datetime)
+  end
+
+  it 'returns an array even if cc is empty' do
+    expect(normalized(nocc_params)[:cc]).to eq([])
+  end
+
+  it 'detects which format of params is in use' do
+    expect(Griddler::Cloudmailin::Adapter.new(BASE_PARAMS).legacy?).to be_falsey
+    expect(Griddler::Cloudmailin::Adapter.new(BASE_PARAMS_LEGACY).legacy?).to be_truthy
+  end
+
+  def normalized(params = BASE_PARAMS)
+    Griddler::Cloudmailin::Adapter.normalize_params(params)
+  end
+
+  def bcc_params
+    BASE_PARAMS.merge(
+      envelope: BASE_PARAMS[:envelope].merge(to: 'sandra@example.com')
+    )
+  end
+
+  def nocc_params
+    BASE_PARAMS.merge(
+      headers: BASE_PARAMS[:headers].except(:cc)
+    )
+  end
 
-        hey sup
-      EOS
-    }
+  def cc_params
+    BASE_PARAMS.merge(
+      headers: BASE_PARAMS[:headers].merge(
+        cc: 'Some Identifier <some-identifier@example.com>',
+        to: 'emily@example.com'
+      )
+    )
   end
+
+  BASE_PARAMS = {
+    envelope: {
+      to: 'some-identifier@example.com',
+      from: 'joeuser@example.com'
+    },
+    headers: {
+      subject: 'Re: [ThisApp] That thing',
+      from: 'Joe User <joeuser@example.com>',
+      to: 'Some Identifier <some-identifier@example.com>',
+      cc: 'emily@example.com',
+      date: 'Fri, 30 Sep 2016 10:30:15 +0200'
+    },
+    plain: "Dear bob\n\nReply ABOVE THIS LINE\n\nhey sup"
+  }.freeze
+
+  BASE_PARAMS_LEGACY = {
+    envelope: {
+      to: 'some-identifier@example.com',
+      from: 'joeuser@example.com'
+    },
+    headers: {
+      Subject: 'Re: [ThisApp] That thing',
+      From: 'Joe User <joeuser@example.com>',
+      To: 'Some Identifier <some-identifier@example.com>',
+      Cc: 'emily@example.com',
+      Date: 'Fri, 30 Sep 2016 10:30:15 +0200'
+    },
+    plain: "Dear bob\n\nReply ABOVE THIS LINE\n\nhey sup"
+  }.freeze
 end

data/spec/spec_helper.rb

@@ -1,3 +1,11 @@
+unless ENV['NO_SIMPLECOV']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.start { add_filter '/spec/' }
+  Coveralls.wear! if ENV['COVERALLS_REPO_TOKEN']
+end
+
 require 'griddler/testing'
 require 'griddler/cloudmailin'
 

metadata

@@ -1,79 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: griddler-cloudmailin
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.1.0
 platform: ruby
 authors:
-- calebthompson
+- Dominic Sayers & Caleb Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !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: rspec
-  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: griddler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Griddler Cloudmailin
+description: Griddler Plugin for cloudmailin email parsing service
 email:
-- caleb@calebthompson.io
+- dominic@sayers.cc
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .hound.yml
+- .rubocop.yml
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,7 +45,7 @@ files:
 - lib/griddler/cloudmailin/version.rb
 - spec/griddler/cloudmailin/adapter_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/thoughtbot/griddler-cloudmailin
 licenses:
 - MIT
 metadata: {}
@@ -94,20 +55,20 @@ 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.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Griddler Cloudmailin
+summary: Griddler Plugin for cloudmailin
 test_files:
 - spec/griddler/cloudmailin/adapter_spec.rb
 - spec/spec_helper.rb