Class: S3::Service

Inherits:
Object
  • Object
show all
Includes:
Proxies, Parser
Defined in:
lib/s3/service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Parser

#parse_copy_object_result, #parse_error, #parse_list_all_my_buckets_result, #parse_list_bucket_result, #parse_location_constraint, #rexml_document

Constructor Details

#initialize(options) ⇒ Service

Creates new service.

Options

  • :access_key_id - Access key id (REQUIRED)

  • :secret_access_key - Secret access key (REQUIRED)

  • :use_ssl - Use https or http protocol (false by default)

  • :debug - Display debug information on the STDOUT (false by default)

  • :timeout - Timeout to use by the Net::HTTP object (60 by default)

Raises:

  • (ArgumentError) 


25
26
27
28
29
30
31
32
33
34
 
# File 'lib/s3/service.rb', line 25

def initialize(options)
  @access_key_id = options.fetch(:access_key_id)
  @secret_access_key = options.fetch(:secret_access_key)
  @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

Instance Attribute Details

#access_key_id ⇒ Object (readonly)

Returns the value of attribute access_key_id.



6
7
8
 
# File 'lib/s3/service.rb', line 6

def access_key_id
  @access_key_id
end

#proxy ⇒ Object (readonly)

Returns the value of attribute proxy.



6
7
8
 
# File 'lib/s3/service.rb', line 6

def proxy
  @proxy
end

#secret_access_key ⇒ Object (readonly)

Returns the value of attribute secret_access_key.



6
7
8
 
# File 'lib/s3/service.rb', line 6

def secret_access_key
  @secret_access_key
end

#use_ssl ⇒ Object (readonly)

Returns the value of attribute use_ssl.



6
7
8
 
# File 'lib/s3/service.rb', line 6

def use_ssl
  @use_ssl
end

Instance Method Details

#==(other) ⇒ Object

Compares service to other, by access_key_id and secret_access_key



10
11
12
 
# File 'lib/s3/service.rb', line 10

def ==(other)
  self.access_key_id == other.access_key_id and self.secret_access_key == other.secret_access_key
end

#buckets ⇒ Object

Returns all buckets in the service and caches the result (see reload)



38
39
40
 
# File 'lib/s3/service.rb', line 38

def buckets
  Proxy.new(lambda { list_all_my_buckets}, :owner => self, :extend => BucketsExtension)
end

#inspect ⇒ Object

:nodoc:



54
55
56
 
# File 'lib/s3/service.rb', line 54

def inspect #:nodoc:
  "#<#{self.class}:#@access_key_id>"
end

#port ⇒ Object

Returns 443 or 80, depends on :use_ssl value from initializer



50
51
52
 
# File 'lib/s3/service.rb', line 50

def port
  use_ssl ? 443 : 80
end

#protocol ⇒ Object

Returns “http://” or “https://”, depends on :use_ssl value from initializer



44
45
46
 
# File 'lib/s3/service.rb', line 44

def protocol
  use_ssl ? "https://" : "http://"
end