swift_client 0.0.5 → 0.0.6

data/README.md

@@ -23,13 +23,29 @@ Or install it yourself as:
 First, connect to a Swift cluster:
 
 ```ruby
-swift_client = SwiftClient.new(:auth_url => "https://example.com/auth/v1.0", :username => "account:username", :api_key => "secret api key", :temp_url_key => "optional temp url key")
+swift_client = SwiftClient.new(:auth_url => "https://example.com/auth/v1.0", :username => "account:username", :api_key => "api key", :temp_url_key => "temp url key", :storage_url => "https://example.com/v1/AUTH_account")
 ```
 
+To connect via v2 you have to add version and method specific details:
+
+```ruby
+swift_client = SwiftClient.new(:auth_url => "https://auth.example.com/v2.0", :storage_url => "https://storage.example.com/v1/AUTH_account", :tenant_name => "tenant", :username => "username", :password => "password")
+
+# OR
+
+swift_client = SwiftClient.new(:auth_url => "https://auth.example.com/v2.0", :storage_url => "https://storage.example.com/v1/AUTH_account", :tenant_name => "tenant", :access_key => "access key", :secret_key => "secret key")
+```
+
+where `temp_url_key` and `storage_url` are optional.
+
 SwiftClient will automatically reconnect in case the endpoint responds with 401
-Unauthorized to one of your requests using the provided credentials.
-Otherwise, i.e. in case the endpoint does not respond with 2xx to any of
-SwiftClient's requests, SwiftClient will raise a `SwiftClient::ResponseError`.
+Unauthorized to one of your requests using the provided credentials. In case
+the endpoint does not respond with 2xx to any of SwiftClient's requests,
+SwiftClient will raise a `SwiftClient::ResponseError`. Otherwise, SwiftClient
+responds with an `HTTParty::Response` object, such that you can call `#headers`
+to access the response headers or `#body` as well as `#parsed_response` to
+access the response body and JSON response. Checkout the
+[HTTParty](https://github.com/jnunemaker/httparty) gem to learn more.
 
 SwiftClient offers the following requests:
 
@@ -37,19 +53,22 @@ SwiftClient offers the following requests:
 * post_account(headers = {}) -> HTTParty::Response
 * head_containers -> HTTParty::Response
 * get_containers(query = {}) -> HTTParty::Response
-* get_container(container, query = {}) -> HTTParty::Response
-* head_container(container) -> HTTParty::Response
-* put_container(container, headers = {}) -> HTTParty::Response
-* post_container(container, headers = {}) -> HTTParty::Response
-* delete_container(container) -> HTTParty::Response
-* put_object(object, data_or_io, container, headers = {}) -> HTTParty::Response
-* post_object(object, container, headers = {}) -> HTTParty::Response
-* get_object(object, container) -> HTTParty::Response
-* head_object(object, container) -> HTTParty::Response
-* delete_object(object, container) -> HTTParty::Response
-* get_objects(container, query = {}) -> HTTParty::Response
-* public_url(object, container) -> HTTParty::Response
-* temp_url(object, container) -> HTTParty::Response
+* paginate_containers(query = {}) -> Enumerator
+* get_container(container_name, query = {}) -> HTTParty::Response
+* paginate_container(container_name, query = {}) -> Enumerator
+* head_container(container_name) -> HTTParty::Response
+* put_container(container_name, headers = {}) -> HTTParty::Response
+* post_container(container_name, headers = {}) -> HTTParty::Response
+* delete_container(container_name) -> HTTParty::Response
+* put_object(object_name, data_or_io, container_name, headers = {}) -> HTTParty::Response
+* post_object(object_name, container_name, headers = {}) -> HTTParty::Response
+* get_object(object_name, container_name) -> HTTParty::Response
+* head_object(object_name, container_name) -> HTTParty::Response
+* delete_object(object_name, container_name) -> HTTParty::Response
+* get_objects(container_name, query = {}) -> HTTParty::Response
+* paginate_objetcs(container_name, query = {}) -> Enumerator
+* public_url(object_name, container_name) -> HTTParty::Response
+* temp_url(object_name, container_name) -> HTTParty::Response
 
 ## Contributing
 

data/lib/swift_client/version.rb

@@ -1,5 +1,5 @@
 
 class SwiftClient
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end
 

data/lib/swift_client.rb

@@ -27,10 +27,6 @@ class SwiftClient
   attr_accessor :options, :auth_token, :storage_url
 
   def initialize(options = {})
-    [:auth_url, :username, :api_key].each do |key|
-      raise(OptionError, "#{key} is missing") unless options.key?(key)
-    end
-
     self.options = options
 
     authenticate
@@ -52,93 +48,105 @@ class SwiftClient
     request :get, "/", :query => query
   end
 
-  def get_container(container, query = {})
-    raise(EmptyNameError) if container.empty?
+  def paginate_containers(query = {}, &block)
+    paginate :get_containers, query, &block
+  end
+
+  def get_container(container_name, query = {})
+    raise(EmptyNameError) if container_name.empty?
 
-    request :get, "/#{container}", :query => query
+    request :get, "/#{container_name}", :query => query
   end
 
-  def head_container(container)
-    raise(EmptyNameError) if container.empty?
+  def paginate_container(container_name, query = {}, &block)
+    paginate :get_container, container_name, query, &block
+  end
+
+  def head_container(container_name)
+    raise(EmptyNameError) if container_name.empty?
 
-    request :head, "/#{container}"
+    request :head, "/#{container_name}"
   end
 
-  def put_container(container, headers = {})
-    raise(EmptyNameError) if container.empty?
+  def put_container(container_name, headers = {})
+    raise(EmptyNameError) if container_name.empty?
 
-    request :put, "/#{container}", :headers => headers
+    request :put, "/#{container_name}", :headers => headers
   end
 
-  def post_container(container, headers = {})
-    raise(EmptyNameError) if container.empty?
+  def post_container(container_name, headers = {})
+    raise(EmptyNameError) if container_name.empty?
 
-    request :post, "/#{container}", :headers => headers
+    request :post, "/#{container_name}", :headers => headers
   end
 
-  def delete_container(container)
-    raise(EmptyNameError) if container.empty?
+  def delete_container(container_name)
+    raise(EmptyNameError) if container_name.empty?
 
-    request :delete, "/#{container}"
+    request :delete, "/#{container_name}"
   end
 
-  def put_object(object, data_or_io, container, headers = {})
-    raise(EmptyNameError) if object.empty? || container.empty?
+  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).first
+    mime_type = MIME::Types.of(object_name).first
 
     extended_headers = headers.dup
     extended_headers["Content-Type"] ||= mime_type.content_type if mime_type
 
-    request :put, "/#{container}/#{object}", :body => data_or_io.respond_to?(:read) ? data_or_io.read : data_or_io, :headers => extended_headers
+    request :put, "/#{container_name}/#{object_name}", :body => data_or_io.respond_to?(:read) ? data_or_io.read : data_or_io, :headers => extended_headers
   end
 
-  def post_object(object, container, headers = {})
-    raise(EmptyNameError) if object.empty? || container.empty?
+  def post_object(object_name, container_name, headers = {})
+    raise(EmptyNameError) if object_name.empty? || container_name.empty?
 
-    request :post, "/#{container}/#{object}", :headers => headers
+    request :post, "/#{container_name}/#{object_name}", :headers => headers
   end
 
-  def get_object(object, container)
-    raise(EmptyNameError) if object.empty? || container.empty?
+  def get_object(object_name, container_name)
+    raise(EmptyNameError) if object_name.empty? || container_name.empty?
 
-    request :get, "/#{container}/#{object}"
+    request :get, "/#{container_name}/#{object_name}"
   end
 
-  def head_object(object, container)
-    raise(EmptyNameError) if object.empty? || container.empty?
+  def head_object(object_name, container_name)
+    raise(EmptyNameError) if object_name.empty? || container_name.empty?
 
-    request :head, "/#{container}/#{object}"
+    request :head, "/#{container_name}/#{object_name}"
   end
 
-  def delete_object(object, container)
-    raise(EmptyNameError) if object.empty? || container.empty?
+  def delete_object(object_name, container_name)
+    raise(EmptyNameError) if object_name.empty? || container_name.empty?
 
-    request :delete, "/#{container}/#{object}"
+    request :delete, "/#{container_name}/#{object_name}"
   end
 
-  def get_objects(container, query = {})
-    raise(EmptyNameError) if container.empty?
+  def get_objects(container_name, query = {})
+    raise(EmptyNameError) if container_name.empty?
+
+    request :get, "/#{container_name}", :query => query
+  end
 
-    request :get, "/#{container}", :query => query
+  def paginate_objects(container_name, query = {}, &block)
+    paginate :get_objects, container_name, query, &block
   end
 
-  def public_url(object, container)
-    raise(EmptyNameError) if object.empty? || container.empty?
+  def public_url(object_name, container_name)
+    raise(EmptyNameError) if object_name.empty? || container_name.empty?
 
-    "#{storage_url}/#{container}/#{object}"
+    "#{storage_url}/#{container_name}/#{object_name}"
   end
 
-  def temp_url(object, container, opts = {})
-    raise(EmptyNameError) if object.empty? || container.empty?
+  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}/#{object}").path
+    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}/#{object}?temp_url_sig=#{signature}&temp_url_expires=#{expires}"
+    "#{storage_url}/#{container_name}/#{object_name}?temp_url_sig=#{signature}&temp_url_expires=#{expires}"
   end
 
   private
@@ -162,6 +170,14 @@ class SwiftClient
   end
 
   def authenticate
+    options[:auth_url] =~ /v2/ ? authenticate_v2 : authenticate_v1
+  end
+
+  def authenticate_v1
+    [:auth_url, :username, :api_key].each do |key|
+      raise(AuthenticationError, "#{key} missing") unless options[key]
+    end
+
     response = HTTParty.get(options[:auth_url], :headers => { "X-Auth-User" => options[:username], "X-Auth-Key" => options[:api_key] })
 
     raise(AuthenticationError, "#{response.code}: #{response.message}") unless response.success?
@@ -169,5 +185,50 @@ class SwiftClient
     self.auth_token = response.headers["X-Auth-Token"]
     self.storage_url = options[:storage_url] || response.headers["X-Storage-Url"]
   end
+
+  def authenticate_v2
+    [:auth_url, :storage_url].each do |key|
+      raise(AuthenticationError, "#{key} missing") unless options[key]
+    end
+
+    auth = { "auth" => {} }
+
+    if options[:tenant_name]
+      auth["auth"]["tenantName"] = options[:tenant_name]
+    else
+      raise AuthenticationError, "No tenant specified"
+    end
+
+    if options[:username] && options[:password]
+      auth["auth"]["passwordCredentials"] = { "username" => options[:username], "password" => options[:password] }
+    elsif options[:access_key] && options[:secret_key]
+      auth["auth"]["apiAccessKeyCredentials"] = { "accessKey" => options[:access_key], "secretKey" => options[:secret_key] }
+    else
+      raise AuthenticationError, "Unknown authentication method"
+    end
+
+    response = HTTParty.post("#{options[:auth_url].gsub(/\/+$/, "")}/tokens", :body => JSON.dump(auth), :headers => { "Content-Type" => "application/json" })
+
+    raise(AuthenticationError, "#{response.code}: #{response.message}") unless response.success?
+
+    self.auth_token = response.parsed_response["access"]["token"]["id"]
+    self.storage_url = options[:storage_url]
+  end
+
+  def paginate(method, *args, query)
+    return enum_for(:paginate, method, *args, query) unless block_given?
+
+    marker = nil
+
+    loop do
+      response = send(method, *args, marker ? query.merge(:marker => marker) : query)
+
+      return if response.parsed_response.empty?
+
+      yield response
+
+      marker = response.parsed_response.last["name"]
+    end
+  end
 end
 

data/test/swift_client_test.rb

@@ -11,6 +11,24 @@ class SwiftClientTest < MiniTest::Test
     assert_equal "https://example.com/v1/AUTH_account", @swift_client.storage_url
   end
 
+  def test_v2_authentication_with_password
+    stub_request(:post, "https://auth.example.com/v2.0/tokens").with(:body => JSON.dump("auth" => { "tenantName" => "Tenant", "passwordCredentials" => { "username" => "Username", :password => "Password"  }})).to_return(:status => 200, :body => JSON.dump("access" => { "token" => { "id" => "Token" }}), :headers => { "Content-Type" => "application/json" })
+
+    @swift_client = SwiftClient.new(:storage_url => "https://example.com/v1/AUTH_account", :auth_url => "https://auth.example.com/v2.0", :tenant_name => "Tenant", :username => "Username", :password => "Password")
+
+    assert_equal "Token", @swift_client.auth_token
+    assert_equal "https://example.com/v1/AUTH_account", @swift_client.storage_url
+  end
+
+  def test_v2_authentication_with_key
+    stub_request(:post, "https://auth.example.com/v2.0/tokens").with(:body => JSON.dump("auth" => { "tenantName" => "Tenant", "apiAccessKeyCredentials" => { "accessKey" => "AccessKey", :secretKey => "SecretKey"  }})).to_return(:status => 200, :body => JSON.dump("access" => { "token" => { "id" => "Token" }}), :headers => { "Content-Type" => "application/json" })
+
+    @swift_client = SwiftClient.new(:storage_url => "https://example.com/v1/AUTH_account", :auth_url => "https://auth.example.com/v2.0", :tenant_name => "Tenant", :access_key => "AccessKey", :secret_key => "SecretKey")
+
+    assert_equal "Token", @swift_client.auth_token
+    assert_equal "https://example.com/v1/AUTH_account", @swift_client.storage_url
+  end
+
   def test_storage_url
     stub_request(:get, "https://example.com/auth/v1.0").with(:headers => { "X-Auth-Key" => "secret", "X-Auth-User" => "account:username" }).to_return(:status => 200, :body => "", :headers => { "X-Auth-Token" => "Token", "X-Storage-Url" => "https://example.com/v1/AUTH_account" })
 
@@ -49,6 +67,20 @@ class SwiftClientTest < MiniTest::Test
     assert_equal containers, @swift_client.get_containers.parsed_response
   end
 
+  def test_paginate_containers
+    containers = [
+      { "count" => 1, "bytes" => 1, "name" => "container-1" },
+      { "count" => 1, "bytes" => 1, "name" => "container-2" },
+      { "count" => 1, "bytes" => 1, "name" => "container-3" }
+    ]
+
+    stub_request(:get, "https://example.com/v1/AUTH_account/?limit=2").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(containers[0 .. 1]), :headers => { "Content-Type" => "application/json" })
+    stub_request(:get, "https://example.com/v1/AUTH_account/?limit=2&marker=container-2").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(containers[2 .. 3]), :headers => { "Content-Type" => "application/json" })
+    stub_request(:get, "https://example.com/v1/AUTH_account/?limit=2&marker=container-3").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump([]), :headers => { "Content-Type" => "application/json" })
+
+    assert_equal containers, @swift_client.paginate_containers(:limit => 2).collect(&:parsed_response).flatten
+  end
+
   def test_get_container
     objects = [
       { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-2", "content_type" => "Content type" },
@@ -60,6 +92,20 @@ class SwiftClientTest < MiniTest::Test
     assert_equal objects, @swift_client.get_container("container-1", :limit => 2, :marker => "object-2").parsed_response
   end
 
+  def test_paginate_container
+    objects = [
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-1", "content_type" => "Content type" },
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-2", "content_type" => "Content type" },
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-3", "content_type" => "Content type" },
+    ]
+
+    stub_request(:get, "https://example.com/v1/AUTH_account/container-1?limit=2").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(objects[0 .. 1]), :headers => { "Content-Type" => "application/json" })
+    stub_request(:get, "https://example.com/v1/AUTH_account/container-1?limit=2&marker=object-2").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(objects[2 .. 3]), :headers => { "Content-Type" => "application/json" })
+    stub_request(:get, "https://example.com/v1/AUTH_account/container-1?limit=2&marker=object-3").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump([]), :headers => { "Content-Type" => "application/json" })
+
+    assert_equal objects, @swift_client.paginate_container("container-1", :limit => 2).collect(&:parsed_response).flatten
+  end
+
   def test_head_container
     stub_request(:head, "https://example.com/v1/AUTH_account/container-1").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 204, :body => "", :headers => { "Content-Type" => "application/json" })
 
@@ -128,7 +174,21 @@ class SwiftClientTest < MiniTest::Test
 
     stub_request(:get, "https://example.com/v1/AUTH_account/container-1?limit=2&marker=object-2").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(objects), :headers => { "Content-Type" => "application/json" })
 
-    assert_equal objects, @swift_client.get_container("container-1", :limit => 2, :marker => "object-2").parsed_response
+    assert_equal objects, @swift_client.get_objects("container-1", :limit => 2, :marker => "object-2").parsed_response
+  end
+
+  def test_paginate_objects
+    objects = [
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-1", "content_type" => "Content type" },
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-2", "content_type" => "Content type" },
+      { "hash" => "Hash", "last_modified" => "Last modified", "bytes" => 1, "name" => "object-3", "content_type" => "Content type" }
+    ]
+
+    stub_request(:get, "https://example.com/v1/AUTH_account/container-1?limit=2").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(objects[0 .. 1]), :headers => { "Content-Type" => "application/json" })
+    stub_request(:get, "https://example.com/v1/AUTH_account/container-1?limit=2&marker=object-2").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump(objects[2 .. 3]), :headers => { "Content-Type" => "application/json" })
+    stub_request(:get, "https://example.com/v1/AUTH_account/container-1?limit=2&marker=object-3").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => JSON.dump([]), :headers => { "Content-Type" => "application/json" })
+
+    assert_equal objects, @swift_client.paginate_objects("container-1", :limit => 2).collect(&:parsed_response).flatten
   end
 
   def test_not_found

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swift_client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty