unpacker 0.1.0

data/.bnsignore

@@ -0,0 +1,16 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   PROJ.ignore_file = '.gitignore'
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/.document

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

data/.gitignore

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

data/History.txt

@@ -0,0 +1,8 @@
+== 1.0.1 / 2009-06-10
+
+* Moved to RSpec, ported some fixes and enhancements from unpacked instance.
+* Removed rar call in favor of unrar.
+
+== 1.0.0 / 2009-04-20
+
+* Birthday!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Petyo Ivanov
+
+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,62 @@
+= unpacker
+
+== DESCRIPTION
+
+Small library for unpacking various archives, extracted from Beanstalk (http://beanstalkapp.com) (and rewritten, in fact).
+
+== FEATURES/PROBLEMS
+
+None so far. Won't run on Windows, haven't tested.
+
+== SAMPLE USAGE
+
+To test archives do:
+
+    Unpacker.valid? 'path/to/file.zip'
+
+The method optionally accepts second argument, file name (if it is different than the file path). Handy if you test temp uploaded files.
+
+To extract files do:
+
+    Unpacker.unpack('path/to/myfile.zip') do |directory_that_contains_extracted_files|
+
+    end
+
+To recognize archives do:
+
+    Unpacker.archive? 'path/to/archive.txt'
+
+In case the archive is not supported (currently working with zip, bzip, gzip, tar and rar) you may get UnrecognizedArchiveError in both methods.
+
+The gem takes care to remove any temporary extractings after the block is executed; (uses /tmp/ directory).
+
+When working with .gz files (single archive), the extracted file is always called **gz-contents**.
+
+== REQUIREMENTS
+
+Relies on system calls, so you should have
+- unzip
+- unrar
+- tar
+- gunzip
+- bunzip
+
+In path.
+
+== INSTALL
+
+    sudo gem install unpacker
+
+== 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 Petyo Ivanov. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "unpacker"
+    gem.summary = %Q{Abstraction for extracting various archives }
+    gem.description = %Q{The tool relies on the presence of the command-line tools.}
+    gem.email = "underlog@gmail.com"
+    gem.homepage = "http://github.com/underlog/unpacker"
+    gem.authors = ["Petyo Ivanov"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "unpacker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/bin/unpacker

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib unpacker]))
+
+# Put your code here
+
+# EOF

data/lib/unpacker.rb

@@ -0,0 +1,105 @@
+require 'fileutils'
+require 'tmpdir'
+
+module Unpacker
+
+  class UnrecognizedArchiveError < StandardError; end
+  class UnpackedFailedError < StandardError; end
+
+  SUPPORTED_FILEEXTS = %w[tar rar zip gz bz tgz bgz tar]
+
+  def self.unpack(file, tmpdir = "/tmp", &block) 
+    Dir.mktmpdir 'unpacker' do |dir|
+      cmd = command_by_file_ext(file)% [file, dir]
+      system("#{cmd} 1>/dev/null") or raise UnrecognizedArchiveError($?)
+      block.call(Dir.new(dir))
+    end
+  end
+
+  def self.archive?(file_name)
+    SUPPORTED_FILEEXTS.include? File.extname(file_name).sub('.', '')
+  end
+
+  def self.valid?(file_path, file_name = file_path)
+    cmd = test_cmd_by_file_ext(file_name)% file_path
+    system("#{cmd} 1>/dev/null 2>/dev/null")
+  end
+
+  # :stopdoc:
+  VERSION = '1.0.1'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+  private
+
+  def self.test_cmd_by_file_ext(file_name)
+    case file_name
+    when /rar$/
+      'unrar t "%s"'
+    when /(tar|tar\.bz|tbz)$/
+      'tar tf "%s"'
+    when /zip$/
+      'zip -T "%s"'
+    when /gz|tgz$/
+      'gunzip -t "%s"'
+    else
+      raise UnrecognizedArchiveError
+    end
+  end
+
+  def self.command_by_file_ext(file_name)
+    case file_name
+    when /rar$/
+      'unrar x -y "%s" "%s"'
+    when /(tar|tgz|tar\.gz|tar\.bz|tbz)$/
+      'tar xf "%s" --directory "%s"'
+    when /zip$/
+      'unzip "%s" -d "%s"'
+    when /gz$/
+      '(gunzip -c "%s" > "%s/gz-contents")'
+    else
+      raise UnrecognizedArchiveError
+    end
+  end
+
+end  # module Unpacker
+
+Unpacker.require_all_libs_relative_to(__FILE__)
+
+# EOF

data/spec/fixtures/archive-contents/sample-file

@@ -0,0 +1 @@
+a

data/spec/fixtures/invalid-file.rar

@@ -0,0 +1,116 @@
+ Cras eget augue. 
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. 
+ Duis congue urna ac lectus. 
+ Fusce arcu est, sodales nec, convallis sit amet, ultricies sed, ante. 
+ In cursus odio. 
+ Duis congue urna ac lectus. 
+ Donec condimentum velit eget sapien. 
+ Vestibulum porttitor, enim nec commodo lacinia, nibh orci pulvinar lorem, sit amet rutrum massa ante laoreet mi. 
+ In cursus odio. 
+ Praesent in tortor sed purus ornare pellentesque. 
+ Vivamus mattis nisi sed ipsum. 
+ Curabitur bibendum tincidunt lorem. 
+ In risus nisl, vulputate eget, tristique vitae, aliquet eu, ipsum. 
+ Curabitur bibendum tincidunt lorem. 
+ Curabitur tortor. 
+ Donec condimentum velit eget sapien. 
+ Curabitur tortor. 
+ In id mi. 
+ Curabitur tortor. 
+ Donec condimentum velit eget sapien. 
+ Duis a turpis. 
+ Curabitur tortor. 
+
+
+Mauris tempus velit ut metus. 
+ Fusce libero magna, mattis vel, porttitor vitae, ornare et, metus. 
+ Pellentesque orci. 
+ Maecenas blandit neque. 
+ In cursus odio. 
+ Duis laoreet egestas nibh. 
+ Nulla adipiscing, libero quis faucibus interdum, lacus enim viverra purus, quis feugiat magna justo sed lorem. 
+ Fusce libero magna, mattis vel, porttitor vitae, ornare et, metus. 
+ Phasellus purus dolor, tempor non, tristique sit amet, porttitor porta, velit. 
+ Sed faucibus tempus eros. 
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. 
+ Duis laoreet egestas nibh. 
+ Maecenas quis nulla eget nunc volutpat hendrerit. 
+ Etiam velit. 
+ Integer dignissim augue at velit. 
+ In id mi. 
+ Donec velit diam, laoreet gravida, pretium ac, tristique quis, lacus. 
+ Suspendisse eleifend pretium massa. 
+ Maecenas quis nulla eget nunc volutpat hendrerit. 
+ In id mi. 
+ Cras pulvinar. 
+ Vestibulum at tellus sed augue rutrum dictum. 
+ Cras eget augue. 
+ Donec rhoncus. 
+ Fusce libero magna, mattis vel, porttitor vitae, ornare et, metus. 
+ Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. 
+ Duis congue urna ac lectus. 
+ Nunc ut purus. 
+ Nunc ut purus. 
+ Proin sit amet augue ut arcu accumsan mollis. 
+ Quisque eros felis, lacinia non, tempus et, vehicula eu, sem. 
+ Donec condimentum velit eget sapien. 
+ Fusce libero magna, mattis vel, porttitor vitae, ornare et, metus. 
+ Fusce gravida. 
+
+
+Mauris tempus velit ut metus. 
+ Donec condimentum velit eget sapien. 
+ In risus nisl, vulputate eget, tristique vitae, aliquet eu, ipsum. 
+ Vestibulum porttitor, enim nec commodo lacinia, nibh orci pulvinar lorem, sit amet rutrum massa ante laoreet mi. 
+ Praesent in tortor sed purus ornare pellentesque. 
+
+
+Mauris tempus velit ut metus. 
+ Praesent vestibulum, arcu et semper fringilla, magna urna sodales lacus, vel aliquet turpis tortor ac libero. 
+ Ut commodo, nisl a lobortis dictum, quam nisi pharetra dolor, quis ullamcorper orci tortor posuere felis. 
+ Maecenas et lorem. 
+ Cras felis eros, placerat eget, adipiscing vitae, sodales quis, dolor. 
+ Cras eget augue. 
+ Etiam et neque. 
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. 
+ Praesent vel erat at mi vehicula elementum. 
+ Vivamus tincidunt felis ut libero. 
+ In vestibulum mauris eu sapien. 
+ Vivamus tincidunt felis ut libero. 
+ Maecenas blandit neque. 
+ Duis a turpis. 
+ Phasellus est quam, faucibus vitae, euismod feugiat, ultrices et, quam. 
+ Donec consectetur, ante in volutpat tristique, nulla metus ornare urna, vestibulum ullamcorper dui nulla fringilla eros. 
+ Cras a ligula at diam malesuada tincidunt. 
+ Vestibulum porttitor, enim nec commodo lacinia, nibh orci pulvinar lorem, sit amet rutrum massa ante laoreet mi. 
+ Vivamus varius dui ac leo. 
+ Etiam et neque. 
+ Duis a turpis. 
+ Pellentesque orci. 
+ Donec condimentum velit eget sapien. 
+ Vivamus dui orci, volutpat ac, blandit id, commodo quis, massa. 
+ Suspendisse in sem at enim laoreet placerat. 
+ Mauris dapibus nulla vitae tellus. 
+ Nunc ut purus. 
+
+
+Etiam elementum. 
+ Suspendisse eleifend pretium massa. 
+ Nullam quis nulla. 
+ Etiam velit. 
+ Praesent vel erat at mi vehicula elementum. 
+ In dapibus augue quis leo. 
+ Nulla adipiscing, libero quis faucibus interdum, lacus enim viverra purus, quis feugiat magna justo sed lorem. 
+ Curabitur bibendum tincidunt lorem. 
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. 
+ Donec cursus, velit vel mollis ultrices, augue dui ornare ipsum, at ultricies mi leo in tellus. 
+ Duis placerat purus sed dui. 
+ Curabitur tortor. 

data/spec/matchers/unpacked_correctly.rb

@@ -0,0 +1,15 @@
+Spec::Matchers.define :be_unpacked_correctly_to do |contents|
+  match do |file, matcher|
+    Unpacker.unpack(file) do |result|
+      result.entries.include?(contents)
+    end
+  end
+
+  failure_message_for_should do |file|
+    "#{file} was not unpacked"
+  end
+
+  description do
+    "expects to unpack a file"
+  end
+end

data/spec/matchers/valid_archive.rb

@@ -0,0 +1,17 @@
+Spec::Matchers.define :be_valid_archive do
+  match do |file|
+    Unpacker.valid?(file) 
+  end
+
+  failure_message_for_should do |file|
+    "#{file} not recognized as valid archive"
+  end
+
+  failure_message_for_should_not do |file|
+    "#{file} wrongly recognized as valid archive"
+  end
+
+  description do
+    "expected a valid archive file"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format specdoc
+--loadby mtime
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'unpacker'
+require 'spec'
+require 'spec/autorun'
+
+Dir[ File.join(File.dirname(__FILE__), 'matchers/*') ].each do |matcher|
+  require matcher
+end
+
+Spec::Runner.configure do |config|
+
+end
+

data/spec/unpacker_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Unpacker do
+
+  %w[file.rar file.tar file.tar.gz file.tgz file.tar.bz file.tbz file.zip].each do |file|
+    it "should unpack #{file}" do
+      fixture_archive(file).should be_unpacked_correctly_to('archive-contents')
+    end
+
+    it "should recognize #{file} as valid archive" do
+      fixture_archive(file).should be_valid_archive
+    end
+  end
+
+  %w[invalid-file.rar invalid-file.tar.gz invalid-file.zip invalid-file.gz].each do |file|
+    it "should recognize #{file} as invalid archive" do
+      fixture_archive(file).should_not be_valid_archive
+    end
+  end
+
+  it "should extract gz" do
+    fixture_archive('lipsum.txt.gz').should be_unpacked_correctly_to('gz-contents')
+  end
+
+  it "should recognize archive" do
+    Unpacker.archive?(fixture_archive('test.tgz')).should be_true
+  end
+
+  it "should recognize other files as non-archives" do
+    Unpacker.archive?(fixture_archive('test.txt')).should be_false
+  end
+
+  def fixture_archive(file)
+    File.join("spec", "fixtures", file)
+  end
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: unpacker
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Petyo Ivanov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-02 00:00:00 +03:00
+default_executable: unpacker
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: The tool relies on the presence of the command-line tools.
+email: underlog@gmail.com
+executables: 
+- unpacker
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .bnsignore
+- .document
+- .gitignore
+- History.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/unpacker
+- lib/unpacker.rb
+- spec/fixtures/archive-contents/sample-file
+- spec/fixtures/file.rar
+- spec/fixtures/file.tar
+- spec/fixtures/file.tar.bz
+- spec/fixtures/file.tar.gz
+- spec/fixtures/file.tbz
+- spec/fixtures/file.tgz
+- spec/fixtures/file.zip
+- spec/fixtures/invalid-file.gz
+- spec/fixtures/invalid-file.rar
+- spec/fixtures/invalid-file.tar.gz
+- spec/fixtures/invalid-file.zip
+- spec/fixtures/lipsum.txt.gz
+- spec/matchers/unpacked_correctly.rb
+- spec/matchers/valid_archive.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/unpacker_spec.rb
+- test/test_unpacker.rb
+has_rdoc: true
+homepage: http://github.com/underlog/unpacker
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Abstraction for extracting various archives
+test_files: 
+- spec/matchers/unpacked_correctly.rb
+- spec/matchers/valid_archive.rb
+- spec/spec_helper.rb
+- spec/unpacker_spec.rb
+- test/test_unpacker.rb