Class: S3::Service

Inherits:

Object

• Object
• S3::Service

show all

Includes:

Proxies, Parser

Defined in:

lib/s3/service.rb

Instance Attribute Summary (collapse)

• - (Object) access_key_id readonly

  Returns the value of attribute access_key_id.

• - (Object) proxy readonly

  Returns the value of attribute proxy.

• - (Object) secret_access_key readonly

  Returns the value of attribute secret_access_key.

• - (Object) use_ssl readonly

  Returns the value of attribute use_ssl.

Instance Method Summary (collapse)

• - (Object) ==(other)

  Compares service to other, by access_key_id and secret_access_key.

• - (Object) bucket(name)

  Returns the bucket with the given name.

• - (Object) buckets

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

• - (Service) initialize(options) constructor

  Creates new service.

• - (Object) inspect

  :nodoc:.

• - (Object) port

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

• - (Object) protocol

  Returns "http://" or "https://", depends on :use_ssl value from initializer.

Methods included from Parser

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

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

6
7
8

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

def access_key_id
  @access_key_id
end

6
7
8

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

def proxy
  @proxy
end

6
7
8

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

def secret_access_key
  @secret_access_key
end

6
7
8

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

def use_ssl
  @use_ssl
end

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

45
46
47

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

def bucket(name)
  Bucket.send(:new, self, name)
end

38
39
40

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

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

61
62
63

# File 'lib/s3/service.rb', line 61

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

57
58
59

# File 'lib/s3/service.rb', line 57

def port
  use_ssl ? 443 : 80
end

51
52
53

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

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