pinch 0.2.1 → 0.3.0

data/README.rdoc

@@ -13,7 +13,11 @@ if we could bring that functionality to Ruby :)
 
 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.
+I’ve tested Pinch on 1.9.3, 1.9.2, 1.8.7, MacRuby 0.10, JRuby 1.6.4 and rbx-head, YMMV.
+
+The specs currently blows up on MagLev.
+
+{<img src="https://secure.travis-ci.org/peterhellberg/pinch.png?branch=master" />}[http://travis-ci.org/peterhellberg/pinch]
 
 == Installation
 

data/lib/pinch.rb

@@ -1,11 +1,12 @@
 # encoding: utf-8
 require 'net/https'
 require 'zlib'
+require 'pinch_response'
 
 # @author Peter Hellberg
 # @author Edward Patel
 class Pinch
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 
   attr_reader :uri
 
@@ -19,8 +20,8 @@ class Pinch
   #
   #  puts Pinch.get('http://peterhellberg.github.com/pinch/test.zip', 'data.json')
   #
-  def self.get(url, file_name)
-    new(url).get(file_name)
+  def self.get(url, file_name, &block)
+    new(url).get(file_name, &block)
   end
 
   ##
@@ -53,7 +54,7 @@ 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
+  # @param    [Fixnum] redirects  (Optional) Number of redirects to follow
   # @note You might want to use Pinch.get instead.
   #
   def initialize(url, redirects = 5)
@@ -76,8 +77,8 @@ class Pinch
   #
   # @note You might want to use Pinch.get instead
   #
-  def get(file_name)
-    local_file(file_name)
+  def get(file_name, &block)
+    local_file(file_name, &block)
   end
 
   ##
@@ -137,19 +138,25 @@ private
                    file_headers[file_name][11] +
                    file_headers[file_name][12]
 
-    response = fetch_data(offset_start, offset_end)
+    if block_given?
+      fetch_data(offset_start, offset_end) do |response|
+        yield PinchResponse.new(response)
+      end
+    else
+      response = fetch_data(offset_start, offset_end)
 
-    local_file_header = response.body.unpack('VvvvvvVVVvv')
-    file_data         = response.body[30+local_file_header[9]+local_file_header[10]..-1]
+      local_file_header = response.body.unpack('VvvvvvVVVvv')
+      file_data         = response.body[30+local_file_header[9]+local_file_header[10]..-1]
 
-    if local_file_header[3] == 0
-      # Uncompressed file
-      offset = 30+local_file_header[9]+local_file_header[10]
-      response.body[offset..(offset+local_file_header[8]-1)]
-    else
-      # Compressed file
-      file_data = response.body[30+local_file_header[9]+local_file_header[10]..-1]
-      Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(file_data)
+      if local_file_header[3] == 0
+        # Uncompressed file
+        offset = 30+local_file_header[9]+local_file_header[10]
+        response.body[offset..(offset+local_file_header[8]-1)]
+      else
+        # Compressed file
+        file_data = response.body[30+local_file_header[9]+local_file_header[10]..-1]
+        Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(file_data)
+      end
     end
   end
 
@@ -198,10 +205,11 @@ private
 
       response = fetch_data(offset_start, offset_end)
 
-      if [200, 206].include?(response.code)
-        raise RuntimeError, "Couldn’t find the ZIP file (HTTP: #{response.code})"
-      else
+
+      if ['200', '206'].include?(response.code)
         response.body
+      else
+        raise RuntimeError, "Couldn’t find the ZIP file (HTTP: #{response.code})"
       end
     end
   end
@@ -237,10 +245,10 @@ private
 
   ##
   # Get range of data from URL
-  def fetch_data(offset_start, offset_end)
+  def fetch_data(offset_start, offset_end, &block)
     request = Net::HTTP::Get.new(@uri.request_uri)
-    request.set_range(offset_start, offset_end)
-    connection(@uri).request(request)
+    request.set_range(offset_start..offset_end)
+    connection(@uri).request(request, &block)
   end
 
   ##

data/lib/pinch_response.rb

@@ -0,0 +1,42 @@
+# This class only implements read_body
+# The rest can be implemented when required
+class PinchResponse
+  def initialize(http_response)
+    @http_response = http_response
+    @zstream = Zlib::Inflate.new(-Zlib::MAX_WBITS)
+    @first_chunk = true
+  end
+
+  def read_body
+    if block_given?
+      @http_response.read_body do |chunk|
+        if @first_chunk
+          local_file_header = chunk.unpack('VvvvvvVVVvv')
+          @offset_start = 30+local_file_header[9]+local_file_header[10]
+          @compressed = (local_file_header[3] != 0)
+          @length = @compressed ? local_file_header[7] : local_file_header[8]
+
+          @cursor_start = @offset_start
+          @to_be_read = @length
+          @first_chunk = false
+        end
+
+        cursor_start = [@cursor_start, 0].max
+        cursor_end   = [@to_be_read, chunk.length].min
+        data = chunk[cursor_start, cursor_end]
+        @cursor_start -= chunk.length
+
+        if data
+          @to_be_read -= data.length
+          if @compressed
+            yield @zstream.inflate(data)
+          else
+            yield data
+          end
+        end
+      end
+    else
+      @zstream.inflate @http_response.read_body
+    end
+  end
+end

data/spec/pinch_spec.rb

@@ -1,6 +1,19 @@
+# encoding: utf-8
+
 # Require psych under MRI to remove warning messages
 if Object.const_defined?(:RUBY_ENGINE) && RUBY_ENGINE == "ruby"
-  require 'psych'
+  begin
+    require 'psych'
+  rescue LoadError
+    # Psych isn’t installed
+  end
+end
+
+begin
+  gem 'minitest'
+rescue LoadError
+  # Run the tests with the built in minitest instead
+  # if the gem isn’t installed.
 end
 
 require 'minitest/pride'
@@ -8,10 +21,10 @@ require 'minitest/autorun'
 require 'minitest/spec'
 require 'vcr'
 
-VCR.config do |c|
+VCR.configure do |c|
   c.allow_http_connections_when_no_cassette = true
   c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
-  c.stub_with :fakeweb
+  c.hook_into :fakeweb
 end
 
 require File.dirname(__FILE__) + '/../lib/pinch'
@@ -69,6 +82,19 @@ describe Pinch do
       end
     end
 
+    it "should yield to the block with PinchResponse object similar to HTTPResponse" do
+      body = ''
+      VCR.use_cassette('test_zip_with_block') do
+        Pinch.get(@url, @file) do |response|
+          response.must_be_kind_of PinchResponse
+          response.read_body do |chunk|
+            body << chunk
+          end
+        end
+      end
+      body.must_equal @data
+    end
+
     it "should retrieve the contents of the file data.json when passed a HTTPS url" do
       VCR.use_cassette('ssl_test') do
         @url  = 'https://dl.dropbox.com/u/2230186/pinch_test.zip'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinch
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,52 +10,41 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-08 00:00:00.000000000Z
+date: 2012-05-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &70351992865600 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70351992865600
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70351992864920 !ruby/object:Gem::Requirement
+  requirement: &70160741137260 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *70351992864920
+  version_requirements: *70160741137260
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70351992864160 !ruby/object:Gem::Requirement
+  requirement: &70160741136600 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70351992864160
+  version_requirements: *70160741136600
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70351992863460 !ruby/object:Gem::Requirement
+  requirement: &70160741136020 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70351992863460
+  version_requirements: *70160741136020
 description: Pinch makes it possible to download a specific file from within a ZIP
   file over HTTP 1.1.
 email: peter@c7.se
@@ -66,6 +55,7 @@ extra_rdoc_files:
 - MIT-LICENSE
 files:
 - lib/pinch.rb
+- lib/pinch_response.rb
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
@@ -96,9 +86,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Retrieve a file from inside a zip file, over the network!
 test_files:
 - spec/pinch_spec.rb
+has_rdoc: true