azure-storage 0.11.4.preview → 0.11.5.preview

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4512753b91913e5655d1351527e53e8c57c8513
-  data.tar.gz: 4441fca205689321defd8362034cc8c12c8ca497
+  metadata.gz: 99c064d9e707d08b6efa5c7c83f96e6cb8a5ddc6
+  data.tar.gz: 5cc39f4003ae67bbb655fe8d30a5701d2404b736
 SHA512:
-  metadata.gz: 389d6ade41ef5fbcda27fd80dc7204c04b89a8a968d8cac4909043c0f3850a1c6fa6f3e0ce722669696075a53f42554c03fffaf5e805bb26333e8560dcc1de13
-  data.tar.gz: 8c2ac0e6eb75d2a1e079f93cd18df38619febce078432b7d975e1165e85b5fc612268522645316c2bc02742ef0b2f9ae88939a3320a2014c3d0ea580823c1339
+  metadata.gz: 0359aaaeca2ae969a7ec5ffd68a281fb679fe952bf12fcbdda6e1a9086b2221a8e6c33853e8c0f8df170b6906fc748b21f86011a20c4ed4280baea3b07dd5393
+  data.tar.gz: a19f2f613d09b8da5305c0fc9d46395929be89d8640978af4123f1934147cae34fb6e5cbd230e20109e9eff7de041246c21699a28fcf944c4b289ba8b2c4f0a5

data/lib/azure/storage/blob/blob.rb

@@ -787,7 +787,7 @@ module Azure::Storage
         StorageService.with_header headers, 'x-ms-lease-id', options[:lease_id]
       end
 
-      response = call(:put, uri, nil, headers, options)
+      call(:put, uri, nil, headers, options)
       nil
     end
     

data/lib/azure/storage/blob/blob_service.rb

@@ -38,10 +38,10 @@ module Azure::Storage
       include Azure::Storage::Blob
       include Azure::Storage::Blob::Container
       
-      def initialize(options = {})
+      def initialize(options = {}, &block)
         client_config = options[:client] || Azure::Storage
         signer = options[:signer] || Azure::Storage::Core::Auth::SharedKey.new(client_config.storage_account_name, client_config.storage_access_key)
-        super(signer, client_config.storage_account_name, options)
+        super(signer, client_config.storage_account_name, options, &block)
         @host = client.storage_blob_host
       end
 
@@ -49,7 +49,7 @@ module Azure::Storage
         # Force the request.body to the content encoding of specified in the header
         if headers && !body.nil? && (body.is_a? String) && ((body.encoding.to_s <=> 'ASCII_8BIT') != 0)
           if headers['x-ms-blob-content-type'].nil?
-            Service::StorageService.with_header headers, 'x-ms-blob-content-type', "text/plain; charset=#{body.encoding.to_s}"
+            Service::StorageService.with_header headers, 'x-ms-blob-content-type', "text/plain; charset=#{body.encoding}"
           else
             charset = parse_charset_from_content_type(headers['x-ms-blob-content-type'])
             body.force_encoding(charset) if charset
@@ -177,7 +177,7 @@ module Azure::Storage
         else
           uri = container_uri(container, query)
         end
-        
+
         duration = -1
         duration = options[:duration] if options[:duration]
 

data/lib/azure/storage/client.rb

@@ -27,6 +27,7 @@ require 'azure/storage/core/http_client'
 
 require 'azure/storage/client_options'
 
+require 'azure/storage/service/storage_service'
 require 'azure/storage/blob/blob_service'
 require 'azure/storage/table/table_service'
 require 'azure/storage/queue/queue_service'
@@ -59,6 +60,7 @@ module Azure::Storage
     # * +:default_endpoints_protocol+     - String. http or https
     # * +:use_path_style_uri+             - String. Whether use path style URI for specified endpoints
     # * +:ca_file+                        - String. File path of the CA file if having issue with SSL
+    # * +:user_agent_prefix+              - String. The user agent prefix that can identify the application calls the library
     #
     # The valid set of options inlcude:
     # * Storage Emulator: +:use_development_storage+ required, +:development_storage_proxy_uri+ optionally
@@ -76,19 +78,24 @@ module Azure::Storage
     # When empty options are given, it will try to read settings from Environment Variables. Refer to [Azure::Storage::ClientOptions.env_vars_mapping] for the mapping relationship
     #
     # @return [Azure::Storage::Client]
-    def initialize(options = {})
+    def initialize(options = {}, &block)
       if options.is_a?(Hash)
         options = setup_options if options.length == 0
         options = parse_connection_string(options[:storage_connection_string]) if options[:storage_connection_string]
-      end
 
+        if options.has_key?(:user_agent_prefix)
+          Azure::Storage::Service::StorageService.user_agent_prefix = options[:user_agent_prefix]
+          options.delete :user_agent_prefix
+        end
+      end
+      Azure::Storage::Service::StorageService.register_request_callback &block if block_given?
       reset!(options)
     end
 
     # Azure Blob service client configured from this Azure Storage client instance
     # @return [Azure::Storage::Blob::BlobService]
-    def blob_client(options = {})
-      @blob_client ||= Azure::Storage::Blob::BlobService.new(default_client(options))
+    def blob_client(options = {}, &block)
+      @blob_client ||= Azure::Storage::Blob::BlobService.new(default_client(options), &block)
     end
 
     # Azure Queue service client configured from this Azure Storage client instance
@@ -104,7 +111,6 @@ module Azure::Storage
     end
 
     class << self
-
       # Public: Creates an instance of [Azure::Storage::Client]
       #
       # ==== Attributes
@@ -127,6 +133,7 @@ module Azure::Storage
       # * +:default_endpoints_protocol+     - String. http or https
       # * +:use_path_style_uri+             - String. Whether use path style URI for specified endpoints
       # * +:ca_file+                        - String. File path of the CA file if having issue with SSL
+      # * +:user_agent_prefix+              - String. The user agent prefix that can identify the application calls the library
       #
       # The valid set of options inlcude:
       # * Storage Emulator: +:use_development_storage+ required, +:development_storage_proxy_uri+ optionally
@@ -144,8 +151,8 @@ module Azure::Storage
       # When empty options are given, it will try to read settings from Environment Variables. Refer to [Azure::Storage::ClientOptions.env_vars_mapping] for the mapping relationship
       #
       # @return [Azure::Storage::Client]
-      def create(options={})
-        Client.new(options)
+      def create(options={}, &block)
+        Client.new(options, &block)
       end
 
       # Public: Creates an instance of [Azure::Storage::Client] with Storage Emulator
@@ -155,17 +162,16 @@ module Azure::Storage
       # * +proxy_uri+    - String. Used with +:use_development_storage+ if emulator is hosted other than localhost.
       #
       # @return [Azure::Storage::Client]
-      def create_development(proxy_uri=nil)
+      def create_development(proxy_uri=nil, &block)
         proxy_uri ||= StorageServiceClientConstants::DEV_STORE_URI
-        create(:use_development_storage => true, :development_storage_proxy_uri => proxy_uri)
+        create(:use_development_storage => true, :development_storage_proxy_uri => proxy_uri, &block)
       end
 
-
       # Public: Creates an instance of [Azure::Storage::Client] from Environment Variables
       #
       # @return [Azure::Storage::Client]
-      def create_from_env
-        create
+      def create_from_env(&block)
+        create &block
       end
 
       # Public: Creates an instance of [Azure::Storage::Client] from Environment Variables
@@ -175,8 +181,8 @@ module Azure::Storage
       # * +connection_string+    - String. Please refer to https://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/.
       #
       # @return [Azure::Storage::Client]
-      def create_from_connection_string(connection_string)
-        Client.new(connection_string)
+      def create_from_connection_string(connection_string, &block)
+        Client.new(connection_string, &block)
       end
     end
 

data/lib/azure/storage/client_options.rb

@@ -327,7 +327,7 @@ module Azure::Storage
 
     def parse_connection_string(connection_string)
       opts = {}
-      cs_items = connection_string.split(';').each do |i|
+      connection_string.split(';').each do |i|
         e = i.index('=')
         raise InvalidConnectionStringError,SR::INVALID_CONNECTION_STRING if e < 0 || e == i.length - 1
         key,value = i[0..e-1],i[e+1..i.length-1]

data/lib/azure/storage/core/auth/shared_access_signature_generator.rb

@@ -153,7 +153,7 @@ module Azure::Storage::Core
           valid_mappings.merge!(TABLE_KEY_MAPPINGS)
         end
 
-        invalid_options = options.reject { |k,v| valid_mappings.key?(k) }
+        invalid_options = options.reject { |k, _| valid_mappings.key?(k) }
         raise Azure::Storage::InvalidOptionsError,"invalid options #{invalid_options} provided for SAS token generate" if invalid_options.length > 0
 
         canonicalize_time(options)
@@ -162,7 +162,7 @@ module Azure::Storage::Core
         .reject { |k, v| SERVICE_OPTIONAL_QUERY_PARAMS.include?(k) && v.to_s == '' }
         .merge( sig: @signer.sign(signable_string_for_service(service_type, path, options)) )
         
-        sas_params = URI.encode_www_form(query_hash)
+        URI.encode_www_form(query_hash)
       end
 
       # Construct the plaintext to the spec required for signatures
@@ -222,7 +222,7 @@ module Azure::Storage::Core
         options = DEFAULTS.merge(options)
         valid_mappings = ACCOUNT_KEY_MAPPINGS
 
-        invalid_options = options.reject { |k,v| valid_mappings.key?(k) }
+        invalid_options = options.reject { |k, _| valid_mappings.key?(k) }
         raise Azure::Storage::InvalidOptionsError,"invalid options #{invalid_options} provided for SAS token generate" if invalid_options.length > 0
 
         canonicalize_time(options)
@@ -231,7 +231,7 @@ module Azure::Storage::Core
         .reject { |k, v| ACCOUNT_OPTIONAL_QUERY_PARAMS.include?(k) && v.to_s == '' }
         .merge( sig: @signer.sign(signable_string_for_account(options)) )
         
-        sas_params = URI.encode_www_form(query_hash)
+        URI.encode_www_form(query_hash)
       end
 
       # Construct the plaintext to the spec required for signatures
@@ -239,7 +239,6 @@ module Azure::Storage::Core
       def signable_string_for_account(options)
         # Order is significant
         # The newlines from empty strings here are required
-        signable_string =
         [
           @account_name,
           options[:permissions],
@@ -311,7 +310,7 @@ module Azure::Storage::Core
       # * +:startrk+              - String. Optional. The start row key of a specified row key range.
       # * +:endrk+                - String. Optional. The end row key of a specified row key range.
       def signed_uri(uri, use_account_sas, options)
-        parsed_query = CGI::parse(uri.query || '').inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+        CGI::parse(uri.query || '').inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
 
         if options[:service] == nil and uri.host != nil
           host_splits = uri.host.split('.')
@@ -324,7 +323,7 @@ module Azure::Storage::Core
                        generate_service_sas_token(uri.path, options)
                      end
 
-        result = URI.parse(uri.to_s + (uri.query.nil? ? '?' : '&') + sas_params)
+        URI.parse(uri.to_s + (uri.query.nil? ? '?' : '&') + sas_params)
       end
     end
   end

data/lib/azure/storage/queue/queue_service.rb

@@ -30,10 +30,10 @@ module Azure::Storage
     include Azure::Storage::Service
     class QueueService < StorageService
 
-      def initialize(options = {})
+      def initialize(options = {}, &block)
         client_config = options[:client] || Azure::Storage
         signer = options[:signer] || Azure::Storage::Core::Auth::SharedKey.new(client_config.storage_account_name, client_config.storage_access_key)
-        super(signer, client_config.storage_account_name, options)
+        super(signer, client_config.storage_account_name, options, &block)
         @host = @client.storage_queue_host
       end
 

data/lib/azure/storage/service/storage_service.rb

@@ -33,10 +33,11 @@ module Azure::Storage
       # Create a new instance of the StorageService
       #
       # @param signer         [Azure::Core::Auth::Signer] An implementation of Signer used for signing requests.
-      # (optional, Default=Azure::Storage::Auth::SharedKey.new)
+      #                                                   (optional, Default=Azure::Storage::Auth::SharedKey.new)
       # @param account_name   [String] The account name (optional, Default=Azure::Storage.storage_account_name)
       # @param options        [Azure::Storage::Configurable] the client configuration context
-      def initialize(signer=nil, account_name=nil, options = {})
+      def initialize(signer=nil, account_name=nil, options = {}, &block)
+        StorageService.register_request_callback &block if block_given?
         options[:client] = Azure::Storage if options[:client] == nil
         client_config = options[:client]
         signer = signer || Azure::Storage::Core::Auth::SharedKey.new(
@@ -118,6 +119,20 @@ module Azure::Storage
       end
         
       class << self
+        # @!attribute user_agent_prefix
+        # @return [Proc] Get or set the user agent prefix
+        attr_accessor :user_agent_prefix
+        
+        # @!attribute request_callback
+        # @return [Proc] The callback before the request is signed and sent
+        attr_reader :request_callback
+
+        # Registers the callback when sending the request
+        # The headers in the request can be viewed or changed in the code block
+        def register_request_callback
+          @request_callback = Proc.new
+        end
+
         # Adds metadata properties to header hash with required prefix
         #
         # metadata  - A Hash of metadata name/value pairs
@@ -127,7 +142,7 @@ module Azure::Storage
             metadata.each do |key, value|
               headers["x-ms-meta-#{key}"] = value
             end
-           end
+          end
         end
         
         # Adds a value to the Hash object
@@ -157,9 +172,10 @@ module Azure::Storage
         def common_headers(options = {})
           headers = {
             'x-ms-version' => Azure::Storage::Default::STG_VERSION,
-            'User-Agent' => Azure::Storage::Default::USER_AGENT
+            'User-Agent' => user_agent_prefix ? "#{user_agent_prefix}; #{Azure::Storage::Default::USER_AGENT}" : Azure::Storage::Default::USER_AGENT
           }
           headers.merge!({'x-ms-client-request-id' => options[:request_id]}) if options[:request_id]
+          @request_callback.call(headers) if @request_callback
           headers
         end
       end

data/lib/azure/storage/table/batch.rb

@@ -184,12 +184,12 @@ module Azure::Storage
           if op[:headers]
             op[:headers].each { |k,v|
                 body.add_line "#{k}: #{v}"
-              }
+            }
           end
           
           if op[:body]
             body.add_line "Content-Type: application/atom+xml;type=entry"
-            body.add_line "Content-Length: #{op[:body].bytesize.to_s}"
+            body.add_line "Content-Length: #{op[:body].bytesize}"
             body.add_line ""
             body.add_line op[:body]
           else

data/lib/azure/storage/table/query.rb

@@ -109,7 +109,7 @@ module Azure::Storage
         result = ""
         clauses = []
         filters.each { |f|
-          clauses.push "#{f[0].to_s} #{f[1].to_s} #{Azure::Storage::Table::EdmType.serialize_query_value(f[2])}"
+          clauses.push "#{f[0]} #{f[1]} #{Azure::Storage::Table::EdmType.serialize_query_value(f[2])}"
         }
         return nil if clauses.length == 0 
         

data/lib/azure/storage/table/table_service.rb

@@ -31,10 +31,10 @@ module Azure::Storage
   module Table
     class TableService < Service::StorageService
 
-      def initialize(options = {})
+      def initialize(options = {}, &block)
         client_config = options[:client] || Azure::Storage
         signer = options[:signer] || Auth::SharedKey.new(client_config.storage_account_name, client_config.storage_access_key)
-        super(signer, client_config.storage_account_name, options)
+        super(signer, client_config.storage_account_name, options, &block)
         @host = client.storage_table_host
       end
 
@@ -569,12 +569,12 @@ module Azure::Storage
         return table_name if table_name.kind_of? ::URI
 
         path = if partition_key && row_key
-          "%s(PartitionKey='%s',RowKey='%s')" % [
-            table_name.encode("UTF-8"), encodeODataUriValue(partition_key.encode("UTF-8")), encodeODataUriValue(row_key.encode("UTF-8"))
-          ]
-        else
-          "%s()" % table_name.encode("UTF-8")
-        end
+               "%s(PartitionKey='%s',RowKey='%s')" % [
+                 table_name.encode("UTF-8"), encodeODataUriValue(partition_key.encode("UTF-8")), encodeODataUriValue(row_key.encode("UTF-8"))
+               ]
+               else
+                 "%s()" % table_name.encode("UTF-8")
+               end
 
         uri = generate_uri(path)
         qs = []

data/lib/azure/storage/version.rb

@@ -28,7 +28,7 @@ module Azure
       # Fields represent the parts defined in http://semver.org/
       MAJOR = 0 unless defined? MAJOR
       MINOR = 11 unless defined? MINOR
-      UPDATE = 4 unless defined? UPDATE
+      UPDATE = 5 unless defined? UPDATE
       PRE = 'preview' unless defined? PRE
 
       class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azure-storage
 version: !ruby/object:Gem::Version
-  version: 0.11.4.preview
+  version: 0.11.5.preview
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: azure-core
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement