Class AWS::S3::Base
In: lib/aws/s3/base.rb
Parent: Object

AWS::S3::Base is the abstract super class of all classes who make requests against S3, such as the built in Service, Bucket and S3Object classes. It provides methods for making requests, inferring or setting response classes, processing request options, and accessing attributes from S3’s response data.

Establishing a connection with the Base class is the entry point to using the library:

  AWS::S3::Base.establish_connection!(:access_key_id => '...', :secret_access_key => '...')

The :access_key_id and :secret_access_key are the two required connection options. More details can be found in the docs for Connection::Management::ClassMethods.

Extensive examples can be found in the README.

Methods

External Aliases

set_current_bucket_to -> current_bucket=

Attributes

attributes  [R] 

Public Class methods

Called when a method which requires a bucket name is called without that bucket name specified. It will try to infer the current bucket by looking for it as the subdomain of the current connection’s address. If no subdomain is found, CurrentBucketNotSpecified will be raised.

  MusicBucket.establish_connection! :server => 'jukeboxzero.s3.amazonaws.com'
  MusicBucket.connection.server
  => 'jukeboxzero.s3.amazonaws.com'
  MusicBucket.current_bucket
  => 'jukeboxzero'

Rather than infering the current bucket from the subdomain, the current class’ bucket can be explicitly set with set_current_bucket_to.

[Source]

     # File lib/aws/s3/base.rb, line 103
103:         def current_bucket
104:           connection.subdomain or raise CurrentBucketNotSpecified.new(connection.http.address)
105:         end

Wraps the current connection’s request method and picks the appropriate response class to wrap the response in. If the response is an error, it will raise that error as an exception. All such exceptions can be caught by rescuing their superclass, the ResponseError exception class.

It is unlikely that you would call this method directly. Subclasses of Base have convenience methods for each http request verb that wrap calls to request.

[Source]

    # File lib/aws/s3/base.rb, line 66
66:         def request(verb, path, options = {}, body = nil, attempts = 0, &block)
67:           Service.response = nil
68:           process_options!(options, verb)
69:           response = response_class.new(connection.request(verb, path, options, body, &block))
70:           Service.response = response
71: 
72:           Error::Response.new(response.response).error.raise if response.error?
73:           response
74:         # Once in a while, a request to S3 returns an internal error. A glitch in the matrix I presume. Since these 
75:         # errors are few and far between the request method will rescue InternalErrors the first three times they encouter them
76:         # and will retry the request again. Most of the time the second attempt will work.
77:         rescue *retry_exceptions
78:           body.rewind if body.respond_to?(:rewind)        
79:           attempts == 3 ? raise : (attempts += 1; retry)
80:         end

If you plan on always using a specific bucket for certain files, you can skip always having to specify the bucket by creating a subclass of Bucket or S3Object and telling it what bucket to use:

  class JukeBoxSong < AWS::S3::S3Object
    set_current_bucket_to 'jukebox'
  end

For all methods that take a bucket name as an argument, the current bucket will be used if the bucket name argument is omitted.

  other_song = 'baby-please-come-home.mp3'
  JukeBoxSong.store(other_song, open(other_song))

This time we didn’t have to explicitly pass in the bucket name, as the JukeBoxSong class knows that it will always use the ‘jukebox’ bucket.

"Astute readers", as they say, may have noticed that we used the third parameter to pass in the content type, rather than the fourth parameter as we had the last time we created an object. If the bucket can be inferred, or is explicitly set, as we’ve done in the JukeBoxSong class, then the third argument can be used to pass in options.

Now all operations that would have required a bucket name no longer do.

  other_song = JukeBoxSong.find('baby-please-come-home.mp3')

[Source]

     # File lib/aws/s3/base.rb, line 130
130:         def set_current_bucket_to(name)
131:           raise ArgumentError, "`#{__method__}' must be called on a subclass of #{self.name}" if self == AWS::S3::Base
132:           instance_eval("def current_bucket\n'\#{name}'\nend\n")
133:         end

[Validate]