tinnef 0.0.1

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 Georg Ledermann
+
+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,108 @@
+= tinnef
+
+This gem handles e-mail attachments packaged in the Microsoft "application/ms-tnef" MIME type. It's a Ruby wrapper for the 'tnef' converter from http://tnef.sourceforge.net/
+
+From Wikipedia: "Transport Neutral Encapsulation Format or TNEF is, despite the name, a proprietary E-mail attachment format used by Microsoft Outlook and Microsoft Exchange Server. An attached file with TNEF encoding is most often named winmail.dat or win.dat, and has a MIME type of Application/MS-TNEF."
+http://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format
+
+
+== Requirements
+
+=== Ruby
+
+Ruby 1.8.6 or 1.8.7 is required. It's not tested with 1.9.
+
+=== tnef
+
+The binary of tnef in a recent version is required, 1.4.6 is ok. Check if this tool already exists on your machine:
+
+    tnef --version
+    
+It doesn't exist? You can install it:
+
+==== Mac OS X
+
+Using MacPorts, just do:
+
+    sudo ports install tnef
+    
+==== Linux
+
+There are chances that this will work:
+
+    apt-get install tnef
+    
+Beware: On older Linux distribution, you will get a too old version of tnef, which does not work (e.g. 1.4.3 in Ubuntu hardy), so have to compile it by yourself. It's easy:
+
+  wget http://sourceforge.net/projects/tnef/files/tnef/v1.4.7/tnef-1.4.7.tar.gz/download
+  tar -xzvf tnef-1.4.7.tar.gz
+  cd tnef-1.4.7
+  ./configure
+  make
+  make check
+  make install
+
+==== Windows
+
+What? I don't think this gem will work on Windows.
+
+
+== Installation
+
+In Rails, add this to your environment.rb:
+
+    config.gem 'tinnef'
+    
+Then run
+
+    rake gems:install
+
+or
+
+    gem install tinnef
+
+== Usage
+
+The gem defines the class TNEF with just one class method to converta given winmail.dat file. Use it like in the following example:
+
+    require 'rubygems'
+    require 'tinnef'
+
+    content = File.new('winmail.dat').read
+    TNEF.convert(content, :command => '/opt/local/bin/tnef') do |temp_file|
+      unpacked_content = temp_file.read
+      unpacked_filename = File.basename(temp_file.path)
+  
+      File.open("/some/path/#{unpacked_filename}", 'w') do |new_file| 
+        new_file.write(unpacked_content)
+      end
+    end
+
+
+== About the naming of this gem
+
+"Tinnef" is a german slang word for "rubbish" or "trash". TNEF => TiNnEF => Tinnef - you know?
+
+
+== TODO
+
+* Add some tests
+
+
+== 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
+
+This code is based on the work by Peter Collingbourne, published as part of the project "whatdotheyknow":
+http://github.com/mysociety/whatdotheyknow/blob/master/lib/tnef.rb
+Thank you for sharing!
+
+Copyright (c) 2010 Georg Ledermann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tinnef"
+    gem.summary = %Q{Ruby wrapper for tnef, a tool for unpacking 'winmail.dat' files}
+    gem.description = %Q{Handling e-mail attachments coming with MIME type 'application/ms-tnef' }
+    gem.email = "ledermann@dipl-wirt-inf.de"
+    gem.homepage = "http://github.com/ledermann/tinnef"
+    gem.authors = ["Georg Ledermann"]
+    # 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 = "tinnef #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/tinnef.rb

@@ -0,0 +1,26 @@
+require 'tinnef/dir_patch'
+
+class TNEF
+  def self.convert(content, options={}, &block)
+    command = options[:command] || 'tnef'
+    
+    Dir.mktmpdir do |dir|
+      IO.popen("#{command} -K -C #{dir}", "w") do |f|
+        f.write(content)
+        f.close
+        if $?.signaled?
+          raise IOError, "tnef exited with signal #{$?.termsig}"
+        end
+        if $?.exited? && $?.exitstatus != 0
+          raise IOError, "tnef exited with status #{$?.exitstatus}"
+        end
+      end
+      Dir.new(dir).sort.each do |file_name| # sort for deterministic behaviour
+        if file_name != "." && file_name != ".."
+          file = File.open("#{dir}/#{file_name}", "r")
+          block.call(file)
+        end
+      end
+    end
+  end
+end

data/lib/tinnef/dir_patch.rb

@@ -0,0 +1,49 @@
+require 'dir'
+require 'tmpdir'
+
+#
+# Dir.mktmpdir is missing in Ruby 1.8.6 patchlevel 111, so monkeypatch it from
+# http://www.ruby-doc.org/core-1.9/classes/Dir.src/M002362.html
+#
+unless Dir.respond_to?(:mktmpdir)
+  class Dir
+    def self.mktmpdir(prefix_suffix=nil, tmpdir=nil)
+      case prefix_suffix
+      when nil
+        prefix = "d"
+        suffix = ""
+      when String
+        prefix = prefix_suffix
+        suffix = ""
+      when Array
+        prefix = prefix_suffix[0]
+        suffix = prefix_suffix[1]
+      else
+        raise ArgumentError, "unexpected prefix_suffix: #{prefix_suffix.inspect}"
+      end
+      tmpdir ||= Dir.tmpdir
+      t = Time.now.strftime("%Y%m%d")
+      n = nil
+      begin
+        path = "#{tmpdir}/#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+        path << "-#{n}" if n
+        path << suffix
+        Dir.mkdir(path, 0700)
+      rescue Errno::EEXIST
+        n ||= 0
+        n += 1
+        retry
+      end
+
+      if block_given?
+        begin
+          yield path
+        ensure
+          FileUtils.remove_entry_secure path
+        end
+      else
+        path
+      end
+    end
+  end
+end

data/test/helper.rb

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

data/test/test_tinnef.rb

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

data/tinnef.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tinnef}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Georg Ledermann"]
+  s.date = %q{2010-05-18}
+  s.description = %q{Handling e-mail attachments coming with MIME type 'application/ms-tnef' }
+  s.email = %q{ledermann@dipl-wirt-inf.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/tinnef.rb",
+     "lib/tinnef/dir_patch.rb",
+     "test/helper.rb",
+     "test/test_tinnef.rb",
+     "tinnef.gemspec"
+  ]
+  s.homepage = %q{http://github.com/ledermann/tinnef}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby wrapper for tnef, a tool for unpacking 'winmail.dat' files}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_tinnef.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: tinnef
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Georg Ledermann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-18 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "Handling e-mail attachments coming with MIME type 'application/ms-tnef' "
+email: ledermann@dipl-wirt-inf.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tinnef.rb
+- lib/tinnef/dir_patch.rb
+- test/helper.rb
+- test/test_tinnef.rb
+- tinnef.gemspec
+has_rdoc: true
+homepage: http://github.com/ledermann/tinnef
+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: Ruby wrapper for tnef, a tool for unpacking 'winmail.dat' files
+test_files: 
+- test/helper.rb
+- test/test_tinnef.rb