eml_to_pdf 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e81efeb010801805fe22e63ff844e4a3f400955c
-  data.tar.gz: 1a02a94a289f960e79827c5f63d927d6d37a2888
+SHA256:
+  metadata.gz: 4ca4521f1d3dd67c4bec67daa9470390d9fb4f2ea6567e2623241699f812a9c2
+  data.tar.gz: beaaf4003bd695c8621e6a81e4afa66c0bb829a0d0d5fa582ca18815e5e93697
 SHA512:
-  metadata.gz: b613139c02acf27408c43fad2114e34db2321ea9fa2b3709923f4dbc610d15f62751bce105a06e046b7d7246487b6e46d59a785fbe0afc84efe47decb1b70e8c
-  data.tar.gz: 43e6e8b27008a6482229fa8077af78bcc245b0987d905c3fb7636b3de4f387308a9a459aa6413f05bd3df2df000580fa26583622a195808dc7f74a558bdc76cc
+  metadata.gz: 404e1d85c233b1fb6a8b753a755210b76f8e3cfa571e0fe3ee8b205d83c0d4bf1f5879f31b30f340133ef94057aa4e67af548c10f67e2a1a7a8627c20a3f3505
+  data.tar.gz: 0c8a0d071dad60ce8bfaf43c5b0d33c1250902aa0e032de0f107d8cf7d7996b34c942bd7682b127b4576ecb85b34afc9eccdcd72babdf05facc1748c09cf4bd8

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+languages:
+  Ruby: true
+exclude_paths:
+- "lib/eml_to_pdf/extraction_step.rb"
+- "test/"

data/.gitignore

@@ -6,4 +6,5 @@
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
+/tmp/*
+!/tmp/.gitkeep

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.7.1

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.6
+  - 2.7
+
+before_install:
+  - gem install bundler
+  - sudo apt-get install xfonts-75dpi xfonts-base
+  - wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.5/wkhtmltox_0.12.5-1.xenial_amd64.deb
+  - sudo apt install ./wkhtmltox_0.12.5-1.xenial_amd64.deb

data/README.md

@@ -4,7 +4,8 @@ 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)
+[![Build Status](https://travis-ci.org/siegy22/eml_to_pdf.svg?branch=master)](https://travis-ci.org/siegy22/eml_to_pdf)
+[![Code Climate](https://codeclimate.com/github/siegy22/eml_to_pdf/badges/gpa.svg)](https://codeclimate.com/github/siegy22/eml_to_pdf)
 
 ## Installation
 
@@ -30,11 +31,14 @@ Use the `configure` method to configure your labels
 
 ```ruby
 EmlToPdf.configure do |config|
+  config.timeout = 60 # Seconds, defaults to 0
   config.from_label = "From =>"
   config.to_label = "To =>"
   config.cc_label = "Cc =>"
   config.date_label = "Date =>"
-  config.date_format = "%d.%m.%Y" # see Date#strftime
+  config.date_format do |date|
+    date.strftime("%Y")
+  end
 end
 ```
 
@@ -56,7 +60,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/siegy22/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

data/Rakefile

@@ -3,6 +3,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
 end
 
 desc "Run tests"

data/eml_to_pdf.gemspec

@@ -19,11 +19,13 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = ">= 2.2.0"
+
+  spec.add_development_dependency "bundler", ">= 1.10"
+  spec.add_development_dependency "rake", "~> 12.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'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.7'
 end

data/exe/eml_to_pdf

@@ -1,13 +1,4 @@
 #!/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"

data/lib/eml_to_pdf.rb

@@ -5,6 +5,8 @@ require "eml_to_pdf/converter"
 require "eml_to_pdf/email"
 require "eml_to_pdf/wkhtmltopdf"
 require "eml_to_pdf/metadata_context"
+require "eml_to_pdf/extraction_step"
+require "eml_to_pdf/extraction_step_list"
 
 module EmlToPdf
   def self.convert(input, output)

data/lib/eml_to_pdf/configuration.rb

@@ -1,22 +1,27 @@
 module EmlToPdf
   class Configuration
-    attr_accessor :from_label, :to_label, :cc_label, :date_label
-    attr_reader :date_format
+    attr_accessor :from_label, :to_label, :cc_label, :date_label, :wkhtmltopdf, :timeout
 
     def initialize
       @from_label = "From"
       @to_label = "To"
       @cc_label = "Cc"
       @date_label = "Date"
-      @date_format = "%Y-%m-%d %H:%M:%S %z"
+      @date_format = lambda { |date| date.strftime("%Y-%m-%d %H:%M:%S %z") }
+      @wkhtmltopdf = 'wkhtmltopdf'
+      @timeout = 0
     end
 
-    def date_format=(value)
-      if value.is_a?(String)
-        @date_format = value
+    def date_format(&block)
+      if block_given?
+        @date_format = block
       else
-        raise ArgumentError, "You can only use a String to format the date. (See Date#strftime)"
+        @date_format
       end
     end
+
+    def format_date(date)
+      @date_format.call(date)
+    end
   end
 end

data/lib/eml_to_pdf/email.rb

@@ -5,12 +5,6 @@ require "erb"
 
 module EmlToPdf
   class Email
-    MIME_TYPES = {
-      plain_text: "text/plain",
-      html: "text/html",
-      multipart_alternative: "multipart/alternative"
-    }
-
     TEMPLATES_PATH = Pathname.new(File.expand_path(__dir__)) + "templates"
 
     def initialize(input_path)
@@ -19,26 +13,15 @@ module EmlToPdf
     end
 
     def to_html
-      html = text_parts(@mail).join
-      html = resolve_cids_from_attachments(html, @mail.attachments)
+      extraction = ExtractionStep.new(@mail)
+      extraction = extraction.next until extraction.finished?
+      html = extraction.to_html
+      html = resolve_cids_from_attachments(html, @mail.all_parts)
       html = add_mail_metadata_to_html(@mail, html)
       html
     end
 
     private
-    def text_parts(mail_or_part)
-      if mail_or_part.multipart? && multipart_alternative?(mail_or_part)
-        best_part = extract_best_part(mail_or_part.parts)
-        text_parts(best_part)
-      elsif mail_or_part.multipart?
-        mail_or_part.parts.map do |part|
-          text_parts(part)
-        end
-      else
-        [text_body(mail_or_part)]
-      end.flatten
-    end
-
     def visible_attachments(mail)
       mail.attachments.select do |attachment|
         !attachment.inline?
@@ -64,42 +47,6 @@ module EmlToPdf
       end
     end
 
-    def extract_best_part(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_alternative?(part)
-      part.mime_type == MIME_TYPES[:multipart_alternative]
-    end
-
-    def text_body(mail_or_part)
-      if mail_or_part.mime_type == MIME_TYPES[:html] && !mail_or_part.attachment?
-        mail_or_part.decoded
-      elsif mail_or_part.mime_type == MIME_TYPES[:plain_text] && !mail_or_part.attachment?
-        wrap_text_in_pre_tag(mail_or_part.decoded)
-      else
-        ""
-      end
-    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),
@@ -123,11 +70,7 @@ module EmlToPdf
     end
 
     def save_extract_header(mail, header)
-      if header = mail.header[header]
-        header.decoded
-      else
-        ""
-      end
+      (mail.header[header] && mail.header[header].decoded) || ""
     end
   end
 end

data/lib/eml_to_pdf/extraction_step.rb

@@ -1,54 +1,63 @@
-module EmlToPdf
+require 'eml_to_pdf/extraction_step_list'
+require 'eml_to_pdf/empty_part'
 
-  # TODO: in email#to_html remove recursive function with this class
-  # for a better control and to be able to make more unit tests.
+module EmlToPdf
   class ExtractionStep
+    MIME_TYPES = {
+      plain_text: "text/plain",
+      html: "text/html",
+      multipart_alternative: "multipart/alternative"
+    }
+
     def initialize(mail_or_part)
       @mail_or_part = mail_or_part
     end
 
-    # extraction = ExtractionStep.new(@mail)
-    # extraction = extraction.next until extraction.finished?
-
     def next
       if multipart_alternative?(@mail_or_part)
         best_part = extract_best_part(@mail_or_part.parts)
         ExtractionStep.new(best_part)
       elsif @mail_or_part.multipart?
-
+        ExtractionStepList.new(@mail_or_part.parts.map { |part| ExtractionStep.new(part) })
       else
-
+        self
       end
     end
 
     def finished?
-      @mail_or_part.parts.none?(&:multipart?)
+      !@mail_or_part.multipart?
     end
 
     def to_html
-      if html_part = @mail_or_part.html_part
-        html_part
-      elsif text_part = @mail_or_part.text_part
-        wrap_text_in_pre_tag(text_part)
+      text_body(@mail_or_part)
+    end
+
+    private
+    def multipart_alternative?(part)
+      part.mime_type == MIME_TYPES[:multipart_alternative]
+    end
+
+    def text_body(mail_or_part)
+      if mail_or_part.mime_type == MIME_TYPES[:html] && !mail_or_part.attachment?
+        mail_or_part.decoded
+      elsif mail_or_part.mime_type == MIME_TYPES[:plain_text] && !mail_or_part.attachment?
+        wrap_text_in_pre_tag(mail_or_part.decoded)
       else
         ""
       end
     end
 
     def extract_best_part(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
+      parts.detect(&:multipart?) ||
+        find_body_with_type(parts, :html) ||
+        find_body_with_type(parts, :plain_text) ||
+        EmlToPdf::EmptyPart.new
     end
 
-    def multipart_alternative?(part)
-      part.mime_type == MIME_TYPES[:multipart_alternative]
+    def find_body_with_type(parts, type)
+      parts.detect do |part|
+        part.mime_type == MIME_TYPES[type]
+      end
     end
 
     def wrap_text_in_pre_tag(text)

data/lib/eml_to_pdf/extraction_step_list.rb

@@ -0,0 +1,24 @@
+module EmlToPdf
+  class ExtractionStepList
+    def initialize(steps)
+      @steps = steps
+    end
+
+    def next
+      self.class.new(@steps.map(&:next))
+    end
+
+    def finished?
+      @steps.all?(&:finished?)
+    end
+
+    def to_html
+      @steps.flatten.map(&:to_html).join
+    end
+
+    private
+    def multipart_alternative?(part)
+      part.mime_type == MIME_TYPES[:multipart_alternative]
+    end
+  end
+end

data/lib/eml_to_pdf/metadata_context.rb

@@ -1,14 +1,9 @@
 require "filesize"
 require "cgi"
+require "ostruct"
 
 module EmlToPdf
-  class MetadataContext
-    def initialize(metadata)
-      metadata.each do |k, v|
-        eval("@#{k}=v")
-      end
-    end
-
+  class MetadataContext < OpenStruct
     def config
       EmlToPdf.configuration
     end
@@ -18,7 +13,7 @@ module EmlToPdf
     end
 
     def format_date(date)
-      date.strftime(config.date_format)
+      config.format_date(date)
     end
 
     def html_escape(str)

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

@@ -3,25 +3,25 @@
   <table>
     <tr>
       <td><strong><%= config.from_label %></strong></td>
-      <td><%= html_escape(@from) %></td>
+      <td><%= html_escape(from) %></td>
     </tr>
     <tr>
       <td><strong><%= config.to_label %></strong></td>
-      <td><%= html_escape(@to) %></td>
+      <td><%= html_escape(to) %></td>
     </tr>
     <tr>
       <td><strong><%= config.cc_label %></strong></td>
-      <td><%= html_escape(@cc) %></td>
+      <td><%= html_escape(cc) %></td>
     </tr>
     <tr>
       <td><strong><%= config.date_label %></strong></td>
-      <td><%= format_date(@date) if @date %></td>
+      <td><%= format_date(date) if date %></td>
     </tr>
   </table>
-  <h3><%= @subject %></h3>
+  <h3><%= subject %></h3>
   <hr>
   <ul class="email-attachments">
-    <% @attachments.each do |att| %>
+    <% attachments.each do |att| %>
       <li class="attachement">
         <span class="filename"><%= att.filename %></span>
         <span class="file-size"><%= format_attachment_size(att) %></span>

data/lib/eml_to_pdf/version.rb

@@ -1,3 +1,3 @@
 module EmlToPdf
-  VERSION = "0.2.0"
+  VERSION = "0.5.0"
 end

data/lib/eml_to_pdf/wkhtmltopdf.rb

@@ -1,10 +1,25 @@
+require 'timeout'
+
 module EmlToPdf
   class Wkhtmltopdf
+    class ConversionError < StandardError; end
+    class ConversionTimeoutError < StandardError
+      def message
+        "Failed to convert within the configured timeout. Use EmlToPdf.configure to increase the timeout if needed."
+      end
+    end
+
     def self.convert(input, output_path)
-      IO.popen("wkhtmltopdf --encoding utf-8 --footer-center [page] --footer-spacing 2.5 - #{output_path} 2>&1", "r+") do |pipe|
-        pipe.puts(input)
-        pipe.close_write
-        pipe.readlines # TODO save output
+      Timeout.timeout(EmlToPdf.configuration.timeout, ConversionTimeoutError) do
+        IO.popen("#{EmlToPdf.configuration.wkhtmltopdf} --encoding utf-8 --footer-center [page] --footer-spacing 2.5 --quiet - #{output_path} 2>&1", "r+") do |pipe|
+          pipe.puts(input)
+          pipe.close_write
+          output = pipe.readlines.join
+          pipe.close
+          unless $?.success?
+            raise ConversionError, output
+          end
+        end
       end
     end
   end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: eml_to_pdf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yves Siegrist
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-09 00:00:00.000000000 Z
+date: 2020-06-25 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
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -92,20 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.7.2
+        version: '1.7'
   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
+        version: '1.7'
 description: This gem uses wkhtmltopdf to convert an eml to a pdf. (eml -> html ->
   pdf)
 email:
@@ -115,6 +109,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
@@ -133,11 +128,13 @@ files:
 - lib/eml_to_pdf/email.rb
 - lib/eml_to_pdf/empty_part.rb
 - lib/eml_to_pdf/extraction_step.rb
+- lib/eml_to_pdf/extraction_step_list.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
+- tmp/.gitkeep
 homepage: https://github.com/Elektron1c97/eml_to_pdf
 licenses:
 - MIT
@@ -150,15 +147,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.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: 3.1.2
 signing_key: 
 specification_version: 4
 summary: This gem allows you to convert an eml (email) into a pdf.