pinch 0.3.0 → 0.3.1

data/README.rdoc

@@ -31,6 +31,23 @@ The specs currently blows up on MagLev.
 
     puts data
 
+== Patch to use Pinch against Amazon S3 storage with pre-signed urls
+AWS S3 storage verifies url signature against HTTP verb, therefore requiring different pre-signed urls for HEAD and GET requests. Patch extends Pinch gem to accept hash or 2 urls, allowing to fetch items stored in zip archives on S3.
+
+require 'pinch'
+
+require 'right_aws'
+
+s3 = RightAws::S3Generator.new('...','...')
+
+bucket = s3.bucket('my-bucket')
+
+head_ticket = bucket.key('test.zip').head
+
+get_ticket = bucket.key('test.zip').get
+
+data=Pinch.get({:head => head_url, :get => get_url},'data.json')
+
 == LICENSE
 
 Copyright (c) 2011 Peter Hellberg and Edward Patel

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake/testtask'
+require 'bundler/gem_tasks'
 
 task :default => :test
 

data/lib/pinch.rb

@@ -6,63 +6,100 @@ require 'pinch_response'
 # @author Peter Hellberg
 # @author Edward Patel
 class Pinch
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 
-  attr_reader :uri
+  attr_reader :get_uri, :user, :pass
 
   ##
   # Retrieve a file from inside a zip file, over the network!
   #
   # @param    [String] url        Full URL to the ZIP file
   # @param    [String] file_name  Name of the file inside the ZIP archive
+  # @param    [String] user       (Optional) Username for Basic Authentication
+  # @param    [String] pass       (Optional) Password for Basic Authentication
   # @return   [String]            File data, ready to be displayed/saved
   # @example
   #
   #  puts Pinch.get('http://peterhellberg.github.com/pinch/test.zip', 'data.json')
   #
-  def self.get(url, file_name, &block)
-    new(url).get(file_name, &block)
+  def self.get(url, file_name, user = nil, pass = nil, &block)
+    new(url, user, pass).get(file_name, &block)
   end
 
   ##
   # List of files inside the zip file
   #
   # @param    [String] url        Full URL to the ZIP file
+  # @param    [String] user       (Optional) Username for Basic Authentication
+  # @param    [String] pass       (Optional) Password for Basic Authentication
   # @return   [Array]             List of all the files in the ZIP archive
   # @example
   #
   #  Pinch.file_list('http://peterhellberg.github.com/pinch/test.zip').first #=> "data.json"
   #
-  def self.file_list(url)
-    new(url).file_list
+  def self.file_list(url, user = nil, pass = nil)
+    new(url, user, pass).file_list
   end
 
   ##
   # Retrieve the size of the ZIP file
   #
   # @param    [String] url        Full URL to the ZIP file
+  # @param    [String] user       (Optional) Username for Basic Authentication
+  # @param    [String] pass       (Optional) Password for Basic Authentication
   # @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
+  def self.content_length(url, user = nil, pass = nil)
+    new(url, user, pass).content_length
   end
 
   ##
   # Initializes a new Pinch object
   #
-  # @param    [String] url        Full URL to the ZIP file
+  # @param [String or Hash] url Full URL to the ZIP file or hash with different URLs for HTTP verbs, e.g.
+  #    {
+  #     :head => 'my-url-signed-for-head-verb'
+  #     :get => 'my-url-signed-for-get-verb'
+  #    }
+  # @param    [String] user       (Optional) Username for Basic Authentication
+  # @param    [String] pass       (Optional) Password for Basic Authentication
   # @param    [Fixnum] redirects  (Optional) Number of redirects to follow
   # @note You might want to use Pinch.get instead.
   #
-  def initialize(url, redirects = 5)
-    @uri       = URI.parse(url)
+  def initialize(url, user = nil, pass = nil, redirects = 5)
+    if url.respond_to? :fetch
+      @get_uri  = URI.parse(url.fetch(:get))
+      @head_uri = URI.parse(url.fetch(:head))
+    else
+      @get_uri = @head_uri = URI.parse(url)
+    end
+
+    @user      = user
+    @pass      = pass
     @files     = {}
     @redirects = redirects
   end
 
+  ##
+  # Set Username and Password for Basic Authentication
+  #
+  # @param    [String] username   (Optional) Username for Basic Authentication
+  # @param    [String] password   (Optional) Password for Basic Authentication
+  # @return   [Pinch]             Returns self to support chained calls
+  # @example
+  #
+  #  puts Pinch.new('http://code.mrgossett.com/pinch_test.zip').auth('pinch_test','thisisjustatest').get('data.json')
+  #
+  def auth(username, password)
+    @user = username
+    @pass = password
+
+    return self
+  end
+
   ##
   # @note You might want to use Pinch.file_list instead.
   #
@@ -86,9 +123,9 @@ class Pinch
   #
   def content_length
     @content_length ||= begin
-      response = connection(@uri).start { |http|
-        http.head(@uri.path)
-      }
+      request = Net::HTTP::Head.new(@head_uri.request_uri)
+      request.basic_auth(@user, @pass) unless @user.nil? || @pass.nil?
+      response = connection(@head_uri).request(request)
 
       # Raise exception if the response code isn’t in the 2xx range
       response.error! unless response.kind_of?(Net::HTTPSuccess)
@@ -96,17 +133,17 @@ class Pinch
       # 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}"
+              "Range HTTP header not supported on #{@head_uri.host}"
       end
 
       response['Content-Length'].to_i
     rescue Net::HTTPRetriableError => e
-      @uri = URI.parse(e.response['Location'])
+      @head_uri = URI.parse(e.response['Location'])
 
       if (@redirects -= 1) > 0
         retry
       else
-        raise TooManyRedirects, "Gave up at on #{@uri.host}"
+        raise TooManyRedirects, "Gave up at on #{@head_uri.host}"
       end
     end
   end
@@ -246,9 +283,10 @@ private
   ##
   # Get range of data from URL
   def fetch_data(offset_start, offset_end, &block)
-    request = Net::HTTP::Get.new(@uri.request_uri)
+    request = Net::HTTP::Get.new(@get_uri.request_uri)
+    request.basic_auth(@user, @pass) unless @user.nil? || @pass.nil?
     request.set_range(offset_start..offset_end)
-    connection(@uri).request(request, &block)
+    connection(@get_uri).request(request, &block)
   end
 
   ##

data/spec/pinch_spec.rb

@@ -111,6 +111,30 @@ describe Pinch do
       end
     end
   end
+  
+  describe "when calling get on the example ZIP file behind HTTP Basic Authentication" do
+    before do
+      @url  = 'http://code.mrgossett.com/pinch_test.zip'
+      @file = 'data.json'
+      @data = "{\"gem\":\"pinch\",\"authors\":[\"Peter Hellberg\",\"Edward Patel\"],\"github_url\":\"https://github.com/peterhellberg/pinch\"}\n"
+    end
+
+    it "should retrieve the contents of the file data.json with valid authentication" do
+      VCR.use_cassette('valid_basic_auth') do
+        data = Pinch.get @url, @file, 'pinch_test', 'thisisjustatest'
+        data.must_equal @data
+        data.size.must_equal 114
+      end
+    end
+
+    it "should not retrieve the contents of the file data.json with invalid authentication" do
+      VCR.use_cassette('invalid_basic_auth') do
+        lambda {
+          Pinch.get @url, @file, 'invalid_username', 'invalid_password'
+        }.must_raise Net::HTTPServerException
+      end
+    end
+  end
 
   describe "Pinch.file_list" do
     it "should return a list with all the file names in the ZIP file" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,22 +10,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-27 00:00:00.000000000 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70160741137260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '4.0'
   type: :development
   prerelease: false
-  version_requirements: *70160741137260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70160741136600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,18 +38,28 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70160741136600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70160741136020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
-  version_requirements: *70160741136020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: Pinch makes it possible to download a specific file from within a ZIP
   file over HTTP 1.1.
 email: peter@c7.se
@@ -84,9 +99,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 752809128111839856
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Retrieve a file from inside a zip file, over the network!