postmark_customized 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 139d25036ac960c70d9fb78205bfc0f9c3fba36c1d742d50b3b3b21ad349f9d7
+  data.tar.gz: f63d6adadd4d8501329829eba748190dce5c7e0e668fc46842cf2b162da299bd
+SHA512:
+  metadata.gz: d5829229fde461c6576b3ec29d8b835c87dcc8b64b588ce972e6e20c7bb8818b35f8d76a4a5c3b761b964b17ec73cb241ef77546134e0bb3c7b81a6b71fe4da3
+  data.tar.gz: a00a808798eee7bdfee25cec4b1c15a5c6ebbdbe6b0aab3e0ca00c07a8500293be43d16fade53c63cb6f10885d7efb3f4d1d221019c263c6a67f7a64ebbe7dd3

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'griddler', github: 'thoughtbot/griddler'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Vladyslav Sydorenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Griddler::PostmarkCustomized
+
+Customized adapter for [Postmark](http://developer.postmarkapp.com/developer-inbound-parse.html) to use with [Griddler](https://github.com/thoughtbot/griddler)
+
+Original gem - [griddler-postmark](https://github.com/r38y/griddler-postmark)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'griddler'
+gem 'postmark_customized'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postmark_customized
+
+## Usage
+
+Create an initializer with the following settings:
+
+```ruby
+Griddler.configure do |config|
+  config.email_service = :postmark_customized
+end
+```
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "postmark_customized"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/griddler/postmark_customized.rb

@@ -0,0 +1,5 @@
+require "griddler"
+require "griddler/postmark_customized/version"
+require "griddler/postmark_customized/adapter"
+
+Griddler.adapter_registry.register(:postmark_customized, Griddler::PostmarkCustomized::Adapter)

data/lib/griddler/postmark_customized/adapter.rb

@@ -0,0 +1,87 @@
+require 'active_support/core_ext/string/strip'
+
+module Griddler
+  module PostmarkCustomized
+    class Adapter
+      def initialize(params)
+        @params = params
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        {
+          from: full_email(params[:FromFull]),
+          to_email: params[:To],
+          from_email: params[:From],
+          to: extract_recipients(:ToFull),
+          cc: extract_recipients(:CcFull),
+          bcc: extract_recipients(:BccFull),
+          headers: headers,
+          subject: params[:Subject],
+          text: params[:TextBody],
+          html: params[:HtmlBody],
+          original_recipient: params[:OriginalRecipient],
+          reply_to: params[:ReplyTo],
+          mailbox_hash: params[:MailboxHash],
+          attachments: attachment_files
+        }
+      end
+
+      private
+
+      attr_reader :params
+
+      def headers
+        Array(@params[:Headers]).inject({}) do |hash, header|
+          hash[header[:Name]] = header[:Value]
+          hash
+        end
+      end
+
+      def extract_recipients(key)
+        params[key].to_a.map { |recipient| full_email(recipient) }
+      end
+
+      def full_email(contact_info)
+        email = contact_info[:Email]
+        if contact_info[:Name].present?
+          "#{contact_info[:Name]} <#{email}>"
+        else
+          email
+        end
+      end
+
+      def attachment_files
+        attachments = Array(params[:Attachments])
+
+        attachments.map do |attachment|
+          ActionDispatch::Http::UploadedFile.new(
+            filename: attachment[:Name],
+            type: attachment[:ContentType],
+            tempfile: create_tempfile(attachment)
+          )
+        end
+      end
+
+      def create_tempfile(attachment)
+        filename = attachment[:Name].gsub(/\/|\\/, '_')[0..150]
+        tempfile = Tempfile.new(filename, Dir::tmpdir, encoding: 'ascii-8bit')
+        tempfile.write(content(attachment))
+        tempfile.rewind
+        tempfile
+      end
+
+      def content(attachment)
+        if content = attachment[:Content]
+          Base64.decode64(content)
+        else
+          content
+        end
+      end
+    end
+  end
+end

data/lib/griddler/postmark_customized/version.rb

@@ -0,0 +1,5 @@
+module Griddler
+  module PostmarkCustomized
+    VERSION = "0.1.0"
+  end
+end

data/postmark_customized.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "griddler/postmark_customized/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "postmark_customized"
+  spec.version       = Griddler::PostmarkCustomized::VERSION
+  spec.authors       = ["Vladyslav Sydorenko"]
+  spec.email         = ["svuitis@gmail.com"]
+
+  spec.summary       = %q{Customized Postmark adapter for Griddler}
+  spec.description   = %q{Allows to accept MailboxHash from Postmark response}
+  spec.homepage      = "https://github.com/Equitis90/postmark_customized"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "griddler"
+end

data/spec/griddler/postmark_customized/adapter_spec.rb

@@ -0,0 +1,195 @@
+require 'spec_helper'
+
+describe Griddler::PostmarkCustomized::Adapter, '.normalize_params' do
+  it_should_behave_like 'Griddler adapter', :postmark_customized,
+    {
+      FromFull: {
+        Email: 'there@example.com',
+        Name: 'There',
+      },
+      ToFull: [{
+                 Email: 'hi@example.com',
+                 Name: 'Hello World',
+               }],
+      CcFull: [{
+                 Email: 'emily@example.com',
+                 Name: '',
+               }],
+      BccFull: [{
+                  Email: 'mary@example.com',
+                  Name: 'Mary',
+                }],
+      TextBody: 'hi',
+      MailboxHash: '1234'
+    }
+
+  it 'normalizes parameters' do
+    expect(Griddler::PostmarkCustomized::Adapter.normalize_params(default_params)).to be_normalized_to({
+      to: ["Robert Paulson <bob@example.com>"],
+      cc: ["Jack <jack@example.com>"],
+      bcc: ["Mary <mary@example.com>"],
+      original_recipient: "dick@example.com",
+      reply_to: "john@example.com",
+      from: "Tyler Durden <tdurden@example.com>",
+      subject: 'Reminder: First and Second Rule',
+      text: %r{Dear bob\nReply ABOVE THIS LINE\nhey sup},
+      html: /<p>Dear bob<\/p>\nReply ABOVE THIS LINE\nhey sup/,
+      headers: {
+        "Message-ID" => "<message-id@mail.gmail.com>"
+      },
+      mailbox_hash: '1234'
+    })
+  end
+
+  it 'handles CcFull of nil' do
+    no_cc_params = default_params
+    no_cc_params[:CcFull] = nil
+    normalized = Griddler::PostmarkCustomized::Adapter.normalize_params(no_cc_params)
+
+    expect(normalized[:cc]).to eq []
+  end
+
+  it 'passes the received array of files' do
+    params = default_params.merge({ Attachments: [upload_1_params, upload_2_params] })
+
+    normalized_params = Griddler::PostmarkCustomized::Adapter.normalize_params(params)
+
+    first, second = *normalized_params[:attachments]
+
+    expect(first.original_filename).to eq('photo1.jpg')
+    expect(first.content_type).to eq(upload_1_params[:ContentType])
+
+    expect(second.original_filename).to eq('photo2.jpg')
+    expect(second.content_type).to eq(upload_2_params[:ContentType])
+  end
+
+  it 'has no attachments' do
+    params = default_params
+
+    normalized_params = Griddler::PostmarkCustomized::Adapter.normalize_params(params)
+
+    expect(normalized_params[:attachments]).to be_empty
+  end
+
+  it 'gets rid of the original postmark params' do
+    expect(Griddler::PostmarkCustomized::Adapter.normalize_params(default_params)).to be_normalized_to({
+      To: nil,
+      From: nil,
+      ToFull: nil,
+      FromFull: nil,
+      CcFull: nil,
+      Subject:  nil,
+      TextBody: nil,
+      HtmlBody: nil,
+      Attachments: nil,
+      MailboxHash: nil
+    })
+  end
+
+  it 'can handle a blank attachment content' do
+  params = default_params.merge({
+      Attachments: [
+        {
+          Name: "empty.gif",
+        }
+      ]
+    })
+    expect {
+      Griddler::PostmarkCustomized::Adapter.normalize_params(params)
+    }.to_not raise_error
+  end
+
+  it 'can handle a really long name' do
+    params = default_params.merge({
+                                    Attachments: [
+                                      {
+                                        Name: ("x"*500),
+                                      }
+                                    ]
+                                  })
+    expect {
+      Griddler::PostmarkCustomized::Adapter.normalize_params(params)
+    }.to_not raise_error
+  end
+
+  def default_params
+    {
+      To: 'bob@example.com',
+      From: 'tdurden@example.com',
+      FromFull: {
+        Email: 'tdurden@example.com',
+        Name: 'Tyler Durden'
+      },
+      ToFull: [{
+                 Email: 'bob@example.com',
+                 Name: 'Robert Paulson'
+               }],
+      CcFull: [{
+                 Email: 'jack@example.com',
+                 Name: 'Jack'
+               }],
+      BccFull: [{
+                  Email: 'mary@example.com',
+                  Name: 'Mary',
+                }],
+      OriginalRecipient: "dick@example.com",
+      ReplyTo: "john@example.com",
+      Subject: 'Reminder: First and Second Rule',
+      TextBody: text_body,
+      HtmlBody: text_html,
+      Headers: [
+        {
+          Name: "Message-ID",
+          Value: "<message-id@mail.gmail.com>"
+        }
+      ],
+      MailboxHash: '1234'
+    }
+  end
+
+  def text_body
+    <<-EOS.strip_heredoc.strip
+      Dear bob
+      Reply ABOVE THIS LINE
+      hey sup
+    EOS
+  end
+
+  def text_html
+    <<-EOS.strip_heredoc.strip
+      <p>Dear bob</p>
+      Reply ABOVE THIS LINE
+      hey sup
+    EOS
+  end
+
+  def upload_1_params
+    @upload_1_params ||= begin
+                           file = fixture_file('photo1.jpg')
+                           {
+                             Name: 'photo1.jpg',
+                             Content: Base64.encode64(file.read),
+                             ContentType: 'image/jpeg',
+                             ContentLength: file.size,
+                             ContentID: "photo1.jpg@01D2DF9B.C09E7220"
+                           }
+                         end
+  end
+
+  def upload_2_params
+    @upload_2_params ||= begin
+                           file = fixture_file('photo2.jpg')
+                           {
+                             Name: 'photo2.jpg',
+                             Content: Base64.encode64(file.read),
+                             ContentType: 'image/jpeg',
+                             ContentLength: file.size
+                           }
+                         end
+  end
+
+  def fixture_file(name)
+    cwd = File.expand_path File.dirname(__FILE__)
+    File.new(File.join(cwd, '..', '..', 'fixtures', name))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'griddler/testing'
+require 'griddler/postmark_customized'
+require 'action_dispatch'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+  config.include Griddler::Testing
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: postmark_customized
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladyslav Sydorenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: Allows to accept MailboxHash from Postmark response
+email:
+- svuitis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/griddler/postmark_customized.rb
+- lib/griddler/postmark_customized/adapter.rb
+- lib/griddler/postmark_customized/version.rb
+- postmark_customized.gemspec
+- spec/fixtures/photo1.jpg
+- spec/fixtures/photo2.jpg
+- spec/griddler/postmark_customized/adapter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Equitis90/postmark_customized
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Customized Postmark adapter for Griddler
+test_files: []