attachments 0.0.13 → 0.0.14

data/README.rdoc

@@ -18,6 +18,12 @@ times faster at decoding large attachments if you us ruby 1.9 instead of 1.8.
 
 == NEW STUFF:
 
+Version 0.0.14
+
+* Support in-memory storage of attachments to support processing on
+  systems without access to file system (i.e. Heroku + Cloudmailin)
+* Include set in extract.rb to avoid exception in ruby 1.9.2
+
 Version 0.0.11
 
 * Convert the subject to utf-8
@@ -90,7 +96,7 @@ when they are uncertain.
 	    puts f.inspect
 	    case f[:mime_type]
             when "text/plain" then
-                puts File.read(f[:tmpfile])
+                puts f[:body] || File.read(f[:tmpfile])
 	    end
         end
 	# Remove tmp files and prepare for new parsing action

data/VERSION

@@ -1 +1 @@
-0.0.13
+0.0.14

data/attachments.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{attachments}
+  s.version = "0.0.14"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rune Myrland"]
+  s.date = %q{2011-04-07}
+  s.description = %q{It's original intention is as a helper class class for filtering email attachments before forwarding. The extracted attachments are saved in the /tmp directory.}
+  s.email = %q{rune@epubify.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "attachments.gemspec",
+    "lib/attachments.rb",
+    "lib/attachments/extract.rb",
+    "lib/attachments/filemagic.rb",
+    "test/data/mail_0001.eml",
+    "test/data/mail_0002.eml",
+    "test/data/mail_0002.jpg",
+    "test/data/mail_0004.eml",
+    "test/helper.rb",
+    "test/test_attachments.rb"
+  ]
+  s.homepage = %q{http://github.com/wrimle/attachments}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Extract mail parts of specified mime types.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_attachments.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mail>, [">= 2.2.5"])
+      s.add_runtime_dependency(%q<uuidtools>, [">= 2.1.1"])
+    else
+      s.add_dependency(%q<mail>, [">= 2.2.5"])
+      s.add_dependency(%q<uuidtools>, [">= 2.1.1"])
+    end
+  else
+    s.add_dependency(%q<mail>, [">= 2.2.5"])
+    s.add_dependency(%q<uuidtools>, [">= 2.1.1"])
+  end
+end
+

data/lib/attachments/extract.rb

@@ -5,6 +5,7 @@ require 'uuidtools'
 require 'fileutils'
 require 'mail'
 require 'iconv'
+require 'set'
 
 
 module Attachments
@@ -19,14 +20,15 @@ module Attachments
     UNCERTAIN_TYPES = [ "application/octet-stream" ].to_set
 
 
-    def initialize include_types = [ "text/plain" ]
+    def initialize include_types = [ "text/plain" ], options = { :cache_in_memory => false }
       @include_types = include_types
+      @cache_in_memory = options [ :cache_in_memory ] || false
       reset
     end
 
     def close
       files.each do |f|
-        FileUtils::rm(f[:tmpfile])
+        FileUtils::rm(f[:tmpfile]) unless @cache_in_memory
       end
       reset
     end
@@ -95,7 +97,7 @@ module Attachments
     end
 
     def text_body
-      if(@mail && @mail.text_part && @mail.text_part.body)
+      if(@mail &&  @mail.text_part && @mail.text_part.body)
         m = @mail.text_part.body.decoded
         charset = @mail.text_part.charset
         text = charset ? Iconv.conv("utf-8", charset, m) : m
@@ -173,14 +175,7 @@ module Attachments
         @name = mail.content_type_parameters['name'] || "unnamed"
         @name.gsub! /[^\w\.\-]/, '_' # Sanitize
 
-        # Make it unique
-        uuid = UUIDTools::UUID.random_create.hexdigest
-
-        # The filename used for storage
-        filename = "#{@name}.#{uuid}"
-        filepath = "/tmp/#{filename}" 
-
-
+        # Extract body
         body = case ct
                when "text/plain" then
                  m = mail.body.decoded
@@ -207,24 +202,38 @@ module Attachments
                  mail.body.decoded
                end
 
-        # Save part as it is of a supported type
-        f = File.new(filepath, "wb")
-        f.write(body)
-        f.close
+        # Make it unique
+        uuid = UUIDTools::UUID.random_create.hexdigest
 
-        unless File.exists?(filepath)
-          raise Error::SaveFailed, "Save failed for ", filepath, "\n"
-          return
-        end
+        # The filename used for storage
+        filename = "#{@name}.#{uuid}"
 
-        # Sort out the mime type
-        mime_type = ct
-        if(UNCERTAIN_TYPES.include? mime_type)
-          mime_type = FileMagic::mime filename
+        if @cache_in_memory
+          mime_type = ct
+          @files << { :name => @name, :body => body, :save_as => name, :upload_to => filename, :mime_type => mime_type  }
+        else
+          # Tmp file
+          filepath = "/tmp/#{filename}" 
+
+          # Save part as it is of a supported type
+          f = File.new(filepath, "wb")
+          f.write(body)
+          f.close
+
+          unless File.exists?(filepath)
+            raise Error::SaveFailed, "Save failed for ", filepath, "\n"
+            return
+          end
+
+          # Sort out the mime type
+          mime_type = ct
+          if(UNCERTAIN_TYPES.include? mime_type)
+            mime_type = FileMagic::mime filename
+          end
+
+          # Save meta-data for further processing
+          @files << { :name => @name, :tmpfile => filepath, :save_as => name, :upload_to => filename, :mime_type => mime_type  }
         end
-
-        # Save meta-data for further processing
-        @files << { :name => @name, :tmpfile => filepath, :save_as => name, :upload_to => filename, :mime_type => mime_type  }
       end
     end
   end

data/test/test_attachments.rb

@@ -4,7 +4,7 @@ require 'helper'
 require 'iconv'
 
 class TestAttachments < Test::Unit::TestCase
-  def compare_extractors a, b
+  def compare_extractors_old a, b
     (0...a.files.length).each do |i|
       tmp_a = a.files[i][:tmpfile]
       tmp_b = b.files[i][:tmpfile]
@@ -14,9 +14,20 @@ class TestAttachments < Test::Unit::TestCase
     end
   end
 
+
+  def compare_extractors a, b
+    (0...a.files.length).each do |i|
+      tmp_a = a.files[i][:body] || File.read(a.files[i][:tmpfile])
+      tmp_b = b.files[i][:body] || File.read(a.files[i][:tmpfile])
+
+      isIdentical = (tmp_a === tmp_b)
+      assert(isIdentical)
+    end
+  end
+
   context "Parse test cases without crashes" do
     setup do
-      @extract = Attachments::Extract.new [ "text/plain", "image/jpeg" ]
+      @extract = Attachments::Extract.new [ "text/plain", "image/jpeg" ], { :cache_in_memory => true }
     end
 
     teardown do
@@ -45,7 +56,7 @@ class TestAttachments < Test::Unit::TestCase
 
   context "Just text text/plain and text/html" do
     setup do
-      @extract = Attachments::Extract.new [ "text/plain" ]
+      @extract = Attachments::Extract.new [ "text/plain" ], { :cache_in_memory => false }
       @extract.parse "./test/data/mail_0001.eml"
     end
 
@@ -87,7 +98,7 @@ class TestAttachments < Test::Unit::TestCase
 
   context "UTF-8 and text/plain and image attachment" do
     setup do
-      @extract = Attachments::Extract.new [ "text/plain", "image/jpeg" ]
+      @extract = Attachments::Extract.new [ "text/plain", "image/jpeg" ], { :cache_in_memory => false }
       @extract.parse "./test/data/mail_0002.eml"
     end
 
@@ -106,7 +117,7 @@ class TestAttachments < Test::Unit::TestCase
 
   context "convenience accessors" do
     setup do
-      @extract = Attachments::Extract.new [ "text/plain", "image/jpeg" ]
+      @extract = Attachments::Extract.new [ "text/plain", "image/jpeg" ], { :cache_in_memory => true }
       @extract.parse "./test/data/mail_0001.eml"
     end
 
@@ -138,8 +149,8 @@ class TestAttachments < Test::Unit::TestCase
 
   context "Parse parameters" do
     setup do
-      @a = Attachments::Extract.new [ "text/plain", "image/jpeg" ]
-      @b = Attachments::Extract.new [ "text/plain", "image/jpeg" ]
+      @a = Attachments::Extract.new [ "text/plain", "image/jpeg" ], { :cache_in_memory => true }
+      @b = Attachments::Extract.new [ "text/plain", "image/jpeg" ], { :cache_in_memory => true }
     end
 
     teardown do

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: attachments
 version: !ruby/object:Gem::Version 
-  hash: 5
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 13
-  version: 0.0.13
+  prerelease: 
+  version: 0.0.14
 platform: ruby
 authors: 
 - Rune Myrland
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-14 00:00:00 +02:00
+date: 2011-04-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,11 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 2
-        - 2
-        - 5
         version: 2.2.5
   type: :runtime
   version_requirements: *id001
@@ -42,11 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 1
-        - 1
         version: 2.1.1
   type: :runtime
   version_requirements: *id002
@@ -61,11 +46,11 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
+- attachments.gemspec
 - lib/attachments.rb
 - lib/attachments/extract.rb
 - lib/attachments/filemagic.rb
@@ -80,8 +65,8 @@ homepage: http://github.com/wrimle/attachments
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -89,26 +74,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Extract mail parts of specified mime types.
 test_files: 
-- test/test_attachments.rb
 - test/helper.rb
+- test/test_attachments.rb

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC