azure-storage 0.10.0.preview

data/lib/azure/storage/core/error.rb

@@ -0,0 +1,47 @@
+#-------------------------------------------------------------------------
+# # 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 Core
+    # Superclass for errors generated from this library, so people can
+    # just rescue this for generic error handling
+    class Error < StandardError;end
+  end
+end
+
+module Azure::Storage
+  # Superclass for errors generated from this library, so people can
+  # just rescue this for generic error handling
+  class StorageError < StandardError
+    # attr_reader :description
+    # attr_reader :status_code
+    # attr_reader :type
+
+    # def initialize(description, type, status)
+    #   @type = type
+    #   @status_code = status
+    #   @description = description
+    #   super("#{type} (#{status_code}): #{description}")
+    # end
+  end
+end

data/lib/azure/storage/core/filtered_service.rb

@@ -0,0 +1,54 @@
+#-------------------------------------------------------------------------
+# # 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/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)
+        super(method, uri, body, headers) do |request|
+          filters.each { |filter| request.with_filter filter } 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/storage/core/http/debug_filter.rb

@@ -0,0 +1,45 @@
+#-------------------------------------------------------------------------
+# # 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/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/storage/core/http/http_error.rb

@@ -0,0 +1,95 @@
+#-------------------------------------------------------------------------
+# # 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/core/error'
+
+module Azure
+  module Core
+    module Http
+      # Public: Class for handling all HTTP response errors
+      class HTTPError < Azure::Core::Error
+        
+        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: 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
+          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.body.include?('<')
+
+            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?
+
+            # 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?
+          else
+            @type = 'Unknown'
+            if @http_response.body
+              @description = "#{@http_response.body.strip}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+#-------------------------------------------------------------------------
+# # 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 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

data/lib/azure/storage/core/http/http_request.rb

@@ -0,0 +1,182 @@
+#-------------------------------------------------------------------------
+# # 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 'digest/md5'
+require 'base64'
+require 'net/http'
+require 'time'
+
+require 'azure/storage/version'
+require 'azure/storage/core/http/http_response'
+require 'azure/storage/core/constants'
+
+module Azure
+  module Core
+    module Http
+      # Represents a HTTP request can perform synchronous queries to a 
+      # HTTP server, returning a HttpResponse 
+      class HttpRequest
+
+        alias_method :_method, :method
+
+        # The HTTP method to use (:get, :post, :put, :delete, etc...)
+        attr_accessor :method
+
+        # The URI of the HTTP endpoint to query
+        attr_accessor :uri
+
+        # The header values as a Hash
+        attr_accessor :headers
+
+        # The body of the request (IO or String)
+        attr_accessor :body
+
+        # Azure storage client which contains configuration context and http agents
+        # @return [Azure::Storage::Client]
+        attr_accessor :client
+
+        # Public: Create the HttpRequest
+        #
+        # @param method   [Symbol] The HTTP method to use (:get, :post, :put, :del, etc...)
+        # @param uri      [URI] The URI of the HTTP endpoint to query
+        # @param options_or_body  [Hash|IO|String] The request options including {:client, :body} or raw body only
+        def initialize(method, uri, options_or_body = {})
+          options ||= unless options_or_body.is_a?(Hash)
+                        {body: options_or_body}
+                      end || options_or_body || {}
+
+          @method = method
+          @uri = if uri.is_a?(String)
+                   URI.parse(uri)
+                 else
+                   uri
+                 end
+
+          @client = options[:client] || Azure::Storage
+
+          self.headers = default_headers(options[:current_time] || Time.now.httpdate).merge(options[:headers] || {})
+          self.body = options[:body]
+        end
+
+        # Public: Applies a HttpFilter to the HTTP Pipeline
+        #
+        # filter - Any object that responds to .call(req, _next) and 
+        #          returns a HttpResponse eg. HttpFilter, Proc, 
+        #          lambda, etc. (optional)
+        #
+        # &block - An inline block may be used instead of a filter
+        #
+        #          example:
+        #
+        #             request.with_filter do |req, _next| 
+        #               _next.call
+        #             end
+        #
+        # NOTE:
+        #
+        # The code block provided must call _next or the filter pipeline
+        # will not complete and the HTTP request will never execute
+        # 
+        def with_filter(filter=nil, &block)
+          filter = filter || block
+          if filter
+            old_impl = self._method(:call)
+
+            # support 1.8.7 (define_singleton_method doesn't exist until 1.9.1)
+            new_impl = Proc.new do
+              filter.call(self, old_impl)
+            end
+            k = class << self;
+              self;
+            end
+            if k.method_defined? :define_singleton_method
+              self.define_singleton_method(:call, new_impl)
+            else
+              k.send(:define_method, :call, new_impl)
+            end
+          end
+        end
+
+        # Build a default headers Hash
+        def default_headers(current_time)
+          {}.tap do |def_headers|
+            def_headers['User-Agent'] = Azure::Storage::Default::USER_AGENT
+            def_headers['x-ms-date'] = current_time
+            def_headers['x-ms-version'] = Azure::Storage::Default::STG_VERSION
+            def_headers['DataServiceVersion'] = '1.0;NetFx'
+            def_headers['MaxDataServiceVersion'] = '3.0;NetFx'
+            def_headers['Content-Type'] = 'application/atom+xml; charset=utf-8'
+          end
+        end
+
+        def http_setup
+          http = @client.agents(uri)
+          unless headers.nil?
+            keep_alive = headers['Keep-Alive'] || headers['keep-alive']
+            http.read_timeout = keep_alive.split('=').last.to_i unless keep_alive.nil?
+          end
+
+          http
+        end
+
+        def body=(body)
+          @body = body
+          apply_body_headers
+        end
+
+        # Sends request to HTTP server and returns a HttpResponse
+        #
+        # @return [HttpResponse]
+        def call
+          conn = http_setup
+          res = conn.run_request(method.to_sym, uri, nil, nil) do |req|
+            req.body = body if body
+            req.headers = headers if headers
+          end
+
+          response = HttpResponse.new(res)
+          response.uri = uri
+          raise response.error unless response.success?
+          response
+        end
+
+        private
+
+        def apply_body_headers
+          if body
+            if IO === body
+              headers['Content-Length'] = body.size.to_s
+              headers['Content-MD5'] = Digest::MD5.file(body.path).base64digest unless headers['Content-MD5']
+            else
+              headers['Content-Length'] = body.bytesize.to_s
+              headers['Content-MD5'] = Base64.strict_encode64(Digest::MD5.digest(body)) unless headers['Content-MD5']
+            end
+          else
+            headers['Content-Length'] = '0'
+          end
+        end
+
+      end
+    end
+  end
+end