azure-storage-common2 2.0.8 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02278cee9975ab0029e7c8ab4ba8c844775a2cfc3a2167ab3b22e068fa401f4a'
-  data.tar.gz: 8941a3827da961032c9078d877779cc8f2ba4e73c0feebd49624dbd73fe88c8f
+  metadata.gz: cfd8cb6ee4fcad3e2354050762c85bc138c8963e9d4e53f2398c98132ff64e8c
+  data.tar.gz: 9e4a633ebc65ff91386edd548a400ce240d34f86b20191f43b020d9aea27007d
 SHA512:
-  metadata.gz: ccc3e97fca8c33c62d6b2fb01437ec8147ec1a1e37e3491e10f63041a62b0adfda6e955c4c282085ba23de1a8aa271fc653e8d96407e42d3899d5790f7e989c8
-  data.tar.gz: 3279006d6953ae01d263714d90d6e20845dbb593602dc485e9a91a58f64b83616ed99d97139edcd5b15769303392f3e3ddcd5767262efb706740bbc89b0a6ffe
+  metadata.gz: f4c28756c8623d31ff6c9d50c05ee43ce5ed689310e970fda1b0945513fbef08a59edd317a7a722e0db30272f8c742f39bdfa2944b208b475b2f715e72ad112b
+  data.tar.gz: 6fe00a0bbc206db2047923e076dfcc0c70e83da661411368ad6a2220b5e68ba564c23b6fff0f1a2539914b4fae47d1bbd664bc172bc53c0fd1f1232fb35e6d52

data/lib/azure/core/auth/authorizer.rb

@@ -0,0 +1,36 @@
+#-------------------------------------------------------------------------
+# # 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 "azure/core/configuration"
+
+module Azure
+  module Core
+    module Auth
+      class Authorizer
+        # Public: Signs an HTTP request before it's made, by adding the
+        # Authorization header
+        #
+        # request - An Azure::Core::HttpRequest that hasn't been signed
+        # signer  - A signing strategy, such as Azure::Table::Auth::SharedKey
+        #
+        # Returns the modified request
+        def sign(request, signer)
+          signature = signer.sign(request.method, request.uri, request.headers)
+          request.headers['Authorization'] = "#{signer.name} #{signature}"
+          request
+        end
+      end
+    end
+  end
+end

data/lib/azure/core/auth/shared_key.rb

@@ -0,0 +1,125 @@
+#-------------------------------------------------------------------------
+# # 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 'cgi'
+require 'azure/core/auth/signer'
+
+module Azure
+  module Core
+    module Auth
+      class SharedKey < Signer
+        # The Azure account's name.
+        attr :account_name
+
+        # Initialize the Signer.
+        #
+        # @param account_name [String] The account name. Defaults to the one in the
+        #                global configuration.
+        # @param access_key   [String] The access_key encoded in Base64. Defaults to the
+        #                one in the global configuration.
+        def initialize(account_name=Azure.storage_account_name, access_key=Azure.storage_access_key)
+          @account_name = account_name
+          super(access_key)
+        end
+
+        # The name of the strategy.
+        #
+        # @return [String]
+        def name
+          'SharedKey'
+        end
+
+        # Create the signature for the request parameters
+        #
+        # @param method     [Symbol] HTTP request method.
+        # @param uri        [URI] URI of the request we're signing.
+        # @param headers    [Hash] HTTP request headers.
+        #
+        # @return           [String] base64 encoded signature
+        def sign(method, uri, headers)
+          "#{account_name}:#{super(signable_string(method, uri, headers))}"
+        end
+
+        # Sign the request
+        #
+        # @param req    [Azure::Core::Http::HttpRequest] HTTP request to sign
+        #
+        # @return       [Azure::Core::Http::HttpRequest]
+        def sign_request(req)
+          # Need to make sure Content-Length is correctly set.
+          if ((!req.body.nil?)) then
+            if (req.body.respond_to? :bytesize) then
+              req.headers['Content-Length'] = req.body.bytesize.to_s
+            elsif (req.body.respond_to? :size)
+              req.headers['Content-Length'] = req.body.size.to_s
+            end
+          end
+          req.headers['Authorization'] = "#{name} #{sign(req.method, req.uri, req.headers)}"
+          req
+        end
+
+        # Generate the string to sign.
+        #
+        # @param method     [Symbol] HTTP request method.
+        # @param uri        [URI] URI of the request we're signing.
+        # @param headers    [Hash] HTTP request headers.
+        #
+        # @return [String]
+        def signable_string(method, uri, headers)
+          [
+            method.to_s.upcase,
+            headers.fetch('Content-Encoding', ''),
+            headers.fetch('Content-Language', ''),
+            headers.fetch('Content-Length', ''),
+            headers.fetch('Content-MD5', ''),
+            headers.fetch('Content-Type', ''),
+            headers.fetch('Date', ''),
+            headers.fetch('If-Modified-Since', ''),
+            headers.fetch('If-Match', ''),
+            headers.fetch('If-None-Match', ''),
+            headers.fetch('If-Unmodified-Since', ''),
+            headers.fetch('Range', ''),
+            canonicalized_headers(headers),
+            canonicalized_resource(uri)
+          ].join("\n")
+        end
+
+        # Calculate the Canonicalized Headers string for a request.
+        #
+        # @param headers    [Hash] HTTP request headers.
+        #
+        # @return [String] a string with the canonicalized headers.
+        def canonicalized_headers(headers)
+          headers = headers.map { |k,v| [k.to_s.downcase, v] }
+          headers.select! { |k,_| k =~ /^x-ms-/ }
+          headers.sort_by! { |(k,_)| k }
+          headers.map! { |k,v| '%s:%s' % [k, v] }.join("\n")
+        end
+
+        # Calculate the Canonicalized Resource string for a request.
+        #
+        # @param uri        [URI] URI of the request we're signing.
+        #
+        # @return           [String] a string with the canonicalized resource.
+        def canonicalized_resource(uri)
+          resource = '/' + account_name + (uri.path.empty? ? '/' : uri.path)
+          params = CGI.parse(uri.query.to_s).map { |k,v| [k.downcase, v] }
+          params.sort_by! { |k,_| k }
+          params.map! { |k,v| '%s:%s' % [k, v.map(&:strip).sort.join(',')] }
+          [resource, *params].join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/azure/core/auth/shared_key_lite.rb

@@ -0,0 +1,48 @@
+#-------------------------------------------------------------------------
+# # 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 "azure/core/auth/shared_key"
+
+module Azure
+  module Core
+    module Auth
+      class SharedKeyLite < SharedKey
+        # The name of the strategy.
+        #
+        # @return [String]
+        def name
+          'SharedKeyLite'
+        end
+
+        # Generate the string to sign.
+        #
+        # @param method     [Symbol] The HTTP request method.
+        # @param uri        [URI] The URI of the request we're signing.
+        # @param headers    [Hash] A Hash of HTTP request headers.
+        #
+        # Returns a plain text string.
+        def signable_string(method, uri, headers)
+          [
+            method.to_s.upcase,
+            headers.fetch('Content-MD5', ''),
+            headers.fetch('Content-Type', ''),
+            headers.fetch('Date') { raise IndexError, 'Headers must include Date' },
+            canonicalized_headers(headers),
+            canonicalized_resource(uri)
+          ].join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/azure/core/auth/signer.rb

@@ -0,0 +1,51 @@
+#-------------------------------------------------------------------------
+# # 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 'openssl'
+require 'base64'
+
+module Azure
+  module Core
+    module Auth
+      # Utility class to sign strings with HMAC-256 and then encode the
+      # signed string using Base64.
+      class Signer
+        # The access key for the account
+        attr :access_key
+
+        # Initialize the Signer.
+        #
+        # @param access_key [String] The access_key encoded in Base64.
+        def initialize(access_key)
+          if access_key.nil?
+            raise ArgumentError, 'Signing key must be provided'
+          end
+
+          @access_key = Base64.decode64(access_key)
+        end
+
+        # Generate an HMAC signature.
+        #
+        # @param body [String] The string to sign.
+        #
+        # @return [String] a Base64 String signed with HMAC.
+        def sign(body)
+          signed = OpenSSL::HMAC.digest('sha256', access_key, body)
+          Base64.strict_encode64(signed)
+        end
+
+      end
+    end
+  end
+end

data/lib/azure/core/default.rb

@@ -0,0 +1,23 @@
+#-------------------------------------------------------------------------
+# # 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
+    module Default
+      # Default User Agent header string
+      USER_AGENT   = "Azure-Core/#{Azure::Core::Version}".freeze
+    end
+  end
+end

data/lib/azure/core/error.rb

@@ -0,0 +1,21 @@
+#-------------------------------------------------------------------------
+# # 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
+    # Superclass for errors generated from this library, so people can
+    # just rescue this for generic error handling
+    class Error < StandardError;end
+  end
+end

data/lib/azure/core/filtered_service.rb

@@ -0,0 +1,45 @@
+#-------------------------------------------------------------------------
+# # 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 'azure/core/service'
+
+module Azure
+  module Core
+    # A base class for Service implementations
+    class FilteredService < Service
+
+      # Create a new instance of the FilteredService
+      #
+      # @param host     [String] The hostname. (optional, Default empty)
+      # @param options  [Hash] options including {:client} (optional, Default {})
+      def initialize(host='', options={})
+        super
+        @filters = []
+      end
+
+      attr_accessor :filters
+
+      def call(method, uri, body=nil, headers=nil, options={})
+        super(method, uri, body, headers) do |request|
+          filters.reverse.each { |filter| request.with_filter filter, options } if filters
+        end
+      end
+
+      def with_filter(filter=nil, &block)
+        filter = filter || block
+        filters.push filter if filter
+      end
+    end
+  end
+end

data/lib/azure/core/http/debug_filter.rb

@@ -0,0 +1,36 @@
+#-------------------------------------------------------------------------
+# # 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 "azure/core/http/http_filter"
+
+module Azure
+  module Core
+    module Http
+      # A HttpFilter implementation that displays information about the request and response for debugging
+      class DebugFilter < HttpFilter
+        def call(req, _next)
+          puts "--REQUEST-BEGIN---------------------------"
+          puts "method:", req.method, "uri:", req.uri, "headers:", req.headers, "body:", req.body
+          puts "--REQUEST-END---------------------------"
+
+          r = _next.call
+          puts "--RESPONSE-BEGIN---------------------------"
+          puts "status_code:", r.status_code, "headers:", r.headers, "body:", r.body
+          puts "--RESPONSE-END---------------------------"
+          r
+        end
+      end
+    end
+  end
+end

data/lib/azure/core/http/http_error.rb

@@ -0,0 +1,135 @@
+#-------------------------------------------------------------------------
+# # 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 'azure/core/error'
+require 'nokogiri'
+require 'json'
+
+module Azure
+  module Core
+    module Http
+      # Public: Class for handling all HTTP response errors
+      class HTTPError < Azure::Core::Error
+
+        # Public: Detail of the response
+        #
+        # Returns an Azure::Core::Http::HttpResponse object
+        attr :http_response
+
+        # Public: The request URI
+        #
+        # Returns a String
+        attr :uri
+
+        # Public: The HTTP status code of this error
+        #
+        # Returns a Fixnum
+        attr :status_code
+
+        # Public: The type of error
+        #
+        # http://msdn.microsoft.com/en-us/library/azure/dd179357
+        #
+        # Returns a String
+        attr :type
+
+        # Public: Description of the error
+        #
+        # Returns a String
+        attr :description
+
+        # Public: Detail of the error
+        #
+        # Returns a String
+        attr :detail
+
+        # Public: The header name whose value is invalid
+        #
+        # Returns a String
+        attr :header
+
+        # Public: The invalid header value
+        #
+        # Returns a String
+        attr :header_value
+
+        # Public: Initialize an error
+        #
+        # http_response - An Azure::Core::HttpResponse
+        def initialize(http_response)
+          @http_response = http_response
+          @uri = http_response.uri
+          @status_code = http_response.status_code
+          parse_response
+          # Use reason phrase as the description if description is empty
+          @description = http_response.reason_phrase if (@description.nil? || @description.empty?) && http_response.reason_phrase
+          super("#{type} (#{status_code}): #{description}")
+        end
+
+        # Extract the relevant information from the response's body. If the response
+        # body is not an XML, we return an 'Unknown' error with the entire body as
+        # the description
+        #
+        # Returns nothing
+        def parse_response
+          if @http_response.body && @http_response.respond_to?(:headers) && @http_response.headers['Content-Type']
+            if @http_response.headers['Content-Type'].include?('xml')
+              parse_xml_response
+            elsif @http_response.headers['Content-Type'].include?('json')
+              parse_json_response
+            end
+          else
+            parse_unknown_response
+          end
+        end
+
+        def parse_xml_response
+          document = Nokogiri.Slop(@http_response.body)
+
+          @type = document.css('code').first.text if document.css('code').any?
+          @type = document.css('Code').first.text if document.css('Code').any?
+          @description = document.css('message').first.text if document.css('message').any?
+          @description = document.css('Message').first.text if document.css('Message').any?
+          @header = document.css('headername').first.text if document.css('headername').any?
+          @header = document.css('HeaderName').first.text if document.css('HeaderName').any?
+          @header_value = document.css('headervalue').first.text if document.css('headervalue').any?
+          @header_value = document.css('HeaderValue').first.text if document.css('HeaderValue').any?
+
+          # service bus uses detail instead of message
+          @detail = document.css('detail').first.text if document.css('detail').any?
+          @detail = document.css('Detail').first.text if document.css('Detail').any?
+        end
+
+        def parse_json_response
+          odata_error = JSON.parse(@http_response.body)['odata.error']
+          @type = odata_error['code']
+          @description = odata_error['message']['value']
+        end
+
+        def parse_unknown_response
+          @type = 'Unknown'
+          if @http_response.body
+            @description = "#{@http_response.body.strip}"
+          end
+        end
+
+        def inspect
+          string = "#<#{self.class.name}:#{self.object_id} "
+          fields = self.instance_variables.map{|field| "#{field}: #{self.send(field.to_s.delete("@")).inspect}"}
+          string << fields.join(", ") << ">"
+        end
+      end
+    end
+  end
+end

data/lib/azure/core/http/http_filter.rb

@@ -0,0 +1,53 @@
+#-------------------------------------------------------------------------
+# # 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
+    module Http
+      # A filter which can modify the HTTP pipeline both before and
+      # after requests/responses. Multiple filters can be nested in a
+      # "Russian Doll" model to create a compound HTTP pipeline
+      class HttpFilter
+
+        # Initialize a HttpFilter
+        #
+        # &block - An inline block which implements the filter.
+        #
+        # The inline block should take parameters |request, _next| where
+        # request is a HttpRequest and _next is an object that implements
+        # a method .call which returns an HttpResponse. The block passed
+        # to the constructor should also return HttpResponse, either as
+        # the result of calling _next.call or by customized logic.
+        #
+        def initialize(&block)
+          @block = block
+        end
+
+        # Executes the filter
+        #
+        # request - HttpRequest. The request
+        # _next   - An object that implements .call (no params)
+        #
+        # NOTE: _next is a either a subsequent HttpFilter wrapped in a
+        # closure, or the HttpRequest object's call method. Either way,
+        # it must have it's .call method executed within each filter to
+        #  complete the pipeline. _next.call should return an HttpResponse
+        # and so should this Filter.
+        def call(request, _next)
+          @block ? @block.call(request, _next) : _next.call
+        end
+      end
+    end
+  end
+end