mail-embed-html-images 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18fbffc4fa14e22e22e252d8689acf9779315e6e
+  data.tar.gz: d4fe77c7beef921aefd86932e3592a37884fefa5
+SHA512:
+  metadata.gz: 72351c3bd207b8817def046e09716bd69aecf80fdd32be7092ecda2ffc4150adb9b74c2ec1d3c776c5de63bdf6225dee3a15e5eabe5386250e29303d3d3e47be
+  data.tar.gz: 7f0fa9c630d742b6f00fa5be53a6da6c63a0b30a5d543e2730f13295dfd689fc0d0a5074da287d066cdb63daf86afc43ff7c9bcb1afa4da498a048b014302b75

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2015 by Imperial College Union
+
+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,37 @@
+mail-embed-html-images
+======================
+
+Extends [Mail](https://github.com/mikel/mail) to provide a mechanism for
+converting external image sources to embedded attachments.
+
+Usage
+-----
+
+```ruby
+require 'mail'
+require 'mail/embed-html-images'
+
+mail = Mail.new do
+  from       'sender@example.com'
+  to         'recipient@example.com''
+  subject    'This is a test email'
+  html_part  File.read('body.html')
+end
+
+mail.embed_html_images
+mail.deliver
+```
+
+The `embed_html_images` method looks for image tags with http[s] sources,
+downloads the image from the src attribute, adds it as an attachment, and
+replaces the original src attribute with a cid reference to the attachment.
+
+It keeps track of downloaded files so if you have two images with the same
+source it will only download and attach tha image once and ref the same
+attachment from both images.
+
+If you change the html_part, then you will need to re-run
+`embed_html_images`.  This will download any new images found, and remove
+any attached images which are no longer required.
+
+That is all.

data/lib/mail/embed-html-images.rb

@@ -0,0 +1,58 @@
+require 'mail'
+require 'digest/sha1'
+require 'net/http'
+
+module Mail
+  module EmbedHTMLImages
+    MIME_TO_EXTENSION = {
+      'image/png'  => 'png',
+      'image/jpeg' => 'jpg',
+      'image/gif'  => 'gif',
+    }
+
+    def embed_html_images
+      @_embedded_images ||= {}
+      current_images = {}
+
+      # Don't do anything if we don't have an html part
+      return unless html_part
+
+      # Find all img tags in the html part
+      new_html = html_part.body.to_s.gsub(/<img (.*?)src=((?<![\\])['"])(http(?:.(?!(?<![\\])\2))*.?)\2([^>]*)>/) do |match_string|
+        img_src_original = $3
+        img_src_hash = Digest::SHA1.hexdigest img_src_original
+
+        # Check to see whether or not we already have this image: if not, attach it
+        if !@_embedded_images[img_src_hash]
+          response = Net::HTTP.get_response(URI(img_src_original))
+          attachment_filename = img_src_hash + '.' + MIME_TO_EXTENSION[response["content-type"]]
+          add_file filename: attachment_filename, content: response.body
+          @_embedded_images[img_src_hash] = attachment_filename
+        end
+        current_images[img_src_hash] = @_embedded_images[img_src_hash]
+
+        attached_image = attachments[@_embedded_images[img_src_hash]]
+
+        # Create new src using content id of attachment
+        img_src_new = "cid:#{attached_image.cid}"
+
+        # Return substitute with new src
+        "<img #{$1}src=\"#{img_src_new}\"#{$4}>"
+      end
+
+      # Detach any images that are no longer needed
+      @_embedded_images.each do |hash, filename|
+        if !current_images[hash]
+          self.parts.delete_if { |p| p.filename == filename }
+        end
+      end
+      @_embedded_images = current_images
+
+      html_part.body = new_html
+    end
+  end
+
+  class Message
+    include EmbedHTMLImages
+  end
+end

data/lib/mail/embed-html-images/version.rb

@@ -0,0 +1,5 @@
+module Mail
+  module EmbedHTMLImages
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: mail-embed-html-images
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Phil Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Extends Mail to provide a mechanism for converting external image sources
+  to embedded attachments.
+email:
+- phil.stewart@lichp.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/mail/embed-html-images.rb
+- lib/mail/embed-html-images/version.rb
+homepage: https://github.com/lichp/mail-embed-html-images
+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: Extends Mail to provide a mechanism for converting external image sources
+  to embedded attachments.
+test_files: []