azure-storage 0.13.0.preview → 0.14.0.preview

data/lib/azure/storage/client_options_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-------------------------------------------------------------------------
 # # Copyright (c) Microsoft and contributors. All rights reserved.
 #
@@ -22,13 +24,12 @@
 # THE SOFTWARE.
 #--------------------------------------------------------------------------
 
-require 'azure/storage/core'
+require "azure/storage/core"
 
 module Azure::Storage
-
   class InvalidConnectionStringError < Core::StorageError
     def initialize(message = SR::INVALID_CONNECTION_STRING)
-    	super(message)
+      super(message)
     end
   end
 
@@ -37,5 +38,4 @@ module Azure::Storage
       super(message)
     end
   end
-
-end
+end

data/lib/azure/storage/configurable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-------------------------------------------------------------------------
 # # Copyright (c) Microsoft and contributors. All rights reserved.
 #
@@ -25,7 +27,6 @@
 module Azure::Storage
   # The Azure::Storage::Configurable module provides basic configuration for Azure storage activities.
   module Configurable
-
     # @!attribute [w] storage_access_key
     #   @return [String] Azure Storage access key.
     # @!attribute storage_account_name
@@ -93,7 +94,7 @@ module Azure::Storage
     def reset_config!(options = {})
       Azure::Storage::Configurable.keys.each do |key|
         value = if self == Azure::Storage
-                  Azure::Storage::Default.options[key]
+          Azure::Storage::Default.options[key]
                 else
                   Azure::Storage.send(key)
                 end
@@ -105,7 +106,7 @@ module Azure::Storage
     end
 
     alias setup reset_config!
-    
+
     # Storage queue host
     # @return [String]
     def storage_queue_host
@@ -123,7 +124,7 @@ module Azure::Storage
     def storage_table_host
       @storage_table_host || default_host(:table)
     end
-    
+
     # Storage file host
     # @return [String]
     def storage_file_host
@@ -132,48 +133,47 @@ module Azure::Storage
 
     private
 
-    def default_host(service)
-      "https://#{storage_account_name}.#{service}.core.windows.net" if storage_account_name
-    end
+      def default_host(service)
+        "https://#{storage_account_name}.#{service}.core.windows.net" if storage_account_name
+      end
 
-    def setup_options
-      opts = {}
-      Azure::Storage::Configurable.keys.map do |key|
-        opts[key] = Azure::Storage.send(key) if Azure::Storage.send(key)
+      def setup_options
+        opts = {}
+        Azure::Storage::Configurable.keys.map do |key|
+          opts[key] = Azure::Storage.send(key) if Azure::Storage.send(key)
+        end
+        opts
       end
-      opts
-    end
 
-    def account_name_from_endpoint endpoint
-      return nil if endpoint.nil?
-      uri = URI::parse endpoint
-      fields = uri.host.split '.'
-      fields[0]
-    end
+      def account_name_from_endpoint(endpoint)
+        return nil if endpoint.nil?
+        uri = URI::parse endpoint
+        fields = uri.host.split "."
+        fields[0]
+      end
 
-    def determine_account_name
-      if instance_variable_get(:@storage_account_name).nil?
-        hosts = [@storage_blob_host, @storage_table_host, @storage_queue_host, @storage_file_host]
-        account_name = nil;
-        hosts.each do |host|
-          parsed = account_name_from_endpoint host
-          if account_name.nil?
-            account_name = parsed
-          elsif !account_name.nil? and !parsed.nil? and (account_name <=> parsed) != 0
-            raise InvalidOptionsError, "Ambiguous account name in service hosts."
+      def determine_account_name
+        if instance_variable_get(:@storage_account_name).nil?
+          hosts = [@storage_blob_host, @storage_table_host, @storage_queue_host, @storage_file_host]
+          account_name = nil;
+          hosts.each do |host|
+            parsed = account_name_from_endpoint host
+            if account_name.nil?
+              account_name = parsed
+            elsif !account_name.nil? && !parsed.nil? && (account_name <=> parsed) != (0)
+              raise InvalidOptionsError, "Ambiguous account name in service hosts."
+            end
           end
+          raise InvalidOptionsError, "Cannot identify account name." if account_name.nil?
+          @storage_account_name = account_name
         end
-        raise InvalidOptionsError, "Cannot identify account name." if account_name.nil?
-        @storage_account_name = account_name
       end
-    end
 
-    def setup_signer_for_service
-      if @storage_sas_token
-        determine_account_name
-        @signer = Azure::Storage::Core::Auth::SharedAccessSignatureSigner.new @storage_account_name, @storage_sas_token
+      def setup_signer_for_service
+        if @storage_sas_token
+          determine_account_name
+          @signer = Azure::Storage::Core::Auth::SharedAccessSignatureSigner.new @storage_account_name, @storage_sas_token
+        end
       end
-    end
-
   end
-end
+end

data/lib/azure/storage/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-------------------------------------------------------------------------
 # # Copyright (c) Microsoft and contributors. All rights reserved.
 #
@@ -27,7 +29,7 @@ module Azure
   end
 end
 
-require 'azure/storage/core/error'
-require 'azure/storage/default'
-require 'azure/storage/core/sr'
-require 'azure/storage/core/utility'
+require "azure/storage/core/error"
+require "azure/storage/default"
+require "azure/storage/core/sr"
+require "azure/storage/core/utility"

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-------------------------------------------------------------------------
 # # Copyright (c) Microsoft and contributors. All rights reserved.
 #
@@ -22,7 +24,7 @@
 # THE SOFTWARE.
 #--------------------------------------------------------------------------
 
-require 'azure/storage/core/auth/shared_access_signature_generator'
-require 'azure/storage/core/auth/shared_access_signature_signer'
+require "azure/storage/core/auth/shared_access_signature_generator"
+require "azure/storage/core/auth/shared_access_signature_signer"
 
-include Azure::Storage::Core::Auth
+include Azure::Storage::Core::Auth

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-------------------------------------------------------------------------
 # # Copyright (c) Microsoft and contributors. All rights reserved.
 #
@@ -22,19 +24,18 @@
 # THE SOFTWARE.
 #--------------------------------------------------------------------------
 
-require 'azure/storage/core'
-require 'azure/storage/client_options_error'
-require 'azure/core/auth/signer'
-require 'time'
-require 'uri'
+require "azure/storage/core"
+require "azure/storage/client_options_error"
+require "azure/core/auth/signer"
+require "time"
+require "uri"
 
 # @see https://msdn.microsoft.com/library/azure/dn140255.aspx for more information on construction
 module Azure::Storage::Core
   module Auth
     class SharedAccessSignature
-
       DEFAULTS = {
-        permissions: 'r',
+        permissions: "r",
         version: Azure::Storage::Default::STG_VERSION
       }
 
@@ -102,7 +103,7 @@ module Azure::Storage::Core
       #
       # @param account_name [String] The account name. Defaults to the one in the global configuration.
       # @param access_key [String]   The access_key encoded in Base64. Defaults to the one in the global configuration.
-      def initialize(account_name=Azure::Storage.storage_account_name, access_key=Azure::Storage.storage_access_key)
+      def initialize(account_name = Azure::Storage.storage_account_name, access_key = Azure::Storage.storage_access_key)
         @account_name = account_name
         @signer = Azure::Core::Auth::Signer.new(access_key)
       end
@@ -122,7 +123,7 @@ module Azure::Storage::Core
       #                                              Combination of 'r', 'a', 'u', 'p' in this order for a queue.
       #                                              Combination of 'r', 'a', 'u', 'd' in this order for a table.
       #                                              This option must be omitted if it has been specified in an associated stored access policy.
-      # * +:start+               - String. Optional. UTC Date/Time in ISO8601 format. 
+      # * +:start+               - String. Optional. UTC Date/Time in ISO8601 format.
       # * +:expiry+              - String. Optional. UTC Date/Time in ISO8601 format. Default now + 30 minutes.
       # * +:identifier+          - String. Optional. Identifier for stored access policy.
       # * +:protocol+            - String. Optional. Permitted protocols.
@@ -140,13 +141,13 @@ module Azure::Storage::Core
       # * +:endpk+               - String. Optional but must accompany endrk. The end partition key of a specified partition key range.
       # * +: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 generate_service_sas_token(path, options={})
+      def generate_service_sas_token(path, options = {})
         if options.key?(:service)
           service_type = SERVICE_TYPE_MAPPING[options[:service].to_sym]
           options.delete(:service)
         end
 
-        raise Azure::Storage::InvalidOptionsError,"SAS version cannot be set" if options[:version]
+        raise Azure::Storage::InvalidOptionsError, "SAS version cannot be set" if options[:version]
 
         options = DEFAULTS.merge(options)
         valid_mappings = SERVICE_KEY_MAPPINGS
@@ -154,7 +155,7 @@ module Azure::Storage::Core
           if options[:resource]
             options.merge!(resource: options[:resource])
           else
-            options.merge!(resource: 'b')
+            options.merge!(resource: "b")
           end
           valid_mappings.merge!(BLOB_KEY_MAPPINGS)
         elsif service_type == Azure::Storage::ServiceType::TABLE
@@ -164,20 +165,20 @@ module Azure::Storage::Core
           if options[:resource]
             options.merge!(resource: options[:resource])
           else
-            options.merge!(resource: 'f')
+            options.merge!(resource: "f")
           end
           valid_mappings.merge!(FILE_KEY_MAPPINGS)
         end
 
         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
+        raise Azure::Storage::InvalidOptionsError, "invalid options #{invalid_options} provided for SAS token generate" if invalid_options.length > 0
 
         canonicalize_time(options)
 
         query_hash = Hash[options.map { |k, v| [SERVICE_KEY_MAPPINGS[k], v] }]
-        .reject { |k, v| SERVICE_OPTIONAL_QUERY_PARAMS.include?(k) && v.to_s == '' }
-        .merge( sig: @signer.sign(signable_string_for_service(service_type, path, options)) )
-        
+        .reject { |k, v| SERVICE_OPTIONAL_QUERY_PARAMS.include?(k) && v.to_s == "" }
+        .merge(sig: @signer.sign(signable_string_for_service(service_type, path, options)))
+
         URI.encode_www_form(query_hash)
       end
 
@@ -225,28 +226,28 @@ module Azure::Storage::Core
       # * +:service+             - String. Required. Accessible services. Combination of 'b' (blob), 'q' (queue), 't' (table), 'f' (file).
       # * +:resource+            - String. Required. Accessible resource types. Combination of 's' (service), 'c' (container-level), 'o'(object-level).
       # * +:permissions+         - String. Required. Permissions. Combination of 'r' (read), 'w' (write), 'd'(delete), 'l'(list), 'a'(add),
-      #                                              'c'(create), 'u'(update), 'p'(process). Permissions are only valid if they match 
+      #                                              'c'(create), 'u'(update), 'p'(process). Permissions are only valid if they match
       #                                              the specified signed resource type; otherwise they are ignored.
       # * +:start+               - String. Optional. UTC Date/Time in ISO8601 format.
       # * +:expiry+              - String. Optional. UTC Date/Time in ISO8601 format. Default now + 30 minutes.
       # * +:protocol+            - String. Optional. Permitted protocols.
-      # * +:ip_range+            - String. Optional. An IP address or a range of IP addresses from which to accept requests. 
+      # * +:ip_range+            - String. Optional. An IP address or a range of IP addresses from which to accept requests.
       #                                    When specifying a range, note that the range is inclusive.
-      def generate_account_sas_token(options={})
-        raise Azure::Storage::InvalidOptionsError,"SAS version cannot be set" if options[:version]
+      def generate_account_sas_token(options = {})
+        raise Azure::Storage::InvalidOptionsError, "SAS version cannot be set" if options[:version]
 
         options = DEFAULTS.merge(options)
         valid_mappings = ACCOUNT_KEY_MAPPINGS
 
         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
+        raise Azure::Storage::InvalidOptionsError, "invalid options #{invalid_options} provided for SAS token generate" if invalid_options.length > 0
 
         canonicalize_time(options)
 
         query_hash = Hash[options.map { |k, v| [ACCOUNT_KEY_MAPPINGS[k], v] }]
-        .reject { |k, v| ACCOUNT_OPTIONAL_QUERY_PARAMS.include?(k) && v.to_s == '' }
-        .merge( sig: @signer.sign(signable_string_for_account(options)) )
-        
+        .reject { |k, v| ACCOUNT_OPTIONAL_QUERY_PARAMS.include?(k) && v.to_s == "" }
+        .merge(sig: @signer.sign(signable_string_for_account(options)))
+
         URI.encode_www_form(query_hash)
       end
 
@@ -265,7 +266,7 @@ module Azure::Storage::Core
           options[:ip_range],
           options[:protocol],
           Azure::Storage::Default::STG_VERSION,
-          ''
+          ""
         ].join("\n")
       end
 
@@ -278,7 +279,7 @@ module Azure::Storage::Core
       def canonicalize_time(options)
         options[:start] = Time.parse(options[:start]).utc.iso8601 if options[:start]
         options[:expiry] = Time.parse(options[:expiry]).utc.iso8601 if options[:expiry]
-        options[:expiry] ||= (Time.now + 60*30).utc.iso8601
+        options[:expiry] ||= (Time.now + 60 * 30).utc.iso8601
       end
 
       # A customised URI reflecting options for the resource signed with Shared Access Signature
@@ -291,7 +292,7 @@ module Azure::Storage::Core
       # * +:start+                - String. Optional. UTC Date/Time in ISO8601 format.
       # * +:expiry+               - String. Optional. UTC Date/Time in ISO8601 format. Default now + 30 minutes.
       # * +:protocol+             - String. Optional. Permitted protocols.
-      # * +:ip_range+             - String. Optional. An IP address or a range of IP addresses from which to accept requests. 
+      # * +:ip_range+             - String. Optional. An IP address or a range of IP addresses from which to accept requests.
       #                                     When specifying a range, note that the range is inclusive.
       #
       # Below options for account SAS only
@@ -326,20 +327,20 @@ 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)
-        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('.')
+        if options[:service] == (nil) && uri.host != (nil)
+          host_splits = uri.host.split(".")
           options[:service] = host_splits[1].chr if host_splits.length > 1 && host_splits[0] == @account_name
         end
 
         sas_params = if use_account_sas
-                       generate_account_sas_token(options)
+          generate_account_sas_token(options)
                      else
                        generate_service_sas_token(uri.path, options)
                      end
 
-        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/core/auth/shared_access_signature_signer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-------------------------------------------------------------------------
 # # Copyright (c) Microsoft and contributors. All rights reserved.
 #
@@ -22,27 +24,25 @@
 # THE SOFTWARE.
 #--------------------------------------------------------------------------
 
-require 'azure/core/auth/signer'
+require "azure/core/auth/signer"
 
 module Azure::Storage::Core
   module Auth
     class SharedAccessSignatureSigner < Azure::Core::Auth::Signer
-
       attr :account_name, :sas_token
 
       # Public: Initialize the Signer with a SharedAccessSignature
       #
       # @param account_name [String] The account name. Defaults to the one in the global configuration.
       # @param sas_token [String]   The sas token to be used for signing
-      def initialize(account_name=Azure::Storage.storage_account_name, sas_token=Azure::Storage.storage_sas_token)
+      def initialize(account_name = Azure::Storage.storage_account_name, sas_token = Azure::Storage.storage_sas_token)
         @account_name = account_name
         @sas_token = sas_token
       end
 
       def sign_request(req)
-        req.uri = URI.parse(req.uri.to_s + (req.uri.query.nil? ? '?' : '&') + sas_token.sub(/^\?/,'') + '&api-version=' + Azure::Storage::Default::STG_VERSION)
+        req.uri = URI.parse(req.uri.to_s + (req.uri.query.nil? ? "?" : "&") + sas_token.sub(/^\?/, "") + "&api-version=" + Azure::Storage::Default::STG_VERSION)
       end
-
     end
   end
 end

data/lib/azure/storage/core/auth/shared_key.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 'cgi'
-require 'azure/core/auth/signer'
-require 'azure/core/auth/shared_key'
+require "cgi"
+require "azure/core/auth/signer"
+require "azure/core/auth/shared_key"
 
 module Azure::Storage::Core
   module Auth
@@ -38,21 +40,21 @@ module Azure::Storage::Core
       def signable_string(method, uri, headers)
         [
           method.to_s.upcase,
-          headers.fetch('Content-Encoding', ''),
-          headers.fetch('Content-Language', ''),
-          headers.fetch('Content-Length', '').sub(/^0+/,''), # from 2015-02-21, if Content-Length == 0, it won't be signed
-          headers.fetch('Content-MD5', ''),
-          headers.fetch('Content-Type', ''),
-          headers.fetch('Date', ''),
-          headers.fetch('If-Modified-Since', ''),
-          headers.fetch('If-Match', ''),
-          headers.fetch('If-None-Match', ''),
-          headers.fetch('If-Unmodified-Since', ''),
-          headers.fetch('Range', ''),
+          headers.fetch("Content-Encoding", ""),
+          headers.fetch("Content-Language", ""),
+          headers.fetch("Content-Length", "").sub(/^0+/, ""), # from 2015-02-21, if Content-Length == 0, it won't be signed
+          headers.fetch("Content-MD5", ""),
+          headers.fetch("Content-Type", ""),
+          headers.fetch("Date", ""),
+          headers.fetch("If-Modified-Since", ""),
+          headers.fetch("If-Match", ""),
+          headers.fetch("If-None-Match", ""),
+          headers.fetch("If-Unmodified-Since", ""),
+          headers.fetch("Range", ""),
           canonicalized_headers(headers),
           canonicalized_resource(uri)
         ].join("\n")
       end
     end
   end
-end
+end