pinch 0.0.8 → 0.0.9

data/README.rdoc

@@ -21,7 +21,7 @@ I’ve tested Pinch on 1.9.2. YMMV.
 
     require 'pinch'
 
-    data = Pinch.get 'URL_TO_ZIP_FILE', 'path/file.ext'
+    data = Pinch.get 'http://peterhellberg.github.com/pinch/test.zip', 'data.json'
 
     puts data
 

data/lib/pinch.rb

@@ -5,7 +5,7 @@ require 'zlib'
 # @author Peter Hellberg
 # @author Edward Patel
 class Pinch
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 
   attr_reader :uri
 
@@ -36,11 +36,24 @@ class Pinch
     new(url).file_list
   end
 
+  ##
+  # Retrieve the size of the ZIP file
+  #
+  # @param    [String] url        Full URL to the ZIP file
+  # @return   [Fixnum]            Size of the ZIP file
+  # @example
+  #
+  #  Pinch.content_length('http://peterhellberg.github.com/pinch/test.zip') #=> 2516612
+  #
+  def self.content_length(url)
+    new(url).content_length
+  end
+
   ##
   # Initializes a new Pinch object
   #
   # @param    [String] url        Full URL to the ZIP file
-  # @note You might want to use Pinch#get instead.
+  # @note You might want to use Pinch.get instead.
   #
   def initialize(url)
     @uri    = URI.parse(url)
@@ -48,7 +61,7 @@ class Pinch
   end
 
   ##
-  # @note You might want to use Pinch#file_list instead.
+  # @note You might want to use Pinch.file_list instead.
   #
   def file_list
     file_headers.keys
@@ -59,12 +72,21 @@ class Pinch
   #
   #  puts Pinch.new('http://peterhellberg.github.com/pinch/test.zip').get('data.json')
   #
-  # @note You might want to use Pinch#get instead
+  # @note You might want to use Pinch.get instead
   #
   def get(file_name)
     local_file(file_name)
   end
 
+  ##
+  # @note You might want to use Pinch.content_length instead
+  #
+  def content_length
+    @content_length ||= prepared_connection.start { |http|
+      http.head(@uri.path)
+    }['Content-Length'].to_i
+  end
+
 private
 
   def local_file(file_name)
@@ -197,14 +219,6 @@ private
     prepared_connection.request(request)
   end
 
-  ##
-  # Retrieve the content length of the file
-  def content_length
-    @content_length ||= prepared_connection.start { |http|
-      http.head(@uri.path)
-    }['Content-Length'].to_i
-  end
-
   ##
   # Prepare the connection and GET request
   def prepared_connection

data/spec/pinch_spec.rb

@@ -12,7 +12,7 @@ end
 require File.dirname(__FILE__) + '/../lib/pinch'
 
 describe Pinch do
-  describe "when calling get on a compressed zip file" do
+  describe "when calling get on a compressed ZIP file" do
     it "should return the contents of the file" do
       VCR.use_cassette('squeak') do
         @url  = 'http://ftp.sunet.se/pub/lang/smalltalk/Squeak/current_stable/Squeak3.8-6665-full.zip'
@@ -25,7 +25,7 @@ describe Pinch do
     end
   end
 
-  describe "when calling get on a zip file that is not compressed" do
+  describe "when calling get on a ZIP file that is not compressed" do
     it "should return the contents of the file" do
       VCR.use_cassette('canabalt') do
         @url  = 'http://memention.com/ericjohnson-canabalt-ios-ef43b7d.zip'
@@ -38,7 +38,7 @@ describe Pinch do
     end
   end
 
-  describe "when calling get on the example zip file" do
+  describe "when calling get on the example ZIP file" do
     before do
       @url  = 'http://peterhellberg.github.com/pinch/test.zip'
       @file = 'data.json'
@@ -70,8 +70,8 @@ describe Pinch do
     end
   end
 
-  describe "#file_list" do
-    it "should return a list with all the file names in the zip" do
+  describe "Pinch.file_list" do
+    it "should return a list with all the file names in the ZIP file" do
       VCR.use_cassette('file_list') do
         @url = 'http://memention.com/ericjohnson-canabalt-ios-ef43b7d.zip'
 
@@ -80,4 +80,16 @@ describe Pinch do
       end
     end
   end
+
+  describe "Pinch.content_length" do
+    before do
+      @url  = 'http://peterhellberg.github.com/pinch/test.zip'
+    end
+
+    it "should return the size of the ZIP file" do
+      VCR.use_cassette('content_length') do
+        Pinch.content_length(@url).must_equal 2516612
+      end
+    end
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: pinch
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors: 
 - Peter Hellberg
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-07 00:00:00 +02:00
+date: 2011-07-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency