aws-record 1.0.0.pre.4 → 1.0.0.pre.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 102f5cb13fee3789030badc882c2d171ddb800e8
-  data.tar.gz: e4bad779188f59b940492fb2644636901826f41e
+  metadata.gz: e3fb756f0dd0d63461d393e36ec6059482648f79
+  data.tar.gz: 8f3ea1c9ea27cf57f7a2aa26d0096d62e8c6f4cf
 SHA512:
-  metadata.gz: a3ef6f71866145568e25d6cac31ebd31c33ad37bfa776ae648e4a0424f69e2e7c6fa46b8d22e5b0c5d5231f1fbde98d1460e5f83e88a812ea85dd4d87e3d3b68
-  data.tar.gz: 9cb2cf7a7644a0a6754c7e32452dbf5b83e422e6d7e94ca8a5c0442aa1532ac81ed47519bb00175a1a5e8107f193c1612a0a2ebd3df66a046763daa6c51378a5
+  metadata.gz: bda87438c533121bb4cc80f2e7dca54f2a0757f613d4993790c1519733e99c6c3d3df2c54e72c14c24173d8c424dc6368be0ede2b27d86b417847be3152c8fd8
+  data.tar.gz: 2b9a63d40bb40daa48dee6ec115950fe8c7ea85a0c43b80ed7dc64d12936eb7e5b5504343ffbea7b8a26cb446bc37e5241b497452a9a3022902e6817be8cb2e4

data/lib/aws-record/record.rb

@@ -13,6 +13,17 @@
 
 module Aws
   module Record
+    # @!parse extend RecordClassMethods
+    # @!parse include Attributes
+    # @!parse extend Attributes::ClassMethods
+    # @!parse include ItemOperations
+    # @!parse extend ItemOperations::ItemOperationsClassMethods
+    # @!parse include Query
+    # @!parse extend Query::QueryClassMethods
+    # @!parse include SecondaryIndexes
+    # @!parse extend SecondaryIndexes::SecondaryIndexesClassMethods
+    # @!parse include DirtyTracking
+    # @!parse extend DirtyTracking::DirtyTrackingClassMethods
 
     # Usage of {Aws::Record} requires only that you include this module. This
     # method will then pull in the other default modules.
@@ -60,7 +71,7 @@ module Aws
         if @table_name
           @table_name
         else
-          @table_name = self.name
+          @table_name = self.name.split("::").join("_")
         end
       end
 

data/lib/aws-record/record/attribute.rb

@@ -21,8 +21,8 @@ module Aws
       #  safe to use as a method.
       # @param [Hash] options
       # @option options [Marshaler] :marshaler The marshaler for this attribute.
-      #   So long as you provide a marshaler which implements `#type_cast` and
-      #   `#serialize` that consume raw values as expected, you can bring your
+      #   So long as you provide a marshaler which implements +#type_cast+ and
+      #   +#serialize+ that consume raw values as expected, you can bring your
       #   own marshaler type.
       # @option options [Array] :validators An array of validator classes that
       #   will be run when an attribute is checked for validity.

data/lib/aws-record/record/attributes.rb

@@ -54,8 +54,8 @@ module Aws
         # @param [Symbol] name Name of this attribute.  It should be a name that
         #   is safe to use as a method.
         # @param [Marshaler] marshaler The marshaler for this attribute. So long
-        #   as you provide a marshaler which implements `#type_cast` and
-        #   `#serialize` that consume raw values as expected, you can bring your
+        #   as you provide a marshaler which implements +#type_cast+ and
+        #   +#serialize+ that consume raw values as expected, you can bring your
         #   own marshaler type. Convenience methods will provide this for you.
         # @param [Hash] opts
         # @option opts [Array] :validators An array of validator classes that
@@ -269,7 +269,7 @@ module Aws
 
         # Define a numeric set attribute for your model.
         #
-        # Numeric sets are homogeneous sets, containing only strings. Note that
+        # Numeric sets are homogeneous sets, containing only numbers. Note that
         # empty sets cannot be persisted to DynamoDB. Empty sets are valid for
         # aws-record items, but they will not be persisted as sets. nil values
         # from your table, or a lack of value from your table, will be treated
@@ -284,7 +284,7 @@ module Aws
         #   the hash key for the table.
         # @option opts [Boolean] :range_key Set to true if this attribute is
         #   the range key for the table.
-        def string_set_attr(name, opts = {})
+        def numeric_set_attr(name, opts = {})
           opts[:dynamodb_type] = "NS"
           attr(name, Attributes::NumericSetMarshaler, opts)
         end

data/lib/aws-record/record/errors.rb

@@ -15,10 +15,14 @@ module Aws
   module Record
     module Errors
 
-      class KeyMissing < RuntimeError; end
+      class RecordError < RuntimeError; end
+
+      class KeyMissing < RecordError; end
+      class NotFound < RecordError; end
+      class ItemAlreadyExists < RecordError; end
+
       class NameCollision < RuntimeError; end
       class ReservedName < RuntimeError; end
-      class NotFound < RuntimeError; end
       class InvalidModel < RuntimeError; end
       class TableDoesNotExist < RuntimeError; end
 

data/lib/aws-record/record/item_collection.rb

@@ -12,17 +12,18 @@ module Aws
 
       def each(&block)
         return enum_for(:each) unless block_given?
-        unless @result
-          @result = @client.send(@search_method, @search_params)
-        end
-        @result.each_page do |page|
-          items = _build_items_from_response(page.items, @model)
-          items.each do |item|
+        items.each_page do |page|
+          items_array = _build_items_from_response(page.items, @model)
+          items_array.each do |item|
             yield item
           end
         end
       end
 
+      def empty?
+        items.empty?
+      end
+
       private
       def _build_items_from_response(items, model)
         ret = []
@@ -37,6 +38,10 @@ module Aws
         ret
       end
 
+      def items
+        @_items ||= @client.send(@search_method, @search_params)
+      end
+
     end
   end
 end

data/lib/aws-record/record/item_operations.rb

@@ -18,20 +18,96 @@ module Aws
       # @api private
       def self.included(sub_class)
         sub_class.extend(ItemOperationsClassMethods)
+        sub_class.instance_variable_set("@errors", [])
       end
 
-      # Saves this instance of an item to Amazon DynamoDB using the
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method Aws::DynamoDB::Client#put_item}
-      # API. Uses this item instance's attributes in order to build the request
-      # on your behalf.
+      # Saves this instance of an item to Amazon DynamoDB. If this item is "new"
+      #  as defined by having new or altered key attributes, will attempt a
+      #  conditional
+      #  {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method Aws::DynamoDB::Client#put_item}
+      #  call, which will not overwrite an existing item. If the item only has
+      #  altered non-key attributes, will perform an
+      #  {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_item-instance_method Aws::DynamoDB::Client#update_item}
+      #  call. Uses this item instance's attributes in order to build the
+      #  request on your behalf.
       #
+      # You can use the +:force+ option to perform a simple put/overwrite
+      #  without conditional validation or update logic.
+      #
+      # @param [Hash] opts
+      # @option opts [Boolean] :force if true, will save as a put operation and
+      #  overwrite any existing item on the remote end. Otherwise, and by
+      #  default, will either perform a conditional put or an update call.
       # @raise [Aws::Record::Errors::KeyMissing] if a required key attribute
       #  does not have a value within this item instance.
-      def save
-        dynamodb_client.put_item(
-          table_name: self.class.table_name,
-          item: build_item_for_save
-        )
+      # @raise [Aws::Record::Errors::ItemAlreadyExists] if a conditional put
+      #  fails because the item exists on the remote end.
+      def save!(opts = {})
+        force = opts[:force]
+        expect_new = expect_new_item?
+        if force
+          dynamodb_client.put_item(
+            table_name: self.class.table_name,
+            item: build_item_for_save
+          )
+        elsif expect_new
+          put_opts = {
+            table_name: self.class.table_name,
+            item: build_item_for_save
+          }.merge(prevent_overwrite_expression)
+          begin
+            dynamodb_client.put_item(put_opts)
+          rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
+            raise Errors::ItemAlreadyExists.new(
+              "Conditional #put_item call failed, an item with the same key"\
+                " already exists in the table. Either load and update this"\
+                " item, or include the :force option to clobber the remote"\
+                " item."
+            )
+          end
+        else
+          dynamodb_client.update_item(
+            table_name: self.class.table_name,
+            key: key_values,
+            attribute_updates: dirty_changes_for_update
+          )
+        end
+      end
+
+      # Saves this instance of an item to Amazon DynamoDB. If this item is "new"
+      #  as defined by having new or altered key attributes, will attempt a
+      #  conditional
+      #  {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method Aws::DynamoDB::Client#put_item}
+      #  call, which will not overwrite an existing item. If the item only has
+      #  altered non-key attributes, will perform an
+      #  {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_item-instance_method Aws::DynamoDB::Client#update_item}
+      #  call. Uses this item instance's attributes in order to build the
+      #  request on your behalf.
+      #
+      # You can use the +:force+ option to perform a simple put/overwrite
+      #  without conditional validation or update logic.
+      #
+      # In the case where persistence fails, will populate the +errors+ array
+      #  with any generated error messages, and will cause +#valid?+ to return
+      #  false until there is a successful save.
+      #
+      # @param [Hash] opts
+      # @option opts [Boolean] :force if true, will save as a put operation and
+      #  overwrite any existing item on the remote end. Otherwise, and by
+      #  default, will either perform a conditional put or an update call.
+      def save(opts = {})
+        result = save!(opts)
+        errors.clear
+        result
+      rescue Errors::RecordError => e
+        errors << e.message
+        false
+      end
+
+      # Checks if the record is a valid record. +false+ if most recent +#save+
+      # call raised errors, or if there are missing keys. +true+ otherwise.
+      def valid?
+        errors.empty? && missing_key_values.empty?
       end
 
       # Deletes the item instance that matches the key values of this item
@@ -46,6 +122,10 @@ module Aws
         true
       end
 
+      def errors
+        self.class.instance_variable_get("@errors")
+      end
+
       private
       def build_item_for_save
         validate_key_values
@@ -84,6 +164,44 @@ module Aws
         end
       end
 
+      def expect_new_item?
+        # Algorithm: Are keys dirty? If so, we treat as new.
+        self.class.keys.any? do |_, attr_name|
+          attribute_dirty?(attr_name)
+        end
+      end
+
+      def prevent_overwrite_expression
+        conditions = []
+        expression_attribute_names = {}
+        # Hash Key
+        conditions << "attribute_not_exists(#H)"
+        expression_attribute_names["#H"] = self.class.hash_key.database_name
+        # Range Key
+        if self.class.range_key
+          conditions << "attribute_not_exists(#R)"
+          expression_attribute_names["#R"] = self.class.range_key.database_name
+        end
+        {
+          condition_expression: conditions.join(" and "),
+          expression_attribute_names: expression_attribute_names
+        }
+      end
+
+      def dirty_changes_for_update
+        attributes = self.class.attributes
+        ret = dirty.inject({}) do |acc, attr_name|
+          key = attributes[attr_name].database_name
+          value = {
+            value: attributes[attr_name].serialize(@data[attr_name]),
+            action: "PUT"
+          }
+          acc[key] = value
+          acc
+        end
+        ret
+      end
+
       module ItemOperationsClassMethods
 
         # @example Usage Example
@@ -92,7 +210,7 @@ module Aws
         #     integer_attr :id,   hash_key: true
         #     string_attr  :name, range_key: true
         #   end
-        #   
+        #
         #   MyModel.find(id: 1, name: "First")
         #
         # @param [Hash] opts attribute-value pairs for the key you wish to

data/lib/aws-record/record/version.rb

@@ -13,6 +13,6 @@
 
 module Aws
   module Record
-    VERSION = "1.0.0.pre.4"
+    VERSION = '1.0.0.pre.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.4
+  version: 1.0.0.pre.5
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: AWS Record library for Amazon DynamoDB