ocean-dynamo 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e5d649565fd30bee32f1b8d80c7f6117009229e
-  data.tar.gz: e281cb72d49607d53e9ddd7053462f50c29b0604
+  metadata.gz: 2fb7536da67529e55053f4d69555c8da40c90caf
+  data.tar.gz: 05bd66e0d69782c47bdcc8f7c9dff93ee2ddcd64
 SHA512:
-  metadata.gz: cf608c59e414e273d9e13cf30070e3e2c3ba6ef79e343900b66d7fc1dbc08dd903332fe9297310fbebb5dbc1c9050957130178fe864dafc316ced76e397c629c
-  data.tar.gz: 708e7170927244786d84e20bc2b7ffc99206263d210f3fe4e73ee4306be3bb659b1383b01cb9631b91ef85c4d378a03947a28b3a4cb60f3f5dbbf896c99c34cf
+  metadata.gz: 24cef1a99d5517f5ef77f93502b355e012faa1bff8b8fa1f04368e362e0c55fb849cee1db90119b4badace1497f17aaa9a0ca23f74e7e06f30c5ac04dc9f0263
+  data.tar.gz: ccf031cc32f7807a6a1231f6e83b816e813657e3352a4b0b302b7b458fe60457367f674d2567cfdca64841c785e11628239de370402225098ff6eb7657e3502b

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2016 Peter Bengtson
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -30,6 +30,8 @@ OceanDynamo is fully usable as an ActiveModel and can be used by Rails
 controllers. Thanks to its structural similarity to ActiveRecord, OceanDynamo works 
 with FactoryGirl.
 
+OceanDynamo supports optimistic record locking via a combination of DynamoDB conditional 
+writes and atomic updates. This is activated by default.
 
 === Current State
 
@@ -48,14 +50,11 @@ with FactoryGirl.
 
 === Current use
 
-OceanDynamo is used as a central component in Ocean, a Rails framework and development 
-pipeline for creating massively scalable HATEOAS microservice SOAs in the cloud.
+OceanDynamo is used as a central component in Ocean, a Rails framework and development,
+testing, and production 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. 
-It will be used increasingly as features are added to OceanDynamo and will eventually 
-replace all ActiveRecord tables in Ocean. 
-
 However, OceanDynamo can of course also be used stand-alone.
 
 
@@ -139,6 +138,15 @@ value will return the empty string, <tt>""</tt>.
    ...
    ...
  end
+ 
+Tip: you might want to use the following idiom when declaring a +dynamo_schema+. It is used everywhere in Ocean:
+ 
+ dynamo_schema(:id, table_name_suffix: Api.basename_suffix, 
+                    create: Rails.env != "production") do
+   ...
+ end
+ 
+This will auto-create the DynamoDB table in all environments except production, and it will also add a suffix to the table name in order to prevent tests from colliding. Cf +Api.basename_suffix+ in the +ocean-rails+ gem for more information.
 
 == +has_many+ and +belongs_to+
 
@@ -176,6 +184,7 @@ is required as the Topic class itself has a +belongs_to+ relation and thus has
 a composite key. This must be declared in the child class as it needs to know
 how to retrieve its parent.
 
+
 === Restrictions
 
 Restrictions for +belongs_to+ tables: 
@@ -190,6 +199,7 @@ Restrictions for +has_many+ tables:
 These restrictions allow OceanDynamo to implement the +has_many+ / +belongs_to+ 
 relation in a very efficient and massively scalable way. 
 
+
 === Implementation
 
 +belongs_to+ claims the range key and uses it to store its own id, which normally
@@ -358,36 +368,6 @@ With DynamoDB Local running, you should now be able to do
 
 All tests should pass.
 
-
-=== Cleaning up the DB
-
-You might want to add the following to your spec_helper.rb file, before the +RSpec.configure+
-block:
-
-  # DynamoDB table cleaner
-  CHEF_ENV = "master" unless defined?(CHEF_ENV)
-  regexp = Regexp.new("^.+_#{CHEF_ENV}_[0-9]{1,3}-[0-9]{1,3}-[0-9]{1,3}-[0-9]{1,3}_test$")
-  cleaner = lambda { 
-    c = Aws::DynamoDB::Client.new
-    c.list_tables.table_names.each do |t| 
-      begin
-        c.delete_table({table_name: t}) if t =~ regexp
-      rescue Aws::DynamoDB::Errors::LimitExceededException
-        sleep 1
-        retry
-      end
-    end
-  }
-
-Then, inside the +RSpec.configure+ block:
-
-  config.before(:suite) { cleaner.call }
-  config.after(:suite) { cleaner.call }
-
-This will remove only those test tables created by the specs on this particular machine and
-environment. This is safe even on AWS and in parallel with other machines.
-
-
 == Rails console
 
 The Rails console is available from the built-in dummy application:

data/lib/ocean-dynamo/attributes.rb

@@ -124,7 +124,7 @@ module OceanDynamo
       if fields.has_key?(attr_name)
         @attributes[attr_name]
       else
-        raise ActiveModel::MissingAttributeError, "can't read unknown attribute '#{attr_ name}"
+        raise ActiveModel::MissingAttributeError, "can't read unknown attribute '#{attr_name}"
       end
     end
 

data/lib/ocean-dynamo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2017-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -158,7 +158,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- LICENSE
 - README.rdoc
 - Rakefile
 - config/routes.rb
@@ -189,7 +189,7 @@ files:
 - lib/ocean-dynamo/version.rb
 homepage: https://github.com/OceanDev/ocean-dynamo
 licenses:
-- MIT
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2013 Peter Bengtson
-
-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.