azure-storage 0.13.0.preview → 0.14.0.preview

data/lib/azure/storage/file/file_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-------------------------------------------------------------------------
 # # Copyright (c) Microsoft and contributors. All rights reserved.
 #
@@ -21,9 +23,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #--------------------------------------------------------------------------
-require 'azure/storage/core/auth/shared_key'
-require 'azure/storage/file/serialization'
-require 'azure/storage/file/file'
+require "azure/storage/core/auth/shared_key"
+require "azure/storage/file/serialization"
+require "azure/storage/file/file"
 
 module Azure::Storage
   module File
@@ -40,13 +42,13 @@ module Azure::Storage
         @host = client.storage_file_host
       end
 
-      def call(method, uri, body=nil, headers={}, options={})
+      def call(method, uri, body = nil, headers = {}, options = {})
         # 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-content-type'].nil?
-            Service::StorageService.with_header headers, 'x-ms-content-type', "text/plain; charset=#{body.encoding}"
+        if headers && !body.nil? && (body.is_a? String) && ((body.encoding.to_s <=> "ASCII_8BIT") != 0)
+          if headers["x-ms-content-type"].nil?
+            Service::StorageService.with_header headers, "x-ms-content-type", "text/plain; charset=#{body.encoding}"
           else
-            charset = parse_charset_from_content_type(headers['x-ms-content-type'])
+            charset = parse_charset_from_content_type(headers["x-ms-content-type"])
             body.force_encoding(charset) if charset
           end
         end
@@ -55,8 +57,8 @@ module Azure::Storage
 
         # Force the response.body to the content charset of specified in the header.
         # Content-Type is echo'd back for the blob and is used to store the encoding of the octet stream
-        if !response.nil? && !response.body.nil? && response.headers['Content-Type']
-          charset = parse_charset_from_content_type(response.headers['Content-Type'])
+        if !response.nil? && !response.body.nil? && response.headers["Content-Type"]
+          charset = parse_charset_from_content_type(response.headers["Content-Type"])
           response.body.force_encoding(charset) if charset && charset.length > 0
         end
 
@@ -93,21 +95,21 @@ module Azure::Storage
       #
       # * +:timeout+                 - Integer. A timeout in seconds.
       #
-      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
       #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See: https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/list-shares
       #
       # Returns an Azure::Service::EnumerationResults
       #
-      def list_shares(options={})
-        query = { }
+      def list_shares(options = {})
+        query = {}
         if options
-          StorageService.with_query query, 'prefix', options[:prefix]
-          StorageService.with_query query, 'marker', options[:marker]
-          StorageService.with_query query, 'maxresults', options[:max_results].to_s if options[:max_results]
-          StorageService.with_query query, 'include', 'metadata' if options[:metadata] == true
-          StorageService.with_query query, 'timeout', options[:timeout].to_s if options[:timeout]
+          StorageService.with_query query, "prefix", options[:prefix]
+          StorageService.with_query query, "marker", options[:marker]
+          StorageService.with_query query, "maxresults", options[:max_results].to_s if options[:max_results]
+          StorageService.with_query query, "include", "metadata" if options[:metadata] == true
+          StorageService.with_query query, "timeout", options[:timeout].to_s if options[:timeout]
         end
 
         uri = shares_uri(query)
@@ -125,10 +127,10 @@ module Azure::Storage
       # Returns a URI.
       #
       protected
-      def shares_uri(query={})
-        query = { 'comp' => 'list' }.merge(query)
-        generate_uri('', query)
-      end
+        def shares_uri(query = {})
+          query = { "comp" => "list" }.merge(query)
+          generate_uri("", query)
+        end
 
       # Protected: Generate the URI for a specific share.
       #
@@ -140,11 +142,11 @@ module Azure::Storage
       # Returns a URI.
       #
       protected
-      def share_uri(name, query={})
-        return name if name.kind_of? ::URI
-        query = { 'restype' => 'share' }.merge(query)
-        generate_uri(name, query)
-      end
+        def share_uri(name, query = {})
+          return name if name.kind_of? ::URI
+          query = { "restype" => "share" }.merge(query)
+          generate_uri(name, query)
+        end
 
       # Protected: Generate the URI for a specific directory.
       #
@@ -158,11 +160,11 @@ module Azure::Storage
       # Returns a URI.
       #
       protected
-      def directory_uri(share, directory_path, query={})
-        path = directory_path.nil? ? share : ::File.join(share, directory_path)
-        query = { 'restype' => 'directory' }.merge(query)
-        generate_uri(path, query, true)
-      end
+        def directory_uri(share, directory_path, query = {})
+          path = directory_path.nil? ? share : ::File.join(share, directory_path)
+          query = { "restype" => "directory" }.merge(query)
+          generate_uri(path, query, true)
+        end
 
       # Protected: Generate the URI for a specific file.
       #
@@ -176,16 +178,16 @@ module Azure::Storage
       # Returns a URI.
       #
       protected
-      def file_uri(share, directory_path, file, query={})
-        if directory_path.nil?
-          path = ::File.join(share, file)
-        else
-          path = ::File.join(share, directory_path, file)
+        def file_uri(share, directory_path, file, query = {})
+          if directory_path.nil?
+            path = ::File.join(share, file)
+          else
+            path = ::File.join(share, directory_path, file)
+          end
+          generate_uri(path, query, true)
         end
-        generate_uri(path, query, true)
-      end
     end
   end
 end
 
-Azure::Storage::FileService = Azure::Storage::File::FileService
+Azure::Storage::FileService = Azure::Storage::File::FileService

data/lib/azure/storage/file/serialization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-------------------------------------------------------------------------
 # # Copyright (c) Microsoft and contributors. All rights reserved.
 #
@@ -21,7 +23,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #--------------------------------------------------------------------------
-require 'azure/storage/service/serialization'
+require "azure/storage/service/serialization"
 
 module Azure::Storage
   module File
@@ -33,7 +35,7 @@ module Azure::Storage
         expect_node("EnumerationResults", xml)
 
         results = enumeration_results_from_xml(xml, Azure::Service::EnumerationResults.new)
-        
+
         return results unless (xml > "Shares").any? && ((xml > "Shares") > "Share").any?
 
         if xml.Shares.Share.count == 0
@@ -79,7 +81,7 @@ module Azure::Storage
 
       def self.share_properties_from_headers(headers)
         props = {}
-        props[:last_modified] = headers["Last-Modified"] 
+        props[:last_modified] = headers["Last-Modified"]
         props[:etag] = headers["ETag"]
         props
       end
@@ -162,7 +164,7 @@ module Azure::Storage
 
       def self.directory_properties_from_headers(headers)
         props = {}
-        props[:last_modified] = headers["Last-Modified"] 
+        props[:last_modified] = headers["Last-Modified"]
         props[:etag] = headers["ETag"]
         props
       end
@@ -183,12 +185,13 @@ module Azure::Storage
 
         props[:content_length] = headers["Content-Length"].to_i unless headers["Content-Length"].nil?
         props[:content_length] = headers["x-ms-content-length"].to_i unless headers["x-ms-content-length"].nil?
-  
+
         props[:content_type] =  headers["Content-Type"]
         props[:content_encoding] = headers["Content-Encoding"]
         props[:content_language] = headers["Content-Language"]
         props[:content_disposition] = headers["Content-Disposition"]
-        props[:content_md5] = headers["Content-MD5"]
+        props[:content_md5] = headers["x-ms-content-md5"] || headers["Content-MD5"]
+        props[:range_md5] = headers["Content-MD5"] if headers["x-ms-content-md5"] && headers["Content-MD5"]
         props[:cache_control] = headers["Cache-Control"]
 
         props[:copy_id] = headers["x-ms-copy-id"]

data/lib/azure/storage/file/share.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-------------------------------------------------------------------------
 # # Copyright (c) Microsoft and contributors. All rights reserved.
 #
@@ -21,12 +23,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #--------------------------------------------------------------------------
-require 'azure/storage/file/serialization'
+require "azure/storage/file/serialization"
 
 module Azure::Storage::File
   module Share
     include Azure::Storage::Service
-    
+
     class Share
       def initialize
         @properties = {}
@@ -55,16 +57,16 @@ module Azure::Storage::File
     # * +:quota+                    - Integer. The maximum size of the share, in gigabytes.
     #                                 Must be greater than 0, and less than or equal to 5TB (5120). (optional).
     # * +:timeout+                  - Integer. A timeout in seconds.
-    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
     #                                 in the analytics logs when storage analytics logging is enabled.
     #
     # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/create-share
     #
     # Returns a Share
-    def create_share(name, options={})
+    def create_share(name, options = {})
       # Query
-      query = { }
-      query['timeout'] = options[:timeout].to_s if options[:timeout]
+      query = {}
+      query["timeout"] = options[:timeout].to_s if options[:timeout]
 
       # Scheme + path
       uri = share_uri(name, query)
@@ -72,7 +74,7 @@ module Azure::Storage::File
       # Headers
       headers = StorageService.common_headers
       StorageService.add_metadata_to_headers(options[:metadata], headers) if options[:metadata]
-      headers['x-ms-share-quota'] = options[:quota].to_s if options[:quota]
+      headers["x-ms-share-quota"] = options[:quota].to_s if options[:quota]
 
       # Call
       response = call(:put, uri, nil, headers, options)
@@ -96,16 +98,16 @@ module Azure::Storage::File
     #
     # Accepted key/value pairs in options parameter are:
     # * +:timeout+                  - Integer. A timeout in seconds.
-    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
     #                                 in the analytics logs when storage analytics logging is enabled.
     #
     # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/get-share-properties
     #
     # Returns a Share
-    def get_share_properties(name, options={})
+    def get_share_properties(name, options = {})
       # Query
-      query = { }
-      query['timeout'] = options[:timeout].to_s if options[:timeout]
+      query = {}
+      query["timeout"] = options[:timeout].to_s if options[:timeout]
 
       # Call
       response = call(:get, share_uri(name, query), nil, {}, options)
@@ -129,24 +131,24 @@ module Azure::Storage::File
     # * +:quota+                    - Integer. The maximum size of the share, in gigabytes.
     #                                 Must be greater than 0, and less than or equal to 5TB (5120). (optional).
     # * +:timeout+                  - Integer. A timeout in seconds.
-    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
     #                                 in the analytics logs when storage analytics logging is enabled.
     #
     # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/set-share-properties
     #
     # Returns nil on success
-    def set_share_properties(name, options={})
+    def set_share_properties(name, options = {})
       # Query
-      query = { 'comp' => 'properties' }
-      query['timeout'] = options[:timeout].to_s if options[:timeout]
+      query = { "comp" => "properties" }
+      query["timeout"] = options[:timeout].to_s if options[:timeout]
 
       # Headers
       headers = StorageService.common_headers
-      headers['x-ms-share-quota'] = options[:quota].to_s if options[:quota]
+      headers["x-ms-share-quota"] = options[:quota].to_s if options[:quota]
 
       # Call
       call(:put, share_uri(name, query), nil, headers, options)
-      
+
       # Result
       nil
     end
@@ -162,16 +164,16 @@ module Azure::Storage::File
     #
     # Accepted key/value pairs in options parameter are:
     # * +:timeout+                  - Integer. A timeout in seconds.
-    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
     #                                 in the analytics logs when storage analytics logging is enabled.
     #
     # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/get-share-metadata
     #
     # Returns a Share
-    def get_share_metadata(name, options={})
+    def get_share_metadata(name, options = {})
       # Query
-      query = { 'comp' => 'metadata' }
-      query['timeout'] = options[:timeout].to_s if options[:timeout]
+      query = { "comp" => "metadata" }
+      query["timeout"] = options[:timeout].to_s if options[:timeout]
 
       # Call
       response = call(:get, share_uri(name, query), nil, {}, options)
@@ -194,16 +196,16 @@ module Azure::Storage::File
     #
     # Accepted key/value pairs in options parameter are:
     # * +:timeout+                  - Integer. A timeout in seconds.
-    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
     #                                 in the analytics logs when storage analytics logging is enabled.
     #
     # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/set-share-metadata
     #
     # Returns nil on success
-    def set_share_metadata(name, metadata, options={})
+    def set_share_metadata(name, metadata, options = {})
       # Query
-      query = { 'comp' => 'metadata' }
-      query['timeout'] = options[:timeout].to_s if options[:timeout]
+      query = { "comp" => "metadata" }
+      query["timeout"] = options[:timeout].to_s if options[:timeout]
 
       # Headers
       headers = StorageService.common_headers
@@ -211,7 +213,7 @@ module Azure::Storage::File
 
       # Call
       call(:put, share_uri(name, query), nil, headers, options)
-      
+
       # Result
       nil
     end
@@ -227,20 +229,20 @@ module Azure::Storage::File
     #
     # Accepted key/value pairs in options parameter are:
     # * +:timeout+                  - Integer. A timeout in seconds.
-    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
     #                                 in the analytics logs when storage analytics logging is enabled.
     #
     # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/delete-share
     #
     # Returns nil on success
-    def delete_share(name, options={})
+    def delete_share(name, options = {})
       # Query
-      query = { }
-      query['timeout'] = options[:timeout].to_s if options[:timeout]
+      query = {}
+      query["timeout"] = options[:timeout].to_s if options[:timeout]
 
       # Call
       call(:delete, share_uri(name, query), nil, {}, options)
-      
+
       # result
       nil
     end
@@ -256,7 +258,7 @@ module Azure::Storage::File
     #
     # Accepted key/value pairs in options parameter are:
     # * +:timeout+                  - Integer. A timeout in seconds.
-    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
     #                                 in the analytics logs when storage analytics logging is enabled.
     #
     # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/get-share-acl
@@ -265,11 +267,11 @@ module Azure::Storage::File
     #   share                       - A Azure::Storage::File::Share::Share instance
     #   signed_identifiers          - A list of Azure::Storage::Service::SignedIdentifier instances
     #
-    def get_share_acl(name, options={})
+    def get_share_acl(name, options = {})
       # Query
-      query = { 'comp' => 'acl' }
-      query['timeout'] = options[:timeout].to_s if options[:timeout]
-      
+      query = { "comp" => "acl" }
+      query["timeout"] = options[:timeout].to_s if options[:timeout]
+
       # Call
       response = call(:get, share_uri(name, query), nil, {}, options)
 
@@ -295,19 +297,19 @@ module Azure::Storage::File
     # Accepted key/value pairs in options parameter are:
     # * +:signed_identifiers+          - Array. A list of Azure::Storage::Service::SignedIdentifier instances.
     # * +:timeout+                     - Integer. A timeout in seconds.
-    # * +:request_id+                  - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+    # * +:request_id+                  - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
     #                                    in the analytics logs when storage analytics logging is enabled.
-    # 
+    #
     # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/set-share-acl
     #
     # Returns a tuple of (share, signed_identifiers)
     # * +share+                        - A Azure::Storage::File::Share::Share instance
     # * +signed_identifiers+           - A list of Azure::Storage::Service::SignedIdentifier instances
     #
-    def set_share_acl(name, options={})
+    def set_share_acl(name, options = {})
       # Query
-      query = { 'comp' => 'acl' }
-      query['timeout'] = options[:timeout].to_s if options[:timeout]
+      query = { "comp" => "acl" }
+      query["timeout"] = options[:timeout].to_s if options[:timeout]
 
       # Scheme + path
       uri = share_uri(name, query)
@@ -339,16 +341,16 @@ module Azure::Storage::File
     #
     # Accepted key/value pairs in options parameter are:
     # * +:timeout+                  - Integer. A timeout in seconds.
-    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+    # * +:request_id+               - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
     #                                 in the analytics logs when storage analytics logging is enabled.
     #
     # See https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/get-share-stats
     #
     # Returns a Share
-    def get_share_stats(name, options={})
+    def get_share_stats(name, options = {})
       # Query
-      query = { 'comp' => 'stats' }
-      query['timeout'] = options[:timeout].to_s if options[:timeout]
+      query = { "comp" => "stats" }
+      query["timeout"] = options[:timeout].to_s if options[:timeout]
 
       # Call
       response = call(:get, share_uri(name, query), nil, {}, options)
@@ -360,4 +362,4 @@ module Azure::Storage::File
       share
     end
   end
-end
+end