ocean-dynamo 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74c7e10d51de039a64fc18d60408e3a1a0c9b7f4
-  data.tar.gz: e71adf734d5c6cbde2b2ade2b0b251514c2a9abc
+  metadata.gz: 5e10e3f4a197a97537b6afa0eee14b831c6fbacf
+  data.tar.gz: af58bdb937981f25306d6db7c7b43da97cfd8217
 SHA512:
-  metadata.gz: b50cc6aeac65b2a4c1f51e390e0f6d443559507bffcee8f9a13aee347e0e8b06e4aa49d10af2afec8787a6ada8eb82f6902089b68835d07a380444813b8ad0cb
-  data.tar.gz: a12992af3f67eb5d237096e9877506b9ba0b01d101b4c7e2a8e37ad51c8c80c8f07812fc19cc7c3cc61bb70e69c398041a8169a9b8db90f4032e853a4278f88a
+  metadata.gz: 87f23170e015fb2592d98e43ed264f06d97e1c147c01be3d006601b7159871be36b4a98e591e2baaa5693964fd2040c1441de873d897c60cb1cb621545d14c17
+  data.tar.gz: 5649dbf1e4513a19af1387566531fa64f10ce04c70910d0e0970c3d19e0d3b0cfe26144d0bac103d8373c1f663c91c01afd3d2f78fd9087a5f9dedadda05dc58

data/README.rdoc

@@ -8,6 +8,11 @@ OceanDynamo requires Ruby 2.0 and Ruby on Rails 4.0.0 or later.
 {<img src="https://badge.fury.io/rb/ocean-dynamo.png" alt="Gem Version" />}[http://badge.fury.io/rb/ocean-dynamo]
 
 
+==== Installation
+
+ gem install ocean-dynamo
+
+
 ==== Features
 
 As one important use case for OceanDynamo is to facilitate the conversion of SQL based
@@ -31,6 +36,48 @@ which means it will scale without limits. (NB: this is a pre-release which as ye
 implement relations, but they are underway.)
 
 
+==== Example
+
+The following example shows the syntax. 
+
+  class AsyncJob < OceanDynamo::Base
+
+    dynamo_schema do
+      attribute :credentials,          :string
+      attribute :token
+      attribute :steps,                :serialized, default: []
+      attribute :max_seconds_in_queue, :integer,    default: 1.day
+      attribute :default_poison_limit, :integer,    default: 5
+      attribute :default_step_time,    :integer,    default: 30
+      attribute :started_at,           :datetime
+      attribute :last_completed_step,  :integer
+      attribute :finished_at,          :datetime
+      attribute :destroy_at,           :datetime
+      attribute :created_by
+      attribute :updated_by
+      attribute :succeeded,            :boolean,    default: false
+      attribute :failed,               :boolean,    default: false
+      attribute :poison,               :boolean,    default: false
+    end
+    
+  end
+
+Each attribute has a name, a type (:string, :integer, :float, :datetime, :boolean, or 
+:serialized) where :string is the default. Each attribute also optionally has a default 
+value, which can be a Proc.
+
+The :string, :integer, :float and :datetime types can also store sets of their type.
+Sets are represented as arrays and may not contain duplicates and may not be empty.
+
+All attributes except the :string type can take the value nil. Storing nil for a string
+value will return the empty string, "".
+
+Also, dynamo_schema takes args and many options. Detailed documentation is forthcoming.
+
+At the moment, OceanDynamo is fully usable as an ActiveModel and can be used by Rails
+controllers. Relations are not yet implemented.
+
+
 === Documentation
 
 * Ocean-dynamo gem API: http://rdoc.info/github/OceanDev/ocean-dynamo/frames
@@ -93,10 +140,6 @@ The Rails console is available from the built-in dummy application:
  cd spec/dummy
  rails console
 
-You may need to initialise the table connection (for each table):
-
- CloudModel.establish_db_connection
-
 This will, amongst other things, also create the CloudModel table if it doesn't already
 exist. On Amazon, this will take a little while. With +fake_dynamo+, it's practically
 instant.

data/lib/ocean-dynamo/attributes.rb

@@ -30,6 +30,26 @@ module OceanDynamo
     end
 
 
+    def [](attribute)
+      read_attribute attribute
+    end
+
+
+    def []=(attribute, value)
+      write_attribute attribute, value
+    end
+
+
+    def id
+      read_attribute(table_hash_key)
+    end
+
+
+    def id=(value)
+      write_attribute(table_hash_key, value)
+    end
+
+
     def read_attribute_for_validation(key)
       @attributes[key.to_s]
     end
@@ -55,6 +75,28 @@ module OceanDynamo
     end
 
 
+    def to_key
+      return nil unless persisted?
+      key = respond_to?(:id) && id
+      return nil unless key
+      table_range_key ? [key, read_attribute(table_range_key)] : [key]
+    end
+
+
+    def assign_attributes(values)
+      return if values.blank?
+      values = values.stringify_keys
+      # if values.respond_to?(:permitted?)
+      #   unless values.permitted?
+      #     raise ActiveModel::ForbiddenAttributesError
+      #   end
+      # end
+      values.each do |k, v|
+        _assign_attribute(k, v)
+      end
+    end
+
+
     def type_cast_attribute_for_write(name, value, metadata=fields[name],
                                       type: metadata[:type])
       case type
@@ -161,52 +203,9 @@ module OceanDynamo
     end
 
 
-    def [](attribute)
-      read_attribute attribute
-    end
-
-
-    def []=(attribute, value)
-      write_attribute attribute, value
-    end
-
-
-    def id
-      read_attribute(table_hash_key)
-    end
-
-
-    def id=(value)
-      write_attribute(table_hash_key, value)
-    end
-
-
-    def to_key
-      return nil unless persisted?
-      key = respond_to?(:id) && id
-      return nil unless key
-      table_range_key ? [key, read_attribute(table_range_key)] : [key]
-    end
-
-
-    def assign_attributes(values)
-      return if values.blank?
-      values = values.stringify_keys
-      # if values.respond_to?(:permitted?)
-      #   unless values.permitted?
-      #     raise ActiveModel::ForbiddenAttributesError
-      #   end
-      # end
-      values.each do |k, v|
-        #send("#{k}=", v)
-        _assign_attribute(k, v)
-      end
-    end
-
-
     private
 
-    def _assign_attribute(k, v)
+    def _assign_attribute(k, v) # :nodoc:
       public_send("#{k}=", v)
     rescue ActiveModel::NoMethodError
       if respond_to?("#{k}=")
@@ -219,7 +218,7 @@ module OceanDynamo
 
     protected
 
-    def evaluate_default(default, type)
+    def evaluate_default(default, type) # :nodoc:
       return default.call if default.is_a?(Proc)
       return "" if default == nil && type == :string
       return default.clone if default.is_a?(Array) || default.is_a?(String)   # Instances need their own copies

data/lib/ocean-dynamo/persistence.rb

@@ -75,7 +75,8 @@ module OceanDynamo
 
     def save!(options={})
       if perform_validations(options)
-        create_or_update || raise(RecordNotSaved)
+        options[:validate] = false
+        create_or_update(options) || raise(RecordNotSaved)
       else
         raise RecordInvalid.new(self)
       end
@@ -94,14 +95,14 @@ module OceanDynamo
     end
 
 
-    def create_or_update
-      result = new_record? ? create : update
+    def create_or_update(options={})
+      result = new_record? ? create(options) : update(options)
       result != false
     end
 
 
-    def create
-      return false unless valid?(:create)
+    def create(options={})
+      return false if options[:validate] != false && !valid?(:create)
       run_callbacks :commit do
         run_callbacks :save do
           run_callbacks :create do
@@ -118,8 +119,8 @@ module OceanDynamo
     end
 
 
-    def update
-      return false unless valid?(:update)
+    def update(options={})
+      return false if options[:validate] != false && !valid?(:update)
       run_callbacks :commit do
         run_callbacks :save do
           run_callbacks :update do
@@ -189,13 +190,13 @@ module OceanDynamo
     end
 
 
-    def dynamo_persist
+    def dynamo_persist # :nodoc:
       @dynamo_item = dynamo_items.put(serialized_attributes)
       @new_record = false
     end
 
 
-    def post_instantiate(item, consistent)
+    def post_instantiate(item, consistent) # :nodoc:
       @dynamo_item = item
       @new_record = false
       assign_attributes(deserialized_attributes(

data/lib/ocean-dynamo/schema.rb

@@ -1,6 +1,38 @@
 module OceanDynamo
   class Base
 
+
+    def self.dynamo_schema(table_hash_key=:uuid, table_range_key=nil,
+                           table_name: compute_table_name,
+                           table_name_prefix: nil,
+                           table_name_suffix: nil,
+                           read_capacity_units: 10,
+                           write_capacity_units: 5,
+                           connect: true,
+                           &block)
+      # Set class vars
+      self.dynamo_client = nil
+      self.dynamo_table = nil
+      self.dynamo_items = nil
+      self.table_hash_key = table_hash_key
+      self.table_range_key = table_range_key
+      self.table_name = table_name
+      self.table_name_prefix = table_name_prefix
+      self.table_name_suffix = table_name_suffix
+      self.table_read_capacity_units = read_capacity_units
+      self.table_write_capacity_units = write_capacity_units
+      # Init
+      self.fields = HashWithIndifferentAccess.new
+      attribute table_hash_key, :string, default: ''
+      DEFAULT_ATTRIBUTES.each { |name, type, **pairs| attribute name, type, **pairs }
+      block.call
+      # Connect to AWS
+      establish_db_connection if connect
+      # Finally return the full table name
+      table_full_name
+    end
+
+
     def self.set_table_name(name)
       self.table_name = name
       true
@@ -29,24 +61,6 @@ module OceanDynamo
     end
 
 
-    #
-    # This is where the class is initialized
-    #
-    def self.primary_key(hash_key, range_key=nil)
-      self.dynamo_client = nil
-      self.dynamo_table = nil
-      self.dynamo_items = nil
-      self.table_name = compute_table_name
-      self.table_name_prefix = nil
-      self.table_name_suffix = nil
-      self.fields = HashWithIndifferentAccess.new
-      self.table_hash_key = hash_key
-      self.table_range_key = range_key
-      DEFAULT_ATTRIBUTES.each { |k, name, **pairs| attribute k, name, **pairs }
-      nil
-    end
-
-
     def self.read_capacity_units(units)
       self.table_read_capacity_units = units
     end

data/lib/ocean-dynamo/version.rb

@@ -1,3 +1,3 @@
 module OceanDynamo
-  VERSION = "0.1.13"
+  VERSION = "0.1.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Peter Bengtson