swift_client 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb7d0291c3fcc0d03fd4aa4711c8c7c4a06b46bf
-  data.tar.gz: 8caa6d7f8e4e21ce1567f7d968e6197fd83760f4
+  metadata.gz: f508dc3170899b3d306bf359c0d2df09edf0a694
+  data.tar.gz: a2ec9c73c26ca3ba8d7eb4b374d3d6c92acfb7d2
 SHA512:
-  metadata.gz: 88d70e38c7d901e1625c03d12e7a9e016f7d26a3687c1ad3282cc7c29847a3cdfc168ce275453cfd69aff8e27a7ece108c25d2438c3e989beae693d8c17688dd
-  data.tar.gz: eada405a14079e11075ba3a378461c2975da0ef2107609dcf706dca2373da5fde6eea263376873bab01455e38d84d2dd512feacc9a15b84c9395ef55ae0b2bbc
+  metadata.gz: 79cdf304996ef393d92c032d0da81ed9cb57c0cb8c17b3262f6854b722140293075202a3b7b6bc1b8d4049d137ab52d1a6dc9ac51504447b1ed44bca7d47d81f
+  data.tar.gz: ad166b66f8aa123e6a8ceda6d5acab0125a50034f20347af008cded08b00e4f0b5e35bf660110ae694bb46364f51bdeddc357b481494f21cad76b548d6307b1d

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.ruby-version

data/README.md

@@ -140,6 +140,7 @@ SwiftClient offers the following requests:
 * 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
+* get_object(object_name, container_name){|chunk| save chunk } -> 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
@@ -148,6 +149,42 @@ SwiftClient offers the following requests:
 * temp_url(object_name, container_name, options = {}) -> HTTParty::Response
 * bulk_delete(entries) -> entries
 
+### Getting large objects
+The `get_object` method with out a block is suitable for small objects that easily fit in memory. For larger objects, specify a block to process chunked data as it comes in.
+
+```ruby
+File.open("/tmp/output", "wb") do |file_io|
+  swift_client.get_object("/large/object", "container") do |chunk|
+    file_io.write(chunk)
+  end
+end
+```
+
+## Re-Using/Sharing/Caching Auth Tokens
+
+Certain OpenStack/Swift providers have limits in place regarding token
+generation. To re-use auth tokens by caching them via memcached, install dalli
+
+`gem install dalli`
+
+and provide an instance of Dalli::Client to SwiftClient:
+
+```ruby
+swift_client = SwiftClient.new(
+  :auth_url => "https://example.com/auth/v1.0",
+  ...
+  :cache_store => Dalli::Client.new
+)
+```
+
+The cache key used to store the auth token will include all neccessary details
+to ensure the auth token won't be used for a different swift account erroneously.
+
+The cache implementation of SwiftClient is not restricted to memcached. To use
+a different one, simply implement a driver for your favorite cache store. See
+[null_cache.rb](https://github.com/mrkamel/swift_client/blob/master/lib/swift_client/null_cache.rb)
+for more info.
+
 ## bulk_delete
 
 Takes an array containing container_name/object_name entries.

data/lib/swift_client.rb

@@ -114,10 +114,10 @@ class SwiftClient
     request :post, "/#{container_name}/#{object_name}", :headers => headers
   end
 
-  def get_object(object_name, container_name)
+  def get_object(object_name, container_name, &block)
     raise(EmptyNameError) if object_name.empty? || container_name.empty?
 
-    request :get, "/#{container_name}/#{object_name}"
+    request(:get, "/#{container_name}/#{object_name}", block ? { :stream_body => true } : {}, &block)
   end
 
   def head_object(object_name, container_name)
@@ -183,21 +183,21 @@ class SwiftClient
     headers.keys.detect { |k| k.downcase == key.downcase }
   end
 
-  def request(method, path, opts = {})
+  def request(method, path, opts = {}, &block)
     headers = (opts[:headers] || {}).dup
     headers["X-Auth-Token"] = auth_token
     headers["Accept"] = "application/json"
 
     stream_pos = opts[:body_stream].pos if opts[:body_stream]
 
-    response = HTTParty.send(method, "#{storage_url}#{path}", opts.merge(:headers => headers))
+    response = HTTParty.send(method, "#{storage_url}#{path}", opts.merge(:headers => headers), &block)
 
     if response.code == 401
       authenticate
 
       opts[:body_stream].pos = stream_pos if opts[:body_stream]
 
-      return request(method, path, opts)
+      return request(method, path, opts, &block)
     end
 
     raise(ResponseError.new(response.code, response.message)) unless response.success?
@@ -357,4 +357,3 @@ class SwiftClient
     end
   end
 end
-

data/lib/swift_client/version.rb

@@ -1,5 +1,4 @@
 
 class SwiftClient
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end
-

data/test/swift_client_test.rb

@@ -277,8 +277,18 @@ class SwiftClientTest < MiniTest::Test
 
   def test_get_object
     stub_request(:get, "https://example.com/v1/AUTH_account/container/object").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => "Body", :headers => {})
+    block_res = 0
+
+    large_body = "Body" * 16384
+    stub_request(:get, "https://example.com/v1/AUTH_account/container/large_object").with(:headers => { "Accept" => "application/json", "X-Auth-Token" => "Token" }).to_return(:status => 200, :body => large_body, :headers => {})
 
     assert_equal "Body", @swift_client.get_object("object", "container").body
+
+    @swift_client.get_object("large_object", "container") do |chunk|
+      block_res += chunk.length
+    end
+
+    assert_equal block_res, large_body.length
   end
 
   def test_head_object
@@ -340,4 +350,3 @@ class SwiftClientTest < MiniTest::Test
     assert @swift_client.temp_url("object", "container", :expires_in => 86400) =~ %r{https://example.com/v1/AUTH_account/container/object\?temp_url_sig=[a-f0-9]{40}&temp_url_expires=1086400}
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swift_client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty