azure-storage 0.10.0.preview

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

@@ -0,0 +1,105 @@
+#-------------------------------------------------------------------------
+# # 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_error'
+
+module Azure
+  module Core
+    module Http
+      # A small proxy to clean up the API of Net::HTTPResponse.
+      class HttpResponse
+
+        # Public: Initialize a new response.
+        #
+        # http_response - A Net::HTTPResponse.
+        def initialize(http_response, uri='')
+          @http_response = http_response
+          @uri = uri
+        end
+
+        attr_accessor :uri
+
+        # Public: Get the response body.
+        #
+        # Returns a String.
+        def body
+          @http_response.body
+        end
+
+        # Public: Get the response status code.
+        #
+        # Returns a Fixnum.
+        def status_code
+          @http_response.status
+        end
+
+        # Public: Check if this response was successful. A request is considered
+        # successful if the response is in the 200 - 399 range.
+        #
+        # Returns nil|false.
+        def success?
+          @http_response.success?
+        end
+
+        # Public: Get all the response headers as a Hash.
+        #
+        # Returns a Hash.
+        def headers
+          @http_response.headers
+        end
+
+        # Public: Get an error that wraps this HTTP response, as long as this
+        # response was unsuccessful. This method will return nil if the
+        # response was successful.
+        #
+        # Returns an Azure::Core::Http::HTTPError.
+        def exception
+          HTTPError.new(self) unless success?
+        end
+        
+        alias_method :error, :exception
+
+        # TODO: This needs to be deleted and HttpError needs to be refactored to not rely on HttpResponse.
+        # The dependency on knowing the internal structure of HttpResponse breaks good design principles.
+        # The only reason this class exists is because the HttpError parses the HttpResponse to produce an error msg.
+        class MockResponse
+          def initialize(code, body, headers)
+            @status = code
+            @body = body
+            @headers = headers
+            @headers.each { |k,v|
+              @headers[k] = [v] unless v.respond_to? first
+            }
+          end
+          attr_accessor :status
+          attr_accessor :body
+          attr_accessor :headers
+
+          def to_hash
+            @headers
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+#-------------------------------------------------------------------------
+# # 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 handles retrying based on a 
+      # specific policy when HTTP layer errors occur
+      class RetryPolicy < HttpFilter
+    
+        def initialize(&block)
+          @block = block
+        end
+
+        attr_accessor :retry_data
+
+        # Overrides the base class implementation of call to implement 
+        # a retry loop that uses should_retry? to determine when to 
+        # break the loop
+        # 
+        # req   - HttpRequest. The HTTP request
+        # _next - HttpFilter. The next filter in the pipeline
+        def call(req, _next)
+          retry_data = {}
+          response = nil
+          begin
+            response = _next.call
+          rescue
+            retry_data[:error] = $!
+          end while should_retry?(response, retry_data)
+          if retry_data.has_key?(:error)
+            raise retry_data[:error]
+          else
+            response
+          end
+        end
+
+        # Determines if the HTTP request should continue retrying
+        # 
+        # response - HttpResponse. The response from the active request
+        # retry_data - Hash. Stores stateful retry data
+        #
+        # The retry_data is a Hash which can be used to store 
+        # stateful data about the request execution context (such as an 
+        # incrementing counter, timestamp, etc). The retry_data object 
+        # will be the same instance throughout the lifetime of the request.
+        #
+        # If an inline block was passed to the constructor, that block 
+        # will be used here and should return true to retry the job, or
+        # false to stop exit. If an inline block was not passed to the 
+        # constructor the method returns false.
+        #
+        # Alternatively, a subclass could override this method.
+        def should_retry?(response, retry_data)
+          @block ? @block.call(response, retry_data) : false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+#-------------------------------------------------------------------------
+# # 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 creates a authorization signature which is added to the request headers
+      class SignerFilter < HttpFilter
+        def initialize(signer)
+          @signer = signer
+        end
+
+        def call(req, _next)
+          @signer.sign_request(req)
+          _next.call
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+#-------------------------------------------------------------------------
+# # 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::Core
+  module HttpClient
+    # Returns the http agent based on uri
+    # @param uri  [URI|String] the base uri (scheme, host, port) of the http endpoint
+    # @return [Net::HTTP] http agent for a given uri
+    def agents(uri)
+      key = uri.to_s
+      @agents ||= {}
+      unless @agents.key?(key)
+        @agents[key] = build_http(uri)
+      end
+      @agents[key]
+    end
+
+    # Empties all the http agents
+    def reset_agents!
+      @agents = nil
+    end
+
+    private
+
+    def build_http(uri)
+      ssl_options = {}
+      if uri.is_a?(URI) && uri.scheme.downcase == 'https'
+        ssl_options[:ca_file] = self.ca_file if self.ca_file
+        ssl_options[:verify] = true
+      end
+      proxy_options = if ENV['HTTP_PROXY']
+                        URI::parse(ENV['HTTP_PROXY'])
+                      elsif ENV['HTTPS_PROXY']
+                        URI::parse(ENV['HTTPS_PROXY'])
+                      end || nil
+      Faraday.new(uri, ssl: ssl_options, proxy: proxy_options) do |conn|
+        conn.use FaradayMiddleware::FollowRedirects
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+#-------------------------------------------------------------------------
+# # 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_request'
+
+module Azure
+  module Core
+    # A base class for Service implementations
+    class Service
+
+      # Create a new instance of the Service
+      # 
+      # @param host     [String] The hostname. (optional, Default empty)
+      # @param options  [Hash] options including {:client} (optional, Default {})
+      def initialize(host='', options = {})
+        @host = host
+        @client = options[:client] || Azure::Storage
+      end
+
+      attr_accessor :host, :client
+
+      def call(method, uri, body=nil, headers={})
+        request = Core::Http::HttpRequest.new(method, uri, body: body, headers: headers, client: @client)
+        yield request if block_given?
+        request.call
+      end
+
+      def generate_uri(path='', query={})
+        uri = URI.parse(File.join(host, path))
+        uri.query = URI.encode_www_form(query) unless query == nil or query.empty?
+        uri
+      end
+    end
+  end
+end

data/lib/azure/storage/core/signed_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/filtered_service'
+require 'azure/storage/core/http/signer_filter'
+require 'azure/storage/core/auth/shared_key'
+
+module Azure
+  module Core
+    # A base class for Service implementations
+    class SignedService < FilteredService
+
+      # Create a new instance of the SignedService
+      #
+      # @param signer         [Azure::Core::Auth::Signer]. An implementation of Signer used for signing requests. (optional, Default=Azure::Storage::Auth::SharedKey.new)
+      # @param account_name   [String] The account name (optional, Default=Azure::Storage.config.storage_account_name)
+      # @param options        [Hash] options
+      def initialize(signer=nil, account_name=nil, options={})
+        super('', options)
+        signer ||= Azure::Storage::Auth::SharedKey.new(client.storage_account_name, client.storage_access_key)
+        @account_name = account_name || client.storage_account_name
+        @signer = signer
+        filters.unshift Core::Http::SignerFilter.new(signer) if signer
+      end
+
+      attr_accessor :account_name
+      attr_accessor :signer
+
+      def call(method, uri, body=nil, headers=nil)
+        super(method, uri, body, headers)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+#-------------------------------------------------------------------------
+# # 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
+  module SR
+    ANONYMOUS_ACCESS_BLOBSERVICE_ONLY = 'Anonymous access is only valid for the BlobService.'
+    ARGUMENT_NULL_OR_EMPTY = 'The argument must not be null or an empty string. Argument name: %s.'
+    ARGUMENT_NULL_OR_UNDEFINED = 'The argument must not be null or undefined. Argument name: %s.'
+    ARGUMENT_OUT_OF_RANGE_ERROR = 'The argument is out of range. Argument name: %s, Value passed: %s.'
+    BATCH_ONE_PARTITION_KEY = 'All entities in the batch must have the same PartitionKey value.'
+    BATCH_ONE_RETRIEVE = 'If a retrieve operation is part of a batch, it must be the only operation in the batch.'
+    BATCH_TOO_LARGE = 'Batches must not contain more than 100 operations.'
+    BLOB_INVALID_SEQUENCE_NUMBER = 'The sequence number may not be specified for an increment operation.'
+    BLOB_TYPE_MISMATCH = 'Blob type of the blob reference doesn\'t match blob type of the blob.'
+    CANNOT_CREATE_SAS_WITHOUT_ACCOUNT_KEY = 'Cannot create Shared Access Signature unless the Account Name and Key are used to create the ServiceClient.'
+    CONTENT_LENGTH_MISMATCH = 'An incorrect number of bytes was read from the connection. The connection may have been closed.'
+    CONTENT_TYPE_MISSING = 'Content-Type response header is missing or invalid.'
+    EMPTY_BATCH = 'Batch must not be empty.'
+    EXCEEDED_SIZE_LIMITATION = 'Upload exceeds the size limitation. Max size is %s but the current size is %s'
+    HASH_MISMATCH = 'Hash mismatch (integrity check failed), Expected value is %s, retrieved %s.'
+    INCORRECT_ENTITY_KEYS = 'PartitionKey and RowKey must be specified as strings in the entity object.'
+    INVALID_BLOB_LENGTH = 'createBlockBlobFromText requires the size of text to be less than 64MB. Please use createBlockBlobFromLocalFile or createBlockBlobFromStream to upload large blobs.'
+    INVALID_CONNECTION_STRING = 'Connection strings must be of the form "key1=value1;key2=value2".'
+    INVALID_CONNECTION_STRING_BAD_KEY = 'Connection string contains unrecognized key: "%s"'
+    INVALID_CONNECTION_STRING_DUPLICATE_KEY = 'Connection string contains duplicate key: "%s"'
+    INVALID_CONNECTION_STRING_EMPTY_KEY = 'Connection strings must not contain empty keys.'
+    INVALID_CLIENT_OPTIONS = 'Storage client options are invalid'
+    INVALID_DELETE_SNAPSHOT_OPTION = 'The deleteSnapshots option cannot be included when deleting a specific snapshot using the snapshotId option.'
+    INVALID_EDM_TYPE = 'The value \'%s\' does not match the type \'%s\'.'
+    INVALID_FILE_LENGTH = 'createFileFromText requires the size of text to be less than 4MB. Please use createFileFromLocalFile or createFileFromStream to upload large files.'
+    INVALID_FILE_RANGE_FOR_UPDATE = 'Range size should be less than 4MB for a file range update operation.'
+    INVALID_HEADERS = 'Headers are not supported in the 2012-02-12 version.'
+    INVALID_MESSAGE_ID = 'Message ID cannot be null or undefined for deleteMessage and updateMessage operations.'
+    INVALID_PAGE_BLOB_LENGTH = 'Page blob length must be multiple of 512.'
+    INVALID_PAGE_END_OFFSET = 'Page end offset must be multiple of 512.'
+    INVALID_PAGE_RANGE_FOR_UPDATE = 'Page range size should be less than 4MB for a page update operation.'
+    INVALID_PAGE_START_OFFSET = 'Page start offset must be multiple of 512.'
+    INVALID_POP_RECEIPT = 'Pop Receipt cannot be null or undefined for deleteMessage and updateMessage operations.'
+    INVALID_PROPERTY_RESOLVER = 'The specified property resolver returned an invalid type. %s:{_:%s,$:%s }'
+    INVALID_RANGE_FOR_MD5 = 'The requested range should be less than 4MB when contentMD5 is expected from the server'
+    INVALID_SAS_VERSION = 'SAS Version ? is invalid. Valid versions include: ?.'
+    INVALID_SAS_TOKEN = 'The SAS token should not contain api-version.'
+    INVALID_SIGNED_IDENTIFIERS = 'Signed identifiers need to be an array.'
+    INVALID_STREAM_LENGTH = 'The length of the provided stream is invalid.'
+    INVALID_STRING_ERROR = 'Invalid string error.'
+    INVALID_TABLE_OPERATION = 'Operation not found: %s'
+    INVALID_TEXT_LENGTH = 'The length of the provided text is invalid.'
+    MAXIMUM_EXECUTION_TIMEOUT_EXCEPTION = 'The client could not finish the operation within specified maximum execution timeout.'
+    MD5_NOT_PRESENT_ERROR = 'MD5 does not exist. If you do not want to force validation, please disable useTransactionalMD5.'
+    METADATA_KEY_INVALID = 'The key for one of the metadata key-value pairs is null, empty, or whitespace.'
+    METADATA_VALUE_INVALID = 'The value for one of the metadata key-value pairs is null, empty, or whitespace.'
+    NO_CREDENTIALS_PROVIDED = 'Credentials must be provided when creating a service client.'
+    PRIMARY_ONLY_COMMAND = 'This operation can only be executed against the primary storage location.'
+    QUERY_OPERATOR_REQUIRES_WHERE = '%s operator needs to be used after where.'
+    SECONDARY_ONLY_COMMAND = 'This operation can only be executed against the secondary storage location.'
+    STORAGE_HOST_LOCATION_REQUIRED = 'The host for the storage service must be specified.'
+    STORAGE_HOST_MISSING_LOCATION = 'The host for the target storage location is not specified. Please consider changing the request\'s location mode.'
+    TYPE_NOT_SUPPORTED = 'Type not supported when sending data to the service: '
+    MAX_BLOB_SIZE_CONDITION_NOT_MEET = 'The max blob size condition specified was not met.'
+  end
+end