dynamodb_framework 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43c68b4046339dcf1497fd9b227b2b28856c281e
-  data.tar.gz: cd4cccc048de83ac5b7d3f793cedf90be72ad18c
+  metadata.gz: 318aa80e8817e3654c1b398b6ae5610c6306ed1f
+  data.tar.gz: 23223e4bdf089ff9257a0501c01ae8c1eaa39538
 SHA512:
-  metadata.gz: 18566e0f81953f9f6956e813a15340cb15e8d937247773a91a0895e7106e2022587cf629d8b0d5ae13cd7b48e41bccf98aa90fde3f74972ac56666e11267ff1d
-  data.tar.gz: 7ee89bb2e01f23de3ff65f3c6a157db3a3f1d5faf3384c92a22613c3bd2b5a20594fc08747ab6493a305948a1c976d632a4824786114efc488340011b54f333d
+  metadata.gz: c32e535abdaea1c5361947f781ef81e6db62061840be50f97048a7ea8d4e8ecafe4479a9a43edf04c5eb44847fdddcfdc864332e08f0791bb89be2fdaf7e02d5
+  data.tar.gz: 154e6bb5af6b03eb69d692a94bd5e67e6e10fa28b8caee2247baaa320e01a8744201e0f5ecba6b4a5c1f949972516faec7815defd50d31cf809af7c70243ff43

data/.idea/.rakeTasks

@@ -4,4 +4,4 @@ You are allowed to:
 1. Remove rake task
 2. Add existing rake tasks
 To add existing rake tasks automatically delete this file and reload the project.
---><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build dynamodb_framework-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install dynamodb_framework-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install dynamodb_framework-0.1.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.1.0 and build and push dynamodb_framework-0.1.0.gem to Rubygems" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build dynamodb_framework-1.2.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install dynamodb_framework-1.2.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install dynamodb_framework-1.2.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v1.2.0 and build and push dynamodb_framework-1.2.0.gem to Rubygems" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/Gemfile

@@ -3,4 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in dynamodb_framework.gemspec
 gemspec
 
+group :test, :development do
+  gem 'yard'
+end
 
+group :test do
+  gem 'simplecov', :require => false
+end

data/README.md

@@ -250,6 +250,15 @@ Before calling any methods from the repository the **.table_name** attribute mus
 ### #put
 This method is called to insert an item into a DynamoDb table.
 
+*Note*: 
+
+         [DateTime] attributes will be stored as an ISO8601 string
+         
+         [Time] attributes will be stored as an Epoch Int
+
+The intent is that if you need to sort in dynamo by dates, then make sure you use a [Time] type. The Epoch int allows 
+you to compare properly as comparing date strings are not reliable.
+
 **Params**
 
  - **item** [Object] [Required] The document to store within the table.

data/lib/dynamodb_framework/dynamodb_repository.rb

@@ -11,8 +11,12 @@ module DynamoDbFramework
       @dynamodb = store
     end
 
+    # Store the hash of an object to the dynamodb table
+    # *Note* : [DateTime] attributes will be stored as an ISO8601 string
+    #          [Time] attributes will be stored as an Epoch Int
+    # The intent is that if you need to sort in dynamo by dates, then make sure you use a [Time] type. The Epoch int allows
+    # you to compare properly as comparing date strings are not reliable.
     def put(item)
-
       hash = to_hash(item)
 
       clean_hash(hash)
@@ -196,14 +200,27 @@ module DynamoDbFramework
       @hash_helper ||= HashHelper.new
     end
 
+    # Convert empty string values to nil, as well as convert DateTime and Time to appropriate storage formats.
     def clean_hash(hash)
       hash.each do |key, value|
         if value == ''
           hash[key] = nil
+        elsif value.is_a?(Array)
+          value.each do |item|
+            clean_hash(item) if item.is_a?(Hash)
+          end
+        elsif [DateTime, Time].include?(value.class)
+          hash[key] = convert_date(value)
         elsif value.is_a?(Hash)
           clean_hash(value)
         end
       end
     end
+
+    def convert_date(value)
+      klass = value.class
+      return value.iso8601 if klass == DateTime
+      return value.to_i if klass == Time
+    end
   end
 end

data/lib/dynamodb_framework/version.rb

@@ -1,3 +1,3 @@
 module DynamoDbFramework
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/yard.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/bash
+
+yard stats --list-undoc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb_framework
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,6 +135,7 @@ files:
 - script/restart.sh
 - script/start.sh
 - script/stop.sh
+- yard.sh
 homepage: https://github.com/vaughanbrittonsage/dynamodb_framework
 licenses:
 - MIT
@@ -161,4 +162,3 @@ specification_version: 4
 summary: A lightweight framework to provide managers for working with aws dynamodb
   (incuding local version).
 test_files: []
-has_rdoc: