s3 0.3.11 → 0.3.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e94aa6f4e9214e728160e133f28264d1bd00b25
+  data.tar.gz: e3e15a25e2ef8f5882f088ec487ebb177cbc56b9
+SHA512:
+  metadata.gz: 2faf2eb87b1bf05b904dea7134e4efddd14b118963a7a0bb817d26e3277a43072c180bb4fe92a1bec92ac5fc97f42f558144e33e27d890487bdbffdfff4969fb
+  data.tar.gz: e19ef4917499f81051c263883660353a5a17c1c334cae53cc212f251c2ded50520d0cc1970debc09f76876bcd03b0818f93958d27f3e2b7bc152337e6cfc40a6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    s3 (0.3.11)
+    s3 (0.3.12)
       proxies (~> 0.2.0)
 
 GEM

data/README.rdoc

@@ -28,6 +28,15 @@ It supports both: European and US buckets through the {REST API}[http://docs.ama
     first_bucket = service.buckets.find("first-bucket")
     #=> #<S3::Bucket:first-bucket>
 
+=== Create bucket
+
+    new_bucket = service.buckets.build("newbucketname")
+    new_bucket.save(:location => :eu)
+
+Remember that bucket name for EU can't include "_" (underscore).
+
+Please refer to: http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html for more information about bucket name restrictions.
+
 === List objects in a bucket
 
     first_bucket.objects
@@ -67,6 +76,24 @@ It supports both: European and US buckets through the {REST API}[http://docs.ama
 Please note that new objects are created with "public-read" ACL by
 default.
 
+=== Fetch ACL
+
+   object = bucket.objects.find('lenna.png')
+   object.request_acl # or bucket.request_acl
+
+This will return hash with all users/groups and theirs permissions
+
+=== Modify ACL
+
+   object = bucket.objects.find("lenna.png")
+   object.copy(:key => "lenna.png", :bucket => bucket, :acl => :private)
+
+=== Upload file direct to amazon
+
+==== Rails 3
+
+  To do that you just send file using proper form direct to amazon. You can create simple halper for that, for example like this one: https://gist.github.com/3169039
+
 == See also
 
 * rubygems[http://rubygems.org/gems/s3]

data/lib/s3/bucket.rb

@@ -4,14 +4,14 @@ module S3
     include Proxies
     extend Forwardable
 
-    attr_reader :name, :service
+    attr_reader :name, :service, :acl
 
     def_instance_delegators :service, :service_request
     private_class_method :new
 
     # Retrieves the bucket information from the server. Raises an
     # S3::Error exception if the bucket doesn't exist or you don't
-    # have access to it, etc.
+    # have access to it.
     def retrieve
       bucket_headers
       self
@@ -30,11 +30,34 @@ module S3
       self.name == other.name and self.service == other.service
     end
 
+    # Retrieves acl for bucket from the server.
+    #
+    # Return:
+    # hash: user|group => permission
+    def request_acl
+      body = bucket_request(:get, :params => "acl").body
+      parse_acl(body)
+    end
+
+    # Assigns a new ACL to the bucket. Please note that ACL is not
+    # retrieved from the server and set to "public-read" by default.
+    #
+    # Valid Values: :private | :public_read | :public_read_write | authenticated_read
+    #
+    # ==== Example
+    #   bucket.acl = :public_read
+    def acl=(acl)
+      @acl = acl.to_s.gsub("_","-") if acl
+    end
+
     # Similar to retrieve, but catches S3::Error::NoSuchBucket
-    # exceptions and returns false instead.
+    # exceptions and returns false instead. Also catch S3::Error::ForbiddenBucket
+    # and return true
     def exists?
       retrieve
       true
+    rescue Error::ForbiddenBucket
+      true
     rescue Error::NoSuchBucket
       false
     end
@@ -101,6 +124,14 @@ module S3
       "#<#{self.class}:#{name}>"
     end
 
+    def save_acl(options = {})
+      headers = {}
+      headers[:content_length] = 0
+      headers[:x_amz_acl] = options[:acl] || acl || "public-read"
+
+      response = bucket_request(:put, :headers => headers, :path => name)
+    end
+
     private
 
     attr_writer :service
@@ -135,10 +166,13 @@ module S3
     def bucket_headers(options = {})
       response = bucket_request(:head, :params => options)
     rescue Error::ResponseError => e
-      if e.response.code.to_i == 404
-        raise Error::ResponseError.exception("NoSuchBucket").new("The specified bucket does not exist.", nil)
-      else
-        raise e
+      case e.response.code.to_i
+        when 404
+          raise Error::ResponseError.exception("NoSuchBucket").new("The specified bucket does not exist.", nil)
+        when 403
+          raise Error::ResponseError.exception("ForbiddenBucket").new("The specified bucket exist but you do not have access to it.", nil)
+        else
+          raise e
       end
     end
 
@@ -174,5 +208,6 @@ module S3
     def name_valid?(name)
       name =~ /\A[a-z0-9][a-z0-9\._-]{2,254}\Z/i and name !~ /\A#{URI::REGEXP::PATTERN::IPV4ADDR}\Z/
     end
+
   end
 end

data/lib/s3/buckets_extension.rb

@@ -5,10 +5,13 @@ module S3
       Bucket.send(:new, proxy_owner, name)
     end
 
-    # Finds the bucket with given name
+    # Finds the bucket with given name (only those which exist and You have access to it)
+    # return nil in case Error::NoSuchBucket or Error::ForbiddenBucket
     def find_first(name)
       bucket = build(name)
       bucket.retrieve
+    rescue Error::ForbiddenBucket, Error::NoSuchBucket
+      nil
     end
     alias :find :find_first
 

data/lib/s3/connection.rb

@@ -128,7 +128,7 @@ module S3
     # Hash of headers translated from symbol to string, containing
     # only interesting headers
     def self.parse_headers(headers)
-      interesting_keys = [:content_type, :cache_control, :x_amz_acl, :x_amz_storage_class, :range,
+      interesting_keys = [:content_type, :content_length, :cache_control, :x_amz_acl, :x_amz_storage_class, :range,
                           :if_modified_since, :if_unmodified_since,
                           :if_match, :if_none_match,
                           :content_disposition, :content_encoding,

data/lib/s3/exceptions.rb

@@ -52,6 +52,7 @@ module S3
     class EntityTooSmall < ResponseError; end
     class EntityTooLarge < ResponseError; end
     class ExpiredToken < ResponseError; end
+    class ForbiddenBucket < ResponseError; end
     class IncompleteBody < ResponseError; end
     class IncorrectNumberOfFilesInPostRequestPOST < ResponseError; end
     class InlineDataTooLarge < ResponseError; end

data/lib/s3/object.rb

@@ -52,9 +52,11 @@ module S3
     end
 
     # Retrieves the object from the server. Method is used to download
-    # object information only (content type, size and so on). It does
-    # NOT download the content of the object (use the #content method
-    # to do it).
+    # object information only (content type, size).
+    # Notice: It does NOT download the content of the object
+    # (use the #content method to do it).
+    # Notice: this do not fetch acl information, use #request_acl
+    # method for that.
     def retrieve
       object_headers
       self
@@ -70,6 +72,15 @@ module S3
       false
     end
 
+    # Retrieves acl for object from the server.
+    #
+    # Return:
+    # hash: user|group => permission
+    def request_acl
+      response = object_request(:get, :params => "acl")
+      parse_acl(response.body)
+    end
+
     # Downloads the content of the object, and caches it. Pass true to
     # clear the cache and download the object again.
     def content(reload = false)
@@ -107,7 +118,7 @@ module S3
     # Returns Object's URL using protocol specified in service,
     # e.g. <tt>http://domain.com.s3.amazonaws.com/key/with/path.extension</tt>
     def url
-      URI.escape("#{protocol}#{host}/#{path_prefix}#{key}")
+      "#{protocol}#{host}/#{path_prefix}#{URI.escape(key, /[^#{URI::REGEXP::PATTERN::UNRESERVED}\/]/)}"
     end
 
     # Returns a temporary url to the object that expires on the

data/lib/s3/parser.rb

@@ -48,5 +48,43 @@ module S3
     def parse_is_truncated xml
       rexml_document(xml).elements["ListBucketResult/IsTruncated"].text =='true'
     end
+
+
+    # Parse acl response and return hash with grantee and their permissions
+    def parse_acl(xml)
+      grants = {}
+      rexml_document(xml).elements.each("AccessControlPolicy/AccessControlList/Grant") do |grant|
+        grants.merge!(extract_grantee(grant))
+      end
+      grants
+    end
+
+    private
+
+     def convert_uri_to_group_name(uri)
+        case uri
+        when "http://acs.amazonaws.com/groups/global/AllUsers"
+          return "Everyone"
+        when "http://acs.amazonaws.com/groups/global/AuthenticatedUsers"
+          return "Authenticated Users"
+        when "http://acs.amazonaws.com/groups/s3/LogDelivery"
+          return "Log Delivery"
+        else
+          return uri
+        end
+      end
+
+     def extract_grantee(grant)
+        grants  = {}
+        grant.each_element_with_attribute("xsi:type", "Group") do |grantee|
+          group_name = convert_uri_to_group_name(grantee.get_text("URI").value)
+          grants[group_name] = grant.get_text("Permission").value
+        end
+        grant.each_element_with_attribute("xsi:type", "CanonicalUser") do |grantee|
+          user_name = grantee.get_text("DisplayName").value
+          grants[user_name] = grant.get_text("Permission").value
+        end
+        grants
+     end
   end
 end

data/lib/s3/signature.rb

@@ -25,7 +25,9 @@ module S3
       request = options[:request]
       access_key_id = options[:access_key_id]
 
-      options.merge!(:headers => request, :method => request.method, :resource => request.path)
+      options.merge!(:headers => request,
+                     :method => request.method,
+                     :resource => request.path)
 
       signature = canonicalized_signature(options)
 
@@ -45,6 +47,8 @@ module S3
     #   the resource, defaults to GET
     # * <tt>:headers</tt> - Any additional HTTP headers you intend
     #   to use when requesting the resource
+    # * <tt>:add_bucket_to_host</tt> - Use in case of virtual-host style,
+    #   defaults to false
     def self.generate_temporary_url_signature(options)
       bucket = options[:bucket]
       resource = options[:resource]
@@ -54,7 +58,10 @@ module S3
       headers = options[:headers] || {}
       headers.merge!("date" => expires.to_i.to_s)
 
-      options.merge!(:resource => "/#{bucket}/#{URI.escape(resource)}",
+      resource = "/#{URI.escape(resource, /[^#{URI::REGEXP::PATTERN::UNRESERVED}\/]/)}"
+      resource = "/#{bucket}" + resource unless options[:add_bucket_to_host]
+
+      options.merge!(:resource => resource,
                      :method => options[:method] || :get,
                      :headers => headers)
       signature = canonicalized_signature(options)
@@ -76,14 +83,25 @@ module S3
     #   the resource, defaults to GET
     # * <tt>:headers</tt> - Any additional HTTP headers you intend
     #   to use when requesting the resource
+    # * <tt>:add_bucket_to_host</tt> - Use in case of virtual-host style,
+    #   defaults to false
     def self.generate_temporary_url(options)
       bucket = options[:bucket]
       resource = options[:resource]
       access_key = options[:access_key]
       expires = options[:expires_at].to_i
+      host = S3::HOST
+
+      if options[:add_bucket_to_host]
+        host = bucket + '.' + host
+        url  = "http://#{host}/#{resource}"
+      else
+        url = "http://#{host}/#{bucket}/#{resource}"
+      end
+
+      options[:host] = host
       signature = generate_temporary_url_signature(options)
 
-      url = "http://#{S3::HOST}/#{bucket}/#{resource}"
       url << "?AWSAccessKeyId=#{access_key}"
       url << "&Expires=#{expires}"
       url << "&Signature=#{signature}"
@@ -209,7 +227,7 @@ module S3
       # requests that don't address a bucket, do nothing. For more
       # information on virtual hosted-style requests, see Virtual
       # Hosting of Buckets.
-      bucket_name = host.sub(/\.?s3\.amazonaws\.com\Z/, "")
+      bucket_name = host.sub(/\.?#{S3::HOST}\Z/, "")
       string << "/#{bucket_name}" unless bucket_name.empty?
 
       # 3. Append the path part of the un-decoded HTTP Request-URI,

data/lib/s3/version.rb

@@ -1,3 +1,3 @@
 module S3
-  VERSION = "0.3.11"
+  VERSION = "0.3.12"
 end

data/s3.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |s|
   s.name        = "s3"
   s.version     = S3::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Jakub Kuźma"]
-  s.email       = ["qoobaa@gmail.com"]
-  s.homepage    = "http://jah.pl/projects/s3.html"
+  s.authors     = ["Kuba Kuźma"]
+  s.email       = ["kuba@jah.pl"]
+  s.homepage    = "http://github.com/qoobaa/s3"
   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."
 

data/test/object_test.rb

@@ -68,6 +68,11 @@ class ObjectTest < Test::Unit::TestCase
     expected = "http://images.s3.amazonaws.com/Lena%20S%C3%B6derberg.png"
     actual = object12.url
     assert_equal expected, actual
+    
+    object13 = S3::Object.send(:new, bucket1, :key => "Lena Söderberg [1].png")
+    expected = "http://images.s3.amazonaws.com/Lena%20S%C3%B6derberg%20%5B1%5D.png"
+    actual = object13.url
+    assert_equal expected, actual
 
     bucket2 = S3::Bucket.send(:new, @service, "images_new")
 

data/test/service_test.rb

@@ -87,10 +87,8 @@ class ServiceTest < Test::Unit::TestCase
     end
   end
 
-  test "buckets find first fail" do
-    assert_raise S3::Error::NoSuchBucket do
-      @service_bucket_not_exists.buckets.find_first("data2.example.com")
-    end
+  test "buckets find first return nil" do
+    assert_equal nil, @service_bucket_not_exists.buckets.find_first("data2.example.com")
   end
 
   test "buckets find all on empty list" do

data/test/signature_test.rb

@@ -151,6 +151,17 @@ class SignatureTest < Test::Unit::TestCase
     expected = "gs6xNznrLJ4Bd%2B1y9pcy2HOSVeg%3D"
     assert_equal expected, actual
   end
+  
+  test "temporary signature for object get with non-unreserved URI characters" do
+    actual = S3::Signature.generate_temporary_url_signature(
+      :bucket => "johnsmith",
+      :resource => "photos/puppy[1].jpg",
+      :secret_access_key => "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o",
+      :expires_at => 1175046589
+    )
+    expected = "gwCM0mVb9IrEPiUf8iaml6EISPc%3D"
+    assert_equal expected, actual
+  end
 
   test "temporary signature for object post" do
     actual = S3::Signature.generate_temporary_url_signature(
@@ -189,6 +200,18 @@ class SignatureTest < Test::Unit::TestCase
     assert_equal expected, actual
   end
 
+  test "temporary url for object get with bucket in the hostname" do
+    actual = S3::Signature.generate_temporary_url(
+      :bucket => "johnsmith",
+      :resource => "photos/puppy.jpg",
+      :secret_access_key => "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o",
+      :expires_at => 1175046589,
+      :add_bucket_to_host => true
+    )
+    expected = "http://johnsmith.s3.amazonaws.com/photos/puppy.jpg?AWSAccessKeyId=&Expires=1175046589&Signature=gs6xNznrLJ4Bd%2B1y9pcy2HOSVeg%3D"
+    assert_equal expected, actual
+  end
+
   test "temporary url for object put with headers" do
     actual = S3::Signature.generate_temporary_url(
       :bucket => "johnsmith",

metadata

@@ -1,64 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: s3
 version: !ruby/object:Gem::Version
-  version: 0.3.11
-  prerelease: 
+  version: 0.3.12
 platform: ruby
 authors:
-- Jakub Kuźma
+- Kuba Kuźma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-24 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: proxies
-  requirement: &6899940 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *6899940
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &6952760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *6952760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &6952100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6952100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &6950720 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *6950720
-description: ! 'S3 library provides access to Amazon''s Simple Storage Service. It
-  supports both: European and US buckets through REST API.'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+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
+- kuba@jah.pl
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -88,31 +99,27 @@ files:
 - test/service_test.rb
 - test/signature_test.rb
 - test/test_helper.rb
-homepage: http://jah.pl/projects/s3.html
+homepage: http://github.com/qoobaa/s3
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3173124590106976282
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: s3
-rubygems_version: 1.8.10
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Library for accessing S3 objects and buckets
 test_files: []