azure 0.0.0 → 0.1.0

data/lib/azure/blobs/uri.rb

@@ -0,0 +1,60 @@
+require "azure/configuration"
+require "uri"
+
+module Azure
+  module Blobs
+    module URI
+      # Public: Generate the URI for the collection of containers.
+      #
+      # query - A Hash of key => value query parameters.
+      # host  - The host of the API.
+      #
+      # Returns a URI.
+      def self.containers(query={}, host=Azure.config.blob_host)
+        query = { "comp" => "list" }.merge(query)
+        uri = join(host, "/")
+        uri.query = ::URI.encode_www_form(query)
+        uri
+      end
+
+      # Public: Generate the URI for a specific container.
+      #
+      # name  - The container name. If this is a URI, we just return this.
+      # query - A Hash of key => value query parameters.
+      # host  - The host of the API.
+      #
+      # Returns a URI.
+      def self.container(name, query={}, host=Azure.config.blob_host)
+        return name if name.kind_of? ::URI
+        query = { "restype" => "container" }.merge(query)
+        uri = join(host, name)
+        uri.query = ::URI.encode_www_form(query)
+        uri
+      end
+
+      # Public: Generate the URI for a specific Blob.
+      #
+      # container_name - String representing the name of the container.
+      # blob_name      - String representing the name of the blob.
+      # query          - A Hash of key => value query parameters.
+      # host           - The host of the API.
+      #
+      # Returns a URI.
+      def self.blob(container_name, blob_name, query={}, host=Azure.config.blob_host)
+        uri = join(host, File.join(container_name, blob_name))
+        uri.query = ::URI.encode_www_form(query)
+        uri
+      end
+
+      # Utility method to generate the URI.
+      #
+      # host - A String with the URI's host.
+      # path - A String with the URI's path.
+      #
+      # Returns a URI.
+      def self.join(host, path)
+        ::URI.parse(File.join(host, path))
+      end
+    end
+  end
+end

data/lib/azure/configuration.rb

@@ -0,0 +1,121 @@
+require "singleton"
+
+module Azure
+  # Public: Sugar to configure the services in a neatly wrapped DSL.
+  #
+  # Yields the Azure::Configuration instance.
+  #
+  # Example:
+  #
+  #   Azure.configure do |config|
+  #     config.account_name = ENV["AZURE_ACCOUNT_NAME"]
+  #   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 :access_key
+
+    # Public: Get/Set the Account Name for this service.
+    attr_accessor :account_name
+
+    # # Public: Get/Set the Access Control Namespace for this service.
+    # attr_accessor :acs_namespace
+
+    # Public: Get/Set the Service Bus Access Key (Issuer Secret) for this service.
+    attr_accessor :sb_access_key
+
+    # Public: Get/Set the Service Bus Issuer for this service.
+    attr_accessor :sb_issuer
+
+    # Public: Get/Set the ACS namespace for this service.
+    attr_accessor :acs_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.table_host = "http://127.0.0.1:10002/devstoreaccount1"
+    attr_writer :table_host
+
+    # Public: Get the host for this service. If you set something using #host=,
+    # then we use that. Else we default to Windows Azure's default hosts, based
+    # on your account name.
+    def table_host
+      @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.blob_host = "http://127.0.0.1:10000/devstoreaccount1"
+    attr_writer :blob_host
+
+    # Public: Get the host for this service. If you set something using #host=,
+    # then we use that. Else we default to Windows Azure's default hosts, based
+    # on your account name.
+    def blob_host
+      @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.queue_host = "http://127.0.0.1:10001/devstoreaccount1"
+    attr_writer :queue_host
+
+    # Public: Get the host for this service. If you set something using #host=,
+    # then we use that. Else we default to Windows Azure's default hosts, based
+    # on your account name.
+    def queue_host
+      @queue_host || default_host(:queue)
+    end
+
+    # Public: Get the host for the ACS service.
+    def acs_host
+      "https://#{acs_namespace}-sb.accesscontrol.windows.net"
+    end
+
+    # Public: Get the host for the Service Bus service.
+    def service_bus_host
+      "https://#{acs_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://#{account_name}.#{service}.core.windows.net"
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+require "cgi"
+require "azure/configuration"
+require "azure/core/signer"
+
+module Azure
+  module Core
+    module Auth
+      class SharedKey < Signer
+        # The Azure account's name.
+        attr :account_name
+
+        # Public: Initialize the Signer.
+        #
+        # account_name - The Azure account name. Defaults to the one in the
+        #                global configuration.
+        # access_key   - The Azure access_key encoded in Base64. Defaults to the
+        #                one in the global configuration.
+        def initialize(account_name=Azure.config.account_name, access_key=Azure.config.access_key)
+          @account_name = account_name
+          super(access_key)
+        end
+
+        # Public: The name of the strategy.
+        #
+        # Returns a String.
+        def name
+          "SharedKey"
+        end
+
+        # Public: Generate a request signature.
+        #
+        # verb       - The HTTP request method.
+        # uri        - The URI of the request we're signing.
+        # headers    - A Hash of HTTP request headers.
+        #
+        # Returns a Base64 String signed with HMAC.
+        def sign(method, uri, headers)
+          super(signable_string(method, uri, headers))
+        end
+
+        # Generate the string to sign.
+        #
+        # verb       - The HTTP request method.
+        # uri        - The URI of the request we're signing.
+        # headers    - A Hash of HTTP request headers.
+        #
+        # Returns a plain text 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.
+        #
+        # headers - A Hash of HTTP request headers.
+        #
+        # Returns a string with the canonicalized headers.
+        def canonicalized_headers(headers)
+          headers = headers.map { |k,v| [k.to_s.downcase, v] }
+          headers.select! { |k,v| k =~ /^x-ms-/ }
+          headers.sort_by! { |(k,v)| k }
+          headers.map! { |k,v| "%s:%s" % [k, v] }
+          headers.map! { |h| h.gsub(/\s+/, " ") }.join("\n")
+        end
+
+        # Calculate the Canonicalized Resource string for a request.
+        #
+        # uri - The request's URI.
+        #
+        # Returns 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,v| 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,34 @@
+require "azure/core/auth/shared_key"
+
+module Azure
+  module Core
+    module Auth
+      class SharedKeyLite < SharedKey
+        # Public: The name of the strategy.
+        #
+        # Returns a String.
+        def name
+          "SharedKeyLite"
+        end
+
+        # Generate the string to sign.
+        #
+        # verb       - The HTTP request method.
+        # uri        - The URI of the request we're signing.
+        # headers    - 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 KeyError, "Headers must include Date" },
+            canonicalized_headers(uri).join("\n"),
+            canonicalized_resource(uri).join("\n")
+          ].join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/azure/core/collection.rb

@@ -0,0 +1,118 @@
+require "delegate"
+
+module Azure
+  module Core
+    # A collection serves two functions: it is an array of models, and at the
+    # same time serves as a proxy to certain services for the models in the
+    # array.
+    #
+    # A Collection belongs to a "parent" object; for example, a collection
+    # of mesages belongs to a queue.
+    #
+    # Examples
+    #
+    #   # Get the collection
+    #   queue.messages
+    #
+    #   # Create a new message
+    #   queue.messages.create("message text")
+    #
+    #   # Fetch a single message
+    #   message = queue.messages["some-message-id"]
+    #
+    #   # Work with the messages
+    #   queue.messages.each { |msg| ... }
+    class Collection < DelegateClass(Array)
+      include Azure::ErrorHandler
+
+      # Public: Initialize the collection.
+      #
+      # parent      - The object that owns this collection.
+      # as          - The name of the relationship between the collection's
+      #               items and the parent.
+      # model_class - The class of the model this collection represents.
+      # service     - The service that implements remote calls.
+      def initialize(parent, as, model_class, service)
+        @parent = parent
+        @as = as
+        @model_class = model_class
+        @service = service
+      end
+
+      # Public: Load the underlying collection from the server.
+      #
+      # Returns self.
+      def load!
+        collection = @service.all(@parent)
+        collection.each { |el| set_parent(el) }
+        __setobj__(collection)
+        self
+      end
+
+      # Public: Create a new model in this collection.
+      #
+      # *args - Any arguments that the model's constructor takes.
+      #
+      # Yields the model before being created for modification.
+      #
+      # Returns an instance of the model.
+      def create(*args, &block)
+        model = @model_class.new(*args, &block)
+        set_parent(model)
+        @service.create(model)
+      end
+
+      # Public: Fetch a model by its identifier(s).
+      #
+      # *ids - The identifier(s) of the model.
+      #
+      # Returns an instance of the model when it's a valid identifier.
+      # Returns nil when no model matches the identifier.
+      def [](*ids)
+        fetch(*ids) { nil }
+      end
+
+      # Public: Find a model by its identifier(s). If no model matches the
+      # provided identifier(s), execute the given block, or raise ArgumentError.
+      #
+      # *ids - The identifier(s) of the model.
+      #
+      # Yields the error returned by the server in case the model wasn't found.
+      #
+      # Returns an instance of the model.
+      # Raises ArgumentError if the model isn't found and no block is given.
+      def fetch(*ids, &block)
+        block ||= -> { raise ArgumentError, "can't find #{@model_class} identified by #{id.inspect}" }
+        model = @service.fetch(@parent, *ids)
+        model.valid? ? model : block.call(model.error)
+      end
+
+      # Internal: Get the underlying collection to which we delegate. If the
+      # collection wasn't already loaded, it loads it from the server.
+      #
+      # Returns an Array.
+      def __getobj__
+        load! unless defined?(@__delegated_list)
+        @__delegated_list
+      end
+
+      # Internal: Change the underlying collection to which we delegate.
+      #
+      # collection - An Array.
+      #
+      # Returns the collection.
+      def __setobj__(collection)
+        @__delegated_list = collection
+      end
+
+      # Internal: Change the parent object of the given model.
+      #
+      # object - A model in this collection.
+      #
+      # Returns the parent.
+      def set_parent(object)
+        object.send("#{@as}=", @parent)
+      end
+    end
+  end
+end

data/lib/azure/core/service.rb

@@ -0,0 +1,43 @@
+require "azure/request"
+require "azure/auth"
+
+module Azure
+  module Core
+    class Service
+      # Initialize the service.
+      #
+      # signer - The strategy to use to sign requests.
+      # auth   - Authorizer object. Defaults to Azure::Auth.new
+      def initialize(signer, auth=Azure::Auth.new)
+        @signer = signer
+        @auth = auth
+      end
+
+      # Sign a request to include the necessary authorization header.
+      #
+      # request - An Azure::Request.
+      # signer  - A signer strategy (defaults to Azure::Tables::Auth::SharedKey)
+      #
+      # Returns the signed request.
+      def sign_request(request)
+        @auth.sign(request, @signer)
+      end
+
+      # Invoke the service.
+      #
+      # method - The HTTP method.
+      # uri    - The URI path for this service call.
+      # body   - The request body, if any (defaults to nil).
+      #
+      # Yields the request before signing it.
+      #
+      # Returns the Response object.
+      def call(method, uri, body=nil, request_factory=Request)
+        request = request_factory.new(method, uri, body)
+        yield request if block_given?
+        sign_request(request)
+        request.request!
+      end
+    end
+  end
+end