azure-storage 0.11.0.preview → 0.11.1.preview

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

@@ -294,7 +294,7 @@ module Azure::Storage
         end
 
         def expect_node(node_name, xml)
-          raise "Xml is not a #{node_name} node." unless xml.name == node_name
+          raise "Xml is not a #{node_name} node. xml:\n#{xml}" unless xml.name == node_name
         end
       end
 

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

@@ -48,8 +48,8 @@ module Azure::Storage
         super(signer, account_name, options)
       end
 
-      def call(method, uri, body=nil, headers={})
-        super(method, uri, body, StorageService.service_properties_headers.merge(headers))
+      def call(method, uri, body=nil, headers={}, options={})
+        super(method, uri, body, StorageService.common_headers(options).merge(headers))
       end
 
       # Public: Get Storage Service properties
@@ -57,10 +57,15 @@ module Azure::Storage
       # See http://msdn.microsoft.com/en-us/library/azure/hh452239
       # See http://msdn.microsoft.com/en-us/library/azure/hh452243
       #
+      # ==== Options
+      #
+      # * +:request_id+                - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                  in the analytics logs when storage analytics logging is enabled.
+      #
       # Returns a Hash with the service properties or nil if the operation failed
-      def get_service_properties
+      def get_service_properties(options={})
         uri = service_properties_uri
-        response = call(:get, uri)
+        response = call(:get, uri, nil, {}, options)
         Serialization.service_properties_from_xml response.body
       end
 
@@ -71,11 +76,16 @@ module Azure::Storage
       # See http://msdn.microsoft.com/en-us/library/azure/hh452235
       # See http://msdn.microsoft.com/en-us/library/azure/hh452232
       #
+      # ==== Options
+      #
+      # * +:request_id+                - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                  in the analytics logs when storage analytics logging is enabled.
+      #
       # Returns boolean indicating success.
-      def set_service_properties(service_properties)
+      def set_service_properties(service_properties, options={})
         body = Serialization.service_properties_to_xml service_properties
         uri = service_properties_uri
-        call(:put, uri, body)
+        call(:put, uri, body, {}, options)
         nil
       end
 
@@ -144,11 +154,13 @@ module Azure::Storage
         alias with_query with_value
         
         # Declares a default hash object for request headers
-        def service_properties_headers
-          {
+        def common_headers(options = {})
+          headers = {
             'x-ms-version' => Azure::Storage::Default::STG_VERSION,
             'User-Agent' => Azure::Storage::Default::USER_AGENT
           }
+          headers.merge!({'x-ms-client-request-id' => options[:request_id]}) if options[:request_id]
+          headers
         end
       end
 

data/lib/azure/storage/table/table_service.rb

@@ -42,14 +42,16 @@ module Azure::Storage
       #
       # ==== Attributes
       #
-      # * +table_name+ - String. The table name
-      # * +options+    - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
       #
-      # * +:timeout+   - Integer. A timeout in seconds.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See http://msdn.microsoft.com/en-us/library/azure/dd135729
       #
@@ -59,7 +61,7 @@ module Azure::Storage
         query['timeout'] = options[:timeout].to_s if options[:timeout]
 
         body = Table::Serialization.hash_to_entry_xml({"TableName" => table_name}).to_xml
-        call(:post, collection_uri(query), body)
+        call(:post, collection_uri(query), body, {}, options)
         nil
       end
 
@@ -67,13 +69,15 @@ module Azure::Storage
       #
       # ==== Attributes
       #
-      # * +table_name+ - String. The table name
-      # * +options+    - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:timeout+   - Integer. A timeout in seconds.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See http://msdn.microsoft.com/en-us/library/azure/dd179387
       #
@@ -82,7 +86,7 @@ module Azure::Storage
         query = { }
         query["timeout"] = options[:timeout].to_s if options[:timeout]
 
-        call(:delete, table_uri(table_name, query))
+        call(:delete, table_uri(table_name, query), nil, {}, options)
         nil
       end
 
@@ -90,36 +94,42 @@ module Azure::Storage
       #
       # ==== Attributes
       #
-      # * +table_name+ - String. The table name
-      # * +options+    - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:timeout+   - Integer. A timeout in seconds.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # Returns the last updated time for the table
       def get_table(table_name, options={})
         query = { }
         query["timeout"] = options[:timeout].to_s if options[:timeout]
 
-        response = call(:get, table_uri(table_name, query))
+        response = call(:get, table_uri(table_name, query), nil, {}, options)
         results = Table::Serialization.hash_from_entry_xml(response.body)
         results[:updated]
+      rescue => e
+        raise_with_response(e, response)
       end
 
       # Public: Gets a list of all tables on the account.
       #
       # ==== Attributes
       #
-      # * +options+    - Hash. Optional parameters. 
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:next_table_token+   - String. A token used to enumerate the next page of results, when the list of tables is
-      #   larger than a single operation can return at once. (optional)
-      # * +:timeout+            - Integer. A timeout in seconds.
+      # * +:next_table_token+        - String. A token used to enumerate the next page of results, when the list of tables is
+      #                                larger than a single operation can return at once. (optional)
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See http://msdn.microsoft.com/en-us/library/azure/dd179405
       #
@@ -130,25 +140,29 @@ module Azure::Storage
         query["timeout"] = options[:timeout].to_s if options[:timeout]
         uri = collection_uri(query)
 
-        response = call(:get, uri)
+        response = call(:get, uri, nil, {}, options)
         entries = Table::Serialization.entries_from_feed_xml(response.body) || []
 
         values = Azure::Service::EnumerationResults.new(entries)
         values.continuation_token = response.headers["x-ms-continuation-NextTableName"]
         values
+      rescue => e
+        raise_with_response(e, response)
       end
 
       # Public: Gets the access control list (ACL) for the table.
       #
       # ==== Attributes
       #
-      # * +table_name+ - String. The table name
-      # * +options+    - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:timeout+   - Integer. A timeout in seconds.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See http://msdn.microsoft.com/en-us/library/azure/jj159100
       #
@@ -157,25 +171,29 @@ module Azure::Storage
         query = { 'comp' => 'acl'}
         query['timeout'] = options[:timeout].to_s if options[:timeout]
 
-        response = call(:get, generate_uri(table_name, query), nil, {'x-ms-version' => '2012-02-12'})
+        response = call(:get, generate_uri(table_name, query), nil, {'x-ms-version' => '2012-02-12'}, options)
 
         signed_identifiers = []
         signed_identifiers = Table::Serialization.signed_identifiers_from_xml response.body unless response.body == nil or response.body.length < 1
         signed_identifiers
+      rescue => e
+        raise_with_response(e, response)
       end
 
       # Public: Sets the access control list (ACL) for the table.
       #
       # ==== Attributes
       #
-      # * +table_name+ - String. The table name
-      # * +options+    - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:signed_identifiers+  - Array. A list of Azure::Storage::Entity::SignedIdentifier instances
-      # * +:timeout+             - Integer. A timeout in seconds.
+      # * +:signed_identifiers+      - Array. A list of Azure::Storage::Entity::SignedIdentifier instances
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       # 
       # See http://msdn.microsoft.com/en-us/library/azure/jj159102
       #
@@ -188,7 +206,7 @@ module Azure::Storage
         body = nil
         body = Table::Serialization.signed_identifiers_to_xml options[:signed_identifiers] if options[:signed_identifiers] && options[:signed_identifiers].length > 0
 
-        call(:put, uri, body, {'x-ms-version' => '2012-02-12'})
+        call(:put, uri, body, {'x-ms-version' => '2012-02-12'}, options)
         nil
       end
 
@@ -197,14 +215,16 @@ module Azure::Storage
       #
       # ==== Attributes
       #
-      # * +table_name+    - String. The table name
-      # * +entity_values+ - Hash. A hash of the name/value pairs for the entity. 
-      # * +options+       - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +entity_values+            - Hash. A hash of the name/value pairs for the entity. 
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:timeout+      - Integer. A timeout in seconds.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See http://msdn.microsoft.com/en-us/library/azure/dd179433
       #
@@ -215,7 +235,7 @@ module Azure::Storage
         query = { }
         query['timeout'] = options[:timeout].to_s if options[:timeout]
 
-        response = call(:post, entities_uri(table_name, nil, nil, query), body)
+        response = call(:post, entities_uri(table_name, nil, nil, query), body, {}, options)
         
         result = Table::Serialization.hash_from_entry_xml(response.body)
 
@@ -225,25 +245,29 @@ module Azure::Storage
           entity.etag = response.headers['etag'] || result[:etag]
           entity.properties = result[:properties]
         end
+      rescue => e
+        raise_with_response(e, response)
       end
 
       # Public: Queries entities for the given table name
       #
       # ==== Attributes
       #
-      # * +table_name+    - String. The table name
-      # * +options+       - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:partition_key+      - String. The partition key (optional)
-      # * +:row_key+            - String. The row key (optional)
-      # * +:select+             - Array. An array of property names to return (optional)
-      # * +:filter+             - String. A filter expression (optional)
-      # * +:top+                - Integer. A limit for the number of results returned (optional)
-      # * +:continuation_token+ - Hash. The continuation token.
-      # * +:timeout+            - Integer. A timeout in seconds.
+      # * +:partition_key+           - String. The partition key (optional)
+      # * +:row_key+                 - String. The row key (optional)
+      # * +:select+                  - Array. An array of property names to return (optional)
+      # * +:filter+                  - String. A filter expression (optional)
+      # * +:top+                     - Integer. A limit for the number of results returned (optional)
+      # * +:continuation_token+      - Hash. The continuation token.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See http://msdn.microsoft.com/en-us/library/azure/dd179421
       #
@@ -258,7 +282,7 @@ module Azure::Storage
         query["timeout"] = options[:timeout].to_s if options[:timeout]
 
         uri = entities_uri(table_name, options[:partition_key], options[:row_key], query)
-        response = call(:get, uri, nil, { "DataServiceVersion" => "2.0;NetFx"})
+        response = call(:get, uri, nil, {"DataServiceVersion" => "2.0;NetFx"}, options)
 
         entities = Azure::Service::EnumerationResults.new
 
@@ -281,6 +305,8 @@ module Azure::Storage
           } if response.headers["x-ms-continuation-NextPartitionKey"]
 
         entities
+      rescue => e
+        raise_with_response(e, response)
       end
 
       # Public: Updates an existing entity in a table. The Update Entity operation replaces 
@@ -288,17 +314,19 @@ module Azure::Storage
       #
       # ==== Attributes
       #
-      # * +table_name+    - String. The table name
-      # * +entity_values+ - Hash. A hash of the name/value pairs for the entity.
-      # * +options+       - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +entity_values+            - Hash. A hash of the name/value pairs for the entity.
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:if_match+              - String. A matching condition which is required for update (optional, Default="*")
-      # * +:create_if_not_exists+  - Boolean. If true, and partition_key and row_key do not reference and existing entity, 
-      #   that entity will be inserted. If false, the operation will fail. (optional, Default=false)
-      # * +:timeout+               - Integer. A timeout in seconds.
+      # * +:if_match+                - String. A matching condition which is required for update (optional, Default="*")
+      # * +:create_if_not_exists+    - Boolean. If true, and partition_key and row_key do not reference and existing entity, 
+      #                                that entity will be inserted. If false, the operation will fail. (optional, Default=false)
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See http://msdn.microsoft.com/en-us/library/azure/dd179427
       #
@@ -319,8 +347,10 @@ module Azure::Storage
 
         body = Table::Serialization.hash_to_entry_xml(entity_values).to_xml
 
-        response = call(:put, uri, body, headers)
+        response = call(:put, uri, body, headers, options)
         response.headers["etag"]
+      rescue => e
+        raise_with_response(e, response)
       end
 
       # Public: Updates an existing entity by updating the entity's properties. This operation
@@ -328,17 +358,19 @@ module Azure::Storage
       #
       # ==== Attributes
       #
-      # * +table_name+    - String. The table name
-      # * +entity_values+ - Hash. A hash of the name/value pairs for the entity.
-      # * +options+       - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +entity_values+            - Hash. A hash of the name/value pairs for the entity.
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:if_match+              - String. A matching condition which is required for update (optional, Default="*")
-      # * +:create_if_not_exists+  - Boolean. If true, and partition_key and row_key do not reference and existing entity, 
-      #   that entity will be inserted. If false, the operation will fail. (optional, Default=false)
-      # * +:timeout+               - Integer. A timeout in seconds.
+      # * +:if_match+                - String. A matching condition which is required for update (optional, Default="*")
+      # * +:create_if_not_exists+    - Boolean. If true, and partition_key and row_key do not reference and existing entity, 
+      #                                that entity will be inserted. If false, the operation will fail. (optional, Default=false)
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       # 
       # See http://msdn.microsoft.com/en-us/library/azure/dd179392
       # 
@@ -359,22 +391,26 @@ module Azure::Storage
 
         body = Table::Serialization.hash_to_entry_xml(entity_values).to_xml
 
-        response = call(:post, uri, body, headers)
+        response = call(:post, uri, body, headers, options)
         response.headers["etag"]
+      rescue => e
+        raise_with_response(e, response)
       end
 
       # Public: Inserts or updates an existing entity within a table by merging new property values into the entity.
       #
       # ==== Attributes
       #
-      # * +table_name+    - String. The table name
-      # * +entity_values+ - Hash. A hash of the name/value pairs for the entity.
-      # * +options+       - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +entity_values+            - Hash. A hash of the name/value pairs for the entity.
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:timeout+      - Integer. A timeout in seconds.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       # 
       # See http://msdn.microsoft.com/en-us/library/azure/hh452241
       # 
@@ -388,14 +424,16 @@ module Azure::Storage
       #
       # ==== Attributes
       #
-      # * +table_name+    - String. The table name
-      # * +entity_values+ - Hash. A hash of the name/value pairs for the entity.
-      # * +options+       - Hash. Optional parameters. 
+      # * +table_name+               - String. The table name
+      # * +entity_values+            - Hash. A hash of the name/value pairs for the entity.
+      # * +options+                  - Hash. Optional parameters. 
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:timeout+      - Integer. A timeout in seconds.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       # 
       # See http://msdn.microsoft.com/en-us/library/azure/hh452242
       #
@@ -409,16 +447,18 @@ module Azure::Storage
       #
       # ==== Attributes
       #
-      # * +table_name+    - String. The table name
-      # * +partition_key+ - String. The partition key
-      # * +row_key+       - String. The row key
-      # * +options+       - Hash. Optional parameters.
+      # * +table_name+               - String. The table name
+      # * +partition_key+            - String. The partition key
+      # * +row_key+                  - String. The row key
+      # * +options+                  - Hash. Optional parameters.
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:if_match+     - String. A matching condition which is required for update (optional, Default="*")
-      # * +:timeout+      - Integer. A timeout in seconds.
+      # * +:if_match+                - String. A matching condition which is required for update (optional, Default="*")
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See http://msdn.microsoft.com/en-us/library/azure/dd135727
       #
@@ -430,7 +470,7 @@ module Azure::Storage
         query = { }
         query["timeout"] = options[:timeout].to_s if options[:timeout]
 
-        call(:delete, entities_uri(table_name, partition_key, row_key, query), nil, { "If-Match"=> if_match })
+        call(:delete, entities_uri(table_name, partition_key, row_key, query), nil, { "If-Match"=> if_match }, options)
         nil
       end
 
@@ -438,13 +478,15 @@ module Azure::Storage
       #
       # ==== Attributes
       #
-      # * +batch+         - The Azure::Storage::Table::Batch instance to execute.
-      # * +options+       - Hash. Optional parameters.
+      # * +batch+                    - The Azure::Storage::Table::Batch instance to execute.
+      # * +options+                  - Hash. Optional parameters.
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:timeout+      - Integer. A timeout in seconds.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # See http://msdn.microsoft.com/en-us/library/azure/dd894038
       #
@@ -460,23 +502,27 @@ module Azure::Storage
         query["timeout"] = options[:timeout].to_s if options[:timeout]
 
         body = batch.to_body
-        response = call(:post, generate_uri('/$batch', query), body, headers)
+        response = call(:post, generate_uri('/$batch', query), body, headers, options)
         batch.parse_response(response)
+      rescue => e
+        raise_with_response(e, response)
       end
 
       # Public: Gets an existing entity in the table.
       #
       # ==== Attributes
       #
-      # * +table_name+    - String. The table name
-      # * +partition_key+ - String. The partition key
-      # * +row_key+       - String. The row key
-      # * +options+       - Hash. Optional parameters.
+      # * +table_name+               - String. The table name
+      # * +partition_key+            - String. The partition key
+      # * +row_key+                  - String. The row key
+      # * +options+                  - Hash. Optional parameters.
       #
       # ==== Options
       #
       # Accepted key/value pairs in options parameter are:
-      # * +:timeout+      - Integer. A timeout in seconds.
+      # * +:timeout+                 - Integer. A timeout in seconds.
+      # * +:request_id+              - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded 
+      #                                in the analytics logs when storage analytics logging is enabled.
       #
       # Returns an Azure::Storage::Table::Entity instance on success
       def get_entity(table_name, partition_key, row_key, options={})
@@ -568,6 +614,12 @@ module Azure::Storage
 
         value
       end
+
+      protected
+      def raise_with_response(e, response)
+        raise e if response.nil?
+        raise "Response header: #{response.headers.inspect}\nResponse body: #{response.body.inspect}\n#{e.inspect}\n#{e.backtrace.join("\n")}"
+      end
     end
   end
 end