attachments 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rune Myrland
+
+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.rdoc

@@ -0,0 +1,71 @@
+= attachments
+
+Extract mail parts of specified mime types.
+
+== DESCRIPTION
+
+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.
+
+== FEATURES/PROBLEMS:
+
+Is the /tmp directory and the 'file' shell command on your OS? If not 
+some porting work is needed.
+
+== REQUIREMENTS:
+
+Typedown is presently using the mail and uuidtools ruby gems.
+It uses the 'file' shell command from filemagic to decide mime types
+when they are uncertain.
+
+
+== SYNOPSIS:
+
+    require 'rubygems'
+    require 'attachments'
+
+
+    # Which mime types do you want to accept?
+    extract = Attachments::Extract.new [ "text/plain" ]
+
+    # I make postfix save incoming mails in MailDir, 
+    # then glob that directory
+    INCOMING_MAIL_DIR = "/your/MailDir"
+    mailfiles = Dir.glob(INCOMING_MAIL_DIR + "/*")
+
+    # Process the mails
+    mailfiles.each do |m|
+        # Open mail stored in filename
+        extract.parse m
+        # Traverse through the extracted attachments
+	extract.files.each do |f|
+	    # Do something with the attachments
+	    puts f.inspect
+	    case f[:mime_type]
+            when "text/plain" then
+                puts File.read(f[:tmpfile])
+	    end
+        end
+	# Remove tmp files and prepare for new parsing action
+	extract.close
+
+	# Probably you want to delete or move the processed email
+	# to an archive here
+	# FileUtils::rm(m)
+    end
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Rune Myrland. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "attachments"
+    gem.summary = %Q{Extract mail parts of specified mime types.}
+    gem.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.}
+    gem.email = "rune@epubify.com"
+    gem.homepage = "http://github.com/wrimle/attachments"
+    gem.authors = ["Rune Myrland"]
+    gem.add_dependency('mail','>= 2.2.5')
+    gem.add_dependency('uuidtools','>= 2.1.1')
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "attachments #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/attachments/extract.rb

@@ -0,0 +1,121 @@
+require 'rubygems'
+require 'uuidtools'
+require 'mail'
+
+
+module Attachments
+  module Error
+    class Base < StandardError; end
+    class SaveFailed < Base; end
+  end
+
+
+  # Extract attachments of specific types from emails and save them in files
+  class Extract
+    UNCERTAIN_TYPES = [ "application/octet-stream" ].to_set
+
+    def initialize include_types = [ "text/plain" ]
+      @include_types = include_types
+      reset
+    end
+
+    def close
+      files.each do |f|
+        FileUtils::rm(f[:filename])
+      end
+      reset
+    end
+
+    def parse filename
+      @last_parsed = filename
+
+      # Load the email
+      mail = Mail.read(filename)
+
+      # To and from is important when sending mail to db
+      @to = mail.to
+
+      @from = mail.from
+
+      # Parse parts recursively until it is not multipart
+      # Ignore types that are not suited for forwarding
+      parse_part mail
+    end
+
+    def to 
+      @to || nil
+    end
+
+    def from
+      @from || nil
+    end
+
+    def name
+      @name
+    end
+
+    def files
+      @files
+    end
+
+    def last_parsed
+      @last_parsed
+    end
+
+
+    private
+    # Use close
+    def reset
+      @last_parsed = nil
+      @to = nil
+      @name = nil
+      @from = nil
+      @files = []
+    end
+
+    def parse_part mail
+      # Filter parts with a type that is not of interest
+      ct = mail.content_type.split(/;/, 2)[0] if mail.content_type
+      unless(mail.multipart? || (ct && @include_types.include?(ct)))
+        return
+      end
+
+      # If part is multipart, recurse
+      if mail.multipart?
+        mail.parts.each do |p|
+          parse_part p
+        end
+      else
+        # Grab filename from content parameters, and make sure its sane
+        @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}" 
+
+        # Save part as it is of a supported type
+        f = File.new(filepath, "wb")
+        f.write(mail.body.decoded)
+        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, :from => @from, :to => @to }
+      end
+    end
+  end
+end

data/lib/attachments/filemagic.rb

@@ -0,0 +1,6 @@
+
+class FileMagic
+  def self.mime filename
+    mime_type = `file --brief --mime-type #{filename}`.strip()
+  end
+end

data/lib/attachments.rb

@@ -0,0 +1,2 @@
+require 'attachments/extract.rb'
+require 'attachments/filemagic.rb'

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'attachments'
+
+class Test::Unit::TestCase
+end

data/test/test_attachments.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAttachments < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: attachments
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Rune Myrland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 2
+        - 5
+        version: 2.2.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id002
+description: 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.
+email: rune@epubify.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/attachments.rb
+- lib/attachments/extract.rb
+- lib/attachments/filemagic.rb
+- test/helper.rb
+- test/test_attachments.rb
+has_rdoc: true
+homepage: http://github.com/wrimle/attachments
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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
+signing_key: 
+specification_version: 3
+summary: Extract mail parts of specified mime types.
+test_files: 
+- test/test_attachments.rb
+- test/helper.rb