RubyGems - betamatt-inline_attachment - Versions diffs - 0.4.1 - Mend

betamatt-inline_attachment 0.4.1

Files changed (3) hide show

data/README ADDED Viewed

@@ -0,0 +1,72 @@
+= Inline Attachment
+This package adds full support for embedding inline images into your HTML emails
+through ActionMailer.
+== Installation
+To perform a system wide installation:
+<tt>gem source -a http://gems.github.com</tt>
+<tt>gem install betamatt-inline_attachment</tt>
+To use inline_attachment in your project, add the following line to your project's
+config/environment.rb:
+<tt>config.gem 'inline_attachment'</tt>
+== Usage
+I've rewritten most of Edmond's great work in this version.  I now override
+path_to_image instead of image_tag because a big reason for all the Rails2
+breakages was because image_tag was basically reproduced in previous versions,
+so broke when that method changed.
+Now we override the very simple path_to_image, and most importantly we really
+just add our own stuff for ActionMailer templates, and resort to the existing
+code for everything else.
+I've also integrated in with the new implicit multipart stuff.  So now, there is
+so little code required!
+  class Notifier < ActionMailer::Base
+    def signup
+	    recipients %q{"Testing IA" <testing@handle.it>}
+		  from       %q{"Mr Tester" <tester@handle.it>}
+		  subject "Here's a funky test"
+    end
+	end
+	# Oh yeah baby!  Read it and weep!  So how's this work?  Well, you'll need
+	# your templates named properly - see the `Multipart email` section of the
+	# ActionMailer::Base docs.
+	# signup.text.plain.erb
+	Your username is: <%= @username %>
+  # signup.text.html.erb
+	<html><head><title>Signup Notification</title></head><body>
+	  <%= image_tag "logo.png" %>
+		<p>Your username is: <%=h @username %>
+	</body></html>
+That's it!  InlineAttachment will look for
+"#{RAILS_ROOT}/public/images/logo.png" and will do the right thing and embed it
+inline into the HTML version of the email.  ActionMailer will do the right thing
+and offer the recipient both the text/plain and text/html parts as alternatives.
+Note, that you should still be able to use this in the 0.3.0 way if you have
+code that uses that.  But there were a lot of alternatives, and the examples in
+here didn't show a crucial step of shuffling the parts around to be sure that
+the image parts came after the html.
+You can also do the old "manual" method if you want.
+== Contributors
+Jason King (JasonKing)
+Matt Griffin (betamatt)

data/lib/inline_attachment.rb ADDED Viewed

@@ -0,0 +1,86 @@
+TMail::HeaderField::FNAME_TO_CLASS.delete('content-id')
+CID_NAME = 'Content-Id'
+module ActionMailer
+  module PartContainer
+    # Add an inline attachment to a multipart message.
+    def inline_attachment(params, &block)
+      params = { :content_type => params } if String === params
+      params = { :disposition => "inline",
+                 :transfer_encoding => "base64" }.merge(params)
+      params[:headers] ||= {}
+      params[:headers][CID_NAME] = params[:cid]
+      part(params, &block)
+    end
+  end
+  class Base
+    private
+      def create_mail_with_inline_attachment
+        # sniff out inline html parts with inline images and wrap them up in a
+        # multipart/related mime part
+        got_inlines = false
+        related_parts = []
+        for_deletion = []
+        @parts.each_with_index do |p,i|
+          logger.debug "Considering #{i}"
+          if p.content_disposition == 'inline' && p.content_type =~ %r{^image/}i && p.headers[CID_NAME]
+            logger.debug "Just adding [#{i}] to the list\n#{p.filename}"
+            for_deletion << i
+            related_parts << p
+            got_inlines = true
+          end
+          if got_inlines && p.content_type =~ %r{text/html}i
+            @parts[i] = ActionMailer::Part.new( :content_type => "multipart/related" )
+            @parts[i].parts << p
+            related_parts.each do |rp|
+              @parts[i].parts << rp
+            end
+            got_inlines = false
+            related_parts = []
+          end
+        end
+        for_deletion.sort{|a,b|b<=>a}.each {|i|@parts.delete_at(i)}
+        create_mail_without_inline_attachment
+      end
+      alias_method_chain :create_mail, :inline_attachment
+  end
+end
+module ActionView
+  module Helpers #:nodoc:
+    module AssetTagHelper
+      def path_to_image_with_inline_attachment(source)
+        @part_container ||= @controller
+        if @part_container.is_a?(ActionMailer::Base) or @part_container.is_a?(ActionMailer::Part)
+          if source =~ /file:\/\//
+            # Handle attached files from the local filesystem.  Should sandbox this somehow.
+            file_path = source.sub(/file:\/\//, '')
+          else
+            # Public image files
+            file_path = "#{RAILS_ROOT}/public#{path_to_image_without_inline_attachment(source).split('?').first}"
+          end
+          if File.exists?(file_path)
+            basename  = File.basename(file_path)
+            ext       = basename.split('.').last
+            cid       = Time.now.to_f.to_s + "#{basename}@inline_attachment"
+            file      = File.open(file_path, 'rb')
+            @part_container.inline_attachment(:content_type => "image/#{ext}",
+                                          :body         => file.read,
+                                          :filename     => basename,
+                                          :cid          => "<#{cid}>",
+                                          :disposition  => "inline")
+            return "cid:#{cid}"
+          end
+        end
+        return path_to_image_without_inline_attachment(source)
+      end
+      alias_method_chain :path_to_image, :inline_attachment
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: betamatt-inline_attachment
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- Matt Griffin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-02-17 00:00:00 -08:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "1.15"
+    version:
+description:
+email: matt@griffinonline.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- lib/inline_attachment.rb
+has_rdoc: true
+homepage: http://github.com/betamatt/inline_attachment
+post_install_message:
+rdoc_options:
+- --inline-source
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project: InlineAttachment
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: Makes image_tag in an ActionMailer template embed the images in the emails.  Forked from the github project by JasonKing.'
+test_files: []