swift_client 0.0.4 → 0.0.5

data/README.md

@@ -18,6 +18,39 @@ Or install it yourself as:
 
     $ gem install swift_client
 
+## Usage
+
+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")
+```
+
+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`.
+
+SwiftClient offers the following requests:
+
+* head_account -> HTTParty::Response
+* 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
+
 ## Contributing
 
 1. Fork it ( https://github.com/mrkamel/swift_client/fork )

data/lib/swift_client.rb

@@ -36,10 +36,18 @@ class SwiftClient
     authenticate
   end
 
+  def head_account
+    request :head, "/"
+  end
+
   def post_account(headers = {})
     request :post, "/", :headers => headers
   end
 
+  def head_containers
+    request :head, "/"
+  end
+
   def get_containers(query = {})
     request :get, "/", :query => query
   end

data/lib/swift_client/version.rb

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

data/test/swift_client_test.rb

@@ -20,12 +20,24 @@ class SwiftClientTest < MiniTest::Test
     assert_equal "https://storage-url.com/path", @swift_client.storage_url
   end
 
+  def test_head_account
+    stub_request(:head, "https://example.com/v1/AUTH_account/").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 204, :body => "", :headers => { "Content-Type" => "application/json" })
+
+    assert 204, @swift_client.head_account.code
+  end
+
   def test_post_account
     stub_request(:post, "https://example.com/v1/AUTH_account/").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token", "X-Account-Meta-Test" => "Test" }).to_return(:status => 204, :body => "", :headers => { "Content-Type" => "application/json" })
 
     assert_equal 204, @swift_client.post_account("X-Account-Meta-Test" => "Test").code
   end
 
+  def test_head_containers
+    stub_request(:head, "https://example.com/v1/AUTH_account/").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 204, :body => "", :headers => { "Content-Type" => "application/json" })
+
+    assert 204, @swift_client.head_containers.code
+  end
+
   def test_get_containers
     containers = [
       { "count" => 1, "bytes" => 1, "name" => "container-1" },

metadata

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