Class: SwiftClient

Inherits:
Object
  • Object
show all
Defined in:
lib/swift_client.rb,
lib/swift_client/version.rb

Defined Under Namespace

Classes: AuthenticationError, EmptyNameError, OptionError, ResponseError, TempUrlKeyMissing

Constant Summary collapse

VERSION = 
"0.1.0"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ SwiftClient

Returns a new instance of SwiftClient.



30
31
32
33
34
 
# File 'lib/swift_client.rb', line 30

def initialize(options = {})
  self.options = options

  authenticate
end

Instance Attribute Details

#auth_token ⇒ Object

Returns the value of attribute auth_token.



28
29
30
 
# File 'lib/swift_client.rb', line 28

def auth_token
  @auth_token
end

#options ⇒ Object

Returns the value of attribute options.



28
29
30
 
# File 'lib/swift_client.rb', line 28

def options
  @options
end

#storage_url ⇒ Object

Returns the value of attribute storage_url.



28
29
30
 
# File 'lib/swift_client.rb', line 28

def storage_url
  @storage_url
end

Instance Method Details

#delete_container(container_name) ⇒ Object

Raises:



84
85
86
87
88
 
# File 'lib/swift_client.rb', line 84

def delete_container(container_name)
  raise(EmptyNameError) if container_name.empty?

  request :delete, "/#{container_name}"
end

#delete_object(object_name, container_name) ⇒ Object

Raises:



125
126
127
128
129
 
# File 'lib/swift_client.rb', line 125

def delete_object(object_name, container_name)
  raise(EmptyNameError) if object_name.empty? || container_name.empty?

  request :delete, "/#{container_name}/#{object_name}"
end

#get_container(container_name, query = {}) ⇒ Object

Raises:



56
57
58
59
60
 
# File 'lib/swift_client.rb', line 56

def get_container(container_name, query = {})
  raise(EmptyNameError) if container_name.empty?

  request :get, "/#{container_name}", :query => query
end

#get_containers(query = {}) ⇒ Object 



48
49
50
 
# File 'lib/swift_client.rb', line 48

def get_containers(query = {})
  request :get, "/", :query => query
end

#get_object(object_name, container_name) ⇒ Object

Raises:



113
114
115
116
117
 
# File 'lib/swift_client.rb', line 113

def get_object(object_name, container_name)
  raise(EmptyNameError) if object_name.empty? || container_name.empty?

  request :get, "/#{container_name}/#{object_name}"
end

#get_objects(container_name, query = {}) ⇒ Object

Raises:



131
132
133
134
135
 
# File 'lib/swift_client.rb', line 131

def get_objects(container_name, query = {})
  raise(EmptyNameError) if container_name.empty?

  request :get, "/#{container_name}", :query => query
end

#head_account ⇒ Object 



36
37
38
 
# File 'lib/swift_client.rb', line 36

def 
  request :head, "/"
end

#head_container(container_name) ⇒ Object

Raises:



66
67
68
69
70
 
# File 'lib/swift_client.rb', line 66

def head_container(container_name)
  raise(EmptyNameError) if container_name.empty?

  request :head, "/#{container_name}"
end

#head_containers ⇒ Object 



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

def head_containers
  request :head, "/"
end

#head_object(object_name, container_name) ⇒ Object

Raises:



119
120
121
122
123
 
# File 'lib/swift_client.rb', line 119

def head_object(object_name, container_name)
  raise(EmptyNameError) if object_name.empty? || container_name.empty?

  request :head, "/#{container_name}/#{object_name}"
end

#paginate_container(container_name, query = {}, &block) ⇒ Object 



62
63
64
 
# File 'lib/swift_client.rb', line 62

def paginate_container(container_name, query = {}, &block)
  paginate :get_container, container_name, query, &block
end

#paginate_containers(query = {}, &block) ⇒ Object 



52
53
54
 
# File 'lib/swift_client.rb', line 52

def paginate_containers(query = {}, &block)
  paginate :get_containers, query, &block
end

#paginate_objects(container_name, query = {}, &block) ⇒ Object 



137
138
139
 
# File 'lib/swift_client.rb', line 137

def paginate_objects(container_name, query = {}, &block)
  paginate :get_objects, container_name, query, &block
end

#post_account(headers = {}) ⇒ Object 



40
41
42
 
# File 'lib/swift_client.rb', line 40

def (headers = {})
  request :post, "/", :headers => headers
end

#post_container(container_name, headers = {}) ⇒ Object

Raises:



78
79
80
81
82
 
# File 'lib/swift_client.rb', line 78

def post_container(container_name, headers = {})
  raise(EmptyNameError) if container_name.empty?

  request :post, "/#{container_name}", :headers => headers
end

#post_object(object_name, container_name, headers = {}) ⇒ Object

Raises:



107
108
109
110
111
 
# File 'lib/swift_client.rb', line 107

def post_object(object_name, container_name, headers = {})
  raise(EmptyNameError) if object_name.empty? || container_name.empty?

  request :post, "/#{container_name}/#{object_name}", :headers => headers
end

#public_url(object_name, container_name) ⇒ Object

Raises:



141
142
143
144
145
 
# File 'lib/swift_client.rb', line 141

def public_url(object_name, container_name)
  raise(EmptyNameError) if object_name.empty? || container_name.empty?

  "#{storage_url}/#{container_name}/#{object_name}"
end

#put_container(container_name, headers = {}) ⇒ Object

Raises:



72
73
74
75
76
 
# File 'lib/swift_client.rb', line 72

def put_container(container_name, headers = {})
  raise(EmptyNameError) if container_name.empty?

  request :put, "/#{container_name}", :headers => headers
end

#put_object(object_name, data_or_io, container_name, headers = {}) ⇒ Object

Raises:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/swift_client.rb', line 90

def put_object(object_name, data_or_io, container_name, headers = {})
  raise(EmptyNameError) if object_name.empty? || container_name.empty?

  mime_type = MIME::Types.of(object_name).first

  extended_headers = (headers || {}).dup

  unless find_header_key(extended_headers, "Content-Type")
    extended_headers["Content-Type"] = mime_type.content_type if mime_type
    extended_headers["Content-Type"] ||= "application/octet-stream"
  end

  extended_headers["Transfer-Encoding"] = "chunked"

  request :put, "/#{container_name}/#{object_name}", :body_stream => data_or_io.respond_to?(:read) ? data_or_io : StringIO.new(data_or_io), :headers => extended_headers
end

#temp_url(object_name, container_name, opts = {}) ⇒ Object

Raises:



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/swift_client.rb', line 147

def temp_url(object_name, container_name, opts = {})
  raise(EmptyNameError) if object_name.empty? || container_name.empty?
  raise(TempUrlKeyMissing) unless options[:temp_url_key]

  expires = (Time.now + (options[:expires_in] || 3600).to_i).to_i
  path = URI.parse("#{storage_url}/#{container_name}/#{object_name}").path

  signature = OpenSSL::HMAC.hexdigest("sha1", options[:temp_url_key], "GET\n#{expires}\n#{path}")

  "#{storage_url}/#{container_name}/#{object_name}?temp_url_sig=#{signature}&temp_url_expires=#{expires}"
end