waz-storage 0.5.7 → 0.5.8

data/lib/waz/blobs/blob_object.rb

@@ -35,7 +35,7 @@ module WAZ
         end
       end
       
-      attr_accessor :name, :url, :content_type
+      attr_accessor :name, :url, :content_type, :snapshot_date
       
       # Creates a new instance of the Blob object. This constructor is internally used by the Container
       # it's initialized thru a hash that's received as parameter. It has the following requirements:
@@ -48,6 +48,7 @@ module WAZ
         self.name = options[:name]
         self.url = options[:url]
         self.content_type = options[:content_type]
+        self.snapshot_date = options[:snapshot_date]
       end
       
       # Returns the blob properties from Windows Azure. This properties always come as HTTP Headers and they include standard headers like
@@ -65,6 +66,7 @@ module WAZ
       # Assigns the given value to the blob content. It also stores a local copy of it in order to avoid round trips 
       # on scenarios when you do Save and Display on the same context.
       def value=(new_value)
+        raise WAZ::Blobs::InvalidOperation if self.snapshot_date
         self.class.service_instance.put_blob(path, new_value, content_type, metadata)
         @value = new_value
       end
@@ -72,6 +74,7 @@ module WAZ
       # Stores the blob properties. Those properties are sent as HTTP Headers it's really important that you name your custom 
       # properties with the <em>x-ms-meta</em> prefix, if not the won't be persisted by the Windows Azure Blob Storage API.
       def put_properties!(properties = {})
+        raise WAZ::Blobs::InvalidOperation if self.snapshot_date
         self.class.service_instance.set_blob_properties(path, properties)
       end
       
@@ -92,6 +95,16 @@ module WAZ
                               :content_type => properties[:content_type])
       end
       
+      # Creates and returns a read-only snapshot of a blob as it looked like in time.
+      def snapshot
+        date = self.class.service_instance.snapshot_blob(self.path)
+        properties = self.class.service_instance.get_blob_properties(self.path)
+        return BlobObject.new(:name => self.name, 
+                              :url => self.class.service_instance.generate_request_uri(self.path) + "?snapshot=#{date}",
+                              :content_type => properties[:content_type],
+                              :snapshot_date => date)
+      end
+      
       # Returns the blob path. This is specially important when simulating containers inside containers
       # by enabling the API to point to the appropiated resource.
       def path

data/lib/waz/blobs/container.rb

@@ -41,6 +41,7 @@ module WAZ
       class << self 
         # Creates a new container with the given name.
         def create(name)
+          raise WAZ::Storage::InvalidParameterValue, {:name => "name", :values => ["lower letters, numbers or - (hypen), and must not start or end with - (hyphen)"]} unless WAZ::Storage::ValidationRules.valid_name?(name)
           service_instance.create_container(name)
           return Container.new(:name => name)
         end

data/lib/waz/blobs/exceptions.rb

@@ -0,0 +1,11 @@
+module WAZ
+  module Blobs    
+    # This exception is raised when the user tries to perform an operation over a snapshoted blob. Since
+    # Snapshots are read-only copies of the original blob they cannot be modified
+    class InvalidOperation < WAZ::Storage::StorageException
+      def initialize()
+        super("A snapshoted blob cannot be modified.")
+      end
+    end
+  end
+end

data/lib/waz/blobs/service.rb

@@ -60,7 +60,7 @@ module WAZ
 
       # Lists all the blobs inside the given container.
       def list_blobs(container_name)
-        content = execute(:get, container_name, { :comp => 'list' })
+        content = execute(:get, container_name, { :comp => 'list'})
         doc = REXML::Document.new(content)
         containers = []
         REXML::XPath.each(doc, '//Blob/') do |item|
@@ -79,17 +79,18 @@ module WAZ
       #
       # metadata is a hash that stores all the properties that you want to add to the blob when creating it.
       def put_blob(path, payload, content_type = "application/octet-stream", metadata = {})
-        execute :put, path, nil, metadata.merge("Content-Type" => content_type), payload
+        default_headers = {"Content-Type" => content_type, :x_ms_version => "2009-09-19", :x_ms_blob_type => "BlockBlob"}
+        execute :put, path, nil, metadata.merge(default_headers), payload
       end
       
       # Retrieves a blob (content + headers) from the current path.
       def get_blob(path, options = {})
-        execute :get, path, options
+        execute :get, path, options, {:x_ms_version => "2009-09-19"}
       end
 
       # Deletes the blob existing on the current path.
       def delete_blob(path)
-        execute :delete, path
+        execute :delete, path, nil, {:x_ms_version => "2009-09-19"}
       end
             
       # Retrieves the properties associated with the blob at the given path.
@@ -104,7 +105,7 @@ module WAZ
       
       # Copies a blob within the same account (not necessarily to the same container)
       def copy_blob(source_path, dest_path)
-        execute :put, dest_path, nil, { :x_ms_version => "2009-04-14", :x_ms_copy_source => canonicalize_message(source_path) }
+        execute :put, dest_path, nil, { :x_ms_version => "2009-09-19", :x_ms_copy_source => canonicalize_message(source_path) }
       end
       
       # Adds a block to the block list of the given blob
@@ -114,7 +115,7 @@ module WAZ
       
       # Retrieves the list of blocks associated with a single blob. The list is filtered (or not) by type of blob
       def list_blocks(path, block_list_type = 'all')
-        raise WAZ::Storage::InvalidParameterValue , {:name => :bloclisttype, :values => ['all', 'uncommitted', 'committed']} unless (block_list_type or "") =~ /all|committed|uncommitted/i
+        raise WAZ::Storage::InvalidParameterValue , {:name => :blocklisttype, :values => ['all', 'uncommitted', 'committed']} unless (block_list_type or "") =~ /all|committed|uncommitted/i
         content = execute(:get, path, {:comp => 'blocklist'}.merge(:blocklisttype => block_list_type.downcase), { :x_ms_version => "2009-04-14" })
         doc = REXML::Document.new(content)
         blocks = []
@@ -125,6 +126,11 @@ module WAZ
         end
         return blocks
       end
+      
+      # Creates a read-only snapshot of a blob as it looked like in time.
+      def snapshot_blob(path)
+        execute(:put, path, { :comp => 'snapshot' }, {:x_ms_version => "2009-09-19"}).headers[:x_ms_snapshot]
+      end
     end
   end
 end

data/lib/waz/queues/queue.rb

@@ -7,15 +7,15 @@ module WAZ
     #	WAZ::Queues::Queue.list
     #
     #	# create a queue (here you can also send hashed metadata)
-    #	WAZ::Queues::Queue.create('my-container')
+    #	WAZ::Queues::Queue.create('test-queue')
     #
     #	# get a specific queue
-    #	queue = WAZ::Queues::Container.find('my-container')
+    #	queue = WAZ::Queues::Queue.find('test-queue')
     #
     #	# get queue properties (including default headers)
     #	queue.metadata #=> hash containing beautified metadata (:x_ms_meta_name)
     #
-    #	# set container properties (should follow x-ms-meta to be persisted)
+    #	# set queue properties (should follow x-ms-meta to be persisted)
     #	# if you specify the optional parameter overwrite, existing metadata 
     #	# will be deleted else merged with new one.
     #	queue.put_properties!(:x_ms_meta_MyProperty => "my value")
@@ -55,6 +55,7 @@ module WAZ
         # metadata to be stored on the queue. (Remember that metadata on the storage account must start with 
         # :x_ms_metadata_{yourCustomPropertyName}, if not it will not be persisted).
         def create(queue_name, metadata = {})
+          raise WAZ::Storage::InvalidParameterValue, {:name => "name", :values => ["lower letters, numbers or - (hypen), and must not start or end with - (hyphen)"]} unless WAZ::Storage::ValidationRules.valid_name?(queue_name)
           service_instance.create_queue(queue_name, metadata)
           WAZ::Queues::Queue.new(:name => queue_name, :url => service_instance.generate_request_uri(queue_name))
         end

data/lib/waz/storage/core_service.rb

@@ -3,13 +3,14 @@ module WAZ
     # This module is imported by the specific services that use Shared Key authentication profile. On the current implementation
     # this module is imported from WAZ::Queues::Service and WAZ::Blobs::Service.
     module SharedKeyCoreService
-      attr_accessor :account_name, :access_key, :use_ssl, :base_url
+      attr_accessor :account_name, :access_key, :use_ssl, :base_url, :type_of_service
       
       # Creates an instance of the implementor service (internally used by the API).
       def initialize(options = {})
         self.account_name = options[:account_name]
         self.access_key = options[:access_key]
         self.use_ssl = options[:use_ssl] or false
+        self.type_of_service = options[:type_of_service]
         self.base_url = "#{options[:type_of_service] or "blobs"}.#{options[:base_url] or "core.windows.net"}"
       end
       
@@ -19,11 +20,11 @@ module WAZ
       def generate_request(verb, url, headers = {}, payload = nil)
         http_headers = {}
         headers.each{ |k, v| http_headers[k.to_s.gsub(/_/, '-')] = v} unless headers.nil?
-        request = RestClient::Request.new(:method => verb.to_s.downcase.to_sym, :url => url, :headers => http_headers, :payload => payload)
-        request.headers["x-ms-Date"] = Time.new.httpdate
-        request.headers["Content-Length"] = (request.payload or "").length
-        request.headers["Authorization"] = "SharedKey #{account_name}:#{generate_signature(request)}"
-        return request
+        http_headers.merge!("x-ms-Date" => Time.new.httpdate)
+        http_headers.merge!("Content-Length" => (payload or "").length)
+        request = {:headers => http_headers, :method => verb.to_s.downcase.to_sym, :url => url, :payload => payload}
+        request[:headers].merge!("Authorization" => "SharedKey #{account_name}:#{generate_signature(request)}")
+        return RestClient::Request.new(request)
       end
       
       # Generates the request uri based on the resource path, the protocol, the account name and the parameters passed
@@ -55,42 +56,43 @@ module WAZ
       # Generates the signature based on Micosoft specs for the REST API. It includes some special headers, 
       # the canonicalized header line and the canonical form of the message, all of the joined by \n character. Encoded with 
       # Base64 and encrypted with SHA256 using the access_key as the seed.
-      def generate_signature(request)
-        return generate_signature20090919(request) if request.headers["x-ms-version"] == "2009-09-19"
-        signature = request.method.to_s.upcase + "\x0A" +
-                     (request.headers["Content-MD5"] or "") + "\x0A" +
-                     (request.headers["Content-Type"] or "") + "\x0A" +
-                     (request.headers["Date"] or "")+ "\x0A" +
-                     canonicalize_headers(request.headers) + "\x0A" +
-                     canonicalize_message(request.url)
+      def generate_signature(options = {})
+        return generate_signature20090919(options) if options[:headers]["x-ms-version"] == "2009-09-19"
+
+        signature = options[:method].to_s.upcase + "\x0A" +
+                     (options[:headers]["Content-MD5"] or "") + "\x0A" +
+                     (options[:headers]["Content-Type"] or "") + "\x0A" +
+                     (options[:headers]["Date"] or "")+ "\x0A"
+
+        signature += canonicalize_headers(options[:headers]) + "\x0A" unless self.type_of_service == 'table'
+        signature += canonicalize_message(options[:url])
                      
-        return Base64.encode64(HMAC::SHA256.new(Base64.decode64(self.access_key)).update(signature.toutf8).digest)
+        Base64.encode64(HMAC::SHA256.new(Base64.decode64(self.access_key)).update(signature.toutf8).digest)
       end
-      
-      
-      def generate_signature20090919(request)
-        signature = request.method.to_s.upcase + "\x0A" +
-                    (request.headers["Content-Encoding"] or "") + "\x0A" +
-                    (request.headers["Content-Language"] or "") + "\x0A" +
-                    (request.headers["Content-Length"] or "").to_s + "\x0A" +                    
-                    (request.headers["Content-MD5"] or "") + "\x0A" +
-                    (request.headers["Content-Type"] or "") + "\x0A" +
-                    (request.headers["Date"] or "")+ "\x0A" +
-                    (request.headers["If-Modified-Since"] or "")+ "\x0A" +
-                    (request.headers["If-Match"] or "")+ "\x0A" +
-                    (request.headers["If-None-Match"] or "")+ "\x0A" +                    
-                    (request.headers["If-Unmodified-Since"] or "")+ "\x0A" +
-                    (request.headers["Range"] or "")+ "\x0A" +                    
-                    canonicalize_headers(request.headers) + "\x0A" +
-                    canonicalize_message20090919(request.url)
-                            
-        return Base64.encode64(HMAC::SHA256.new(Base64.decode64(self.access_key)).update(signature.toutf8).digest)        
+
+      def generate_signature20090919(options = {})
+        signature = options[:method].to_s.upcase + "\x0A" +
+                    (options[:headers]["Content-Encoding"] or "") + "\x0A" +
+                    (options[:headers]["Content-Language"] or "") + "\x0A" +
+                    (options[:headers]["Content-Length"] or "").to_s + "\x0A" +                    
+                    (options[:headers]["Content-MD5"] or "") + "\x0A" +
+                    (options[:headers]["Content-Type"] or "") + "\x0A" +
+                    (options[:headers]["Date"] or "")+ "\x0A" +
+                    (options[:headers]["If-Modified-Since"] or "")+ "\x0A" +
+                    (options[:headers]["If-Match"] or "")+ "\x0A" +
+                    (options[:headers]["If-None-Match"] or "")+ "\x0A" +                    
+                    (options[:headers]["If-Unmodified-Since"] or "")+ "\x0A" +
+                    (options[:headers]["Range"] or "")+ "\x0A" +                    
+                    canonicalize_headers(options[:headers]) + "\x0A" +
+                    canonicalize_message20090919(options[:url])
+                    
+        Base64.encode64(HMAC::SHA256.new(Base64.decode64(self.access_key)).update(signature.toutf8).digest)        
       end
       
       def canonicalize_message20090919(url)
         uri_component = url.gsub(/https?:\/\/[^\/]+\//i, '').gsub(/\?.*/i, '')
         query_component = (url.scan(/\?(.*)/i).first() or []).first()
-        query_component = query_component.downcase.split('&').sort{|a, b| a <=> b}.map{ |p| p.split('=').join(':') }.join("\n") if query_component
+        query_component = query_component.split('&').sort{|a, b| a <=> b}.map{ |p| p.split('=').join(':') }.join("\n") if query_component
         canonicalized_message = "/#{self.account_name}/#{uri_component}"
         canonicalized_message << "\n#{query_component}" if query_component
         return canonicalized_message

data/lib/waz/storage/validation_rules.rb

@@ -0,0 +1,17 @@
+module WAZ
+  module Storage
+    class ValidationRules
+      class << self
+        # Validates that the Container/Queue name given matches with the requirements of Windows Azure. 
+        #
+        # -Container/Queue names must start with a letter or number, and can contain only letters, numbers, and the dash (-) character.
+        # -Every dash (-) character must be immediately preceded and followed by a letter or number.
+        # -All letters in a container name must be lowercase.
+        # -Container/Queue names must be from 3 through 63 characters long.
+        def valid_name?(name)
+          name =~ /^[a-z0-9][a-z0-9\-]{1,}[^-]$/ && name.length < 64
+        end
+      end
+    end
+  end
+end

data/lib/waz/storage/version.rb

@@ -3,7 +3,7 @@ module WAZ
     module VERSION #:nodoc:
       MAJOR    = '0'
       MINOR    = '5'
-      TINY     = '7' 
+      TINY     = '8' 
     end
     
     Version = [VERSION::MAJOR, VERSION::MINOR, VERSION::TINY].compact * '.'

data/lib/waz-blobs.rb

@@ -10,6 +10,7 @@ $:.unshift(File.dirname(__FILE__))
 require 'waz-storage'
 require 'waz/blobs/blob_object'
 require 'waz/blobs/container'
+require 'waz/blobs/exceptions'
 require 'waz/blobs/service'
 
 

data/lib/waz-storage.rb

@@ -3,6 +3,7 @@ require 'waz/storage/base'
 require 'waz/storage/core_service'
 require 'waz/storage/exceptions'
 require 'waz/storage/version'
+require 'waz/storage/validation_rules'
 
 # It will depende on which version of Ruby (or if you have Rails) 
 # but this method is required so we will add it the String class.

data/rakefile

@@ -31,7 +31,7 @@ namespace :dist do
     s.rdoc_options      << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
     
     # Dependencies
-    s.add_runtime_dependency 'rest-client', '>= 1.0.3'
+    s.add_dependency 'rest-client'
     s.add_dependency 'ruby-hmac'
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: waz-storage
 version: !ruby/object:Gem::Version 
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors: 
 - Johnny G. Halife
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-08 00:00:00 -03:00
+date: 2010-02-03 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.3
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: ruby-hmac
@@ -44,6 +44,7 @@ files:
 - rakefile
 - lib/waz/blobs/blob_object.rb
 - lib/waz/blobs/container.rb
+- lib/waz/blobs/exceptions.rb
 - lib/waz/blobs/service.rb
 - lib/waz/queues/exceptions.rb
 - lib/waz/queues/message.rb
@@ -52,6 +53,7 @@ files:
 - lib/waz/storage/base.rb
 - lib/waz/storage/core_service.rb
 - lib/waz/storage/exceptions.rb
+- lib/waz/storage/validation_rules.rb
 - lib/waz/storage/version.rb
 - lib/waz-blobs.rb
 - lib/waz-queues.rb