unzipMe 1.0.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.8.0"
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+  #gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    rake (10.0.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (~> 1.8.4)
+  rdoc (>= 3.12)
+  rspec (>= 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kendra Lawlor
+
+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,40 @@
+= unzipMe
+
+If your application is attempting to handle extracting Zip files with the system unzip command but has failures AND
+they can be unzipped by alternative means, this provides the 7zip failover as a second-in-line attempt at extraction.
+
+== UnzipmeUnzipper
+
+set instance to UnzipmeUnzipper.new(path_and_filename, {:extract_to => path}).
+The second parameter is an optional hash with the :extract_to key.  This is used if you want to extract the files to a different directory.
+
+.new -> will validate the file being passed in, and if not readable through either unzip or 7za wil raise an UnzipmeException.
+
+call instance.unzip -> this will extract the files.
+call instance.file_list -> this will return a clean array of filenames within the zip archive with the header and trailer information removed.
+
+==UnzipmeValidator
+
+(The files are validated when initializing UnzipmeUnzipper, but this can be called just for testing the archive)
+
+set instance to UnzipmeValidator.new(path_and_filename).  This will test the archive but not return an exception if not valid.
+instance.valid_zip? -> returns true if readable by either unzip or 7zip.
+instance.command -> will return which command (unzip or 7ip that will be able to extract the file).
+instance.error_message -> will return a reable message that lists the system error message (determined by the exit code) for both unzip and 7za.
+
+
+== Contributing to unzipMe
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Kendra Lawlor. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "unzipMe"
+  gem.homepage = "http://github.com/kendra/unzipMe"
+  gem.license = "MIT"
+  gem.summary = %Q{using system unzip command and then 7zip as failover}
+  gem.description = %Q{using system unzip command and then 7zip as failover}
+  gem.email = "lawlorkendra@gmail.com"
+  gem.authors = ["Kendra Lawlor"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "unzipMe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/unzipMe.rb

@@ -0,0 +1,3 @@
+require 'unzip_me/unzipme_unzipper'
+require 'unzip_me/unzipme_exception'
+require 'unzip_me/unzipme_validator'

data/lib/unzip_me/unzipme_exception.rb

@@ -0,0 +1,3 @@
+class UnzipmeException < StandardError
+
+end

data/lib/unzip_me/unzipme_unzipper.rb

@@ -0,0 +1,54 @@
+
+class UnzipmeUnzipper
+
+  def initialize(file, args={})
+    validate_file(file)
+    @args = args
+    @file = file
+  end
+
+  def unzip
+    run_system_unzip if @command == UnzipmeValidator::COMMAND_UNZIP
+    run_system_7zip if @command == UnzipmeValidator::COMMAND_7ZIP
+  end
+
+  def file_list
+    files = []
+
+    listing_lines = IO.popen("unzip -l '#{@file}' 2>/dev/null") { |f| f.readlines } if @command == UnzipmeValidator::COMMAND_UNZIP
+    listing_lines = IO.popen("7za l '#{@file}' 2>/dev/null") {|f| f.readlines} if @command == UnzipmeValidator::COMMAND_7ZIP
+
+    listing_lines[0..-3].each_with_index do |line, idx| # The slice means ignore the last 3 lines of the list (just trailer information)
+      next if idx < 3 # Skip the first three lines; just header information
+      files << line.rstrip[27 + 1..-1] # The file name is the last column in the listing.
+    end
+    files
+  end
+
+  private
+
+  def validate_file(file)
+    zip_validator = UnzipmeValidator.new(file)
+    raise(UnzipmeException, "#{zip_validator.error_message}") unless zip_validator.valid_zip?
+    @command = zip_validator.command
+  end
+
+  def run_system_unzip
+    if @args.has_key?(:extract_to)
+      system("unzip -d \"#{@args[:extract_to]}\" \"#{@file}\" > /dev/null")
+    else
+      system("unzip \"#{@file}\" > /dev/null")
+    end
+    $?.exitstatus
+  end
+
+  def run_system_7zip
+    if @args.has_key?(:extract_to)
+      system("7za x \"#{@file}\" -o\"#{@args[:extract_to]}\" > /dev/null")
+    else
+      system("7za x \"#{@file}\" > /dev/null")
+    end
+    $?.exitstatus
+  end
+
+end

data/lib/unzip_me/unzipme_validator.rb

@@ -0,0 +1,77 @@
+class UnzipmeValidator
+
+  SUCCESS = 0
+  COMMAND_UNZIP = 0
+  COMMAND_7ZIP = 1
+
+  def initialize(file)
+    raise(ArgumentError, "You must provide a file.") unless file
+    @file = file
+    test_quietly
+  end
+
+  def valid_zip?
+    @unzip_status == SUCCESS || @sevenzip_status == SUCCESS
+  end
+
+  def command
+    return COMMAND_UNZIP if @unzip_status == SUCCESS
+    return COMMAND_7ZIP if @sevenzip_status == SUCCESS
+  end
+
+  def error_message
+    "Unzip error: #{unzip_error(@unzip_status)}, 7zip error: #{seven_zip_error(@sevenzip_status)}"
+  end
+
+  private
+
+  def test_quietly()
+    @unzip_status = test_with_system_unzip
+    @sevenzip_status = test_with_system_7zip
+  end
+
+  def test_with_system_unzip
+    system "unzip -P '' -tq '#{@file}' > /dev/null 2>&1"
+    $?.exitstatus
+  end
+
+  def test_with_system_7zip
+    system("7za t \"#{@file}\" > /dev/null")
+    $?.exitstatus
+  end
+
+  def unzip_error(exit_code)
+    case exit_code
+      when 1 then "one or more warning errors were encountered."
+      when 2 then "a generic error in the zipfile format was detected."
+      when 3 then "a severe error in the zipfile format was detected."
+      when 4 then "unzip was unable to allocate memory for one or more buffers during program initialization."
+      when 5 then "unzip was unable to allocate memory or unable to obtain a tty to read the decryption password(s)."
+      when 6 then "unzip was unable to allocate memory during decompression to disk."
+      when 7 then "unzip was unable to allocate memory during in-memory decompression."
+      when 9 then "the specified zipfiles were not found."
+      when 10 then "invalid options were specified on the command line."
+      when 11 then "no matching files were found."
+      when 50 then "the disk is (or was) full during extraction"
+      when 51 then "the end of the ZIP archive was encountered prematurely."
+      when 80 then "the user aborted unzip prematurely with control-C (or similar)"
+      when 81 then "testing or extraction of one or more files failed due to unsupported compression methods or unsupported decryption."
+      when 82 then "no files were found due to bad decryption password(s)."
+      else ""
+    end
+  end
+
+  def seven_zip_error(exit_code)
+    case exit_code
+      when 1 then "Warning (Non fatal error(s))."
+      when 2 then "Fatal error."
+      when 7 then "Command line error."
+      when 8 then "Not enough memory for operation."
+      when 255 then "User stopped the process."
+      else ""
+    end
+  end
+
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'unzipMe'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/unzipme_unzipper_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe UnzipmeUnzipper do
+
+  it "raises an exception unless a file is provided" do
+    expect {UnzipmeUnzipper.new(nil)}.to raise_error(ArgumentError, "You must provide a file.")
+  end
+
+
+  private
+
+  def mock_file
+    mock(File)
+  end
+
+  def mock_directory
+    mock(Dir)
+  end
+
+
+end

data/spec/unzipme_validator_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe UnzipmeValidator do
+
+  it "should raise an ArgumentError if initialized with nil" do
+    expect {UnzipmeValidator.new(nil)}.to raise_error(ArgumentError, "You must provide a file.")
+  end
+
+
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: unzipMe
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Kendra Lawlor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.8.4
+  type: :development
+  version_requirements: *id004
+description: using system unzip command and then 7zip as failover
+email: lawlorkendra@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/unzipMe.rb
+- lib/unzip_me/unzipme_exception.rb
+- lib/unzip_me/unzipme_unzipper.rb
+- lib/unzip_me/unzipme_validator.rb
+- spec/spec_helper.rb
+- spec/unzipme_unzipper_spec.rb
+- spec/unzipme_validator_spec.rb
+homepage: http://github.com/kendra/unzipMe
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: using system unzip command and then 7zip as failover
+test_files: []
+