mince_dynamo_db 0.0.5 → 1.0.0

data/Guardfile

@@ -4,6 +4,8 @@
 
 guard 'rspec', :version => 2 do
   watch(%r{^spec/lib/.+_spec\.rb$})
+  watch(%r{^lib/.+\.rb$})
+  watch(%r{^lib/mince_dynamo_db/.+\.rb$})
   watch(%r{^lib/(.+)\.rb})                            { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
   watch(%r{^spec/support/shared_examples/(.+)\.rb$})  { "spec" }

data/lib/mince_dynamo_db/data_sanitizer.rb

@@ -0,0 +1,11 @@
+module MinceDynamoDb
+  module DataSanitizer
+    def self.prepare_field_for_storage(field)
+      field.is_a?(Numeric) ? field : field.to_s
+    end
+
+    def self.prepare_hash_for_storage(hash)
+      hash.each{|key, value| hash[key] = prepare_field_for_storage(value) }
+    end
+  end
+end

data/lib/mince_dynamo_db/data_store.rb

@@ -3,6 +3,7 @@ require 'digest'
 require 'active_support/hash_with_indifferent_access'
 
 require_relative 'connection'
+require_relative 'data_sanitizer'
 
 module MinceDynamoDb # :nodoc:
   # = Mince DynamoDb Data Store
@@ -94,7 +95,7 @@ module MinceDynamoDb # :nodoc:
     # @param [Hash] hash a hash of data to be added to the collection
     def add(collection_name, hash)
       hash.delete_if{|k,v| v.nil? }
-      items(collection_name).create(hash)
+      items(collection_name).create(sanitized_hash(hash))
     end
 
     # Replaces a record in the collection based on the primary key's value.  The hash must contain a key, defined
@@ -104,7 +105,7 @@ module MinceDynamoDb # :nodoc:
     # @param [String] collection_name the name of the collection
     # @param [Hash] hash a hash to replace the record in the collection with
     def replace(collection_name, hash)
-      items(collection_name).put(hash)
+      items(collection_name).put(sanitized_hash(hash))
     end
 
     # Gets all records that have the value for a given key.
@@ -164,7 +165,7 @@ module MinceDynamoDb # :nodoc:
     # @param [*] value_to_push the value to push to the array
     def push_to_array(collection_name, identifying_key, identifying_value, array_key, value_to_push)
       item = items(collection_name).where(identifying_key.to_s => identifying_value).first
-      item.attributes.add(array_key => [value_to_push])
+      item.attributes.add(array_key => [sanitized_field(value_to_push)])
     end
 
     # Removes a value from a record's key that is an array
@@ -227,6 +228,14 @@ module MinceDynamoDb # :nodoc:
 
     private
 
+    def sanitized_field(field)
+      DataSanitizer.prepare_field_for_storage(field)
+    end
+
+    def sanitized_hash(hash)
+      DataSanitizer.prepare_hash_for_storage(hash)
+    end
+
     # Takes a DynamoDB item and returns the attributes of that item as a hash
     def to_hash(item)
       item.attributes.to_h if item

data/lib/mince_dynamo_db/version.rb

@@ -1,3 +1,3 @@
 module MinceDynamoDb
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

data/spec/lib/data_sanitizer_spec.rb

@@ -0,0 +1,40 @@
+require_relative '../../lib/mince_dynamo_db/data_sanitizer'
+
+require 'date'
+
+describe MinceDynamoDb::DataSanitizer do
+  it 'converts a Time object to a string' do
+    value = Time.now
+
+    described_class.prepare_field_for_storage(value).should == value.to_s
+    described_class.prepare_hash_for_storage({ field: value }).should == { field: value.to_s }
+  end
+
+  it 'does not convert a float' do
+    value = 3.2
+
+    described_class.prepare_field_for_storage(value).should == value
+    described_class.prepare_hash_for_storage({ field: value }).should == { field: value }
+  end
+
+  it 'does not convert a string' do
+    value = 'string'
+
+    described_class.prepare_field_for_storage(value).should == value
+    described_class.prepare_hash_for_storage({ field: value }).should == { field: value }
+  end
+
+  it 'does not convert an integer' do
+    value = 1
+
+    described_class.prepare_field_for_storage(value).should == value
+    described_class.prepare_hash_for_storage({ field: value }).should == { field: value }    
+  end
+
+  it 'converts a Date object to a string' do
+    value = Date.today
+
+    described_class.prepare_field_for_storage(value).should == value.to_s
+    described_class.prepare_hash_for_storage({ field: value }).should == { field: value.to_s }        
+  end
+end

data/spec/lib/data_store_spec.rb

@@ -9,13 +9,17 @@ describe MinceDynamoDb::DataStore do
   let(:collection_name) { 'some_collection_name'}
   let(:primary_key) { mock 'primary key'}
   let(:mock_id) { mock 'id' }
-  let(:data) { { :_id => mock_id}}
+  let(:data) { { :_id => mock_id, time_field: mock('time field')}}
+  let(:sanitized_data) { mock 'sanitized data' }
+  let(:sanitized_time) { mock 'sanitized time' }
+  let(:sanitized_id) { mock 'sanitized id' }
   let(:return_data) { mock 'return data', attributes: attributes }
   let(:attributes) { mock 'attributes', to_h: hash }
   let(:hash) { mock 'hash' }
   let(:items) { mock 'items' }
 
   before do
+    MinceDynamoDb::DataSanitizer.stub(:prepare_hash_for_storage).with(data).and_return(sanitized_data)
     MinceDynamoDb::Connection.stub(:instance => mince_dynamo_db_connection)
   end
 
@@ -45,7 +49,7 @@ describe MinceDynamoDb::DataStore do
   end
 
   it 'can write to the collection' do
-    items.should_receive(:create).with(data).and_return(return_data)
+    items.should_receive(:create).with(sanitized_data).and_return(return_data)
 
     subject.add(collection_name, data).should == return_data
   end
@@ -60,7 +64,7 @@ describe MinceDynamoDb::DataStore do
   end
 
   it 'can replace a record' do
-    items.should_receive(:put).with(data)
+    items.should_receive(:put).with(sanitized_data)
 
     subject.replace(collection_name, data)
   end
@@ -118,10 +122,13 @@ describe MinceDynamoDb::DataStore do
   end
 
   it 'can push a value to an array for a specific record' do
+    value_to_push = mock 'value to push to the record'
+    sanitized_value_to_push = mock 'sanitized value to push to the record'
+    MinceDynamoDb::DataSanitizer.stub(:prepare_field_for_storage).with(value_to_push).and_return(sanitized_value_to_push)
     items.should_receive(:where).with("key" => "value").and_return([return_data])
-    attributes.should_receive(:add).with(:array_key => ["value_to_push"])
+    attributes.should_receive(:add).with(:array_key => [sanitized_value_to_push])
 
-    subject.push_to_array(collection_name, :key, "value", :array_key, "value_to_push")
+    subject.push_to_array(collection_name, :key, "value", :array_key, value_to_push)
   end
 
   it 'can remove a value from an array for a specific record' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mince_dynamo_db
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000 Z
+date: 2012-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -123,11 +123,13 @@ files:
 - Rakefile
 - lib/mince_dynamo_db.rb
 - lib/mince_dynamo_db/connection.rb
+- lib/mince_dynamo_db/data_sanitizer.rb
 - lib/mince_dynamo_db/data_store.rb
 - lib/mince_dynamo_db/version.rb
 - mince_dynamo_db.gemspec
 - spec/integration/persisting_to_dynamodb_test.rb
 - spec/lib/connection_spec.rb
+- spec/lib/data_sanitizer_spec.rb
 - spec/lib/data_store_spec.rb
 - spec/support/aws_example.yml
 homepage: https://github.com/coffeencoke/mince_dynamo_db
@@ -157,6 +159,7 @@ summary: Lightweight ORM for Amazon's DynamoDB with Ruby Apps
 test_files:
 - spec/integration/persisting_to_dynamodb_test.rb
 - spec/lib/connection_spec.rb
+- spec/lib/data_sanitizer_spec.rb
 - spec/lib/data_store_spec.rb
 - spec/support/aws_example.yml
 has_rdoc: