eml_to_pdf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3911a7809cb69bc0204d23de4f040070628b93f8
+  data.tar.gz: 1f699d54673e9c659a2678f01a45312baa6ba000
+SHA512:
+  metadata.gz: 6b314e084e442475832f8249f76c6cbf9966787d259c93c5f66d05f6f9735f3f24dbddeac0ddc7dad8b56ee6181b944589e37b55817672d7266f3025b0f42837
+  data.tar.gz: 5cdd6459df4fd50190d9d863a6d9d6a720a52f212ef0e319c2ffa62f0ceea7b092d2dda87fab54eebbd7a5a5e9706db788ed971abc1f6b56badabf117565d95f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eml_to_pdf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yves Siegrist
+
+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,50 @@
+# EmlToPdf
+
+Welcome to EmlToPdf.
+A small converter to convert an eml file to a pdf.
+This gem uses `wkhtmltopdf`. You can get the installer from [here](http://wkhtmltopdf.org/downloads.html)
+
+[![Build Status](https://travis-ci.org/Elektron1c97/eml_to_pdf.svg?branch=master)](https://travis-ci.org/Elektron1c97/eml_to_pdf)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eml_to_pdf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eml_to_pdf
+
+## Usage
+
+Use the `convert` method to covert an eml to a pdf
+
+```ruby
+EmlToPdf.convert("~/Desktop/my_test_email.eml", "~/Desktop/converted_email.pdf")
+```
+
+Or you can use the executable
+
+    $ eml_to_pdf input-path output-path
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/eml_to_pdf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eml_to_pdf"
+
+# 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

data/bin/setup

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

data/eml_to_pdf.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eml_to_pdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eml_to_pdf"
+  spec.version       = EmlToPdf::VERSION
+  spec.authors       = ["Yves Siegrist"]
+  spec.email         = ["Elektron1c97@gmail.com"]
+
+  spec.description   = %q{This gem uses wkhtmltopdf to convert an eml to a pdf. (eml -> html -> pdf)}
+  spec.summary       = %q{This gem allows you to convert an eml (email) into a pdf.}
+  spec.homepage      = "https://github.com/Elektron1c97/eml_to_pdf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest', '~> 5.9'
+
+  spec.add_runtime_dependency 'filesize', '~> 0.1.1'
+  spec.add_runtime_dependency 'mail', '~> 2.5', '>= 2.5.4'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.7.2'
+end

data/exe/eml_to_pdf

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# TODO: use this to convert whole folders
+# Dir["test/fixtures/emails/*.eml"].each do |test_file|
+#   puts "> converting #{test_file}"
+#   begin
+#     EmlToPdf.convert(test_file, "#{test_file[0..-5]}_output.pdf")
+#   rescue NoMethodError => e
+#     puts e.message
+#   end
+# end
+
+if ARGV[0] && ARGV[1]
+  require "bundler/setup"
+  require "eml_to_pdf"
+  EmlToPdf.convert(ARGV[0], ARGV[1])
+else
+  puts %{Please provide an input as well as an output path\nExample: emltopdf test-email.eml output.pdf}
+end

data/lib/eml_to_pdf/converter.rb

@@ -0,0 +1,14 @@
+module EmlToPdf
+  class Converter
+    def initialize(input_path, output_path)
+      @input_path = input_path
+      @output_path = output_path
+    end
+
+    def convert
+      email = Email.new(@input_path)
+      html = email.to_html
+      Wkhtmltopdf.convert(html, @output_path)
+    end
+  end
+end

data/lib/eml_to_pdf/email.rb

@@ -0,0 +1,150 @@
+require 'pathname'
+
+module EmlToPdf
+  class Email
+    MIME_TYPES = {
+      plain_text: "text/plain",
+      html: "text/html",
+      multipart_mixed: "multipart/mixed"
+    }
+
+    TEMPLATES_PATH = Pathname.new(File.expand_path(__dir__)) + "templates"
+
+    def initialize(input_path)
+      @input_path = input_path
+      @mail = Mail.read(input_path)
+    end
+
+    def to_html
+      html = text_parts(@mail).join
+      html = resolve_cids_from_attachments(html, @mail.attachments)
+      html = add_mail_metadata_to_html(@mail, html)
+      html
+    end
+
+    def text_parts(mail_or_part)
+      if mail_or_part.multipart?
+        parts = mail_or_part.parts
+        if mail_or_part.mime_type == MIME_TYPES[:multipart_alternative]
+          text_parts(extract_best_representation_from_parts(parts))
+        else
+          parts.map do |part|
+            text_parts(part)
+          end
+        end
+      else
+        best_part = if mail_or_part.mime_type == MIME_TYPES[:plain_text] && !mail_or_part.attachment?
+                      wrap_text_in_pre_tag(mail_or_part.decoded)
+                    elsif mail_or_part.mime_type == MIME_TYPES[:html] && !mail_or_part.attachment?
+                      mail_or_part.decoded
+                    else
+                      ""
+                    end
+        [best_part]
+      end.flatten
+    end
+
+    private
+    def visible_attachments(mail)
+      mail.attachments.select do |attachment|
+        !attachment.inline?
+      end
+    end
+
+    def resolve_cids_from_attachments(html, attachments)
+      cid_list(attachments).inject(html) do |html, key_and_value|
+        k, v = key_and_value
+        html.gsub!(k, v)
+        html
+      end
+    end
+
+    def cid_list(attachments)
+      @cid_list ||= attachments.inject({}) do |list, attachment|
+        if attachment.content_id && attachment.content_transfer_encoding == "base64"
+          mime_type = attachment.mime_type
+          decoded = attachment.body.raw_source.strip.gsub(/[\n\t\r]/, "")
+          list[attachment.url] = "data:#{mime_type};base64,#{decoded}"
+        end
+        list
+      end
+    end
+
+    def html_body(mail_or_part)
+      if multipart_alternative?(mail_or_part)
+        [extract_best_representation_from_parts(mail_or_part.parts)]
+      elsif multipart_mixed?(mail_or_part)
+        mail_or_part.parts.map do |part|
+          html_body(part)
+        end
+      else
+        [extract_best_representation_from_parts(Array(mail_or_part))]
+      end.flatten
+    end
+
+    def extract_best_representation_from_parts(parts)
+      if multipart_part = parts.detect(&:multipart?)
+        multipart_part
+      elsif html_part = find_body_with_type(parts, :html)
+        html_part
+      elsif text_part = find_body_with_type(parts, :plain_text)
+        text_part
+      else
+        "can't find useable part"
+      end
+    end
+
+    def find_body_with_type(parts, type)
+      parts.detect do |part|
+        part.mime_type == MIME_TYPES[type]
+      end
+    end
+
+    def multipart_mixed?(part)
+      part.mime_type == MIME_TYPES[:multipart_mixed]
+    end
+
+    def multipart_alternative?(part)
+      part.mime_type == MIME_TYPES[:multipart_alternative] || part.mime_type == MIME_TYPES[:multipart_related]
+    end
+
+
+    def wrap_text_in_html(text)
+      "<!DOCTYPE html><html><head></head><body><pre>#{text}</pre></body></html>"
+    end
+
+    def wrap_text_in_pre_tag(text)
+      "<pre>#{text}</pre>"
+    end
+
+    def add_mail_metadata_to_html(mail, html)
+      context = MetadataContext.new(from: save_extract_header(mail, :from),
+                                    to: save_extract_header(mail, :to),
+                                    cc: save_extract_header(mail, :cc),
+                                    date: mail.date,
+                                    subject: mail.subject,
+                                    attachments: visible_attachments(mail))
+      heading = render_template("heading.html.erb", context.get_binding)
+      style = render_template("style.html")
+      html = "<body></body>" if html.empty?
+      doc = Nokogiri::HTML(html)
+      doc.at_css("body").prepend_child(heading)
+      doc.at_css("body").prepend_child(style)
+      doc.to_html
+    end
+
+    def render_template(filename, binding = nil)
+      template = File.read(TEMPLATES_PATH + filename)
+      renderer = ERB.new(template)
+      renderer.result(binding)
+    end
+
+    def save_extract_header(mail, header)
+      if header = mail.header[header]
+        header.decoded
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/eml_to_pdf/metadata_context.rb

@@ -0,0 +1,25 @@
+module EmlToPdf
+  class MetadataContext
+    def initialize(metadata)
+      metadata.each do |k, v|
+        eval("@#{k}=v")
+      end
+    end
+
+    def format_attachment_size(attachment)
+      Filesize.from("#{attachment.body.decoded.size} B").pretty
+    end
+
+    def format_date(date)
+      date.strftime("%d.%m.%Y um %H:%M")
+    end
+
+    def html_escape(str)
+      CGI.escapeHTML(str)
+    end
+
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/eml_to_pdf/templates/heading.html.erb

@@ -0,0 +1,31 @@
+<meta charset="UTF-8">
+<div class="email-metadata">
+  <table>
+    <tr>
+      <td><strong>Von:</strong></td>
+      <td><%= html_escape(@from) %></td>
+    </tr>
+    <tr>
+      <td><strong>An:</strong></td>
+      <td><%= html_escape(@to) %></td>
+    </tr>
+    <tr>
+      <td><strong>Cc:</strong></td>
+      <td><%= html_escape(@cc) %></td>
+    </tr>
+    <tr>
+      <td><strong>Datum:</strong></td>
+      <td><%= format_date(@date) if @date %></td>
+    </tr>
+  </table>
+  <h3><%= @subject %></h3>
+  <hr>
+  <ul class="email-attachments">
+    <% @attachments.each do |att| %>
+      <li class="attachement">
+        <span class="filename"><%= att.filename %></span>
+        <span class="file-size"><%= format_attachment_size(att) %></span>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/lib/eml_to_pdf/templates/style.html

@@ -0,0 +1,56 @@
+<style type="text/css">
+ .email-metadata {
+   width: 100%;
+   background: #fff;
+   font-size: 12pt;
+   font-family: Arial;
+   padding-bottom: 20px;
+ }
+ .email-metadata table {
+   width: 100%;
+ }
+ .email-attachments {
+   padding: 0;
+   margin: 0;
+ }
+ .email-attachments:before,
+ .email-attachments:after {
+   content: "";
+   display: table;
+ }
+ .email-attachments:after {
+   clear: both;
+ }
+ .attachement {
+   padding: 5px 10px;
+   background-color: #eaeaea;
+   border: 1px solid #ccc;
+   display: table;
+   float: left;
+   margin-right: 10px;
+   margin-bottom: 10px;
+ }
+
+ .filename {
+   display: table-cell;
+   width: 75%;
+ }
+
+ .file-size {
+   display: table-cell;
+   width: 25%;
+   font-size: 80%;
+   color: #aaa;
+   padding-left: 5px;
+   text-align: right;
+ }
+
+ pre {
+   white-space: pre-wrap;
+ }
+
+ body {
+   margin: 0;
+   padding: 0;
+ }
+</style>

data/lib/eml_to_pdf/version.rb

@@ -0,0 +1,3 @@
+module EmlToPdf
+  VERSION = "0.1.0"
+end

data/lib/eml_to_pdf/wkhtmltopdf.rb

@@ -0,0 +1,11 @@
+module EmlToPdf
+  class Wkhtmltopdf
+    def self.convert(input, output_path)
+      IO.popen("wkhtmltopdf --encoding utf-8 --footer-center [page] - #{output_path} 2>&1", "r+") do |pipe|
+        pipe.puts(input)
+        pipe.close_write
+        pipe.readlines # TODO save output
+      end
+    end
+  end
+end

data/lib/eml_to_pdf.rb

@@ -0,0 +1,17 @@
+require "cgi"
+require "mail"
+require "erb"
+require "nokogiri"
+require "filesize"
+require "eml_to_pdf/version"
+require "eml_to_pdf/converter"
+require "eml_to_pdf/converter"
+require "eml_to_pdf/email"
+require "eml_to_pdf/wkhtmltopdf"
+require "eml_to_pdf/metadata_context"
+
+module EmlToPdf
+  def self.convert(input, output)
+    Converter.new(input, output).convert
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: eml_to_pdf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yves Siegrist
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: filesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7.2
+description: This gem uses wkhtmltopdf to convert an eml to a pdf. (eml -> html ->
+  pdf)
+email:
+- Elektron1c97@gmail.com
+executables:
+- eml_to_pdf
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eml_to_pdf.gemspec
+- exe/eml_to_pdf
+- lib/eml_to_pdf.rb
+- lib/eml_to_pdf/converter.rb
+- lib/eml_to_pdf/email.rb
+- lib/eml_to_pdf/metadata_context.rb
+- lib/eml_to_pdf/templates/heading.html.erb
+- lib/eml_to_pdf/templates/style.html
+- lib/eml_to_pdf/version.rb
+- lib/eml_to_pdf/wkhtmltopdf.rb
+homepage: https://github.com/Elektron1c97/eml_to_pdf
+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: This gem allows you to convert an eml (email) into a pdf.
+test_files: []