azure-storage-table 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 402740750d3b6341f9a771184e3c8fc4bdf0cad7
+  data.tar.gz: 533ac2a5d1d11074fd714cd3cb0e442dcd335f2b
+SHA512:
+  metadata.gz: 6a0b48932284241d92ad64288b041552c647521ed02bb894e2684026ba36228b47ac92f78b1fb30b52d42ec1320bd685116e516b9dcbf0a5afc16fed6bbf2bb1
+  data.tar.gz: 80eaf676183660f4e661ab64a30987bd86c793f207de3b305420057388777e56f8fa6e5560239d512cd657e0cd6e9cc2551131a3bae7925394f90bf58516fa95

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # 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/table/autoload"

data/table/lib/azure/storage/table/auth/shared_key.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # 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 "cgi"
+require "azure/storage/common/core/auth/shared_key"
+
+module Azure::Storage
+  module Table
+    module Auth
+      class SharedKey < Azure::Storage::Common::Core::Auth::SharedKey
+        # The account name
+        attr :account_name
+
+        # Generate the string to sign.
+        #
+        # @param method   [Symbol]  The HTTP request method.
+        # @param uri      [URI]     The URI of the request we're signing.
+        # @param headers  [Hash]    The 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") { headers.fetch("x-ms-date") },
+              canonicalized_resource(uri)
+          ].join("\n")
+        end
+
+        # Calculate the Canonicalized Resource string for a request.
+        #
+        # @param uri [URI] The request's URI.
+        #
+        # @return  [String] with the canonicalized resource.
+        def canonicalized_resource(uri)
+          resource = "/#{account_name}#{uri.path}"
+
+          comp = CGI.parse(uri.query.to_s).fetch("comp", nil)
+          resource = [resource, "comp=" + comp[0]].join("?") if comp
+
+          resource
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+#-------------------------------------------------------------------------
+# # 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 "rubygems"
+require "nokogiri"
+require "base64"
+
+require "azure/storage/common"
+
+module Azure
+  module Storage
+    module Table
+      autoload :Default,        "azure/storage/table/default"
+      autoload :TableConstants, "azure/storage/table/default"
+      autoload :Version,        "azure/storage/table/version"
+      autoload :Serialization,  "azure/storage/table/serialization"
+      autoload :TableService,   "azure/storage/table/table_service"
+      autoload :Batch,          "azure/storage/table/batch"
+      autoload :Query,          "azure/storage/table/query"
+      autoload :BatchResponse,  "azure/storage/table/batch_response"
+      autoload :EdmType,        "azure/storage/table/edmtype"
+      autoload :Entity,         "azure/storage/table/entity"
+      autoload :GUID,           "azure/storage/table/guid"
+    end
+  end
+end

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

@@ -0,0 +1,366 @@
+#-------------------------------------------------------------------------
+# # 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 "securerandom"
+require "azure/core/http/http_error"
+
+module Azure::Storage
+  module Table
+    # Represents a batch of table operations.
+    #
+    # Example usage:
+    #
+    # svc = TableSerice.new
+    #
+    # batch = Batch.new "table", "partition"
+    # batch.insert "row1", {"meta"=>"data"}
+    # batch.insert "row2", {"meta"=>"data"}
+    #
+    # results = svc.execute_batch batch
+    #
+    class Batch
+      def initialize(table, partition, &block)
+        @table = table
+        @partition = partition
+        @operations = []
+        @entity_keys = []
+        @batch_id = "batch_" + SecureRandom.uuid
+        @changeset_id = "changeset_" + SecureRandom.uuid
+
+        self.instance_eval(&block) if block_given?
+      end
+
+      private
+        attr_reader :table
+        attr_reader :partition
+
+        attr_accessor :operations
+        attr_accessor :entity_keys
+        attr_accessor :changeset_id
+
+      public
+      attr_accessor :batch_id
+
+      protected
+        class ResponseWrapper
+          def initialize(hash)
+            @hash = hash
+          end
+
+          def uri
+            @hash[:uri]
+          end
+
+          def status_code
+            @hash[:status_code].to_i
+          end
+
+          def body
+            @hash[:body]
+          end
+        end
+
+      protected
+        def add_operation(method, row_key = nil, body = nil, headers = nil)
+          raise Azure::Storage::Common::Core::StorageError.new("Get operation should be the only operation in the batch.") if operations.length > 0 && (method == :get || operations[0][:method] == :get)
+          op = {
+            method: method,
+            row_key: row_key,
+            body: body,
+            headers: headers.merge(
+              Azure::Storage::Common::HeaderConstants::CONTENT_TYPE => Azure::Storage::Common::HeaderConstants::JSON_CONTENT_TYPE_VALUE,
+              Azure::Storage::Common::HeaderConstants::DATA_SERVICE_VERSION => TableConstants::DEFAULT_DATA_SERVICE_VERSION
+            )
+          }
+          operations.push op
+        end
+
+      protected
+        def check_entity_key(key)
+          raise ArgumentError, "Only allowed to perform a single operation per entity, and there is already a operation registered in this batch for the key: #{key}." if entity_keys.include? key
+          entity_keys.push key
+        end
+
+      public
+      def parse_response(response)
+        responses = BatchResponse.parse response.body, (!operations.empty? && operations[0][:method] == :get)
+        new_responses = []
+
+        (0..responses.length - 1).each { |index|
+          operation = operations[index]
+          response = responses[index]
+
+          if response[:status_code].to_i > 299
+            # failed
+            error = Azure::Core::Http::HTTPError.new(ResponseWrapper.new(response.merge(uri: operation[:uri])))
+            error.description = response[:message] if (error.description || "").strip == ""
+            raise error
+          else
+            # success
+            case operation[:method]
+            when :post, :get
+              # entity from body
+              entity = Serialization.entity_from_json(response[:body])
+
+              entity.etag = response[:headers]["etag"] if entity.etag.nil?
+
+              new_responses.push entity
+            when :put, :merge
+              # etag from headers
+              new_responses.push response[:headers]["etag"]
+            when :delete
+              # true
+              new_responses.push nil
+            end
+          end
+        }
+
+        new_responses
+      end
+
+      public
+      def to_body(table_service)
+        body = ""
+        body.define_singleton_method(:add_line) do |a| self << (a || nil) + "\n" end
+
+        is_get = true if !operations.empty? && operations[0][:method] == :get
+
+        body.add_line "--#{batch_id}"
+        body.add_line "Content-Type: multipart/mixed; boundary=#{changeset_id}" unless is_get
+        body.add_line "" unless is_get
+
+        operations.each { |op|
+          uri = table_service.entities_uri(@table, @partition, op[:row_key])
+          body.add_line "--#{changeset_id}" unless is_get
+          body.add_line "Content-Type: application/http"
+          body.add_line "Content-Transfer-Encoding: binary"
+          body.add_line ""
+          body.add_line "#{op[:method].to_s.upcase} #{uri} HTTP/1.1"
+
+          if op[:headers]
+            op[:headers].each { |k, v|
+              body.add_line "#{k}: #{v}"
+            }
+          end
+
+          if op[:body]
+            body.add_line "Content-Length: #{op[:body].bytesize}"
+            body.add_line ""
+            body.add_line op[:body]
+          else
+            body.add_line ""
+          end
+
+        }
+        body.add_line "--#{changeset_id}--" unless is_get
+        body.add_line "--#{batch_id}--"
+      end
+
+      # Public: Inserts new entity to the table.
+      #
+      # ==== Attributes
+      #
+      # * +row_key+       - String. The row key
+      # * +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:
+      # * +:accept+              - String. Specifies the accepted content-type of the response payload. Possible values are:
+      #                             :no_meta
+      #                             :min_meta
+      #                             :full_meta
+      # * +:prefer+              - String. Specifies whether the response should include the inserted entity in the payload. Possible values are:
+      #                             Azure::Storage::Common::HeaderConstants::PREFER_CONTENT
+      #                             Azure::Storage::Common::HeaderConstants::PREFER_NO_CONTENT
+      #
+      # See http://msdn.microsoft.com/en-us/library/azure/dd179433
+      public
+      def insert(row_key, entity_values, options = {})
+        check_entity_key(row_key)
+
+        headers = { Azure::Storage::Common::HeaderConstants::ACCEPT => Serialization.get_accept_string(options[:accept]) }
+        headers[Azure::Storage::Common::HeaderConstants::PREFER] = options[:prefer] unless options[:prefer].nil?
+
+        body = Serialization.hash_to_json({
+            "PartitionKey" => partition,
+            "RowKey" => row_key
+          }.merge(entity_values)
+        )
+
+        add_operation(:post, nil, body, headers)
+        self
+      end
+
+      # Public: Gets entity from the table.
+      #
+      # ==== Attributes
+      #
+      # * +row_key+       - String. The row key
+      # * +options+       - Hash. Optional parameters.
+      #
+      # ==== Options
+      #
+      # Accepted key/value pairs in options parameter are:
+      # * +:accept+              - String. Specifies the accepted content-type of the response payload. Possible values are:
+      #                             :no_meta
+      #                             :min_meta
+      #                             :full_meta
+      #
+      # See http://msdn.microsoft.com/en-us/library/azure/dd179433
+      public
+      def get(row_key, options = {})
+        check_entity_key(row_key)
+
+        headers = { Azure::Storage::Common::HeaderConstants::ACCEPT => Serialization.get_accept_string(options[:accept]) }
+
+        add_operation(:get, row_key, nil, headers)
+        self
+      end
+
+      # Public: Updates an existing entity in a table. The Update Entity operation replaces
+      # the entire entity and can be used to remove properties.
+      #
+      # ==== Attributes
+      #
+      # * +row_key+       - String. The row key
+      # * +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)
+      # * +:accept+              - String. Specifies the accepted content-type of the response payload. Possible values are:
+      #                             :no_meta
+      #                             :min_meta
+      #                             :full_meta
+      #
+      # See http://msdn.microsoft.com/en-us/library/azure/dd179427
+      public
+      def update(row_key, entity_values, options = {})
+        check_entity_key(row_key)
+
+        headers = { Azure::Storage::Common::HeaderConstants::ACCEPT => Serialization.get_accept_string(options[:accept]) }
+        headers["If-Match"] = options[:if_match] || "*" unless options[:create_if_not_exists]
+
+        body = Serialization.hash_to_json(entity_values)
+
+        add_operation(:put, row_key, body, headers)
+        self
+      end
+
+      # Public: Updates an existing entity by updating the entity's properties. This operation
+      # does not replace the existing entity, as the update_entity operation does.
+      #
+      # ==== Attributes
+      #
+      # * +row_key+         - String. The row key
+      # * +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)
+      # * +:accept+              - String. Specifies the accepted content-type of the response payload. Possible values are:
+      #                             :no_meta
+      #                             :min_meta
+      #                             :full_meta
+      #
+      # See http://msdn.microsoft.com/en-us/library/azure/dd179392
+      public
+      def merge(row_key, entity_values, options = {})
+        check_entity_key(row_key)
+
+        headers = { Azure::Storage::Common::HeaderConstants::ACCEPT => Serialization.get_accept_string(options[:accept]) }
+        headers["If-Match"] = options[:if_match] || "*" unless options[:create_if_not_exists]
+
+        body = Serialization.hash_to_json(entity_values)
+
+        add_operation(:merge, row_key, body, headers)
+        self
+      end
+
+      # Public: Inserts or updates an existing entity within a table by merging new property values into the entity.
+      #
+      # ==== Attributes
+      #
+      # * +row_key+               - String. The row key
+      # * +entity_values+         - Hash. A hash of the name/value pairs for the entity.
+      #
+      # See http://msdn.microsoft.com/en-us/library/azure/hh452241
+      public
+      def insert_or_merge(row_key, entity_values)
+        merge(row_key, entity_values, create_if_not_exists: true)
+        self
+      end
+
+      # Public: Inserts or updates a new entity into a table.
+      #
+      # ==== Attributes
+      #
+      # * +row_key+               - String. The row key
+      # * +entity_values+         - Hash. A hash of the name/value pairs for the entity.
+      #
+      # See http://msdn.microsoft.com/en-us/library/azure/hh452242
+      public
+      def insert_or_replace(row_key, entity_values)
+        update(row_key, entity_values, create_if_not_exists: true)
+        self
+      end
+
+      # Public: Deletes an existing entity in the table.
+      #
+      # ==== Attributes
+      #
+      # * +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="*")
+      # * +:accept+              - String. Specifies the accepted content-type of the response payload. Possible values are:
+      #                             :no_meta
+      #                             :min_meta
+      #                             :full_meta
+      #
+      # See http://msdn.microsoft.com/en-us/library/azure/dd135727
+      public
+      def delete(row_key, options = {})
+        headers = {
+          Azure::Storage::Common::HeaderConstants::ACCEPT => Serialization.get_accept_string(options[:accept]),
+          "If-Match" => options[:if_match] || "*"
+        }
+        add_operation(:delete, row_key, nil, headers)
+        self
+      end
+    end
+  end
+end