tiny_dyno 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5260b6e451ace6f876c6778496c4e3fe1b5d7337
-  data.tar.gz: a7ff251eba21480888716e3833f632f37916da1f
+  metadata.gz: 2a57635fe6ebcd452a54d007997380f6616bb0f3
+  data.tar.gz: 3e7518b99d5034175ea1781ac4f39812a722c7fa
 SHA512:
-  metadata.gz: 3d12c868b43577811890db7671e8c8498d7d53fe146bedfc7ef66474f19d79ba177c8265de3667f6fd4680ecb46876f65af1171c2d80fec869412d3b86698e37
-  data.tar.gz: 03b3fb815185cf31fddd8eadb81c1fcf4bcbc4694238c9d2242ea901bc0fffbb649d3d10ffdaa5981bd4b0cfaefad41c39a39bbd687142b4215203d7e4641628
+  metadata.gz: cd0dc92db501ed54364de063d527acb8ccb3a115ed27585a1c6c4c5f3e0f73ed65a9441d569150fb6c095f52b58eb0c59bcf313e21949a100cd92a6e3dada745
+  data.tar.gz: e6d2aee6af7d226e667e0e7f522d227daf5662b1f725c961b95ce097e4b5f4a8a88696d95cef8c4da2adc6afb4aa352affef3732e463a47973d2693e9efd345d

data/CHANGES.md

@@ -0,0 +1,12 @@
+0.1.9 (2015-07-01)
+-----------------
+
+* Fixes - clean up of a few stale require 'pry'
+
+0.1.8 (2015-07-01)
+------------------
+
+* Fixes - Raise Error, if multiple hash keys are being defined
+* Fixes - On Create use 'expected' clause to achieve intended behavior on create,
+          to not overwrite an existing record, but only create a new record
+

data/lib/tiny_dyno/changeable.rb

@@ -63,7 +63,7 @@ module TinyDyno
     # @since 2.1.0
     def attribute_change(attr)
       attr = database_field_name(attr)
-      [changed_attributes[attr], attributes[attr]] if attribute_changed?(attr)
+      [changed_attributes[attr], attributes[attr]] if (attribute_changed?(attr) && !attr.nil?)
     end
 
   end

data/lib/tiny_dyno/document.rb

@@ -70,10 +70,10 @@ module TinyDyno
       # check that each option key relates to a hash_key present on the model
       # do not permit scan queries
       def valid_option_keys(options)
-        options.keys.each do |name|
-          named = name.to_s
-          raise TinyDyno::Errors::HashKeysOnly.new(klass: self.class, name: named) unless hash_key_is_defined?(named)
-        end
+        raise TinyDyno::Errors::HashKeyOnly.new(klass: self.class, name: 'primary_key') if primary_key.nil?
+        # options.keys.each do |name|
+        #   named = name.to_s
+        # end
       end
 
       # minimimum implementation for now

data/lib/tiny_dyno/document_composition.rb

@@ -3,27 +3,29 @@ require 'tiny_dyno/changeable'
 require 'tiny_dyno/fields'
 require 'tiny_dyno/stateful'
 require 'tiny_dyno/tables'
-require 'tiny_dyno/hash_keys'
+require 'tiny_dyno/hash_key'
 require 'tiny_dyno/persistable'
+require 'tiny_dyno/expected'
 
 module TinyDyno
   module DocumentComposition
     extend ActiveSupport::Concern
 
     include Attributes
+    include Expected
     include Changeable
     include Fields
-    include HashKeys
+    include HashKey
     include Persistable
     include Stateful
     include Tables
 
-
     MODULES = [
         Attributes,
+        Expected,
         Changeable,
         Fields,
-        HashKeys,
+        HashKey,
         Persistable,
         Stateful,
         Tables,

data/lib/tiny_dyno/errors/hash_key_errors.rb

@@ -50,14 +50,13 @@ module TinyDyno
   end
 end
 
-
 # encoding: utf-8
 module TinyDyno
   module Errors
 
     # This error is raised, when a query is performed with fields specified
     # that are not HashKeys, which would result in a table scan
-    class HashKeysOnly < TinyDynoError
+    class HashKeyOnly < TinyDynoError
 
       # Create the new error.
       #
@@ -76,3 +75,30 @@ module TinyDyno
     end
   end
 end
+
+# encoding: utf-8
+module TinyDyno
+  module Errors
+
+    # This error is raised, when a query is performed with fields specified
+    # that are not HashKeys, which would result in a table scan
+    class OnlyOneHashKeyPermitted < TinyDynoError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   OnlyOneHashKeyPermitted.new(Person, "gender")
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ String, Symbol ] name The name of the attribute.
+      #
+      # @since 3.0.0
+      def initialize(klass:, name:)
+        super(
+            compose_message("you can only define one hash_key", { klass: klass.name, name: name })
+        )
+      end
+    end
+  end
+end
+

data/lib/tiny_dyno/expected.rb

@@ -0,0 +1,18 @@
+module TinyDyno
+  module Expected
+    extend ActiveSupport::Concern
+
+    # insert Expected clause, which will ensure
+    # that INSERTs will only take place
+    # if there is no record with that hash key yet
+    def request_as_new_record(request)
+      request.merge({
+                        expected: {
+                            "#{ primary_key[:attr] }": {
+                                comparison_operator: 'NULL'
+                            }
+                        }})
+    end
+
+  end
+end

data/lib/tiny_dyno/fields/standard.rb

@@ -41,24 +41,24 @@ module TinyDyno
 
       private
 
-      # Is the field included in the fields that were returned from the
-      # database? We can apply the default if:
-      #   1. The field is included in an only limitation (field: 1)
-      #   2. The field is not excluded in a without limitation (field: 0)
-      #
-      # @example Is the field included?
-      #   field.included?(fields)
-      #
-      # @param [ Hash ] fields The field limitations.
-      #
-      # @return [ true, false ] If the field was included.
+      # # Is the field included in the fields that were returned from the
+      # # database? We can apply the default if:
+      # #   1. The field is included in an only limitation (field: 1)
+      # #   2. The field is not excluded in a without limitation (field: 0)
+      # #
+      # # @example Is the field included?
+      # #   field.included?(fields)
+      # #
+      # # @param [ Hash ] fields The field limitations.
+      # #
+      # # @return [ true, false ] If the field was included.
+      # #
+      # # @since 2.4.4
+      # def included?(fields)
+      #   (fields.values.first == 1 && fields[name.to_s] == 1) ||
+      #       (fields.values.first == 0 && !fields.has_key?(name.to_s))
+      # end
       #
-      # @since 2.4.4
-      def included?(fields)
-        (fields.values.first == 1 && fields[name.to_s] == 1) ||
-            (fields.values.first == 0 && !fields.has_key?(name.to_s))
-      end
-
     end
   end
 end

data/lib/tiny_dyno/hash_key.rb

@@ -0,0 +1,109 @@
+module TinyDyno
+  module HashKey
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :attribute_definitions, :key_schema, :primary_key
+
+      # TODO :local_secondary_indexes, :global_secondary_indexes
+      self.attribute_definitions ||= []
+      self.key_schema ||= []
+      self.primary_key ||= {}
+    end
+
+    # return all defined hash keys on an instantiated object
+    # for further use in DynamoDB queries, i.e. to look up an object
+    #
+    def hash_key_as_selector
+      { "#{ self.class.primary_key[:attr] }": attributes[self.class.primary_key[:attr]] }
+    end
+
+    module ClassMethods
+
+      # Defines the primary key for the Document
+      # Only one primary key = hash_key is allowed in DynamoDB
+      #
+      # @example Define a field.
+      #   hash_key :score, :type => Integer
+      #
+      # @param [ Symbol ] name The name of the hash_key.
+      # @param [ Hash ] options The options to pass to the hash_key.
+      #
+      # @option options [ Class ] :type The type of the field.
+      # @option options [ String ] :label The label for the field.
+      #
+      # @return [ Field ] The generated field
+      def hash_key(name, options = {})
+        raise TinyDyno::Errors::OnlyOneHashKeyPermitted.new(klass: self.class, name: name) unless primary_key.empty?
+        named = name.to_s
+        attribute_definition = build_attribute_definition(named,options[:type])
+        key_schema = build_key_schema(named)
+        unless attribute_definition_meets_spec?(attribute_definition)
+          raise TinyDyno::Errors::InvalidHashKey.new(klass: self.class, name: name)
+        end
+        # we need the accessors as well
+        add_field(named, options)
+        self.attribute_definitions << attribute_definition
+        self.key_schema << key_schema
+        self.primary_key = {
+            attr: attribute_definition[:attribute_name],
+            attr_type: attribute_definition[:attribute_type],
+            key_type: key_schema[:key_type],
+        }
+      end
+
+      # convert a hash key into a format as expected by
+      # put_item and update_item request
+      def as_item_entry(hash_key)
+
+      end
+
+      private
+
+      # Return true or false, depending on whether the attribute_definitions on the model
+      # meet the specification of the Aws Sdk
+      # This is a syntax, not a logic check
+      def attribute_definitions_meet_spec?
+        attribute_definitions.each do |definition|
+          return false unless attribute_definition_meets_spec?(definition)
+        end
+      end
+
+      def attribute_definition_meets_spec?(definition)
+        return (definition.has_key?(:attribute_name) && \
+        definition.has_key?(:attribute_type) && \
+        definition[:attribute_name].class == String && \
+        definition[:attribute_type].class == String && \
+        ['S','N', 'B'].include?(definition[:attribute_type]))
+      end
+
+      def build_attribute_definition(name, key_type)
+        {
+            attribute_name: name,
+            attribute_type: hash_key_type(key_type)
+        }
+      end
+
+      def hash_key_type(key_type = nil)
+        return 'S' if key_type == String
+        return 'N' if key_type == Fixnum or key_type == Integer
+        return nil
+      end
+
+      def build_key_schema(name)
+        {
+            attribute_name: name,
+            key_type: 'HASH'
+        }
+      end
+
+      # convert values in queries to DynamoDB
+      # into types as expected by DynamoDB
+      def dyno_typed_key(key:, val:)
+        typed_class = self.fields[key].options[:type]
+        return (document_typed(klass: typed_class, value: val))
+      end
+
+    end
+  end
+end

data/lib/tiny_dyno/persistable.rb

@@ -4,7 +4,13 @@ module TinyDyno
 
     def save(options = {})
       if new_record?
-        request_put_item(options)
+        if request_put_item(options)
+          changes_applied
+          @new_record = nil
+          return true
+        else
+          return false
+        end
       else
         request_update_item(options)
       end
@@ -13,14 +19,8 @@ module TinyDyno
     private
 
     def request_put_item(options)
-      request = build_put_item_request(options)
-      if TinyDyno::Adapter.put_item(put_item_request: request)
-        changes_applied
-        @new_record = nil
-        return true
-      else
-        return false
-      end
+      request = request_as_new_record(build_item_request(options))
+      return(TinyDyno::Adapter.put_item(put_item_request: request))
     end
 
     # The target structure as per
@@ -51,7 +51,7 @@ module TinyDyno
     #                                "ExpressionAttributeValueVariable" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
     #                            },
     #                        })
-    def build_put_item_request(options)
+    def build_item_request(options)
       {
           table_name: self.class.table_name,
           item: build_item_request_entries

data/lib/tiny_dyno/version.rb

@@ -1,3 +1,3 @@
 module TinyDyno
-  VERSION = '0.1.7'
+  VERSION = '0.1.9'
 end

data/lib/tiny_dyno.rb

@@ -1,11 +1,6 @@
 require 'active_model'
 require 'aws-sdk'
 
-# if ENV['RACK_ENV'] == 'development'
-# require 'pry'
-# require 'awesome_print'
-# end
-
 require 'tiny_dyno/extensions'
 
 require 'tiny_dyno/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_dyno
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Tobias Gerschner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - ".ruby-version"
 - ".simplecov"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -185,14 +186,17 @@ files:
 - lib/tiny_dyno/errors/attribute_errors.rb
 - lib/tiny_dyno/errors/hash_key_errors.rb
 - lib/tiny_dyno/errors/tiny_dyno_error.rb
+- lib/tiny_dyno/expected.rb
 - lib/tiny_dyno/extensions.rb
 - lib/tiny_dyno/extensions/module.rb
 - lib/tiny_dyno/fields.rb
 - lib/tiny_dyno/fields/standard.rb
+- lib/tiny_dyno/hash_key.rb
 - lib/tiny_dyno/hash_keys.rb
 - lib/tiny_dyno/loggable.rb
 - lib/tiny_dyno/persistable.rb
 - lib/tiny_dyno/range_attributes.rb
+- lib/tiny_dyno/range_key.rb
 - lib/tiny_dyno/stateful.rb
 - lib/tiny_dyno/tables.rb
 - lib/tiny_dyno/version.rb