pinch 0.1.0 → 0.2.1

data/README.rdoc

@@ -8,10 +8,12 @@ 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 
+The first version was written in Objective-C and we thought it would be cool
 if we could bring that functionality to Ruby :)
 
-I’ve tested Pinch on 1.9.2. YMMV.
+That version is available on https://github.com/epatel/pinch-objc/
+
+I’ve tested Pinch on 1.9.2, 1.8.7 and MacRuby 0.10, YMMV.
 
 == Installation
 

data/Rakefile

@@ -5,5 +5,5 @@ 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.'
+  t.ruby_opts << '-w -I.'
 end

data/lib/pinch.rb

@@ -5,7 +5,7 @@ require 'zlib'
 # @author Peter Hellberg
 # @author Edward Patel
 class Pinch
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 
   attr_reader :uri
 
@@ -53,11 +53,13 @@ class Pinch
   # Initializes a new Pinch object
   #
   # @param    [String] url        Full URL to the ZIP file
+  # @param    [Strin]  redirects  (Optional) Number of redirects to follow
   # @note You might want to use Pinch.get instead.
   #
-  def initialize(url)
-    @uri    = URI.parse(url)
-    @files  = {}
+  def initialize(url, redirects = 5)
+    @uri       = URI.parse(url)
+    @files     = {}
+    @redirects = redirects
   end
 
   ##
@@ -83,14 +85,28 @@ class Pinch
   #
   def content_length
     @content_length ||= begin
-      response = prepared_connection.start { |http|
+      response = connection(@uri).start { |http|
         http.head(@uri.path)
       }
 
       # Raise exception if the response code isn’t in the 2xx range
       response.error! unless response.kind_of?(Net::HTTPSuccess)
 
+      # Raise exception if the server doesn’t support the Range header
+      unless (response['Accept-Ranges'] or "").include?('bytes')
+        raise RangeHeaderException,
+              "Range HTTP header not supported on #{@uri.host}"
+      end
+
       response['Content-Length'].to_i
+    rescue Net::HTTPRetriableError => e
+      @uri = URI.parse(e.response['Location'])
+
+      if (@redirects -= 1) > 0
+        retry
+      else
+        raise TooManyRedirects, "Gave up at on #{@uri.host}"
+      end
     end
   end
 
@@ -138,27 +154,6 @@ private
   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 central_directory
     #0  uint32 centralDirectoryFileHeaderSignature
     #1  uint16 versionMadeBy
     #2  uint16 versionNeededToExtract
@@ -177,6 +172,26 @@ private
     #15 uint32 externalFileAttributes
     #16 uint32 relativeOffsetOfLocalFileHeader
 
+    @file_headers ||= begin
+      raise RuntimeError, "Couldn’t find the central directory." if central_directory.nil?
+
+      headers = {}
+
+      central_directory.
+        unpack("H*")[0].
+        split("504b0102")[1..-1].
+        each do |fh|
+          data        = ["504b0102#{fh}"].pack('H*')
+          file_header = data.unpack('VvvvvvvVVVvvvvvVV')
+          file_name   = data[46...46+file_header[10]]
+          headers[file_name] = file_header
+      end
+
+      headers
+    end
+  end
+
+  def central_directory
     @central_directory ||= begin
       offset_start = end_of_central_directory_record[5]
       offset_end   = end_of_central_directory_record[5] + end_of_central_directory_record[4]
@@ -202,15 +217,18 @@ private
 
     @end_of_central_directory_record ||= begin
       # Retrieve a 4k of data from the end of the zip file
-      offset  = content_length >= 4096 ? content_length-4096 : 0
+      offset = content_length >= 4096 ? content_length-4096 : 0
 
       response = fetch_data(offset, content_length)
 
-      # 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")
+      # Unpack the body into a hex string then split on
+      # the end record signature, and finally unpack the last one.
+      [response.body.
+        unpack("H*")[0].
+        split("504b0506").
+        last[0...36]].
+        pack("H*").
+        unpack("vvvvVVv")
 
       # Skipping the hex unpack and splitting on
       # PK\x05\x06 instead was for some reason slower.
@@ -222,22 +240,22 @@ private
   def fetch_data(offset_start, offset_end)
     request = Net::HTTP::Get.new(@uri.request_uri)
     request.set_range(offset_start, offset_end)
-
-    prepared_connection.request(request)
+    connection(@uri).request(request)
   end
 
   ##
-  # Prepare the connection and GET request
-  def prepared_connection
-    @prepared_connection ||= begin
-      http = Net::HTTP.new(@uri.host, @uri.port)
-
-      if @uri.is_a?(URI::HTTPS)
-        http.use_ssl      = true
-        http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
-      end
+  # A connection that automatically enables SSL (No verification)
+  def connection(uri)
+    http = Net::HTTP.new(uri.host, uri.port)
 
-      http
+    if uri.is_a?(URI::HTTPS)
+      http.use_ssl      = true
+      http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
     end
+
+    http
   end
+
+  class RangeHeaderException < StandardError; end
+  class TooManyRedirects < StandardError; end
 end

data/spec/pinch_spec.rb

@@ -1,3 +1,8 @@
+# Require psych under MRI to remove warning messages
+if Object.const_defined?(:RUBY_ENGINE) && RUBY_ENGINE == "ruby"
+  require 'psych'
+end
+
 require 'minitest/pride'
 require 'minitest/autorun'
 require 'minitest/spec'
@@ -12,6 +17,17 @@ end
 require File.dirname(__FILE__) + '/../lib/pinch'
 
 describe Pinch do
+  describe "url that redirects to the pinch zipball" do
+    it "should throw an exception about missing Range header support on GitHub" do
+      VCR.use_cassette('pinch_zipball') do
+        @url = 'https://github.com/peterhellberg/pinch/zipball/master'
+        lambda {
+          Pinch.file_list(@url)
+        }.must_raise Pinch::RangeHeaderException
+      end
+    end
+  end
+
   describe "when calling get on a compressed ZIP file" do
     it "should return the contents of the file" do
       VCR.use_cassette('squeak') do

metadata

@@ -1,109 +1,104 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pinch
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.1
   prerelease: 
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Peter Hellberg
 - Edward Patel
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-19 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70351992865600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70351992865600
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70351992864920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: fakeweb
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70351992864920
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70351992864160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: vcr
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70351992864160
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70351992863460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-description: Pinch makes it possible to download a specific file from within a ZIP file over HTTP 1.1.
+  prerelease: false
+  version_requirements: *70351992863460
+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: 
+extra_rdoc_files:
 - README.rdoc
 - MIT-LICENSE
-files: 
+files:
 - lib/pinch.rb
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - .gemtest
 - spec/pinch_spec.rb
-has_rdoc: true
 homepage: http://peterhellberg.github.com/pinch/
-licenses: 
+licenses:
 - MIT-LICENSE
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.rdoc
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Retrieve a file from inside a zip file, over the network!
-test_files: 
+test_files:
 - spec/pinch_spec.rb