azure-storage-common2 2.0.8 → 2.0.9

data/lib/azure/core/utility.rb

@@ -0,0 +1,244 @@
+#-------------------------------------------------------------------------
+# Copyright 2013 Microsoft Open Technologies, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#--------------------------------------------------------------------------
+
+require 'ipaddr'
+
+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
+  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
+    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
+  PRIVATE_RANGES = [
+    IPAddr.new('10.0.0.0/8'),
+    IPAddr.new('172.16.0.0/12'),
+    IPAddr.new('192.168.0.0/16')
+  ]
+
+  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
+
+Azure::Loggerx = Azure::Core::Logger

data/lib/azure/core/version.rb

@@ -0,0 +1,33 @@
+#-------------------------------------------------------------------------
+# # Copyright (c) Microsoft and contributors. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#--------------------------------------------------------------------------
+
+module Azure
+  module Core
+    class Version
+      MAJOR = 0 unless defined? MAJOR
+      MINOR = 2 unless defined? MINOR
+      UPDATE = 9 unless defined? UPDATE
+      PRE = nil unless defined? PRE
+
+      class << self
+
+        # @return [String]
+        def to_s
+          [MAJOR, MINOR, UPDATE].join('.') + (PRE.nil? ? '' : "-#{PRE}")
+        end
+      end
+    end
+  end
+end

data/lib/azure/storage/common/autoload.rb

@@ -0,0 +1,62 @@
+# 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 "rubygems"
+require "nokogiri"
+require "base64"
+require "openssl"
+require "uri"
+require "faraday"
+require 'faraday/follow_redirects'
+
+require "azure/storage/common/core/autoload"
+require "azure/storage/common/default"
+
+module Azure
+  module Storage
+    autoload :Common,                       "azure/storage/common/core"
+    module Common
+      autoload :Default,                    "azure/storage/common/default"
+      autoload :Configurable,               "azure/storage/common/configurable"
+      autoload :Client,                     "azure/storage/common/client"
+      autoload :ClientOptions,              "azure/storage/common/client_options"
+
+      module Auth
+        autoload :SharedAccessSignature,    "azure/storage/common/core/auth/shared_access_signature"
+      end
+
+      module Service
+        autoload :Serialization,            "azure/storage/common/service/serialization"
+        autoload :SignedIdentifier,         "azure/storage/common/service/signed_identifier"
+        autoload :AccessPolicy,             "azure/storage/common/service/access_policy"
+        autoload :StorageService,           "azure/storage/common/service/storage_service"
+        autoload :CorsRule,                 "azure/storage/common/service/cors_rule"
+        autoload :EnumerationResults,       "azure/storage/common/service/enumeration_results"
+        autoload :UserDelegationKey,        "azure/storage/common/service/user_delegation_key"
+      end
+    end
+  end
+end

data/lib/azure/storage/common/client.rb

@@ -0,0 +1,162 @@
+# 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
+  class Client
+    include Azure::Storage::Common::Configurable
+    include Azure::Storage::Common::ClientOptions
+    include Azure::Storage::Common::Core::HttpClient
+
+    # Public: Creates an instance of [Azure::Storage::Common::Client]
+    #
+    # ==== Attributes
+    #
+    # * +options+    - Hash. Optional parameters.
+    #
+    # ==== Options
+    #
+    # Accepted key/value pairs in options parameter are:
+    #
+    # * +:use_development_storage+        - TrueClass|FalseClass. Whether to use storage emulator.
+    # * +:development_storage_proxy_uri+  - String. Used with +:use_development_storage+ if emulator is hosted other than localhost.
+    # * +:storage_connection_string+      - String. The storage connection string.
+    # * +:storage_account_name+           - String. The name of the storage account.
+    # * +:storage_access_key+             - Base64 String. The access key of the storage account.
+    # * +:storage_sas_token+              - String. The signed access signature for the storage account or one of its service.
+    # * +:storage_blob_host+              - String. Specified Blob serivce endpoint or hostname
+    # * +:storage_table_host+             - String. Specified Table serivce endpoint or hostname
+    # * +:storage_queue_host+             - String. Specified Queue serivce endpoint or hostname
+    # * +:storage_dns_suffix+             - String. The suffix of a regional Storage Serivce, to
+    # * +:default_endpoints_protocol+     - String. http or https
+    # * +:use_path_style_uri+             - String. Whether use path style URI for specified endpoints
+    # * +:ca_file+                        - String. File path of the CA file if having issue with SSL
+    # * +:user_agent_prefix+              - String. The user agent prefix that can identify the application calls the library
+    #
+    # The valid set of options include:
+    # * Storage Emulator: +:use_development_storage+ required, +:development_storage_proxy_uri+ optionally
+    # * Storage account name and key: +:storage_account_name+ and +:storage_access_key+ required, set +:storage_dns_suffix+ necessarily
+    # * Storage account name and SAS token: +:storage_account_name+ and +:storage_sas_token+ required, set +:storage_dns_suffix+ necessarily
+    # * Specified hosts and SAS token: At least one of the service host and SAS token. It's up to user to ensure the SAS token is suitable for the serivce
+    # * Anonymous Blob: only +:storage_blob_host+, if it is to only access blobs within a container
+    #
+    # Additional notes:
+    # * Specified hosts can be set when use account name with access key or sas token
+    # * +:default_endpoints_protocol+ can be set if the scheme is not specified in hosts
+    # * Storage emulator always use path style URI
+    # * +:ca_file+ is independent.
+    #
+    # When empty options are given, it will try to read settings from Environment Variables. Refer to [Azure::Storage::Common::ClientOptions.env_vars_mapping] for the mapping relationship
+    #
+    # @return [Azure::Storage::Common::Client]
+    def initialize(options = {}, &block)
+      if options.is_a?(Hash) && options.has_key?(:user_agent_prefix)
+        Azure::Storage::Common::Service::StorageService.user_agent_prefix = options[:user_agent_prefix]
+        options.delete :user_agent_prefix
+      end
+      Azure::Storage::Common::Service::StorageService.register_request_callback(&block) if block_given?
+      reset!(options)
+    end
+
+    class << self
+      # Public: Creates an instance of [Azure::Storage::Common::Client]
+      #
+      # ==== Attributes
+      #
+      # * +options+    - Hash. Optional parameters.
+      #
+      # ==== Options
+      #
+      # Accepted key/value pairs in options parameter are:
+      #
+      # * +:use_development_storage+        - TrueClass|FalseClass. Whether to use storage emulator.
+      # * +:development_storage_proxy_uri+  - String. Used with +:use_development_storage+ if emulator is hosted other than localhost.
+      # * +:storage_account_name+           - String. The name of the storage account.
+      # * +:storage_access_key+             - Base64 String. The access key of the storage account.
+      # * +:storage_sas_token+              - String. The signed access signature for the storage account or one of its service.
+      # * +:storage_blob_host+              - String. Specified Blob service endpoint or hostname
+      # * +:storage_table_host+             - String. Specified Table service endpoint or hostname
+      # * +:storage_queue_host+             - String. Specified Queue service endpoint or hostname
+      # * +:storage_dns_suffix+             - String. The suffix of a regional Storage Service, to
+      # * +:default_endpoints_protocol+     - String. http or https
+      # * +:use_path_style_uri+             - String. Whether use path style URI for specified endpoints
+      # * +:ca_file+                        - String. File path of the CA file if having issue with SSL
+      # * +:ssl_version+                    - Symbol. The ssl version to be used, sample: :TLSv1_1, :TLSv1_2, for the details, see https://github.com/ruby/openssl/blob/master/lib/openssl/ssl.rb
+      # * +:ssl_min_version+                - Symbol. The min ssl version supported, only supported in Ruby 2.5+
+      # * +:ssl_max_version+                - Symbol. The max ssl version supported, only supported in Ruby 2.5+
+      # * +:user_agent_prefix+              - String. The user agent prefix that can identify the application calls the library
+      #
+      # The valid set of options include:
+      # * Storage Emulator: +:use_development_storage+ required, +:development_storage_proxy_uri+ optionally
+      # * Storage account name and key: +:storage_account_name+ and +:storage_access_key+ required, set +:storage_dns_suffix+ necessarily
+      # * Storage account name and SAS token: +:storage_account_name+ and +:storage_sas_token+ required, set +:storage_dns_suffix+ necessarily
+      # * Specified hosts and SAS token: At least one of the service host and SAS token. It's up to user to ensure the SAS token is suitable for the serivce
+      # * Anonymous Blob: only +:storage_blob_host+, if it is to only access blobs within a container
+      #
+      # Additional notes:
+      # * Specified hosts can be set when use account name with access key or sas token
+      # * +:default_endpoints_protocol+ can be set if the scheme is not specified in hosts
+      # * Storage emulator always use path style URI
+      # * +:ca_file+ is independent.
+      #
+      # When empty options are given, it will try to read settings from Environment Variables. Refer to [Azure::Storage::Common::ClientOptions.env_vars_mapping] for the mapping relationship
+      #
+      # @return [Azure::Storage::Common::Client]
+      def create(options = {}, &block)
+        Client.new(options, &block)
+      end
+
+      # Public: Creates an instance of [Azure::Storage::Common::Client] with Storage Emulator
+      #
+      # ==== Attributes
+      #
+      # * +proxy_uri+    - String. Used with +:use_development_storage+ if emulator is hosted other than localhost.
+      #
+      # @return [Azure::Storage::Common::Client]
+      def create_development(proxy_uri = nil, &block)
+        proxy_uri ||= StorageServiceClientConstants::DEV_STORE_URI
+        create(use_development_storage: true, development_storage_proxy_uri: proxy_uri, &block)
+      end
+
+      # Public: Creates an instance of [Azure::Storage::Common::Client] from Environment Variables
+      #
+      # @return [Azure::Storage::Client]
+      def create_from_env(&block)
+        create(&block)
+      end
+
+      # Public: Creates an instance of [Azure::Storage::Common::Client] from Environment Variables
+      #
+      # ==== Attributes
+      #
+      # * +connection_string+    - String. Please refer to https://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/.
+      #
+      # @return [Azure::Storage::Common::Client]
+      def create_from_connection_string(connection_string, &block)
+        Client.new(connection_string, &block)
+      end
+    end
+  end
+end