gitlab-fog-azure-rm 1.9.0 → 2.0.0

data/vendor/azure-storage-ruby/blob/lib/azure/storage/blob/serialization.rb

@@ -0,0 +1,351 @@
+# 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 "base64"
+
+module Azure::Storage
+  module Blob
+    module Serialization
+      include Azure::Storage::Common::Service::Serialization
+
+      def self.container_enumeration_results_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("EnumerationResults", xml)
+
+        results = enumeration_results_from_xml(xml, Azure::Storage::Common::Service::EnumerationResults.new)
+
+        return results unless (xml > "Containers").any? && ((xml > "Containers") > "Container").any?
+
+        if xml.Containers.Container.count == 0
+          results.push(container_from_xml(xml.Containers.Container))
+        else
+          xml.Containers.Container.each { |container_node|
+            results.push(container_from_xml(container_node))
+          }
+        end
+
+        results
+      end
+
+      def self.key_info_to_xml(start, expiry)
+        builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+          xml.KeyInfo {
+            xml.Start start.utc.iso8601
+            xml.Expiry expiry.utc.iso8601
+          }
+        end
+        builder.to_xml
+      end
+
+      def self.user_delegation_key_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("UserDelegationKey", xml)
+
+        Azure::Storage::Common::Service::UserDelegationKey.new do |user_delegation_key|
+          user_delegation_key.signed_oid = xml.SignedOid.text if (xml > "SignedOid").any?
+          user_delegation_key.signed_tid = xml.SignedTid.text if (xml > "SignedTid").any?
+          user_delegation_key.signed_start = xml.SignedStart.text if (xml > "SignedStart").any?
+          user_delegation_key.signed_expiry = xml.SignedExpiry.text if (xml > "SignedExpiry").any?
+          user_delegation_key.signed_service = xml.SignedService.text if (xml > "SignedService").any?
+          user_delegation_key.signed_version = xml.SignedVersion.text if (xml > "SignedVersion").any?
+          user_delegation_key.value = xml.Value.text if (xml > "Value").any?
+        end
+      end
+
+      def self.container_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("Container", xml)
+
+        Container::Container.new do |container|
+          container.name = xml.Name.text if (xml > "Name").any?
+          container.properties = container_properties_from_xml(xml.Properties) if (xml > "Properties").any?
+          container.metadata = metadata_from_xml(xml.Metadata) if (xml > "Metadata").any?
+          container.public_access_level = public_access_level_from_properties_xml(xml.Properties) if (xml > "Properties").any?
+        end
+      end
+
+      def self.container_from_headers(headers)
+        Container::Container.new do |container|
+          container.properties = container_properties_from_headers(headers)
+          container.public_access_level = public_access_level_from_headers(headers)
+          container.metadata = metadata_from_headers(headers)
+        end
+      end
+
+      def self.container_properties_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("Properties", xml)
+
+        props = {}
+
+        props[:last_modified] = (xml > "Last-Modified").text if (xml > "Last-Modified").any?
+        props[:etag] = xml.Etag.text if (xml > "Etag").any?
+        props[:lease_status] = xml.LeaseStatus.text if (xml > "LeaseStatus").any?
+        props[:lease_state] = xml.LeaseState.text if (xml > "LeaseState").any?
+        props[:lease_duration] = xml.LeaseDuration.text if (xml > "LeaseDuration").any?
+
+        props
+      end
+
+      def self.container_properties_from_headers(headers)
+        props = {}
+
+        props[:last_modified] = headers["Last-Modified"]
+        props[:etag] = headers["Etag"]
+        props[:lease_status] = headers["x-ms-lease-status"]
+        props[:lease_state] = headers["x-ms-lease-state"]
+        props[:lease_duration] = headers["x-ms-lease-duration"]
+
+        props
+      end
+
+      def self.public_access_level_from_headers(headers)
+        headers["x-ms-blob-public-access"]
+      end
+
+      def self.public_access_level_from_properties_xml(xml)
+        (xml > "PublicAccess").any? ? xml.PublicAccess.text : nil
+      end
+
+      def self.blob_enumeration_results_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("EnumerationResults", xml)
+
+        results = enumeration_results_from_xml(xml, Azure::Storage::Common::Service::EnumerationResults.new)
+
+        return results unless (xml > "Blobs").any?
+
+        if ((xml > "Blobs") > "Blob").any?
+          if xml.Blobs.Blob.count == 0
+            results.push(blob_from_xml(xml.Blobs.Blob))
+          else
+            xml.Blobs.Blob.each { |blob_node|
+              results.push(blob_from_xml(blob_node))
+            }
+          end
+        end
+
+        if ((xml > "Blobs") > "BlobPrefix").any?
+          if xml.Blobs.BlobPrefix.count == 0
+            results.push(blob_prefix_from_xml(xml.Blobs.BlobPrefix))
+          else
+            xml.Blobs.BlobPrefix.each { |blob_prefix|
+              results.push(blob_prefix_from_xml(blob_prefix))
+            }
+          end
+        end
+
+        results
+      end
+
+      def self.blob_prefix_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("BlobPrefix", xml)
+
+        name = xml.Name.text if (xml > "Name").any?
+        name
+      end
+
+      def self.blob_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("Blob", xml)
+
+        Blob.new do |blob|
+          blob.name = xml.Name.text if (xml > "Name").any?
+          blob.snapshot = xml.Snapshot.text if (xml > "Snapshot").any?
+
+          blob.metadata = metadata_from_xml(xml.Metadata) if (xml > "Metadata").any?
+          if (xml > "Properties").any?
+            blob.properties = blob_properties_from_xml(xml.Properties)
+            blob.encrypted = xml.Properties.ServerEncrypted.text == "true" if (xml.Properties > "ServerEncrypted").any?
+          end
+        end
+      end
+
+      def self.blob_from_headers(headers)
+        Blob.new do |blob|
+          blob.properties = blob_properties_from_headers(headers)
+          blob.metadata = metadata_from_headers(headers)
+          blob.encrypted = headers[Azure::Storage::Common::HeaderConstants::REQUEST_SERVER_ENCRYPTED] || headers[Azure::Storage::Common::HeaderConstants::SERVER_ENCRYPTED]
+          blob.encrypted = blob.encrypted.to_s == "true" unless blob.encrypted.nil?
+        end
+      end
+
+      def self.blob_properties_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("Properties", xml)
+
+        props = {}
+
+        props[:access_tier] = (xml > "AccessTier").text if (xml > "AccessTier").any?
+        props[:access_tier_change_time] = (xml > "AccessTierChangeTime").text if (xml > "AccessTierChangeTime").any?
+        props[:creation_Time] = (xml > "Creation-Time").text if (xml > "Creation-Time").any?
+        props[:last_modified] = (xml > "Last-Modified").text if (xml > "Last-Modified").any?
+        props[:etag] = xml.Etag.text if (xml > "Etag").any?
+        props[:lease_status] = xml.LeaseStatus.text if (xml > "LeaseStatus").any?
+        props[:lease_state] = xml.LeaseState.text if (xml > "LeaseState").any?
+        props[:lease_duration] = xml.LeaseDuration.text if (xml > "LeaseDuration").any?
+        props[:content_length] = (xml > "Content-Length").text.to_i if (xml > "Content-Length").any?
+        props[:content_type] = (xml > "Content-Type").text if (xml > "Content-Type").any?
+        props[:content_encoding] = (xml > "Content-Encoding").text if (xml > "Content-Encoding").any?
+        props[:content_language] = (xml > "Content-Language").text if (xml > "Content-Language").any?
+        props[:content_md5] = (xml > "Content-MD5").text if (xml > "Content-MD5").any?
+
+        props[:cache_control] = (xml > "Cache-Control").text if (xml > "Cache-Control").any?
+        props[:sequence_number] = (xml > "x-ms-blob-sequence-number").text.to_i if (xml > "x-ms-blob-sequence-number").any?
+        props[:blob_type] = xml.BlobType.text if (xml > "BlobType").any?
+        props[:copy_id] = xml.CopyId.text if (xml > "CopyId").any?
+        props[:copy_status] = xml.CopyStatus.text if (xml > "CopyStatus").any?
+        props[:copy_source] = xml.CopySource.text if (xml > "CopySource").any?
+        props[:copy_progress] = xml.CopyProgress.text if (xml > "CopyProgress").any?
+        props[:copy_completion_time] = xml.CopyCompletionTime.text if (xml > "CopyCompletionTime").any?
+        props[:copy_status_description] = xml.CopyStatusDescription.text if (xml > "CopyStatusDescription").any?
+        props[:incremental_copy] = xml.IncrementalCopy.text == "true" if (xml > "IncrementalCopy").any?
+
+        props
+      end
+
+      def self.blob_properties_from_headers(headers)
+        props = {}
+
+        props[:last_modified] = headers["Last-Modified"]
+        props[:etag] = headers["Etag"]
+        props[:lease_status] = headers["x-ms-lease-status"]
+        props[:lease_state] = headers["x-ms-lease-state"]
+        props[:lease_duration] = headers["x-ms-lease-duration"]
+
+        props[:content_length] = headers["x-ms-blob-content-length"] || headers["Content-Length"]
+        props[:content_length] = props[:content_length].to_i if props[:content_length]
+
+        props[:content_type] =  headers["x-ms-blob-content-type"] || headers["Content-Type"]
+        props[:content_encoding] = headers["x-ms-blob-content-encoding"] || headers["Content-Encoding"]
+        props[:content_language] = headers["x-ms-blob-content-language"] || headers["Content-Language"]
+        props[:content_disposition] = headers["x-ms-blob-content-disposition"] || headers["Content-Disposition"]
+        props[:content_md5] = headers["x-ms-blob-content-md5"] || headers["Content-MD5"]
+        props[:range_md5] = headers["Content-MD5"] if headers["x-ms-blob-content-md5"] && headers["Content-MD5"]
+
+        props[:cache_control] = headers["x-ms-blob-cache-control"] || headers["Cache-Control"]
+        props[:sequence_number] = headers["x-ms-blob-sequence-number"].to_i if headers["x-ms-blob-sequence-number"]
+        props[:blob_type] = headers["x-ms-blob-type"]
+
+        props[:copy_id] = headers["x-ms-copy-id"]
+        props[:copy_status] = headers["x-ms-copy-status"]
+        props[:copy_source] = headers["x-ms-copy-source"]
+        props[:copy_progress] = headers["x-ms-copy-progress"]
+        props[:copy_completion_time] = headers["x-ms-copy-completion-time"]
+        props[:copy_status_description] = headers["x-ms-copy-status-description"]
+
+        props[:accept_ranges] = headers["Accept-Ranges"].to_i if headers["Accept-Ranges"]
+
+        props[:append_offset] = headers["x-ms-blob-append-offset"].to_i if headers["x-ms-blob-append-offset"]
+        props[:committed_count] = headers["x-ms-blob-committed-block-count"].to_i if headers["x-ms-blob-committed-block-count"]
+        props[:incremental_copy] = headers["x-ms-incremental-copy"].to_s == "true" if headers["x-ms-incremental-copy"]
+
+        props
+      end
+
+      def self.block_list_to_xml(block_list)
+        builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+          xml.BlockList {
+            block_list.each { |block|
+              encoded_id = Base64.strict_encode64(block[0])
+              case block[1]
+              when :uncommitted
+                xml.Uncommitted encoded_id
+              when :committed
+                xml.Committed encoded_id
+              else
+                xml.Latest encoded_id
+              end
+            }
+          }
+        end
+        builder.to_xml
+      end
+
+      def self.block_list_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("BlockList", xml)
+
+        block_list = {
+          committed: [],
+          uncommitted: []
+        }
+
+        if ((xml > "CommittedBlocks") > "Block").any?
+          if xml.CommittedBlocks.Block.count == 0
+            add_block(:committed, xml.CommittedBlocks.Block, block_list)
+          else
+            xml.CommittedBlocks.Block.each { |block_node|
+              add_block(:committed, block_node, block_list)
+            }
+          end
+        end
+
+        return block_list unless (xml > "UncommittedBlocks")
+
+        if ((xml > "UncommittedBlocks") > "Block").any?
+          if xml.UncommittedBlocks.Block.count == 0
+            add_block(:uncommitted, xml.UncommittedBlocks.Block, block_list)
+          else
+            xml.UncommittedBlocks.Block.each { |block_node|
+              add_block(:uncommitted, block_node, block_list)
+            }
+          end
+        end
+
+        block_list
+      end
+
+      def self.add_block(type, block_node, block_list)
+        block = Block.new do |b|
+          b.name = Base64.strict_decode64(block_node.Name.text) if (block_node > "Name").any?
+          b.size = block_node.Size.text.to_i if (block_node > "Size").any?
+          b.type = type
+        end
+        block_list[type].push block
+      end
+
+      def self.page_list_from_xml(xml)
+        xml = slopify(xml)
+        expect_node("PageList", xml)
+
+        page_list = []
+
+        return page_list unless (xml > "PageRange").any?
+
+        if xml.PageRange.count == 0
+          page_list.push [xml.PageRange.Start.text.to_i, xml.PageRange.End.text.to_i]
+        else
+          xml.PageRange.each { |page_range|
+            page_list.push [page_range.Start.text.to_i, page_range.End.text.to_i]
+          }
+        end
+
+        page_list
+      end
+    end
+  end
+end

data/vendor/azure-storage-ruby/blob/lib/azure/storage/blob/version.rb

@@ -0,0 +1,49 @@
+# 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
+  module Storage
+    module Blob
+      class Version
+        # Fields represent the parts defined in http://semver.org/
+        MAJOR = 2 unless defined? MAJOR
+        MINOR = 0 unless defined? MINOR
+        UPDATE = 3 unless defined? UPDATE
+
+        class << self
+          # @return [String]
+          def to_s
+            [MAJOR, MINOR, UPDATE].compact.join(".")
+          end
+
+          def to_uas
+            [MAJOR, MINOR, UPDATE].join(".")
+          end
+        end
+      end
+    end
+  end
+end

data/vendor/azure-storage-ruby/blob/lib/azure/storage/blob.rb

@@ -0,0 +1,26 @@
+# 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/storage/blob/autoload"

data/vendor/azure-storage-ruby/common/BreakingChanges.md

@@ -0,0 +1,8 @@
+Tracking Breaking Changes in 2.0.0
+
+* This module now supports Ruby versions to 2.3 through 2.7
+
+Tracking Breaking Changes in 1.0.0
+
+* This module now consists of functionalities to support service client library modules.
+* All namespaces in this module now begin with "Azure::Storage::Common" instead of "Azure::Storage".

data/vendor/azure-storage-ruby/common/ChangeLog.md

@@ -0,0 +1,41 @@
+2021.12 - version 2.0.4
+* Lifted Ruby-version-based restrictions on Nokogiri version.
+
+2021.10 - version 2.0.3
+* Allowed to use any version 1.x of Nokogiri for Ruby version later than or equal to 2.5.0.
+* Fixed handling of invalid connection strings
+
+2020.8 - version 2.0.2
+* Bumped up Nokogiri version to 1.11.0.rc2 for Ruby version later than or equal to 2.4.0.
+* Changed to use persistent HTTP client to speed up requests #168.
+* Explicitly requiring `tempfile` to avoid runtime errors.
+
+2020.3 - version 2.0.1
+* Resolved an issue where the rubygem 'azure-storage-common' cannot resolve 'faraday_middleware' version automatically.
+* Resolved an issue where automation does not report error for sanity check failure.
+
+2020.3 - version 2.0.0
+* This module now supports Ruby versions to 2.3 through 2.7
+* Service version is upgraded to 2018-11-09.
+* Add support for generating user delegation shared access signatures.
+* This module now contains azure-core which was originally in azure-ruby-asm-core.
+* The following dependency version was bumped up to the specified version for security update:
+    Nokogiri 1.10.4
+    Faraday  1.0.0
+    Rake     13.0
+* Now reuses the HTTP Client on host level.
+
+2018.11 - version 1.1.0
+* Added the support for sending a request with a bearer token.
+* Added the configuration for SSL versions.
+* Fixed the issue that the retry interval could be negative. [#121]
+* Fixed the timeout issue when the resource doesn't exist. [#122]
+
+2018.1 - version 1.0.1
+* Resolved an issue where user cannot use Gem package using `gem install`.
+
+2018.1 - version 1.0.0
+
+* This module now consists of functionalities to support service client library modules.
+* All namespaces in this module now begin with "Azure::Storage::Common" instead of "Azure::Storage".
+* Resolved an issue where user tries to access `Azure::Storage::Common::Default::signer` would throw `undefined method 'signer' for Azure::Storage::Default:Module`.

data/vendor/azure-storage-ruby/common/Gemfile

@@ -0,0 +1,30 @@
+# 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.
+#--------------------------------------------------------------------------
+source "https://rubygems.org"
+
+gemspec name: "azure-storage-common"
+
+gem "coveralls", require: false

data/vendor/azure-storage-ruby/common/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Microsoft Corporation
+
+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.

data/vendor/azure-storage-ruby/common/README.md

@@ -0,0 +1,146 @@
+# Microsoft Azure Storage Common Client Library for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/azure-storage-common.svg)](https://badge.fury.io/rb/azure-storage-common)
+* Master: [![Master Build Status](https://travis-ci.org/Azure/azure-storage-ruby.svg?branch=master)](https://travis-ci.org/Azure/azure-storage-ruby/branches) [![Coverage Status](https://coveralls.io/repos/github/Azure/azure-storage-ruby/badge.svg?branch=master)](https://coveralls.io/github/Azure/azure-storage-ruby?branch=master)
+* Dev: [![Dev Build Status](https://travis-ci.org/Azure/azure-storage-ruby.svg?branch=dev)](https://travis-ci.org/Azure/azure-storage-ruby/branches) [![Coverage Status](https://coveralls.io/repos/github/Azure/azure-storage-ruby/badge.svg?branch=dev)](https://coveralls.io/github/Azure/azure-storage-ruby?branch=dev)
+
+This project provides a Ruby package that supports service client libraries.
+
+# Supported Ruby Versions
+
+* Ruby 2.3 to 2.7
+
+Note: 
+
+* x64 Ruby for Windows is known to have some compatibility issues.
+* azure-storage-common depends on gem nokogiri.
+
+# Getting Started
+
+## Install the rubygem package
+
+You can install the azure storage common rubygem package directly.
+
+```bash
+gem install azure-storage-common
+```
+
+## Create client
+
+You can use this module to create client that can be later shared by service modules, to avoid repeating code of creating storage client.
+
+There are two ways you can create the client:
+
+1. [via code](#via-code)
+2. [via environment variables](#via-environment-variables)
+
+<a name="via-code"></a>
+### Via Code
+* Against Microsoft Azure Services in the cloud
+
+```ruby
+
+  require 'azure/storage/common'
+
+  # Setup a specific instance of an Azure::Storage::Common::Client
+  client = Azure::Storage::Common::Client.create(storage_account_name: <your account name>, storage_access_key: <your access key>)
+
+  # Configure a ca_cert.pem file if you are having issues with ssl peer verification
+  client.ca_file = './ca_file.pem'
+
+```
+
+* Against local Emulator (Windows Only)
+
+```ruby
+
+  require 'azure/storage/common'
+  client = Azure::Storage::Common::Client.create_development
+
+  # Or create by options and provide your own proxy_uri
+  client = Azure::Storage::Common::Client.create(use_development_storage: true, development_storage_proxy_uri: <your proxy uri>)
+
+```
+
+<a name="via-environment-variables"></a>
+### Via Environment Variables
+
+* Against Microsoft Azure Storage Services in the cloud
+
+    ```bash
+    export AZURE_STORAGE_ACCOUNT = <your azure storage account name>
+    export AZURE_STORAGE_ACCESS_KEY = <your azure storage access key>
+    ```
+
+* Against local Emulator (Windows Only)
+
+    ```bash
+    export EMULATED = true
+    ```
+
+* [SSL Certificate File](https://gist.github.com/fnichol/867550) if having issues with ssl peer verification
+    
+    ```bash
+    SSL_CERT_FILE=<path to *.pem>
+    ```
+
+# Usage
+
+<a name="sas"></a>
+## Shared Access Signature generation
+
+```ruby
+
+require "azure/storage/common"
+
+# Creating an instance of `Azure::Storage::Common::Core::Auth::SharedAccessSignature`
+generator = Azure::Storage::Common::Core::Auth::SharedAccessSignature.new(your_account_name, your_access_key)
+
+# The generator now can be used to create service SAS or account SAS.
+generator.generate_service_sas_token(my_path_or_table_name, my_sas_options)
+generator.generate_account_sas_token(my_account_sas_options)
+# For details about the possible options, please reference the document of the class `Azure::Storage::Common::Core::Auth::SharedAccessSignature`
+
+```
+
+<a name="token"></a>
+## Access Token
+
+Please refer to the below links for obtaining an access token:
+* [Authenticate with Azure Active Directory](https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-azure-active-directory)
+* [Getting a MSI access token](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/tutorial-linux-vm-access-storage#get-an-access-token-and-use-it-to-call-azure-storage)
+
+```ruby
+require "azure/storage/common"
+
+access_token = <your initial access token>
+
+# Creating an instance of `Azure::Storage::Common::Core::TokenCredential`
+token_credential = Azure::Storage::Common::Core::TokenCredential.new access_token
+token_signer = Azure::Storage::Common::Core::Auth::TokenSigner.new token_credential
+common_token_client = Azure::Storage::Common::Client.create.new(storage_account_name: <your_account_name>, signer: token_signer)
+
+# Refresh internal is 50 minutes
+refresh_interval = 50 * 60
+# The user-defined thread that renews the access token
+cancelled = false
+renew_token = Thread.new do
+  Thread.stop
+  while !cancelled
+    sleep(refresh_interval)
+
+    # Renew the access token here
+
+    # Update the access token to the credential
+    token_credential.renew_token <new_access_token>
+  end
+end
+sleep 0.1 while renew_token.status != 'sleep'
+renew_token.run
+
+# Call client functions as usaual
+
+```
+
+# Code of Conduct 
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.