actionmailer-html2text 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: beb931e5db7e9bd0501ba2ddee4d78cd7ca920df
+  data.tar.gz: c574ecdb40d77779a9f9b0c16ba5602805e8c790
+SHA512:
+  metadata.gz: d0d1202fcc88b8e3ad55e359cb2d7c54b40b1cd29424536239bf5e474546f6730c35fe9c91f796b5f9c23d8ea20d2cbb6495f408315e97510f6e47e26fb21dc5
+  data.tar.gz: d44e06517e580abd37a726192da8fa911557e5792dd6ed6e189b02262e07b98f1b518ca7399386a33e60d08861862105c08177f47b9ff73bbc28b5bee2660b52

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2015 Jevon Wright
+
+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/lib/actionmailer-html2text.rb

@@ -0,0 +1,26 @@
+require "html2text"
+
+module ActionMailer
+  module Html2Text
+    TEXT_PLAIN = "text/plain"
+    TEXT_HTML = "text/html"
+
+    def collect_responses(headers)
+      add_plain_text(super(headers))
+    end
+
+    def add_plain_text(responses)
+      html_part = responses.detect { |response| response[:content_type] == TEXT_HTML }
+      text_part = responses.detect { |response| response[:content_type] == TEXT_PLAIN }
+
+      if html_part && !text_part
+        responses.insert 0, {
+          content_type: TEXT_PLAIN,
+          body: ::Html2Text.convert(html_part[:body])
+        }
+      end
+
+      responses
+    end
+  end
+end

data/lib/actionmailer-html2text/version.rb

@@ -0,0 +1,5 @@
+module ActionMailer
+  module Html2Text
+    VERSION = "0.1.2"
+  end
+end

data/spec/html2text_spec.rb

@@ -0,0 +1,95 @@
+require "spec_helper"
+require_relative "test_mailer"
+
+describe ActionMailer::Html2Text do
+  let(:mailer) { Class.new(TestMailer) }
+
+  let(:to_address) { "test@example.com" }
+  let(:mail) { mailer.test_email(to_address) }
+  let(:text) { mail.parts.first.body }
+
+  context "by default" do
+    it "is not a multipart email" do
+      expect(mail).to_not be_multipart
+      expect(mail.parts).to be_empty
+    end
+  end
+
+  context "when including our html2text module" do
+    let(:mailer) do
+      Class.new(TestMailer) do
+        include ActionMailer::Html2Text
+      end
+    end
+
+    it "is a multipart email" do
+      expect(mail).to be_multipart
+    end
+
+    it "has two parts" do
+      expect(mail.parts.size).to eq(2)
+    end
+
+    it "has text first" do
+      expect(mail.parts.first.content_type).to match("text/plain")
+    end
+
+    it "has html second" do
+      expect(mail.parts.second.content_type).to match("text/html")
+    end
+
+    context "the text part" do
+      it "does not have any HTML" do
+        expect(text).to_not include("<")
+      end
+
+      it "includes a markdown-style link" do
+        expect(text).to include("[your website](http://example.com)")
+      end
+
+      it "includes the to: address" do
+        expect(text).to include(to_address)
+      end
+    end
+  end
+
+  context "when defining our own multipart templates without Html2Text" do
+    let(:mailer) do
+      Class.new(TestMailer) do
+        def template_name
+          "multipart_email"
+        end
+      end
+    end
+
+    it "is a multipart email" do
+      expect(mail).to be_multipart
+    end
+
+    it "has two parts" do
+      expect(mail.parts.size).to eq(2)
+    end
+
+    it "has text first" do
+      expect(mail.parts.first.content_type).to match("text/plain")
+    end
+
+    it "has html second" do
+      expect(mail.parts.second.content_type).to match("text/html")
+    end
+
+    context "the text part" do
+      it "does not have any HTML" do
+        expect(text).to_not include("<")
+      end
+
+      it "includes a markdown-style link" do
+        expect(text).to include("[your website](http://example.com)")
+      end
+
+      it "includes the to: address" do
+        expect(text).to include(to_address)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rspec"
+require "rspec/collection_matchers"
+require "action_mailer"
+
+require File.join(File.dirname(__FILE__), "..", "lib", "actionmailer-html2text")
+
+ActionMailer::Base.view_paths = File.join(File.dirname(__FILE__), "views")

data/spec/test_mailer.rb

@@ -0,0 +1,19 @@
+class TestMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+
+  def template_name
+    "test_email"
+  end
+
+  def test_email(to)
+    @to = to
+
+    mail({
+      to: to,
+      subject: "Test email",
+      template_path: "templates",
+      template_name: template_name
+    })
+  end
+end

data/spec/views/layouts/mailer.html.erb

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>An ignored title</title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/views/templates/multipart_email.html.erb

@@ -0,0 +1,7 @@
+<body>
+  <h1>Welcome to this multipart email</h1>
+
+  <p>
+    Hello, <%= @to %>, to <a href="http://example.com">your website</a>!
+  </p>
+</body>

data/spec/views/templates/multipart_email.text.erb

@@ -0,0 +1,3 @@
+Welcome to this multipart email
+
+Hello, <%= @to %>, to [your website](http://example.com)!

data/spec/views/templates/test_email.html.erb

@@ -0,0 +1,7 @@
+<body>
+  <h1>Welcome</h1>
+
+  <p>
+    Hello, <%= @to %>, to <a href="http://example.com">your website</a>!
+  </p>
+</body>

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: actionmailer-html2text
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Jevon Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html2text
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  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'
+- !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: rspec-collection_matchers
+  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: colorize
+  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: 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'
+description: Automatically add plain text parts into HTML emails sent by ActionMailer.
+email:
+- jevon@powershop.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- lib/actionmailer-html2text.rb
+- lib/actionmailer-html2text/version.rb
+- spec/html2text_spec.rb
+- spec/spec_helper.rb
+- spec/test_mailer.rb
+- spec/views/layouts/mailer.html.erb
+- spec/views/templates/multipart_email.html.erb
+- spec/views/templates/multipart_email.text.erb
+- spec/views/templates/test_email.html.erb
+homepage: https://github.com/soundasleep/actionmailer-html2text
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Add plain text automatically to HTML emails.
+test_files:
+- spec/html2text_spec.rb
+- spec/spec_helper.rb
+- spec/test_mailer.rb
+- spec/views/layouts/mailer.html.erb
+- spec/views/templates/multipart_email.html.erb
+- spec/views/templates/multipart_email.text.erb
+- spec/views/templates/test_email.html.erb