tinnef 0.1.0 → 0.1.1

data/.gitignore

@@ -1,21 +1,4 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.6
+  - 1.8.7
+  - 1.9.2
+before_script:
+  - "sudo apt-get install tnef -y"

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in tinnef.gemspec
+gemspec

data/{LICENSE → MIT-LICENSE}

@@ -1,4 +1,5 @@
-Copyright (c) 2009 Georg Ledermann
+Copyright (c) 2010-2011 Georg Ledermann
+based on the work of Peter Collingbourne
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,96 @@
+# tinnef
+
+[![Build Status](http://travis-ci.org/ledermann/tinnef.png)](http://travis-ci.org/ledermann/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](http://tnef.sourceforge.net).
+
+From [Wikipedia](http://en.wikipedia.org/wiki/Transport_Neutral_Encapsulation_Format): "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."
+
+
+## Requirements
+
+### Ruby
+
+Tested with Ruby 1.8.6, 1.8.7 and 1.9.2.
+
+### tnef
+
+The binary of tnef is required in a current version, 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 Homebrew, just do:
+
+    brew install tnef
+
+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 you 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
+
+    gem install tinnef
+
+## Usage
+
+The gem defines the class TNEF with a class method to convert a given winmail.dat file. Use it with a block 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?
+
+## 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 [alaveteli](https://github.com/sebbacon/alaveteli/blob/master/lib/tnef.rb) project.
+Thank you for sharing!
+
+Copyright (c) 2010-2011 Georg Ledermann. See MIT-LICENSE for details.

data/Rakefile

@@ -1,52 +1,15 @@
-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 'bundler/gem_tasks'
 
+require 'rake'
 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
 
+desc 'Default: run unit tests.'
 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
+desc 'Test the tinnef gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/tinnef.rb

@@ -1,26 +1,54 @@
 require 'tinnef/dir_patch'
 
 class TNEF
+  # = convert
+  #
+  # Extract the content of a winmail.dat file and 
+  # executes the given block for every single file in it
+  # 
+  # Parameters:
+  #   content => Content of the winmail.dat file
+  # 
+  #   Options hash with this keys:
+  #     :command 
+  #       Full path of the tnf binary to execute (defaults to 'tnf', so it has to be in the path)
+  #
+  # Example:
+  #   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
   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}"
+      file_names = extract(content, options.merge(:dir => dir))
+      file_names.each do |file_name|
+        File.open("#{dir}/#{file_name}", "r") do |file|
+          yield(file)
         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
+  
+  def self.extract(content, options={})
+    command = options[:command] || 'tnef'
+    dir = options[: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.delete_if { |file_name| File.directory?(file_name) }
   end
 end

data/lib/tinnef/version.rb

@@ -0,0 +1,3 @@
+module Tinnef
+  VERSION = "0.1.1"
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/tinnef'

data/test/tinnef_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class TestDir < Test::Unit::TestCase
+  def test_mktmpdir_path
+    dir = Dir.mktmpdir
+    
+    assert File.directory?(dir)
+    assert_equal true, File.directory?(dir)
+  end
+  
+  def test_mktmpdir_block
+    directory = ''
+    Dir.mktmpdir do |dir|
+      directory = dir
+    end
+
+    assert !File.directory?(directory)
+    assert_equal false, File.directory?(directory)
+  end
+end
+
+class TestTinnef < Test::Unit::TestCase
+  def setup
+    @content = File.new(File.dirname(__FILE__) + '/fixtures/quick-winmail.dat').read
+  end
+  
+  def test_file_names
+    files = []
+    TNEF.convert(@content) do |temp_file|
+      files << File.basename(temp_file.path)
+    end
+    
+    assert_equal %w(quick.doc quick.html quick.pdf quick.txt quick.xml), files
+  end
+  
+  def test_content
+    TNEF.convert(@content) do |temp_file|
+      if File.basename(temp_file.path) == 'quick.txt'
+        assert_match /The quick brown fox jumps over the lazy dog/, temp_file.read
+      end
+    end
+  end
+end

data/tinnef.gemspec

@@ -1,52 +1,23 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tinnef/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{tinnef}
-  s.version = "0.1.0"
+  s.name        = 'tinnef'
+  s.version     = Tinnef::VERSION
+  s.authors     = ["Georg Ledermann"]
+  s.email       = ["mail@georg-ledermann.de"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby wrapper for tnef, a tool for unpacking 'winmail.dat' files}
+  s.description = %q{Handling e-mail attachments with MIME type 'application/ms-tnef'}
 
-  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
+  s.rubyforge_project = "."
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'mocha'
 end
-

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tinnef
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Georg Ledermann
@@ -15,38 +15,66 @@ 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
+date: 2011-08-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Handling e-mail attachments with MIME type 'application/ms-tnef'
+email: 
+- mail@georg-ledermann.de
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .document
 - .gitignore
-- LICENSE
-- README.rdoc
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
 - Rakefile
-- VERSION
 - lib/tinnef.rb
 - lib/tinnef/dir_patch.rb
-- test/helper.rb
-- test/test_tinnef.rb
+- lib/tinnef/version.rb
+- test/fixtures/quick-winmail.dat
+- test/test_helper.rb
+- test/tinnef_test.rb
 - tinnef.gemspec
-has_rdoc: true
-homepage: http://github.com/ledermann/tinnef
+homepage: ""
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -69,11 +97,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: .
+rubygems_version: 1.8.6
 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
+- test/fixtures/quick-winmail.dat
+- test/test_helper.rb
+- test/tinnef_test.rb

data/README.rdoc

@@ -1,108 +0,0 @@
-= 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/VERSION

@@ -1 +0,0 @@
-0.1.0

data/test/helper.rb

@@ -1,9 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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