underlog-unpacker 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2009-04-20
+
+* 1 major enhancement
+  * Birthday!

data/README.markdown

@@ -0,0 +1,66 @@
+# unpacker
+    by Petyo Ivanov
+
+## 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'
+
+To extract files do:
+
+    Unpacker.unpack('path/to/myfile.zip') do |directory_that_contains_extracted_files|
+      
+    end
+
+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 underlog-unpacker`
+
+## LICENSE
+
+(The MIT License)
+
+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/Rakefile

@@ -0,0 +1,48 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rcov/rcovtask'
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'unpacker'
+
+task :default => :test
+
+desc 'Test the unpacker gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Performs code coverage on the unpacker gem.'
+Rcov::RcovTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+PROJ.name = 'unpacker'
+PROJ.authors = 'Petyo Ivanov'
+PROJ.email = 'underlog@gmail.com'
+PROJ.url = 'http://github.com/underlog/unpacker'
+PROJ.version = Unpacker::VERSION
+PROJ.rubyforge.name = 'unpacker'
+
+PROJ.spec.opts << '--color'
+
+# EOF

data/lib/unpacker.rb

@@ -0,0 +1,103 @@
+require 'fileutils'
+require 'tmpdir'
+require 'digest/sha1'
+
+module Unpacker
+
+  class UnrecognizedArchiveError < StandardError; end
+  class UnpackedFailedError < StandardError; end
+
+
+  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.valid?(file)
+    cmd = test_cmd_by_file_ext(file)% file
+    system("#{cmd} 1>/dev/null 2>/dev/null")
+  rescue UnrecognizedArchiveError
+    false
+  end
+
+  # :stopdoc:
+  VERSION = '1.0.0'
+  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$/
+      'rar t "%s"'
+    when /(tar|tgz|tar\.gz|tar\.bz|tbz)$/
+      'tar tf "%s"'
+    when /zip$/
+      'zip -T "%s"'
+    when /gz$/
+      '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/test/fixtures/archive-contents/sample-file

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

data/test/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/test/test_helper.rb

@@ -0,0 +1,14 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+$: << File.join(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'test/unit'
+require 'unpacker'
+
+class Test::Unit::TestCase
+
+  def fixture_archive(file)
+    File.join("test", "fixtures", file)
+  end
+
+end

data/test/unpacker_test.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class UnpackerTest < Test::Unit::TestCase
+
+  def test_extracting_files()
+    files.each do |target|
+      file = fixture_archive(target)
+      Unpacker.unpack(file) do |result|
+        assert result.entries.include?('archive-contents'), "#{target} was not extracted properly - entries contained #{result.entries.inspect}"
+      end
+    end
+  end
+
+  def test_extracting_gz
+    Unpacker.unpack(fixture_archive('lipsum.txt.gz')) do |result|
+      assert result.entries.include?('gz-contents'), "gz extracting did not work"
+    end
+  end
+
+  def test_valid_files
+    (files + ['lipsum.txt.gz']).each do |file|
+      assert Unpacker.valid? fixture_archive(file)
+    end
+  end
+
+  def test_invalid_files
+    invalid_files.each do |file|
+      assert ! Unpacker.valid?(fixture_archive(file))
+    end
+  end
+
+  private 
+
+  def files
+    %w[file.rar file.tar file.tar.gz file.tgz file.tar.bz file.tbz file.zip]
+  end
+
+  def invalid_files
+    %w[invalid-file.gz invalid-file.rar invalid-file.tar.gz invalid-file.zip]
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: underlog-unpacker
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Petyo Ivanov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.4.2
+    version: 
+description: Small library for unpacking various archives, extracted from Beanstalk (http://beanstalkapp.com) (and rewritten, in fact).
+email: underlog@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.markdown
+files: 
+- History.txt
+- README.markdown
+- Rakefile
+- lib/unpacker.rb
+- test/fixtures/archive-contents/sample-file
+- test/fixtures/file.rar
+- test/fixtures/file.tar
+- test/fixtures/file.tar.bz
+- test/fixtures/file.tar.gz
+- test/fixtures/file.tbz
+- test/fixtures/file.tgz
+- test/fixtures/file.zip
+- test/fixtures/invalid-file.gz
+- test/fixtures/invalid-file.rar
+- test/fixtures/invalid-file.tar.gz
+- test/fixtures/invalid-file.zip
+- test/fixtures/lipsum.txt.gz
+- test/test_helper.rb
+- test/unpacker_test.rb
+has_rdoc: true
+homepage: http://github.com/underlog/unpacker
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: unpacker
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Small library for unpacking various archives, extracted from Beanstalk (http://beanstalkapp
+test_files: 
+- test/test_helper.rb