azure-storage-common 1.0.1 → 2.0.3

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 = 0 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/core.rb

@@ -0,0 +1,47 @@
+#-------------------------------------------------------------------------
+# # 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.
+#--------------------------------------------------------------------------
+
+require 'rubygems'
+require 'nokogiri'
+require 'faraday'
+require 'faraday_middleware'
+
+module Azure
+  module Core
+    autoload :Utility,                        'azure/core/utility'
+    autoload :Logger,                         'azure/core/utility'
+    autoload :Error,                          'azure/core/error'
+    autoload :Service,                        'azure/core/service'
+    autoload :FilteredService,                'azure/core/filtered_service'
+    autoload :SignedService,                  'azure/core/signed_service'
+    autoload :Default,                        'azure/core/default'
+    module Auth
+      autoload :SharedKey,                    'azure/core/auth/shared_key'
+      autoload :Signer,                       'azure/core/auth/signer'
+      autoload :Authorizer,                   'azure/core/auth/authorizer'
+      autoload :SharedKeyLite,                'azure/core/auth/shared_key_lite'
+    end
+    module Http
+      autoload :DebugFilter,                  'azure/core/http/debug_filter'
+      autoload :HTTPError,                    'azure/core/http/http_error'
+      autoload :HttpFilter,                   'azure/core/http/http_filter'
+      autoload :HttpRequest,                  'azure/core/http/http_request'
+      autoload :HttpResponse,                 'azure/core/http/http_response'
+      autoload :RetryPolicy,                  'azure/core/http/retry_policy'
+      autoload :SignerFilter,                 'azure/core/http/signer_filter'
+    end
+  end
+
+end

data/lib/azure/http_response_helper.rb

@@ -0,0 +1,38 @@
+#-------------------------------------------------------------------------
+# # 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 HttpResponseHelper
+
+      # Sends request to HTTP server and returns a Faraday::Response
+      # @param method   [Symbol] The HTTP method to use (:get, :post, :put, :del, etc...)
+      # @param url      [URI] The URI of the HTTP endpoint to query
+      # @param conn     [Net::HTTP] http agent for a given uri
+      # @param headers  [String] The request headers
+      # @param body     [String] The request body
+      #returns Faraday::Response
+      def set_up_response(method, url, conn, headers ,body)
+        conn.run_request(method, url, nil, nil) do |req|
+          req.body = body if body
+          req.headers = headers if headers
+          unless headers.nil?
+            keep_alive = headers['Keep-Alive'] || headers['keep-alive']
+            req.options[:timeout] = keep_alive.split('=').last.to_i unless keep_alive.nil?
+          end
+          req.options[:open_timeout] ||= 60
+        end
+      end
+  end
+end

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

@@ -1,61 +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_middleware"
-
-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"
-      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 "rubygems"
+require "nokogiri"
+require "base64"
+require "openssl"
+require "uri"
+require "faraday"
+require "faraday_middleware"
+
+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