azure-storage-common 1.1.0 → 2.0.1

data/lib/azure/storage/common/core/http_client.rb

@@ -1,69 +1,79 @@
-# frozen_string_literal: true
-
-#-------------------------------------------------------------------------
-# # Copyright (c) Microsoft and contributors. All rights reserved.
-#
-# The MIT License(MIT)
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files(the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions :
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#--------------------------------------------------------------------------
-
-module Azure::Storage::Common::Core
-  module HttpClient
-    # Returns the http agent based on uri
-    # @param uri  [URI|String] the base uri (scheme, host, port) of the http endpoint
-    # @return [Net::HTTP] http agent for a given uri
-    def agents(uri)
-      key = uri.to_s
-      @agents ||= {}
-      unless @agents.key?(key)
-        @agents[key] = build_http(uri)
-      end
-      @agents[key]
-    end
-
-    # Empties all the http agents
-    def reset_agents!
-      @agents = nil
-    end
-
-    private
-
-      def build_http(uri)
-        ssl_options = {}
-        if uri.is_a?(URI) && uri.scheme.downcase == "https"
-          ssl_options[:version] = self.ssl_version if self.ssl_version
-          # min_version and max_version only supported in ruby 2.5
-          ssl_options[:min_version] = self.ssl_min_version if self.ssl_min_version
-          ssl_options[:max_version] = self.ssl_max_version if self.ssl_max_version
-          ssl_options[:ca_file] = self.ca_file if self.ca_file
-          ssl_options[:verify] = true
-        end
-        proxy_options = if ENV["HTTP_PROXY"]
-                          URI::parse(ENV["HTTP_PROXY"])
-                        elsif ENV["HTTPS_PROXY"]
-                          URI::parse(ENV["HTTPS_PROXY"])
-                        end || nil
-        Faraday.new(uri, ssl: ssl_options, proxy: proxy_options) do |conn|
-          conn.use FaradayMiddleware::FollowRedirects
-          conn.adapter Faraday.default_adapter
-        end
-      end
-  end
-end
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# The MIT License(MIT)
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#--------------------------------------------------------------------------
+
+module Azure::Storage::Common::Core
+  module HttpClient
+    # Returns the http agent based on uri
+    # @param uri  [URI|String] the base uri (scheme, host, port) of the http endpoint
+    # @return [Net::HTTP] http agent for a given uri
+    def agents(uri)
+      uri = URI(uri) unless uri.is_a? URI
+      key = uri.host
+
+      @agents ||= {}
+      unless @agents.key?(key)
+        @agents[key] = build_http(uri)
+      else
+        reuse_agent!(@agents[key])
+      end
+      @agents[key]
+    end
+
+    # Empties all the http agents
+    def reset_agents!
+      @agents = nil
+    end
+
+    private
+
+      # Empties all information that cannot be reused.
+      def reuse_agent!(agent)
+        agent.params.clear
+        agent.headers.clear
+      end
+
+      def build_http(uri)
+        ssl_options = {}
+        if uri.is_a?(URI) && uri.scheme.downcase == "https"
+          ssl_options[:version] = self.ssl_version if self.ssl_version
+          # min_version and max_version only supported in ruby 2.5
+          ssl_options[:min_version] = self.ssl_min_version if self.ssl_min_version
+          ssl_options[:max_version] = self.ssl_max_version if self.ssl_max_version
+          ssl_options[:ca_file] = self.ca_file if self.ca_file
+          ssl_options[:verify] = true
+        end
+        proxy_options = if ENV["HTTP_PROXY"]
+                          URI::parse(ENV["HTTP_PROXY"])
+                        elsif ENV["HTTPS_PROXY"]
+                          URI::parse(ENV["HTTPS_PROXY"])
+                        end || nil
+        Faraday.new(uri, ssl: ssl_options, proxy: proxy_options) do |conn|
+          conn.use FaradayMiddleware::FollowRedirects
+          conn.adapter Faraday.default_adapter
+        end
+      end
+  end
+end

data/lib/azure/storage/common/core/sr.rb

@@ -1,85 +1,85 @@
-# frozen_string_literal: true
-
-#-------------------------------------------------------------------------
-# # Copyright (c) Microsoft and contributors. All rights reserved.
-#
-# The MIT License(MIT)
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files(the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions :
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#--------------------------------------------------------------------------
-
-
-module Azure::Storage::Common::Core
-  module SR
-    ANONYMOUS_ACCESS_BLOBSERVICE_ONLY = "Anonymous access is only valid for the BlobService."
-    ARGUMENT_NULL_OR_EMPTY = "The argument must not be null or an empty string. Argument name: %s."
-    ARGUMENT_NULL_OR_UNDEFINED = "The argument must not be null or undefined. Argument name: %s."
-    ARGUMENT_OUT_OF_RANGE_ERROR = "The argument is out of range. Argument name: %s, Value passed: %s."
-    BATCH_ONE_PARTITION_KEY = "All entities in the batch must have the same PartitionKey value."
-    BATCH_ONE_RETRIEVE = "If a retrieve operation is part of a batch, it must be the only operation in the batch."
-    BATCH_TOO_LARGE = "Batches must not contain more than 100 operations."
-    BLOB_INVALID_SEQUENCE_NUMBER = "The sequence number may not be specified for an increment operation."
-    BLOB_TYPE_MISMATCH = 'Blob type of the blob reference doesn\'t match blob type of the blob.'
-    CANNOT_CREATE_SAS_WITHOUT_ACCOUNT_KEY = "Cannot create Shared Access Signature unless the Account Name and Key are used to create the ServiceClient."
-    CONTENT_LENGTH_MISMATCH = "An incorrect number of bytes was read from the connection. The connection may have been closed."
-    CONTENT_TYPE_MISSING = "Content-Type response header is missing or invalid."
-    EMPTY_BATCH = "Batch must not be empty."
-    EXCEEDED_SIZE_LIMITATION = "Upload exceeds the size limitation. Max size is %s but the current size is %s"
-    HASH_MISMATCH = "Hash mismatch (integrity check failed), Expected value is %s, retrieved %s."
-    INCORRECT_ENTITY_KEYS = "PartitionKey and RowKey must be specified as strings in the entity object."
-    INVALID_BLOB_LENGTH = "createBlockBlobFromText requires the size of text to be less than 64MB. Please use createBlockBlobFromLocalFile or createBlockBlobFromStream to upload large blobs."
-    INVALID_CONNECTION_STRING = 'Connection strings must be of the form "key1=value1;key2=value2".'
-    INVALID_CONNECTION_STRING_BAD_KEY = 'Connection string contains unrecognized key: "%s"'
-    INVALID_CONNECTION_STRING_DUPLICATE_KEY = 'Connection string contains duplicate key: "%s"'
-    INVALID_CONNECTION_STRING_EMPTY_KEY = "Connection strings must not contain empty keys."
-    INVALID_CLIENT_OPTIONS = "Storage client options are invalid"
-    INVALID_DELETE_SNAPSHOT_OPTION = "The deleteSnapshots option cannot be included when deleting a specific snapshot using the snapshotId option."
-    INVALID_EDM_TYPE = 'The value \'%s\' does not match the type \'%s\'.'
-    INVALID_FILE_LENGTH = "createFileFromText requires the size of text to be less than 4MB. Please use createFileFromLocalFile or createFileFromStream to upload large files."
-    INVALID_FILE_RANGE_FOR_UPDATE = "Range size should be less than 4MB for a file range update operation."
-    INVALID_HEADERS = "Headers are not supported in the 2012-02-12 version."
-    INVALID_MESSAGE_ID = "Message ID cannot be null or undefined for deleteMessage and updateMessage operations."
-    INVALID_PAGE_BLOB_LENGTH = "Page blob length must be multiple of 512."
-    INVALID_PAGE_END_OFFSET = "Page end offset must be multiple of 512."
-    INVALID_PAGE_RANGE_FOR_UPDATE = "Page range size should be less than 4MB for a page update operation."
-    INVALID_PAGE_START_OFFSET = "Page start offset must be multiple of 512."
-    INVALID_POP_RECEIPT = "Pop Receipt cannot be null or undefined for deleteMessage and updateMessage operations."
-    INVALID_PROPERTY_RESOLVER = "The specified property resolver returned an invalid type. %s:{_:%s,$:%s }"
-    INVALID_RANGE_FOR_MD5 = "The requested range should be less than 4MB when contentMD5 is expected from the server"
-    INVALID_SAS_VERSION = "SAS Version ? is invalid. Valid versions include: ?."
-    INVALID_SAS_TOKEN = "The SAS token should not contain api-version."
-    INVALID_SIGNED_IDENTIFIERS = "Signed identifiers need to be an array."
-    INVALID_STREAM_LENGTH = "The length of the provided stream is invalid."
-    INVALID_STRING_ERROR = "Invalid string error."
-    INVALID_TABLE_OPERATION = "Operation not found: %s"
-    INVALID_TEXT_LENGTH = "The length of the provided text is invalid."
-    MAXIMUM_EXECUTION_TIMEOUT_EXCEPTION = "The client could not finish the operation within specified maximum execution timeout."
-    MD5_NOT_PRESENT_ERROR = "MD5 does not exist. If you do not want to force validation, please disable useTransactionalMD5."
-    METADATA_KEY_INVALID = "The key for one of the metadata key-value pairs is null, empty, or whitespace."
-    METADATA_VALUE_INVALID = "The value for one of the metadata key-value pairs is null, empty, or whitespace."
-    NO_CREDENTIALS_PROVIDED = "Credentials must be provided when creating a service client."
-    PRIMARY_ONLY_COMMAND = "This operation can only be executed against the primary storage location."
-    QUERY_OPERATOR_REQUIRES_WHERE = "%s operator needs to be used after where."
-    SECONDARY_ONLY_COMMAND = "This operation can only be executed against the secondary storage location."
-    STORAGE_HOST_LOCATION_REQUIRED = "The host for the storage service must be specified."
-    STORAGE_HOST_MISSING_LOCATION = 'The host for the target storage location is not specified. Please consider changing the request\'s location mode.'
-    TYPE_NOT_SUPPORTED = "Type not supported when sending data to the service: "
-    MAX_BLOB_SIZE_CONDITION_NOT_MEET = "The max blob size condition specified was not met."
-  end
-end
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# The MIT License(MIT)
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#--------------------------------------------------------------------------
+
+
+module Azure::Storage::Common::Core
+  module SR
+    ANONYMOUS_ACCESS_BLOBSERVICE_ONLY = "Anonymous access is only valid for the BlobService."
+    ARGUMENT_NULL_OR_EMPTY = "The argument must not be null or an empty string. Argument name: %s."
+    ARGUMENT_NULL_OR_UNDEFINED = "The argument must not be null or undefined. Argument name: %s."
+    ARGUMENT_OUT_OF_RANGE_ERROR = "The argument is out of range. Argument name: %s, Value passed: %s."
+    BATCH_ONE_PARTITION_KEY = "All entities in the batch must have the same PartitionKey value."
+    BATCH_ONE_RETRIEVE = "If a retrieve operation is part of a batch, it must be the only operation in the batch."
+    BATCH_TOO_LARGE = "Batches must not contain more than 100 operations."
+    BLOB_INVALID_SEQUENCE_NUMBER = "The sequence number may not be specified for an increment operation."
+    BLOB_TYPE_MISMATCH = 'Blob type of the blob reference doesn\'t match blob type of the blob.'
+    CANNOT_CREATE_SAS_WITHOUT_ACCOUNT_KEY = "Cannot create Shared Access Signature unless the Account Name and Key are used to create the ServiceClient."
+    CONTENT_LENGTH_MISMATCH = "An incorrect number of bytes was read from the connection. The connection may have been closed."
+    CONTENT_TYPE_MISSING = "Content-Type response header is missing or invalid."
+    EMPTY_BATCH = "Batch must not be empty."
+    EXCEEDED_SIZE_LIMITATION = "Upload exceeds the size limitation. Max size is %s but the current size is %s"
+    HASH_MISMATCH = "Hash mismatch (integrity check failed), Expected value is %s, retrieved %s."
+    INCORRECT_ENTITY_KEYS = "PartitionKey and RowKey must be specified as strings in the entity object."
+    INVALID_BLOB_LENGTH = "createBlockBlobFromText requires the size of text to be less than 64MB. Please use createBlockBlobFromLocalFile or createBlockBlobFromStream to upload large blobs."
+    INVALID_CONNECTION_STRING = 'Connection strings must be of the form "key1=value1;key2=value2".'
+    INVALID_CONNECTION_STRING_BAD_KEY = 'Connection string contains unrecognized key: "%s"'
+    INVALID_CONNECTION_STRING_DUPLICATE_KEY = 'Connection string contains duplicate key: "%s"'
+    INVALID_CONNECTION_STRING_EMPTY_KEY = "Connection strings must not contain empty keys."
+    INVALID_CLIENT_OPTIONS = "Storage client options are invalid"
+    INVALID_DELETE_SNAPSHOT_OPTION = "The deleteSnapshots option cannot be included when deleting a specific snapshot using the snapshotId option."
+    INVALID_EDM_TYPE = 'The value \'%s\' does not match the type \'%s\'.'
+    INVALID_FILE_LENGTH = "createFileFromText requires the size of text to be less than 4MB. Please use createFileFromLocalFile or createFileFromStream to upload large files."
+    INVALID_FILE_RANGE_FOR_UPDATE = "Range size should be less than 4MB for a file range update operation."
+    INVALID_HEADERS = "Headers are not supported in the 2012-02-12 version."
+    INVALID_MESSAGE_ID = "Message ID cannot be null or undefined for deleteMessage and updateMessage operations."
+    INVALID_PAGE_BLOB_LENGTH = "Page blob length must be multiple of 512."
+    INVALID_PAGE_END_OFFSET = "Page end offset must be multiple of 512."
+    INVALID_PAGE_RANGE_FOR_UPDATE = "Page range size should be less than 4MB for a page update operation."
+    INVALID_PAGE_START_OFFSET = "Page start offset must be multiple of 512."
+    INVALID_POP_RECEIPT = "Pop Receipt cannot be null or undefined for deleteMessage and updateMessage operations."
+    INVALID_PROPERTY_RESOLVER = "The specified property resolver returned an invalid type. %s:{_:%s,$:%s }"
+    INVALID_RANGE_FOR_MD5 = "The requested range should be less than 4MB when contentMD5 is expected from the server"
+    INVALID_SAS_VERSION = "SAS Version ? is invalid. Valid versions include: ?."
+    INVALID_SAS_TOKEN = "The SAS token should not contain api-version."
+    INVALID_SIGNED_IDENTIFIERS = "Signed identifiers need to be an array."
+    INVALID_STREAM_LENGTH = "The length of the provided stream is invalid."
+    INVALID_STRING_ERROR = "Invalid string error."
+    INVALID_TABLE_OPERATION = "Operation not found: %s"
+    INVALID_TEXT_LENGTH = "The length of the provided text is invalid."
+    MAXIMUM_EXECUTION_TIMEOUT_EXCEPTION = "The client could not finish the operation within specified maximum execution timeout."
+    MD5_NOT_PRESENT_ERROR = "MD5 does not exist. If you do not want to force validation, please disable useTransactionalMD5."
+    METADATA_KEY_INVALID = "The key for one of the metadata key-value pairs is null, empty, or whitespace."
+    METADATA_VALUE_INVALID = "The value for one of the metadata key-value pairs is null, empty, or whitespace."
+    NO_CREDENTIALS_PROVIDED = "Credentials must be provided when creating a service client."
+    PRIMARY_ONLY_COMMAND = "This operation can only be executed against the primary storage location."
+    QUERY_OPERATOR_REQUIRES_WHERE = "%s operator needs to be used after where."
+    SECONDARY_ONLY_COMMAND = "This operation can only be executed against the secondary storage location."
+    STORAGE_HOST_LOCATION_REQUIRED = "The host for the storage service must be specified."
+    STORAGE_HOST_MISSING_LOCATION = 'The host for the target storage location is not specified. Please consider changing the request\'s location mode.'
+    TYPE_NOT_SUPPORTED = "Type not supported when sending data to the service: "
+    MAX_BLOB_SIZE_CONDITION_NOT_MEET = "The max blob size condition specified was not met."
+  end
+end

data/lib/azure/storage/common/core/token_credential.rb

@@ -1,64 +1,64 @@
-# frozen_string_literal: true
-
-#-------------------------------------------------------------------------
-# # Copyright (c) Microsoft and contributors. All rights reserved.
-#
-# The MIT License(MIT)
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files(the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions :
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#--------------------------------------------------------------------------
-require "azure/core"
-
-module Azure::Storage::Common::Core
-  class TokenCredential
-
-    # Public: Initializes an instance of [Azure::Storage::Common::Core::TokenCredential]
-    #
-    # ==== Attributes
-    #
-    # * +token+                           - String. The initial access token.
-    #
-    def initialize(token)
-      @token = token
-      @mutex = Mutex.new
-    end
-
-    # Public: Gets the access token
-    #
-    # Note: Providing this getter under the protect of a mutex
-    #
-    def token
-      @mutex.synchronize do
-        @token
-      end
-    end
-
-    # Public: Renews the access token
-    #
-    # ==== Attributes
-    #
-    # * +new_token+                       - String. The new access token.
-    #
-    def renew_token(new_token)
-      @mutex.synchronize do
-        @token = new_token
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# The MIT License(MIT)
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#--------------------------------------------------------------------------
+require "azure/core"
+
+module Azure::Storage::Common::Core
+  class TokenCredential
+
+    # Public: Initializes an instance of [Azure::Storage::Common::Core::TokenCredential]
+    #
+    # ==== Attributes
+    #
+    # * +token+                           - String. The initial access token.
+    #
+    def initialize(token)
+      @token = token
+      @mutex = Mutex.new
+    end
+
+    # Public: Gets the access token
+    #
+    # Note: Providing this getter under the protect of a mutex
+    #
+    def token
+      @mutex.synchronize do
+        @token
+      end
+    end
+
+    # Public: Renews the access token
+    #
+    # ==== Attributes
+    #
+    # * +new_token+                       - String. The new access token.
+    #
+    def renew_token(new_token)
+      @mutex.synchronize do
+        @token = new_token
+      end
+    end
+  end
+end

data/lib/azure/storage/common/core/utility.rb

@@ -1,255 +1,255 @@
-# frozen_string_literal: true
-
-#-------------------------------------------------------------------------
-# # Copyright (c) Microsoft and contributors. All rights reserved.
-#
-# The MIT License(MIT)
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files(the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions :
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#--------------------------------------------------------------------------
-
-require "ipaddr"
-require "azure/storage/common/core/error"
-
-if RUBY_VERSION.to_f < 2.0
-  begin
-    require "Win32/Console/ANSI" if RUBY_PLATFORM =~ /win32|mingw32/
-  rescue LoadError
-    puts "WARNING: Output will look weird on Windows unless"\
-         ' you install the "win32console" gem.'
-  end
-end
-
-module Azure::Storage::Common
-  module Error
-    # Azure Error
-    class Error <  Azure::Core::Error
-      attr_reader :description
-      attr_reader :status_code
-      attr_reader :type
-
-      def initialize(type, status, description)
-        @type = type
-        @status_code = status
-        @description = description
-        super("#{type} (#{status_code}): #{description}")
-      end
-    end
-  end
-
-  module Core
-    module Utility
-      def random_string(str = "azure", no_of_char = 5)
-        str + (0...no_of_char).map { ("a".."z").to_a[rand(26)] }.join
-      end
-
-      def xml_content(xml, key, default = "")
-        content = default
-        node = xml.at_css(key)
-        content = node.text if node
-        content
-      end
-
-      def locate_file(name)
-        if File.exist? name
-          name
-        elsif File.exist?(File.join(ENV["HOME"], name))
-          File.join(ENV["HOME"], name)
-        else
-          Azure::Loggerx.error_with_exit "Unable to find #{name} file  "
-        end
-      end
-
-      def export_der(cert, key, pass = nil, name = nil)
-        pkcs12 = OpenSSL::PKCS12.create(pass, name, key, cert)
-        Base64.encode64(pkcs12.to_der)
-      rescue Exception => e
-        puts e.message
-        abort
-      end
-
-      def export_fingerprint(certificate)
-        Digest::SHA1.hexdigest(certificate.to_der)
-      end
-
-      def enable_winrm?(winrm_transport)
-        (!winrm_transport.nil? && (winrm_transport.select { |x| x.downcase == "http" || x.downcase == "https" }.size > 0))
-      end
-
-      def get_certificate(private_key_file)
-        rsa = OpenSSL::PKey.read File.read(private_key_file)
-        cert = OpenSSL::X509::Certificate.new
-        cert.version = 2
-        cert.serial = 0
-        name = OpenSSL::X509::Name.new([["CN", "Azure Management Certificate"]])
-        cert.subject = cert.issuer = name
-        cert.not_before = Time.now
-        cert.not_after = cert.not_before + (60 * 60 * 24 * 365)
-        cert.public_key = rsa.public_key
-        cert.sign(rsa, OpenSSL::Digest::SHA1.new)
-        cert
-      end
-
-      def initialize_external_logger(logger)
-        Loggerx.initialize_external_logger(logger)
-      end
-
-      def parse_charset_from_content_type(content_type)
-        if (content_type && content_type.length > 0)
-          charset = content_type.split(";").delete_if { |attribute| !attribute.lstrip.start_with?("charset=") }.map { |x| x.lstrip }[0]
-          charset["charset=".length...charset.length] if charset
-        end
-      end
-    end
-
-    # Logger
-    module Logger
-      class << self
-        attr_accessor :logger
-
-        def info(msg)
-          if logger.nil?
-            puts msg.bold.white
-          else
-            logger.info(msg)
-          end
-        end
-
-        def error_with_exit(msg)
-          if logger.nil?
-            puts msg.bold.red
-          else
-            logger.error(msg)
-          end
-
-          raise msg.bold.red
-        end
-
-        def warn(msg)
-          if logger.nil?
-            puts msg.yellow
-          else
-            logger.warn(msg)
-          end
-
-          msg
-        end
-
-        def error(msg)
-          if logger.nil?
-            puts msg.bold.red
-          else
-            logger.error(msg)
-          end
-
-          msg
-        end
-
-        def exception_message(msg)
-          if logger.nil?
-            puts msg.bold.red
-          else
-            logger.warn(msg)
-          end
-
-          raise msg.bold.red
-        end
-
-        def success(msg)
-          msg_with_new_line = msg + "\n"
-          if logger.nil?
-            print msg_with_new_line.green
-          else
-            logger.info(msg)
-          end
-        end
-
-        def initialize_external_logger(logger)
-          @logger = logger
-        end
-      end
-    end
-  end
-end
-
-class String
-  { reset:  0,
-    bold:  1,
-    dark:  2,
-    underline:  4,
-    blink:  5,
-    orange:  6,
-    negative:  7,
-    black: 30,
-    red: 31,
-    green: 32,
-    yellow: 33,
-    blue: 34,
-    magenta: 35,
-    cyan: 36,
-    white: 37,
-  }.each do |key, value|
-    define_method key do
-      "\e[#{value}m" + self + "\e[0m"
-    end
-  end
-end
-
-# Code validate private/public IP acceptable ranges.
-class IPAddr
-  def private?
-    return false unless self.ipv4?
-    PRIVATE_RANGES.each do |ipr|
-      return true if ipr.include?(self)
-    end
-    false
-  end
-
-  def public?
-    !private?
-  end
-
-  class << self
-    def validate_ip_and_prefix(ip, cidr)
-      if cidr.to_s.empty?
-        raise "Cidr is missing for IP '#{ip}'."
-      elsif valid?(ip)
-        raise "Ip address '#{ip}' is invalid."
-      elsif !IPAddr.new(ip).private?
-        raise "Ip Address #{ip} must be private."
-      end
-    end
-
-    def validate_address_space(ip)
-      if ip.split("/").size != 2
-        raise "Cidr is invalid for IP #{ip}."
-      elsif valid?(ip)
-        raise "Address space '#{ip}' is invalid."
-      end
-    end
-
-    def address_prefix(ip, cidr)
-      ip + "/" + cidr.to_s
-    end
-
-    def valid?(ip)
-      (IPAddr.new(ip) rescue nil).nil?
-    end
-  end
-end
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# The MIT License(MIT)
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#--------------------------------------------------------------------------
+
+require "ipaddr"
+require "azure/storage/common/core/error"
+
+if RUBY_VERSION.to_f < 2.0
+  begin
+    require "Win32/Console/ANSI" if RUBY_PLATFORM =~ /win32|mingw32/
+  rescue LoadError
+    puts "WARNING: Output will look weird on Windows unless"\
+         ' you install the "win32console" gem.'
+  end
+end
+
+module Azure::Storage::Common
+  module Error
+    # Azure Error
+    class Error <  Azure::Core::Error
+      attr_reader :description
+      attr_reader :status_code
+      attr_reader :type
+
+      def initialize(type, status, description)
+        @type = type
+        @status_code = status
+        @description = description
+        super("#{type} (#{status_code}): #{description}")
+      end
+    end
+  end
+
+  module Core
+    module Utility
+      def random_string(str = "azure", no_of_char = 5)
+        str + (0...no_of_char).map { ("a".."z").to_a[rand(26)] }.join
+      end
+
+      def xml_content(xml, key, default = "")
+        content = default
+        node = xml.at_css(key)
+        content = node.text if node
+        content
+      end
+
+      def locate_file(name)
+        if File.exist? name
+          name
+        elsif File.exist?(File.join(ENV["HOME"], name))
+          File.join(ENV["HOME"], name)
+        else
+          Azure::Loggerx.error_with_exit "Unable to find #{name} file  "
+        end
+      end
+
+      def export_der(cert, key, pass = nil, name = nil)
+        pkcs12 = OpenSSL::PKCS12.create(pass, name, key, cert)
+        Base64.encode64(pkcs12.to_der)
+      rescue Exception => e
+        puts e.message
+        abort
+      end
+
+      def export_fingerprint(certificate)
+        Digest::SHA1.hexdigest(certificate.to_der)
+      end
+
+      def enable_winrm?(winrm_transport)
+        (!winrm_transport.nil? && (winrm_transport.select { |x| x.downcase == "http" || x.downcase == "https" }.size > 0))
+      end
+
+      def get_certificate(private_key_file)
+        rsa = OpenSSL::PKey.read File.read(private_key_file)
+        cert = OpenSSL::X509::Certificate.new
+        cert.version = 2
+        cert.serial = 0
+        name = OpenSSL::X509::Name.new([["CN", "Azure Management Certificate"]])
+        cert.subject = cert.issuer = name
+        cert.not_before = Time.now
+        cert.not_after = cert.not_before + (60 * 60 * 24 * 365)
+        cert.public_key = rsa.public_key
+        cert.sign(rsa, OpenSSL::Digest::SHA1.new)
+        cert
+      end
+
+      def initialize_external_logger(logger)
+        Loggerx.initialize_external_logger(logger)
+      end
+
+      def parse_charset_from_content_type(content_type)
+        if (content_type && content_type.length > 0)
+          charset = content_type.split(";").delete_if { |attribute| !attribute.lstrip.start_with?("charset=") }.map { |x| x.lstrip }[0]
+          charset["charset=".length...charset.length] if charset
+        end
+      end
+    end
+
+    # Logger
+    module Logger
+      class << self
+        attr_accessor :logger
+
+        def info(msg)
+          if logger.nil?
+            puts msg.bold.white
+          else
+            logger.info(msg)
+          end
+        end
+
+        def error_with_exit(msg)
+          if logger.nil?
+            puts msg.bold.red
+          else
+            logger.error(msg)
+          end
+
+          raise msg.bold.red
+        end
+
+        def warn(msg)
+          if logger.nil?
+            puts msg.yellow
+          else
+            logger.warn(msg)
+          end
+
+          msg
+        end
+
+        def error(msg)
+          if logger.nil?
+            puts msg.bold.red
+          else
+            logger.error(msg)
+          end
+
+          msg
+        end
+
+        def exception_message(msg)
+          if logger.nil?
+            puts msg.bold.red
+          else
+            logger.warn(msg)
+          end
+
+          raise msg.bold.red
+        end
+
+        def success(msg)
+          msg_with_new_line = msg + "\n"
+          if logger.nil?
+            print msg_with_new_line.green
+          else
+            logger.info(msg)
+          end
+        end
+
+        def initialize_external_logger(logger)
+          @logger = logger
+        end
+      end
+    end
+  end
+end
+
+class String
+  { reset:  0,
+    bold:  1,
+    dark:  2,
+    underline:  4,
+    blink:  5,
+    orange:  6,
+    negative:  7,
+    black: 30,
+    red: 31,
+    green: 32,
+    yellow: 33,
+    blue: 34,
+    magenta: 35,
+    cyan: 36,
+    white: 37,
+  }.each do |key, value|
+    define_method key do
+      "\e[#{value}m" + self + "\e[0m"
+    end
+  end
+end
+
+# Code validate private/public IP acceptable ranges.
+class IPAddr
+  def private?
+    return false unless self.ipv4?
+    PRIVATE_RANGES.each do |ipr|
+      return true if ipr.include?(self)
+    end
+    false
+  end
+
+  def public?
+    !private?
+  end
+
+  class << self
+    def validate_ip_and_prefix(ip, cidr)
+      if cidr.to_s.empty?
+        raise "Cidr is missing for IP '#{ip}'."
+      elsif valid?(ip)
+        raise "Ip address '#{ip}' is invalid."
+      elsif !IPAddr.new(ip).private?
+        raise "Ip Address #{ip} must be private."
+      end
+    end
+
+    def validate_address_space(ip)
+      if ip.split("/").size != 2
+        raise "Cidr is invalid for IP #{ip}."
+      elsif valid?(ip)
+        raise "Address space '#{ip}' is invalid."
+      end
+    end
+
+    def address_prefix(ip, cidr)
+      ip + "/" + cidr.to_s
+    end
+
+    def valid?(ip)
+      (IPAddr.new(ip) rescue nil).nil?
+    end
+  end
+end