azure 0.1.1 → 0.5.0

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

@@ -1,3 +1,17 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft. 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
@@ -23,9 +37,9 @@ module Azure
             method.to_s.upcase,
             headers.fetch("Content-MD5", ""),
             headers.fetch("Content-Type", ""),
-            headers.fetch("Date") { raise KeyError, "Headers must include Date" },
-            canonicalized_headers(uri).join("\n"),
-            canonicalized_resource(uri).join("\n")
+            headers.fetch("Date") { raise IndexError, "Headers must include Date" },
+            canonicalized_headers(headers),
+            canonicalized_resource(uri)
           ].join("\n")
         end
       end

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

@@ -0,0 +1,48 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft. 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"
+require "azure/core/configuration"
+
+module Azure
+  module Core
+    module Auth
+      # Public: 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
+
+        # Public: Initialize the Signer.
+        #
+        # access_key - The access_key encoded in Base64. Defaults to the one
+        #              in the global configuration.
+        def initialize(access_key=Azure.config.storage_access_key)
+          @access_key = Base64.strict_decode64(access_key)
+        end
+
+        # Public: Generate an HMAC signature.
+        #
+        # body - The string to sign.
+        #
+        # Returns 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/configuration.rb

@@ -0,0 +1,152 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft. 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 "singleton"
+
+module Azure
+
+  # Proxy config method.
+  def self.config
+    Core.config
+  end
+
+  # Proxy configure method.
+  def self.configure
+    yield Core.config
+  end
+
+  module Core
+
+    # Public: Sugar to configure the services in a neatly wrapped DSL.
+    #
+    # Yields the Azure::Configuration instance.
+    #
+    # Example:
+    #
+    #   Azure.configure do |config|
+    #     config.storage_account_name = ENV["AZURE_STORAGE_ACCOUNT"]
+    #   end
+    #
+    # Returns nothing.
+    def self.configure
+      yield config
+    end
+
+    # Public: Access the service configuration.
+    #
+    # Returns the Azure::Configuration instance.
+    def self.config
+      Configuration.instance
+    end
+
+    # Singleton that keeps the configuration of the system.
+    class Configuration
+      include Singleton
+
+      # Public: Get/Set the Access Key for this service.
+      attr_accessor :storage_access_key
+
+      # Public: Get/Set the Account Name for this service.
+      attr_accessor :storage_account_name
+
+      # Public: Get/Set the Service Bus Access Key (Issuer Secret) for this service.
+      attr_accessor :sb_access_key
+
+      # Public: Set the Service Bus Issuer for this service.
+      attr_writer :sb_issuer
+
+      # Public: Get the issuer for the service bus. If you set something using #sb_issuer=,
+      # then we use that. Otherwise, we default to the default issuer: "owner"
+      def sb_issuer
+        @sb_issuer || "owner"
+      end
+
+      # Public: Get/Set the Service Bus Namespace for this service.
+      attr_accessor :sb_namespace
+
+      # Public: Set the host for the Table service. Only set this if you want
+      # something custom (like, for example, to point this to a LocalStorage
+      # emulator). This should be the complete host, including http:// at the
+      # start. When using the emulator, make sure to include your account name at
+      # the end.
+      #
+      # Example:
+      #
+      #   config.storage_table_host = "http://127.0.0.1:10002/devstoreaccount1"
+      attr_writer :storage_table_host
+
+      # Public: Get the host for this service. If you set something using #storage_table_host=,
+      # then we use that. Else we default to Azure's default hosts, based
+      # on your account name.
+      def storage_table_host
+        @storage_table_host || default_host(:table)
+      end
+
+      # Public: Set the host for the Blob service. Only set this if you want
+      # something custom (like, for example, to point this to a LocalStorage
+      # emulator). This should be the complete host, including http:// at the
+      # start. When using the emulator, make sure to include your account name at
+      # the end.
+      #
+      # Example:
+      #
+      #   config.storage_blob_host = "http://127.0.0.1:10000/devstoreaccount1"
+      attr_writer :storage_blob_host
+
+      # Public: Get the host for this service. If you set something using #storage_blob_host=,
+      # then we use that. Else we default to Azure's default hosts, based
+      # on your account name.
+      def storage_blob_host
+        @storage_blob_host || default_host(:blob)
+      end
+
+      # Public: Set the host for the Queue service. Only set this if you want
+      # something custom (like, for example, to point this to a LocalStorage
+      # emulator). This should be the complete host, including http:// at the
+      # start. When using the emulator, make sure to include your account name at
+      # the end.
+      #
+      # Example:
+      #
+      #   config.storage_queue_host = "http://127.0.0.1:10001/devstoreaccount1"
+      attr_writer :storage_queue_host
+
+      # Public: Get the host for this service. If you set something using #storage_queue_host=,
+      # then we use that. Else we default to Azure's default hosts, based
+      # on your account name.
+      def storage_queue_host
+        @storage_queue_host || default_host(:queue)
+      end
+
+      # Public: Get the host for the ACS service.
+      def acs_host
+        "https://#{sb_namespace}-sb.accesscontrol.windows.net"
+      end
+
+      # Public: Get the host for the Service Bus service.
+      def service_bus_host
+        "https://#{sb_namespace}.servicebus.windows.net"
+      end
+
+      # Calculate the default host for a given service in the cloud.
+      #
+      # service - One of :table, :blob, :queue, etc.
+      #
+      # Returns a String with the hostname, including your account name.
+      def default_host(service)
+        "http://#{storage_account_name}.#{service}.core.windows.net"
+      end
+    end
+  end
+end

data/lib/azure/core/error.rb

@@ -0,0 +1,22 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft. 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
+    # Public: 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,44 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft. 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
+      # 
+      # host            - String. The hostname. (optional, Default empty)
+      def initialize(host='')
+        super(host)
+        @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/core/http/debug_filter.rb

@@ -0,0 +1,36 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft. 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,84 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft. 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"
+
+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/windowsazure/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.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"
+            @description = @http_response.body.strip
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft. 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