s3 0.3.2 → 0.3.4

data/Gemfile.lock

@@ -1,19 +1,17 @@
 PATH
   remote: .
   specs:
-    s3 (0.3.2)
+    s3 (0.3.3)
       proxies
-      trollop
 
 GEM
   remote: http://rubygems.org/
   specs:
     mocha (0.9.8)
       rake
-    proxies (0.1.1)
+    proxies (0.2.1)
     rake (0.8.7)
     test-unit (2.1.1)
-    trollop (1.16.2)
 
 PLATFORMS
   ruby
@@ -24,4 +22,3 @@ DEPENDENCIES
   proxies
   s3!
   test-unit (>= 2.0)
-  trollop

data/lib/s3/bucket.rb

@@ -85,7 +85,7 @@ module S3
     # Returns the objects in the bucket and caches the result (see
     # #reload method).
     def objects
-      MethodProxy.new(self, :list_bucket, :extend => ObjectsExtension)
+      Proxy.new(lambda { list_bucket }, :owner => self, :extend => ObjectsExtension)
     end
 
     def inspect #:nodoc:

data/lib/s3/service.rb

@@ -28,7 +28,7 @@ module S3
       @use_ssl = options.fetch(:use_ssl, false)
       @timeout = options.fetch(:timeout, 60)
       @debug = options.fetch(:debug, false)
-      
+
       raise ArgumentError, "Missing proxy settings. Must specify at least :host." if options[:proxy] && !options[:proxy][:host]
       @proxy = options.fetch(:proxy, nil)
     end
@@ -36,7 +36,7 @@ module S3
     # Returns all buckets in the service and caches the result (see
     # +reload+)
     def buckets
-      MethodProxy.new(self, :list_all_my_buckets, :extend => BucketsExtension)
+      Proxy.new(lambda { list_all_my_buckets}, :owner => self, :extend => BucketsExtension)
     end
 
     # Returns "http://" or "https://", depends on <tt>:use_ssl</tt>

data/lib/s3/signature.rb

@@ -23,64 +23,108 @@ module S3
     # Generated signature string for given hostname and request
     def self.generate(options)
       request = options[:request]
-      host = options[:host]
       access_key_id = options[:access_key_id]
-      secret_access_key = options[:secret_access_key]
-
-      http_verb = request.method
-      content_md5 = request["content-md5"] || ""
-      content_type = request["content-type"] || ""
-      date = request["x-amz-date"].nil? ? request["date"] : ""
-      canonicalized_resource = canonicalized_resource(host, request)
-      canonicalized_amz_headers = canonicalized_amz_headers(request)
 
-      string_to_sign = ""
-      string_to_sign << http_verb
-      string_to_sign << "\n"
-      string_to_sign << content_md5
-      string_to_sign << "\n"
-      string_to_sign << content_type
-      string_to_sign << "\n"
-      string_to_sign << date
-      string_to_sign << "\n"
-      string_to_sign << canonicalized_amz_headers
-      string_to_sign << canonicalized_resource
+      options.merge!(:headers => request,
+                     :method => request.method,
+                     :resource => request.path)
 
-      digest = OpenSSL::Digest::Digest.new('sha1')
-      hmac = OpenSSL::HMAC.digest(digest, secret_access_key, string_to_sign)
-      base64 = Base64.encode64(hmac)
-      signature = base64.chomp
+      signature = canonicalized_signature(options)
 
       "AWS #{access_key_id}:#{signature}"
     end
 
-    # Generates temporary URL for given resource
+    # Generates temporary URL signature for given resource
     #
     # ==== Options
     # * <tt>:bucket</tt> - Bucket in which the resource resides
     # * <tt>:resource</tt> - Path to the resouce you want to create
-    #   a teporary link to
+    #   a temporary link to
     # * <tt>:secret_access_key</tt> - Secret access key
-    # * <tt>:expires_on</tt> - Unix time stamp of when the resouce
+    # * <tt>:expires_at</tt> - Unix time stamp of when the resouce
     #   link will expire
+    # * <tt>:method</tt> - HTTP request method you want to use on
+    #   the resource, defaults to GET
+    # * <tt>:headers</tt> - Any additional HTTP headers you intend
+    #   to use when requesting the resource
     def self.generate_temporary_url_signature(options)
       bucket = options[:bucket]
       resource = options[:resource]
       secret_access_key = options[:secret_access_key]
       expires = options[:expires_at]
 
-      string_to_sign = "GET\n\n\n#{expires.to_i.to_s}\n/#{bucket}/#{resource}";
+      headers = options[:headers] || {}
+      headers.merge!('date' => expires.to_i.to_s)
 
-      digest = OpenSSL::Digest::Digest.new("sha1")
-      hmac = OpenSSL::HMAC.digest(digest, secret_access_key, string_to_sign)
-      base64 = Base64.encode64(hmac)
-      signature = base64.chomp
+      options.merge!(:resource => "/#{bucket}/#{resource}",
+                     :method => options[:method] || :get,
+                     :headers => headers)
+      signature = canonicalized_signature(options)
 
       CGI.escape(signature)
     end
 
+    # Generates temporary URL for given resource
+    #
+    # ==== Options
+    # * <tt>:bucket</tt> - Bucket in which the resource resides
+    # * <tt>:resource</tt> - Path to the resouce you want to create
+    #   a temporary link to
+    # * <tt>:access_key</tt> - Access key
+    # * <tt>:secret_access_key</tt> - Secret access key
+    # * <tt>:expires_at</tt> - Unix time stamp of when the resouce
+    #   link will expire
+    # * <tt>:method</tt> - HTTP request method you want to use on
+    #   the resource, defaults to GET
+    # * <tt>:headers</tt> - Any additional HTTP headers you intend
+    #   to use when requesting the resource
+    def self.generate_temporary_url(options)
+      bucket = options[:bucket]
+      resource = options[:resource]
+      access_key = options[:access_key]
+      expires = options[:expires_at].to_i
+      signature = generate_temporary_url_signature(options)
+
+      url = "http://#{S3::HOST}/#{bucket}/#{resource}"
+      url << "?AWSAccessKeyId=#{access_key}"
+      url << "&Expires=#{expires}"
+      url << "&Signature=#{signature}"
+    end
+
     private
 
+    def self.canonicalized_signature(options)
+      headers = options[:headers] || {}
+      host = options[:host] || ""
+      resource = options[:resource]
+      access_key_id = options[:access_key_id]
+      secret_access_key = options[:secret_access_key]
+
+      http_verb = options[:method].to_s.upcase
+      content_md5 = headers["content-md5"] || ""
+      content_type = headers["content-type"] || ""
+      date = headers["x-amz-date"].nil? ? headers["date"] : ""
+      canonicalized_resource = canonicalized_resource(host, resource)
+      canonicalized_amz_headers = canonicalized_amz_headers(headers)
+
+      string_to_sign = ""
+      string_to_sign << http_verb
+      string_to_sign << "\n"
+      string_to_sign << content_md5
+      string_to_sign << "\n"
+      string_to_sign << content_type
+      string_to_sign << "\n"
+      string_to_sign << date
+      string_to_sign << "\n"
+      string_to_sign << canonicalized_amz_headers
+      string_to_sign << canonicalized_resource
+
+      digest = OpenSSL::Digest::Digest.new('sha1')
+      hmac = OpenSSL::HMAC.digest(digest, secret_access_key, string_to_sign)
+      base64 = Base64.encode64(hmac)
+      base64.chomp
+    end
+
     # Helper method for extracting header fields from Net::HTTPRequest
     # and preparing them for singing in #generate method
     #
@@ -157,7 +201,7 @@ module S3
     #
     # ==== Returns
     # String containing extracted canonicalized resource
-    def self.canonicalized_resource(host, request)
+    def self.canonicalized_resource(host, resource)
       # 1. Start with the empty string ("").
       string = ""
 
@@ -172,7 +216,7 @@ module S3
 
       # 3. Append the path part of the un-decoded HTTP Request-URI,
       # up-to but not including the query string.
-      uri = URI.parse(request.path)
+      uri = URI.parse(resource)
       string << uri.path
 
       # 4. If the request addresses a sub-resource, like ?location,

data/lib/s3/version.rb

@@ -1,3 +1,3 @@
 module S3
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

data/s3.gemspec

@@ -9,13 +9,12 @@ Gem::Specification.new do |s|
   s.authors     = ["Jakub Kuźma"]
   s.email       = ["qoobaa@gmail.com"]
   s.homepage    = "http://jah.pl/projects/s3.html"
-  s.summary     = "Library for accessing S3 objects and buckets, with command line tool"
+  s.summary     = "Library for accessing S3 objects and buckets"
   s.description = "S3 library provides access to Amazon's Simple Storage Service. It supports both: European and US buckets through REST API."
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "s3"
 
-  s.add_dependency "trollop"
   s.add_dependency "proxies"
   s.add_development_dependency "test-unit", ">= 2.0"
   s.add_development_dependency "mocha"

data/test/signature_test.rb

@@ -140,4 +140,66 @@ class SignatureTest < Test::Unit::TestCase
     expected = "AWS 0PN5J17HBGZHT7JJ3X82:dxhSBHoI6eVSPcXJqEghlUzZMnY="
     assert_equal expected, actual
   end
+
+  test "temporary signature for object get" do
+    actual = S3::Signature.generate_temporary_url_signature(
+      :bucket => "johnsmith",
+      :resource => "photos/puppy.jpg",
+      :secret_access_key => "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o",
+      :expires_at => 1175046589
+    )
+    expected = "gs6xNznrLJ4Bd%2B1y9pcy2HOSVeg%3D"
+    assert_equal expected, actual
+  end
+
+  test "temporary signature for object post" do
+    actual = S3::Signature.generate_temporary_url_signature(
+      :bucket => "johnsmith",
+      :resource => "photos/puppy.jpg",
+      :secret_access_key => "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o",
+      :expires_at => 1175046589,
+      :method => :post
+    )
+    expected = "duIzwO2KTEMIlbSYbFFS86Wj0LI%3D"
+    assert_equal expected, actual
+  end
+
+  test "temporary signature for object put with headers" do
+    actual = S3::Signature.generate_temporary_url_signature(
+      :bucket => "johnsmith",
+      :resource => "photos/puppy.jpg",
+      :secret_access_key => "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o",
+      :expires_at => 1175046589,
+      :method => :put,
+      :headers => {'x-amz-acl' => 'public-read'}
+    )
+    expected = "SDMxjIkOKIVR47nWfJ57UNPXxFM%3D"
+    assert_equal expected, actual
+  end
+
+  test "temporary signature for object delete" do
+    actual = S3::Signature.generate_temporary_url_signature(
+      :bucket => "johnsmith",
+      :resource => "photos/puppy.jpg",
+      :secret_access_key => "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o",
+      :expires_at => 1175046589,
+      :method => :delete
+    )
+    expected = "5Vg7A4HxgS6tVCYzBx%2BkMR8sztY%3D"
+    assert_equal expected, actual
+  end
+
+  test "temporary url for object put with headers" do
+    actual = S3::Signature.generate_temporary_url(
+      :bucket => "johnsmith",
+      :resource => "photos/puppy.jpg",
+      :access_key => '0PN5J17HBGZHT7JJ3X82',
+      :secret_access_key => "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o",
+      :expires_at => 1175046589,
+      :method => :put,
+      :headers => {'x-amz-acl' => 'public-read'}
+    )
+    expected = "http://s3.amazonaws.com/johnsmith/photos/puppy.jpg?AWSAccessKeyId=0PN5J17HBGZHT7JJ3X82&Expires=1175046589&Signature=SDMxjIkOKIVR47nWfJ57UNPXxFM%3D"
+    assert_equal expected, actual
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - "Jakub Ku\xC5\xBAma"
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-06 00:00:00 +02:00
+date: 2010-09-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: trollop
+  name: proxies
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -30,23 +30,10 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: proxies
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: test-unit
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -56,11 +43,11 @@ dependencies:
         - 0
         version: "2.0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -69,11 +56,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -84,12 +71,12 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 description: "S3 library provides access to Amazon's Simple Storage Service. It supports both: European and US buckets through REST API."
 email: 
 - qoobaa@gmail.com
-executables: 
-- s3
+executables: []
+
 extensions: []
 
 extra_rdoc_files: []
@@ -101,7 +88,6 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- bin/s3
 - extra/s3_attachment_fu.rb
 - extra/s3_paperclip.rb
 - lib/s3.rb
@@ -155,6 +141,6 @@ rubyforge_project: s3
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Library for accessing S3 objects and buckets, with command line tool
+summary: Library for accessing S3 objects and buckets
 test_files: []
 

data/bin/s3

@@ -1,187 +0,0 @@
-#!/usr/bin/env ruby
-
-$: << File.expand_path(File.dirname(__FILE__) + "/../lib")
-
-require "trollop"
-require "s3"
-
-# HELPER METHODS
-
-include S3
-
-def list_buckets(service)
-  service.buckets.each do |bucket|
-    puts bucket.name
-  end
-end
-
-def create_bucket(service, name, location)
-  service.buckets.build(name).save(location)
-end
-
-def destroy_bucket(service, name)
-  service.buckets.find(name).destroy
-end
-
-def show_bucket(service, name, options = {})
-  service.buckets.find(name).objects.find_all.each do |object|
-    puts "#{name}/#{object.key}"
-  end
-end
-
-def list_objects(service)
-  service.buckets.each do |bucket|
-    bucket.objects.each do |object|
-      puts "#{bucket.name}/#{object.key}"
-    end
-  end
-end
-
-def create_object(service, name, file_name, options = {})
-  bucket_name, object_name = name.split("/", 2)
-  object = service.buckets.find(bucket_name).objects.build(object_name)
-  object.content_type = options[:type]
-  object.content_encoding = options[:encoding]
-  object.content_disposition = options[:disposition]
-  object.acl = options[:acl]
-  object.content = File.new(file_name)
-  object.save
-end
-
-def destroy_object(service, name)
-  bucket_name, object_name = name.split("/", 2)
-  object = service.buckets.find(bucket_name).objects.find(object_name)
-  object.destroy
-end
-
-def show_object(service, name, file_name = nil)
-  bucket_name, object_name = name.split("/", 2)
-  object = service.buckets.find(bucket_name).objects.find_first(object_name)
-  puts "         object:   #{object.name}/#{object.key}"
-  puts "   content type:   #{object.content_type}"
-  puts "           size:   #{object.size}"
-  puts "           etag:   #{object.etag}"
-  puts "  last modified:   #{object.last_modified}"
-  if file_name
-    if file_name == "-"
-      puts object.content
-    else
-      File.open(file_name, "wb") do |file|
-        file.write(object.content)
-      end
-    end
-  end
-end
-
-# COMMAND LINE PARSER
-
-ACCESS_KEY_ID = ENV["ACCESS_KEY_ID"]
-SECRET_ACCESS_KEY = ENV["SECRET_ACCESS_KEY"]
-COMMANDS = %w(bucket object)
-BUCKET_SUBCOMMANDS = %w(add remove show)
-OBJECT_SUBCOMMANDS = %w(add remove show)
-
-global_options = Trollop::options do
-  banner "s3 command line tool"
-  opt :access_key_id, "Your access key id to AWS", :type => :string, :default => ACCESS_KEY_ID
-  opt :secret_access_key, "Your secret access key to AWS", :type => :string, :default => SECRET_ACCESS_KEY
-  opt :debug, "Debug mode", :type => :flag, :default => false
-  stop_on COMMANDS
-end
-
-Trollop::die "No access key id given" unless global_options[:access_key_id]
-Trollop::die "No secret access key given" unless global_options[:secret_access_key]
-
-service = Service.new(:access_key_id => global_options[:access_key_id],
-                      :secret_access_key => global_options[:secret_access_key],
-                      :debug => global_options[:debug])
-
-command = ARGV.shift
-
-begin
-  case command
-  when "bucket"
-    command_options = Trollop::options do
-      banner "manage buckets"
-      stop_on BUCKET_SUBCOMMANDS
-    end
-    subcommand = ARGV.shift
-    case subcommand
-    when "add"
-      subcommand_options = Trollop::options do
-        banner "add bucket"
-        opt :location, "Location of the bucket - EU or US", :default => "US", :type => :string
-      end
-      name = ARGV.shift
-      Trollop::die "Bucket has not been added because of unknown error" unless create_bucket(service, name, subcommand_options[:location])
-    when "remove"
-      subcommand_options = Trollop::options do
-        banner "remove bucket"
-      end
-      name = ARGV.shift
-      Trollop::die "Bucket name must be given" if name.nil? or name.empty?
-      Trollop::die "Bucket has not been removed because of unknown error" unless destroy_bucket(service, name)
-    when "show"
-      subcommand_options = Trollop::options do
-        banner "show bucket"
-        opt :prefix, "Limits the response to keys which begin with the indicated prefix", :type => :string
-        opt :marker, "Indicates where in the bucket to begin listing", :type => :string
-        opt :max_keys, "The maximum number of keys you'd like to see", :type => :integer
-        opt :delimiter, "Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element", :type => :string
-      end
-      name = ARGV.shift
-      Trollop::die "Bucket name must be given" if name.nil? or name.empty?
-      show_bucket(service, name, subcommand_options)
-    when nil
-      list_buckets(service)
-    else
-      Trollop::die "Unknown subcommand: #{subcommand.inspect}"
-    end
-  when "object"
-    command_options = Trollop::options do
-      banner "manage objects"
-      stop_on OBJECT_SUBCOMMANDS
-    end
-    subcommand = ARGV.shift
-    case subcommand
-    when "add"
-      subcommand_options = Trollop::options do
-        banner "object add s3_object_name local_file_name"
-        opt :type, "A standard MIME type describing the format of the contents", :default => "binary/octet-stream"
-        opt :disposition, "Specifies presentational information for the object", :type => :string
-        opt :encoding, "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type header field", :type => :string
-        opt :acl, "The canned ACL to apply to the object. Options include private, public-read, public-read-write, and authenticated-read", :type => :string
-      end
-      name = ARGV.shift
-      Trollop::die "No object name given" if name.nil? or name.empty?
-      file_name = ARGV.shift
-      Trollop::die "No file name given" if file_name.nil? or file_name.empty?
-      Trollop::die "Object has not been added because of unknown error" unless create_object(service, name, file_name, subcommand_options)
-    when "remove"
-      subcommand_options = Trollop::options do
-        banner "object remove s3_object_name"
-      end
-      name = ARGV.shift
-      Trollop::die "No object name given" if name.nil? or name.empty?
-      Trollop::die "Object has not been removed because of unknown error" unless destroy_object(service, name)
-    when "show"
-      subcommand_options = Trollop::options do
-        banner "object show s3_object_name optional_file_name"
-      end
-      name = ARGV.shift
-      Trollop::die "No object name given" if name.nil? or name.empty?
-      file_name = ARGV.shift
-      show_object(service, name, file_name)
-    when nil
-      list_objects(service)
-    else
-      Trollop::die "Unknown subcommand: #{subcommand.inspect}"
-    end
-  when nil
-    Trollop::die "No command given"
-  else
-    Trollop::die "Unknown command #{command.inspect}"
-  end
-rescue Error::ResponseError => e
-  Trollop::die e.message.sub(/\.+\Z/, "")
-end