ocean-dynamo 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eeab3b16bea7186a7a996113e1de39a7f9d21651
-  data.tar.gz: 9bf14c5d5521673acb6637bd03885f02a7ec05e6
+  metadata.gz: 0e5d649565fd30bee32f1b8d80c7f6117009229e
+  data.tar.gz: e281cb72d49607d53e9ddd7053462f50c29b0604
 SHA512:
-  metadata.gz: 71dd4bed657bb9fe67ec15f422f3007bbee26ed88bf5880bc2e569dafdf0a1726260b7d73eb0ec9598a3d7bc2565e9a9c0940aa875fbe268afa247d1a8df2de5
-  data.tar.gz: 2558c9434f37ce7af79a34ced28eaf87f1257e6c0dbe7a0b8d2be6cab1d6966c8d345341b9ef0dbd2875b860d00cb85a3a55f47436882177fdb2177bb0f930a0
+  metadata.gz: cf608c59e414e273d9e13cf30070e3e2c3ba6ef79e343900b66d7fc1dbc08dd903332fe9297310fbebb5dbc1c9050957130178fe864dafc316ced76e397c629c
+  data.tar.gz: 708e7170927244786d84e20bc2b7ffc99206263d210f3fe4e73ee4306be3bb659b1383b01cb9631b91ef85c4d378a03947a28b3a4cb60f3f5dbbf896c99c34cf

data/README.rdoc

@@ -40,16 +40,16 @@ with FactoryGirl.
 
 === Future milestones
 
-* Association proxies, to implement ActiveRecord-style method chaining, e.g.: 
+* Direct support for the DynamoDB JSON attribute types for arrays and hashes
+* Collection proxies, to implement ActiveRecord-style method chaining, e.g.: 
   <code>blog_entry.comments.build(body: "Cool!").save!</code>
 * The +has_and_belongs_to_many+ assocation. 
-* A generator to install the <tt>config/aws.yml</tt> file.
 
 
 === Current use
 
 OceanDynamo is used as a central component in Ocean, a Rails framework and development 
-pipeline for creating highly scalable HATEOAS microservice SOAs in the cloud.
+pipeline for creating massively scalable HATEOAS microservice SOAs in the cloud.
 * http://wiki.oceanframework.net
 
 Ocean uses OceanDynamo to implement highly scalable job queues and authentication. 
@@ -99,6 +99,8 @@ The following example shows the basic syntax for declaring a DynamoDB-based sche
       attribute :succeeded,            :boolean,    default: false
       attribute :failed,               :boolean,    default: false
       attribute :poison,               :boolean,    default: false
+      
+      global_secondary_index :token, projection: :all
     end
     
   end
@@ -210,13 +212,9 @@ which means that secondary indices won't be necessary for the vast majority of
 DynamoDB tables. This ultimately means reduced operational costs, as well as
 reduced complexity.
 
-Nevertheless, as we now have switched to v2 of the DynamoDB API, we will be adding
-the possibility to define both local and secondary indices for Tables. 
 
 == Secondary Indices
 
-We now have support for secondary indices.
-
 === Local Secondary Indices
 
 Up to five attributes can be declared as local secondary indices, in the following manner:
@@ -242,9 +240,9 @@ combination of keys. Secondary indices don't require the range key to be unique
 the same hash key. This means that secondary index searches always will return a
 collection.
 
-High-level support for local secondary indices is now available through
-+find_local_each+ and +find_local+. They take the same arguments; the former
-yields to a block for each item, the other returns all items in an array.
+Local secondary indices are queried through +find_local_each+ and +find_local+. 
+They take the same arguments; the former yields to a block for each item, 
+the other returns all items in an array.
 
 The following finds all Authentications where +:username+ is "joe" and +:token+ is "quux":
 
@@ -259,9 +257,6 @@ The same thing but with the only the item with the highest token value:
  Authentication.find_local(:username, "joe", :token, ">=", "0",
                            scan_index_forward: false, limit: 1)
 
-For more information, see the documentation for
-+find_local_each+ and +find_local+.
-
 
 === Global Secondary Indices
 
@@ -282,37 +277,34 @@ block:
     end
   end
 
-Each +global_secondary_index+ clause takes the following arguments:
+Each +global_secondary_index+ clause (there can be a maximum of 5 per table) takes 
+the following arguments:
 * +hash_value+ (required), 
 * +range_value+ (optional), 
-* +:projection+ (default :keys_only, :all for all attributes)
+* +:projection+ (default +:keys_only+, +:all+ for all attributes)
 * +:read_capacity_units+ (defaults to the table's read capacity, normally 10)
 * +:write_capacity_units+ (default to the table's write capacity, normally 5)
 
-High-level support for global secondary indices is now available through
-+find_global_each+ and +find_global+. They take the same arguments; the former
-yields to a block for each item, the other returns all items in an array.
+Global secondary indices are queried through +find_global_each+ and +find_global+. 
+They take the same arguments; the former yields to a block for each item, 
+the other returns all items in an array.
 
-The following finds all Authentications whose +:token+ is "quux"
+The following finds all Authentications whose +:token+ is +"quux"+:
 
  Authentication.find_global(:token, "quux")
 
-This retrieves all Authentications belonging to the user with the ID "dfstw-ruyhdf-ewijf", 
+This retrieves all Authentications belonging to the user with the ID +"dfstw-ruyhdf-ewijf"+, 
 sorted in ascending order of the +:expires_at+ attribute:
 
  Authentication.find_global(:api_user_id, "dfstw-ruyhdf-ewijf", 
                             :expires_at, ">=", 0)
 
-To get the highest +:expires_at+ record, execute the following:
+To get the highest +:expires_at+ record:
 
  Authentication.find_global(:api_user_id, "dfstw-ruyhdf-ewijf", 
                             :expires_at, ">=", 0,
                             scan_index_forward: false, limit: 1)
 
-The combination of hash and range key must have been explicitly declared using
-+global_secondary_index+. For more information, see the documentation for
-+find_global_each+ and +find_global+.
-
 
 == Installation
 
@@ -335,8 +327,7 @@ to both the following locations in your project:
  config/aws.yml.example
  config/aws.yml
 
-Enter your AWS credentials in the latter file. Eventually, there
-will be a generator to copy these files for you, but for now you need to do it manually. 
+Enter your AWS credentials in the latter file.
 
 
 == Running the specs

data/lib/ocean-dynamo/associations/association.rb

@@ -1,13 +1,15 @@
 module OceanDynamo
   module Associations
+
     #
     # This is the root class of all Associations.
     # The class structure is exactly like in ActiveRecord:
     #
-    #   Association
-    #     CollectionAssociation
-    #       HasAndBelongsToManyAssociation
-    #       HasManyAssociation
+    #   Associations
+    #     Association
+    #       CollectionAssociation
+    #         HasAndBelongsToManyAssociation
+    #         HasManyAssociation
     #
     # It should be noted, however, that the ActiveRecord documentation  
     # is misleading: belongs_to and has_one no longer are implemented using

data/lib/ocean-dynamo/associations/associations.rb

@@ -1,3 +1,13 @@
+#
+# The class structure is exactly like in ActiveRecord:
+#
+#   Associations
+#     Association
+#       CollectionAssociation
+#         HasAndBelongsToManyAssociation
+#         HasManyAssociation
+#
+
 module OceanDynamo
   module Associations
 

data/lib/ocean-dynamo/associations/belongs_to.rb

@@ -151,7 +151,7 @@ module OceanDynamo
       #
       def assert_range_key_not_specified!  # :nodoc:
         raise RangeKeyMustNotBeSpecified, 
-              "Tables with belongs_to relations may not specify the range key" if table_range_key
+              "Tables with belongs_to relations may not specify a range key" if table_range_key
       end
 
 

data/lib/ocean-dynamo/associations/collection_association.rb

@@ -1,15 +1,17 @@
 module OceanDynamo 
   module Associations 
+    
     #
     # CollectionAssociation is an abstract class that provides common stuff to
     # ease the implementation of association proxies that represent
     # collections. See the class hierarchy in AssociationProxy.
     #
-    #  Association
-    #    CollectionAssociation:
-    #      HasAndBelongsToManyAssociation => has_and_belongs_to_many
-    #      HasManyAssociation => has_many
-    #        HasManyThroughAssociation + ThroughAssociation => has_many :through
+    #  Associations
+    #    Association
+    #      CollectionAssociation:
+    #        HasAndBelongsToManyAssociation => has_and_belongs_to_many
+    #        HasManyAssociation => has_many
+    #          HasManyThroughAssociation + ThroughAssociation => has_many :through
     #
     # CollectionAssociation class provides common methods to the collections
     # defined by +has_and_belongs_to_many+, +has_many+ or +has_many+ with

data/lib/ocean-dynamo/associations/collection_proxy.rb

@@ -19,9 +19,8 @@ module OceanDynamo
     # <tt>@owner</tt>, the collection of its posts as <tt>@target</tt>, and
     # the <tt>@reflection</tt> object represents a <tt>:has_many</tt> macro.
     #
-    # This class delegates unknown methods to <tt>@target</tt> NOT via
-    # <tt>method_missing</tt> (as the ActiveRecord documentation falsely states),
-    # but through explicit proxy methods for each separate operation.
+    # This class delegates unknown methods to <tt>@target</tt> through explicit 
+    # proxy methods for each separate operation.
     #
     # The <tt>@target</tt> object is not \loaded until needed. As it turns out,
     # the key to this lazy loading scheme is <tt>to_ary</tt>.

data/lib/ocean-dynamo/associations/has_many.rb

@@ -19,11 +19,13 @@ module OceanDynamo
       # Defines a +has_many+ relation to a +belongs_to+ class.
       #
       # The +dependent:+ keyword arg may be +:destroy+, +:delete+ or +:nullify+
-      # and have the same semantics as in ActiveRecord. With +:nullify+, however,
-      # the hash key is set to the string "NULL" rather than binary NULL, as
-      # DynamoDB doesn't permit storing empty fields.
+      # and have the same semantics as in ActiveRecord.
       #
-      def has_many(children, dependent: :nullify)            # :children
+      # Using +:nullify+ is a Bad Idea on DynamoDB, as it has to first read, 
+      # then delete, and finally recreate each record. You should redesign your 
+      # application to user either +:delete+ (the default) or +:destroy+ instead. 
+      #
+      def has_many(children, dependent: :delete)             # :children
         children_attr = children.to_s.underscore             # "children"
         class_name = children_attr.classify                  # "Child"
         define_class_if_not_defined(class_name)
@@ -176,6 +178,10 @@ module OceanDynamo
     # into orphans. Note that we're not setting the key to NULL as this isn't possible
     # in DynamoDB. Instead, we're using the literal string "NULL".
     #
+    # Using +:nullify+ is a Bad Idea on DynamoDB, as it has to first read, then delete, and
+    # then recreate each record. You should redesign your application to user either
+    # +:delete? (the default) or +:destroy+ instead. 
+    #
     def nullify_children(child_class)
       return if new_record?
       opts = condition_options(child_class)

data/lib/ocean-dynamo/associations/relation.rb

@@ -12,7 +12,6 @@ module OceanDynamo
   #     CollectionProxy    (@association)
   #
   #
-
   class Relation
 
   	attr_reader :klass

data/lib/ocean-dynamo/attributes.rb

@@ -184,6 +184,7 @@ module OceanDynamo
         return true if value == "true"
         false
       when :datetime
+        return value.to_time(:utc) if value.is_a?(String)
         return nil if value == nil || !value.kind_of?(Time)
         value
       when :serialized

data/lib/ocean-dynamo/version.rb

@@ -1,3 +1,3 @@
 module OceanDynamo
-  VERSION = "1.2.4"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-19 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -28,30 +28,30 @@ dependencies:
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: ocean-rails
   requirement: !ruby/object:Gem::Requirement
@@ -140,18 +140,18 @@ description: "== OceanDynamo\n\nAs one important use case for OceanDynamo is to
   the conversion of SQL\ndatabases to no-SQL DynamoDB databases, it is important that
   the syntax and semantics\nof OceanDynamo are as close as possible to those of ActiveRecord.
   This includes\ncallbacks, exceptions and method chaining semantics. OceanDynamo
-  follows this pattern \nclosely and is of course based on ActiveModel.\n\nThe attribute
+  follows this pattern \nclosely and is of course based on ActiveModel.\n\n\nThe attribute
   and persistence layer of OceanDynamo is modeled on that of ActiveRecord:\nthere's
   +save+, +save!+, +create+, +update+, +update!+, +update_attributes+, +find_each+,\n+destroy_all+,
   +delete_all+, +read_attribute+, +write_attribute+ and all the other \nmethods you're
   used to. The design goal is always to implement as much of the ActiveRecord\ninterface
   as possible, without compromising scalability. This makes the task of switching
-  \nfrom SQL to no-SQL much easier.\n\nOceanDynamo uses only primary indices to retrieve
-  related table items and collections, \nwhich means it will scale without limits.\n\nOceanDynamo
-  is fully usable as an ActiveModel and can be used by Rails\ncontrollers. Thanks
-  to its structural similarity to ActiveRecord, OceanDynamo works \nwith FactoryGirl.\n\nSee
+  \nfrom SQL to no-SQL much easier.\n\n\nOceanDynamo uses only primary indices to
+  retrieve related table items and collections, \nwhich means it will scale without
+  limits.\n\n\nOceanDynamo is fully usable as an ActiveModel and can be used by Rails\ncontrollers.
+  Thanks to its structural similarity to ActiveRecord, OceanDynamo works \nwith FactoryGirl.\n\n\nSee
   also Ocean, a Rails framework for creating highly scalable SOAs in the cloud, in
-  which\nocean-dynamo is used as a central component: http://wiki.oceanframework.net"
+  which\nocean-dynamo is used as a central component: http://wiki.oceanframework.net\n"
 email:
 - peter@peterbengtson.com
 executables: []