swift_client 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4555d9e6b744150b80127f8a144e358666a4d70c
-  data.tar.gz: f6da1e97fa79dc31ee538f5c3fa08981d9e76c06
+  metadata.gz: cb7d0291c3fcc0d03fd4aa4711c8c7c4a06b46bf
+  data.tar.gz: 8caa6d7f8e4e21ce1567f7d968e6197fd83760f4
 SHA512:
-  metadata.gz: 34f5162ea5b2b2fcfa3f5647eaf8c2d31dbf8947678a32cb8f6c0134f299c63a6c1b89b5c85a19c82d660bb0510ac48bbdd25e5247aa41b00a632b99e9d29ec2
-  data.tar.gz: 570eaee9130d6c3bd43af82dabe763ab8af06b60add3fc577d805ddeb28623889c50de51c1bd28efad0e6edc2f2e04b8dd6461e760a4eb0a6674cb20e92d5b7c
+  metadata.gz: 88d70e38c7d901e1625c03d12e7a9e016f7d26a3687c1ad3282cc7c29847a3cdfc168ce275453cfd69aff8e27a7ece108c25d2438c3e989beae693d8c17688dd
+  data.tar.gz: eada405a14079e11075ba3a378461c2975da0ef2107609dcf706dca2373da5fde6eea263376873bab01455e38d84d2dd512feacc9a15b84c9395ef55ae0b2bbc

data/README.md

@@ -146,6 +146,12 @@ SwiftClient offers the following requests:
 * paginate_objects(container_name, query = {}) -> Enumerator
 * public_url(object_name, container_name) -> HTTParty::Response
 * temp_url(object_name, container_name, options = {}) -> HTTParty::Response
+* bulk_delete(entries) -> entries
+
+## bulk_delete
+
+Takes an array containing container_name/object_name entries.
+Automatically slices and sends 1_000 items per request.
 
 ## Contributing
 

data/lib/swift_client/null_cache.rb

@@ -0,0 +1,11 @@
+
+class SwiftClient::NullCache
+  def get(key)
+    nil
+  end
+
+  def set(key, value)
+    true
+  end
+end
+

data/lib/swift_client/version.rb

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

data/lib/swift_client.rb

@@ -1,5 +1,6 @@
 
 require "swift_client/version"
+require "swift_client/null_cache"
 
 require "httparty"
 require "mime-types"
@@ -25,12 +26,13 @@ class SwiftClient
     end
   end
 
-  attr_accessor :options, :auth_token, :storage_url
+  attr_accessor :options, :auth_token, :storage_url, :cache_store
 
   def initialize(options = {})
     raise(OptionError, "Setting expires_in connection wide is deprecated") if options[:expires_in]
 
     self.options = options
+    self.cache_store = options[:cache_store] || SwiftClient::NullCache.new
 
     authenticate
   end
@@ -158,8 +160,25 @@ class SwiftClient
     "#{storage_url}/#{container_name}/#{object_name}?temp_url_sig=#{signature}&temp_url_expires=#{expires}"
   end
 
+  def bulk_delete(items)
+    items.each_slice(1_000) do |slice|
+      request :delete, "/?bulk-delete", :body => slice.join("\n"), :headers => { "Content-Type" => "text/plain" }
+    end
+
+    items
+  end
+
   private
 
+  def cache_key
+    auth_keys = [:auth_url, :username, :access_key, :user_id, :user_domain, :user_domain_id, :domain_name,
+      :domain_id, :token, :project_id, :project_name, :project_domain_name, :project_domain_id, :tenant_name]
+
+    auth_key = auth_keys.collect { |key| options[key] }.inspect
+
+    Digest::SHA1.hexdigest(auth_key)
+  end
+
   def find_header_key(headers, key)
     headers.keys.detect { |k| k.downcase == key.downcase }
   end
@@ -187,12 +206,38 @@ class SwiftClient
   end
 
   def authenticate
+    return if authenticate_from_cache
+
     return authenticate_v3 if options[:auth_url] =~ /v3/
     return authenticate_v2 if options[:auth_url] =~ /v2/
 
     authenticate_v1
   end
 
+  def authenticate_from_cache
+    cached_auth_token = cache_store.get("swift_client:auth_token:#{cache_key}")
+    cached_storage_url = cache_store.get("swift_client:storage_url:#{cache_key}")
+
+    return false if cached_auth_token.nil? || cached_storage_url.nil?
+
+    if cached_auth_token != auth_token || cached_storage_url != storage_url
+      self.auth_token = cached_auth_token
+      self.storage_url = cached_storage_url
+
+      return true
+    end
+
+    false
+  end
+
+  def set_authentication_details(auth_token, storage_url)
+    cache_store.set("swift_client:auth_token:#{cache_key}", auth_token)
+    cache_store.set("swift_client:storage_url:#{cache_key}", storage_url)
+
+    self.auth_token = auth_token
+    self.storage_url = storage_url
+  end
+
   def authenticate_v1
     [:auth_url, :username, :api_key].each do |key|
       raise(AuthenticationError, "#{key} missing") unless options[key]
@@ -202,8 +247,7 @@ class SwiftClient
 
     raise(AuthenticationError, "#{response.code}: #{response.message}") unless response.success?
 
-    self.auth_token = response.headers["X-Auth-Token"]
-    self.storage_url = options[:storage_url] || response.headers["X-Storage-Url"]
+    set_authentication_details response.headers["X-Auth-Token"], options[:storage_url] || response.headers["X-Storage-Url"]
   end
 
   def authenticate_v2
@@ -231,8 +275,7 @@ class SwiftClient
 
     raise(AuthenticationError, "#{response.code}: #{response.message}") unless response.success?
 
-    self.auth_token = response.parsed_response["access"]["token"]["id"]
-    self.storage_url = options[:storage_url]
+    set_authentication_details response.parsed_response["access"]["token"]["id"], options[:storage_url]
   end
 
   def authenticate_v3
@@ -277,10 +320,11 @@ class SwiftClient
 
     raise(AuthenticationError, "#{response.code}: #{response.message}") unless response.success?
 
-    self.auth_token = response.headers["X-Subject-Token"]
-    self.storage_url = options[:storage_url] || storage_url_from_v3_response(response)
+    storage_url = options[:storage_url] || storage_url_from_v3_response(response)
 
     raise(AuthenticationError, "storage_url missing") unless storage_url
+
+    set_authentication_details response.headers["X-Subject-Token"], storage_url
   end
 
   def storage_url_from_v3_response(response)

data/test/swift_client_test.rb

@@ -1,6 +1,20 @@
 
 require File.expand_path("../test_helper", __FILE__)
 
+class MemoryCache
+  def initialize
+    @cache = {}
+  end
+
+  def set(key, value)
+    @cache[key] = value
+  end
+
+  def get(key)
+    @cache[key]
+  end
+end
+
 class SwiftClientTest < MiniTest::Test
   def setup
     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" })
@@ -11,6 +25,22 @@ class SwiftClientTest < MiniTest::Test
     assert_equal "https://example.com/v1/AUTH_account", @swift_client.storage_url
   end
 
+  def test_authenticate_from_cache
+    cache = MemoryCache.new
+    cache.set("swift_client:auth_token:49f42f2927701ba93a5bf9750da8fedfa197fa82", "Cached token")
+    cache.set("swift_client:storage_url:49f42f2927701ba93a5bf9750da8fedfa197fa82", "https://cache.example.com/v1/AUTH_account")
+
+    @swift_client = SwiftClient.new(:auth_url => "https://example.com/auth/v1.0", :username => "account:username", :api_key => "secret", :temp_url_key => "Temp url key", :cache_store => cache)
+
+    assert_equal "Cached token", @swift_client.auth_token
+    assert_equal "https://cache.example.com/v1/AUTH_account", @swift_client.storage_url
+
+    @swift_client.send(:authenticate) # Re-authenticate
+
+    assert_equal "Token", @swift_client.auth_token
+    assert_equal "https://example.com/v1/AUTH_account", @swift_client.storage_url
+  end
+
   def test_v3_authentication_unscoped_with_password
     stub_request(:post, "https://auth.example.com/v3/auth/tokens").with(:body => JSON.dump("auth" => { "identity" => { "methods" => ["password"], "password" => { "user" => { "name" => "username", "password" => "secret", "domain" => { "name" => "example.com" }}}}})).to_return(:status => 200, :body => JSON.dump("token" => "..."), :headers => { "X-Subject-Token" => "Token", "Content-Type" => "application/json" })
 
@@ -134,6 +164,18 @@ class SwiftClientTest < MiniTest::Test
     assert_equal containers, @swift_client.get_containers.parsed_response
   end
 
+  def test_bulk_delete
+    objects = [
+      "container1/object1",
+      "container1/object2",
+      "container2/object1"
+    ]
+
+    stub_request(:delete, "https://example.com/v1/AUTH_account/?bulk-delete").with(:body => objects.join("\n"), :headers => { "Content-Type" => "text/plain", "X-Auth-Token" => "Token" }).to_return(:status => 200,:body => "", :headers => { "Content-Type" => "application/json" })
+
+    assert @swift_client.bulk_delete(objects)
+  end
+
   def test_paginate_containers
     containers = [
       { "count" => 1, "bytes" => 1, "name" => "container-1" },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swift_client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -122,6 +122,7 @@ files:
 - README.md
 - Rakefile
 - lib/swift_client.rb
+- lib/swift_client/null_cache.rb
 - lib/swift_client/version.rb
 - swift_client.gemspec
 - test/swift_client_test.rb