blobstore_client 1.5.0.pre.1141 → 1.5.0.pre.1142

data/lib/blobstore_client/base.rb

@@ -43,8 +43,9 @@ module Bosh
       # Get an object from the blobstore.
       # @param [String] id object id
       # @param [File] file where to store the fetched object
+      # @param [Hash] options for individual request configuration
       # @return [String] the object contents if the file parameter is nil
-      def get(id, file = nil)
+      def get(id, file = nil, options = {})
         if file
           get_file(id, file)
           file.flush

data/lib/blobstore_client/client.rb

@@ -1,18 +1,24 @@
-# Copyright (c) 2009-2012 VMware, Inc.
-
 module Bosh
   module Blobstore
     class Client
       PROVIDER_NAMES = %w[dav simple s3 swift atmos local]
 
       def self.create(blobstore_provider, options = {})
-        unless PROVIDER_NAMES.include? blobstore_provider
-          raise BlobstoreError, "Invalid client provider, available providers are: #{PROVIDER_NAMES}"
+        unless PROVIDER_NAMES.include?(blobstore_provider)
+          raise BlobstoreError,
+            "Unknown client provider '#{blobstore_provider}', " +
+            "available providers are: #{PROVIDER_NAMES}"
         end
-
         blobstore_client_constantize(blobstore_provider).new(options)
       end
 
+      def self.safe_create(provider, options = {})
+        wrapped_client = create(provider, options)
+        sha1_client    = Sha1VerifiableBlobstoreClient.new(wrapped_client)
+        retryable      = Retryable.new(tries: 3, sleep: 0.5, on: [BlobstoreError])
+        RetryableBlobstoreClient.new(sha1_client, retryable)
+      end
+
       private
 
       def self.blobstore_client_constantize(base_string)

data/lib/blobstore_client/retryable_blobstore_client.rb

@@ -0,0 +1,29 @@
+require 'forwardable'
+
+module Bosh
+  module Blobstore
+    class RetryableBlobstoreClient < BaseClient
+      extend Forwardable
+
+      def initialize(client, retryable)
+        @client = client
+        @retryable = retryable
+      end
+
+      def get(id, file = nil, options = {})
+        # BoshRetryable#retryer interface does not allow nil
+        # as a successful return value; hence, we save off last result
+        last_result = nil
+
+        @retryable.retryer do
+          last_result = @client.get(id, file, options)
+          true
+        end
+
+        last_result
+      end
+
+      def_delegators :@client, :create, :delete, :exists?
+    end
+  end
+end

data/lib/blobstore_client/sha1_verifiable_blobstore_client.rb

@@ -0,0 +1,43 @@
+require 'digest/sha1'
+require 'forwardable'
+
+module Bosh
+  module Blobstore
+    class Sha1VerifiableBlobstoreClient < BaseClient
+      extend Forwardable
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(id, file = nil, options = {})
+        if options.has_key?(:sha1)
+          expected_sha1 = options[:sha1]
+          raise ArgumentError, 'sha1 must not be nil' unless expected_sha1
+        end
+
+        result_file = @client.get(id, file, options)
+
+        if expected_sha1
+          # Blobstore clients either modify passed in file
+          # or return new temporary file
+          check_sha1(expected_sha1, file || result_file)
+        end
+
+        result_file
+      end
+
+      def_delegators :@client, :create, :delete, :exists?
+
+      private
+
+      def check_sha1(expected_sha1, file_to_check)
+        expected_sha1 = expected_sha1
+        actual_sha1   = Digest::SHA1.file(file_to_check.path).hexdigest
+        unless expected_sha1 == actual_sha1
+          raise BlobstoreError, "sha1 mismatch expected=#{expected_sha1} actual=#{actual_sha1}"
+        end
+      end
+    end
+  end
+end

data/lib/blobstore_client/version.rb

@@ -3,7 +3,7 @@
 module Bosh
   module Blobstore
     class Client
-      VERSION = '1.5.0.pre.1141'
+      VERSION = '1.5.0.pre.1142'
     end
   end
 end

data/lib/blobstore_client.rb

@@ -1,14 +1,15 @@
-# Copyright (c) 2009-2012 VMware, Inc.
-
 require 'common/common'
 require 'blobstore_client/version'
 require 'blobstore_client/errors'
 require 'blobstore_client/client'
 
 Bosh::Blobstore.autoload(:BaseClient, 'blobstore_client/base')
+require 'blobstore_client/retryable_blobstore_client'
+require 'blobstore_client/sha1_verifiable_blobstore_client'
+
 Bosh::Blobstore.autoload(:S3BlobstoreClient, 'blobstore_client/s3_blobstore_client')
 Bosh::Blobstore.autoload(:SimpleBlobstoreClient, 'blobstore_client/simple_blobstore_client')
 Bosh::Blobstore.autoload(:SwiftBlobstoreClient, 'blobstore_client/swift_blobstore_client')
 Bosh::Blobstore.autoload(:AtmosBlobstoreClient, 'blobstore_client/atmos_blobstore_client')
 Bosh::Blobstore.autoload(:LocalClient, 'blobstore_client/local_client')
-Bosh::Blobstore.autoload(:DavBlobstoreClient, 'blobstore_client/dav_blobstore_client')
+Bosh::Blobstore.autoload(:DavBlobstoreClient, 'blobstore_client/dav_blobstore_client')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blobstore_client
 version: !ruby/object:Gem::Version
-  version: 1.5.0.pre.1141
+  version: 1.5.0.pre.1142
   prerelease: 6
 platform: ruby
 authors:
@@ -98,7 +98,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0.pre.1141
+        version: 1.5.0.pre.1142
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,10 +106,42 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0.pre.1141
+        version: 1.5.0.pre.1142
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-fire
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'BOSH blobstore client
 
-  903d52'
+  31eb14'
 email: support@cloudfoundry.com
 executables:
 - blobstore_client_console
@@ -125,7 +157,9 @@ files:
 - lib/blobstore_client/dav_blobstore_client.rb
 - lib/blobstore_client/errors.rb
 - lib/blobstore_client/local_client.rb
+- lib/blobstore_client/retryable_blobstore_client.rb
 - lib/blobstore_client/s3_blobstore_client.rb
+- lib/blobstore_client/sha1_verifiable_blobstore_client.rb
 - lib/blobstore_client/simple_blobstore_client.rb
 - lib/blobstore_client/swift_blobstore_client.rb
 - lib/blobstore_client/version.rb