pinch 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Peter Hellberg
+
+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,48 @@
+= Pinch
+
+Retrieve a file from inside a zip file, over the network!
+
+Pinch makes it possible to download a specific file from within a ZIP file
+over HTTP/1.1 using nothing but the Ruby Standard Library (net/http and zlib)
+
+Pinch is the Ruby implementation of an idea that my colleague Edward Patel
+had a while back.
+
+The first version was written in Objetive-C and we thought it would be cool 
+if we could bring that functionality to Ruby :)
+
+I’ve tested Pitch on 1.9.2. YMMV.
+
+== Installation
+
+    gem install pinch
+
+== Usage example
+
+    require 'pinch'
+
+    data = Pinch.get 'URL_TO_ZIP_FILE', 'path/file.ext'
+
+    puts data
+
+== LICENSE
+
+Copyright (c) 2011 Peter Hellberg and Edward Patel
+
+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,9 @@
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+  t.ruby_opts = ['-rubygems'] if defined? Gem
+  t.ruby_opts << '-I.'
+end

data/lib/pinch.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+require 'net/http'
+require 'zlib'
+
+class Pinch
+  VERSION = "0.0.1"
+
+  attr_reader :uri
+  attr_reader :file_name
+  attr_reader :content_length
+  attr_reader :central_directory
+  attr_reader :file_headers
+
+  def self.get(url, file_name)
+    new(url).data(file_name)
+  end
+
+  def initialize(url)
+    @uri        = URI.parse(url)
+    @files      = {}
+  end
+
+  def file_headers
+    @file_headers ||= begin
+      raise RuntimeError, "Couldn’t find the central directory." if central_directory.nil?
+
+      headers = {}
+      tmp     = central_directory
+
+      begin
+        cd = tmp.unpack('VvvvvvvVVVvvvvvVV')
+        break if cd[1] == 0
+
+        length            = 46+cd[10]+cd[11]+cd[12]
+        current_file_name = tmp[46...46+cd[10]]
+        tmp               = tmp[length..-1]
+        headers[current_file_name] = cd
+      end while true
+
+      headers
+    end
+  end
+
+  def data(file_name)
+    raise Errno::ENOENT if file_headers[file_name].nil?
+
+    req = Net::HTTP::Get.new(uri.path)
+    req.set_range(file_headers[file_name][16],
+                  file_headers[file_name][16] +
+                  file_headers[file_name][8]  +
+                  file_headers[file_name][10] +
+                  file_headers[file_name][11] +
+                  file_headers[file_name][12] + 30)
+
+    res = Net::HTTP.start(uri.host, uri.port) do |http|
+      http.request(req)
+    end
+
+    ###########################################################################
+    # Local file header
+    ###########################################################################
+
+    #0  uint32 localFileHeaderSignature
+    #1  uint16 versionNeededToExtract
+    #2  uint16 generalPurposeBitFlag
+    #3  uint16 compressionMethod
+    #4  uint16 fileLastModificationTime
+    #5  uint16 fileLastModificationDate
+    #6  uint32 CRC32
+    #7  uint32 compressedSize
+    #8  uint32 uncompressedSize
+    #9  uint16 fileNameLength
+    #10 uint16 extraFieldLength
+
+    local_file_header = res.body.unpack('VvvvvvVVVvv')
+    file_data         = res.body[30+local_file_header[9]+local_file_header[10]..-1]
+
+    if local_file_header[3] == 0
+      raise NotImplementedError, "Unable to read uncompressed ZIP files for now"
+    else
+      Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(file_data)
+    end
+  end
+
+  def central_directory
+    #0  uint32 centralDirectoryFileHeaderSignature
+    #1  uint16 versionMadeBy
+    #2  uint16 versionNeededToExtract
+    #3  uint16 generalPurposeBitFlag
+    #4  uint16 compressionMethod
+    #5  uint16 fileLastModificationTime
+    #6  uint16 fileLastModificationDate
+    #7  uint32 CRC32
+    #8  uint32 compressedSize
+    #9  uint32 uncompressedSize
+    #10 uint16 fileNameLength
+    #11 uint16 extraFieldLength
+    #12 uint16 fileCommentLength
+    #13 uint16 diskNumberWhereFileStarts
+    #14 uint16 internalFileAttributes
+    #15 uint32 externalFileAttributes
+    #16 uint32 relativeOffsetOfLocalFileHeader
+
+    @central_directory ||= begin
+      req = Net::HTTP::Get.new(uri.path)
+      req.set_range(end_of_central_directory_record[5],
+                    end_of_central_directory_record[5] +
+                    end_of_central_directory_record[4])
+
+      res = Net::HTTP.start(uri.host, uri.port) { |http|
+        http.request(req)
+      }
+
+      if [200, 206].include?(res.code)
+        raise RuntimeError, "Couldn’t find the ZIP file (HTTP: #{res.code})"
+      else
+        res.body
+      end
+    end
+  end
+
+  # Retrieve the content length of the file
+  def content_length
+    @content_length ||= Net::HTTP.start(@uri.host, @uri.port) { |http|
+      http.head(@uri.path)
+    }['Content-Length'].to_i
+  end
+
+  def end_of_central_directory_record
+    #0  uint16 numberOfThisDisk;
+    #1  uint16 diskWhereCentralDirectoryStarts;
+    #2  uint16 numberOfCentralDirectoryRecordsOnThisDisk;
+    #3  uint16 totalNumberOfCentralDirectoryRecords;
+    #4  uint32 sizeOfCentralDirectory;
+    #5  uint32 offsetOfStartOfCentralDirectory;
+    #6  uint16 ZIPfileCommentLength;
+
+    @end_of_central_directory_record ||= begin
+      # Retrieve a 4k of data from the end of the zip file
+      request = Net::HTTP::Get.new(uri.path)
+      offset = content_length >= 4096 ? content_length-4096 : 0
+
+      request.set_range(offset, content_length)
+
+      response = Net::HTTP.start(uri.host, uri.port) do |http|
+        http.request(request)
+      end
+
+      # Unpack the body into a hex string
+      hex = response.body.unpack("H*")[0]
+
+      # Split on the end record signature, and unpack the last one
+      [hex.split("504b0506").last].pack("H*").unpack("vvvvVVv")
+    end
+  end
+end

data/spec/pinch_spec.rb

@@ -0,0 +1,24 @@
+require 'minitest/pride'
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require File.dirname(__FILE__) + '/../lib/pinch'
+
+describe Pinch do
+  describe "when calling get" do
+    it "should return the contents of the file" do
+      url  = 'http://ftp.sunet.se/pub/lang/smalltalk/Squeak/current_stable/Squeak3.8-6665-full.zip'
+      file = 'ReadMe.txt'
+      data = Pinch.get url, file
+      data.must_match /Morphic graphics architecture/
+    end
+
+    it "should not pinch from a zip file that is not deflated (for now)" do
+      lambda {
+        url  = 'http://memention.com/ericjohnson-canabalt-ios-ef43b7d.zip'
+        file = 'ericjohnson-canabalt-ios-ef43b7d/README.TXT'
+        data = Pinch.get url, file
+      }.must_raise NotImplementedError
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: pinch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Hellberg
+- Edward Patel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-03 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2156678820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156678820
+description: Pinch makes it possible to download a specific file from within a ZIP
+  file over HTTP 1.1.
+email: peter@c7.se
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- MIT-LICENSE
+files:
+- lib/pinch.rb
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- .gemtest
+- spec/pinch_spec.rb
+has_rdoc: true
+homepage: https://github.com/peterhellberg/pinch
+licenses:
+- MIT-LICENSE
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+- --charset=UTF-8
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Retrieve a file from inside a zip file, over the network!
+test_files:
+- spec/pinch_spec.rb