dynamini 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7670b7c7034d305b27556e8308071bce377fb070
-  data.tar.gz: b390eaed2526efccbfa2abefcf304980999c2201
+  metadata.gz: 375aefa0350dd33fcd702b47d06896ffad78b986
+  data.tar.gz: b8159e0743eb229c6c93e5ea27e2cb45ef3147c0
 SHA512:
-  metadata.gz: f2b7b0109bb0ad3b278719c886d5c97122a6dd2551a25fab863746bd20930b102206ba3b88bf9a2f1db79ab4ce4a3a2186982d1d4f6143ad694601043d37be48
-  data.tar.gz: b9adb969dd713d8cb86254e23b245c16ac1b2bbf27da03af0bdbebe57a03cc4b486d7b974b39990db8f403c4e13af1197295d8fb637ffa1e8e7ce14208106ca7
+  metadata.gz: b3c7ac2347cafdcdad0e67d54c3cfaac1fbc94a34324b9dc43e9dcc83831e13b2c0423af95f01c434db677600f5ecb81547968845efed78288243675c24193ab
+  data.tar.gz: 4bba1206df754d28ceddae3e7fe09214561a6368bd52c07d21da40628c36c9b90732a4bdc6c2b5c3836451c11f03abe1d7965f9f10f71ad7ea01d0b3bc91e5b9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dynamini (2.0.1)
+    dynamini (2.1.1)
       activemodel (>= 3, < 5.0)
       aws-sdk (~> 2)
 
@@ -99,6 +99,3 @@ DEPENDENCIES
   guard-shell
   pry (~> 0)
   rspec (~> 3)
-
-BUNDLED WITH
-   1.11.2

data/README.md

@@ -175,13 +175,13 @@ Vehicle.find('H3LLO').stuff
 ```
 
 ## Testing
-There's a test client included with this gem, meaning you don't have to connect to a real Dynamo instance when testing.
-You could also use this in development if you dont have a real Dynamo instance yet, but the data saved to it won't persist through a server restart.
-To activate this feature, just do:
+We've included an optional in-memory test client, so you don't necessarily have to connect to a real Dynamo instance when running tests. You could also use this in your development environment if you don't have a real Dynamo instance yet, but the data saved to it won't persist through a server restart.
+
+To activate this feature, just require the testing module:
 ```ruby
 require 'dynamini/testing'
 ```
-After which any internal API calls will be replaced with calls to Dynamini::TestClient.
+This module replaces all API calls Dynamini makes to AWS DynamoDB with calls to Dynamini::TestClient.
 
 The test client will not reset its database unless you tell it to, like so:
 ```ruby
@@ -205,9 +205,6 @@ config.after(:each) {
 * If you use non-numeric strings for your primary key, remember to change your foreign key columns on related objects to be string type.
 * You might want to conditionally set the table name for your model based on the Rails.env, enabling separate tables for development and production.
 
-## Coming Soon
-* Conditional updates ( http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html )
-
 ## Contributing
 
 If you'd like to contribute, pull requests are welcome!

data/dynamini.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'dynamini'
-  s.version = '2.0.1'
+  s.version = '2.1.1'
   s.summary = 'DynamoDB interface'
   s.description = 'Lightweight DynamoDB interface gem designed as
                    a drop-in replacement for ActiveRecord.

data/lib/dynamini/querying.rb

@@ -1,5 +1,6 @@
 module Dynamini
   module Querying
+    OPTIONAL_QUERY_PARAMS = [:limit, :scan_index_forward]
 
     def find(hash_value, range_value = nil)
       fail 'Range key cannot be blank.' if range_key && range_value.nil?
@@ -51,11 +52,13 @@ module Dynamini
       expression_attribute_values = build_expression_attribute_values(args)
       key_condition_expression = build_key_condition_expression(args)
 
-      client.query(
-          table_name: table_name,
-          key_condition_expression: key_condition_expression,
-          expression_attribute_values: expression_attribute_values
-      )
+      client.query(set_extra_parameters(
+                     {
+                       table_name: table_name,
+                       key_condition_expression: key_condition_expression,
+                       expression_attribute_values: expression_attribute_values
+                     },
+                     args))
     end
 
     def build_expression_attribute_values(args)
@@ -78,6 +81,11 @@ module Dynamini
       expression
     end
 
+    def set_extra_parameters(hash, args)
+      extras = args.select { |k, v| OPTIONAL_QUERY_PARAMS.include? k }
+      hash.merge!(extras)
+    end
+
     def validate_query_values(hash_value, range_value)
       fail 'Key cannot be blank.' if (hash_value.nil? || hash_value == '')
       fail 'Range key cannot be blank.' if range_key && range_value.nil?

data/lib/dynamini/test_client.rb

@@ -124,6 +124,8 @@ module Dynamini
       selected = parent.values
       selected = selected.select{ |item| item[@range_key_attr] >= start_val.to_f } if start_val
       selected = selected.select{ |item| item[@range_key_attr] <= end_val.to_f } if end_val
+      selected = selected.sort! { |a,b| b[@range_key_attr] <=> a[@range_key_attr] } if args[:scan_index_forward] == false
+      selected = selected[0...args[:limit]] if args[:limit]
 
       OpenStruct.new(items: selected)
     end

data/spec/dynamini/querying_spec.rb

@@ -4,10 +4,10 @@ describe Dynamini::Querying do
 
   let(:model_attributes) {
     {
-        name: 'Widget',
-        price: 9.99,
-        id: 'abcd1234',
-        hash_key: '009'
+      name: 'Widget',
+      price: 9.99,
+      id: 'abcd1234',
+      hash_key: '009'
     }
   }
 
@@ -104,6 +104,31 @@ describe Dynamini::Querying do
         expect(TestClassWithRange.query(hash_key: 'non-existent key')).to eq([])
       end
     end
+
+    context 'when :limit is provided' do
+      it 'should return only the first two records' do
+        records = TestClassWithRange.query(hash_key: 'foo', limit: 2)
+        expect(records.length).to eq 2
+        expect(records.first.bar).to eq 1
+        expect(records.last.bar).to eq 2
+      end
+    end
+
+    context 'when :scan_index_forward is provided' do
+      it 'should return records in order when given true' do
+        records = TestClassWithRange.query(hash_key: 'foo', scan_index_forward: true)
+        expect(records.length).to eq 4
+        expect(records.first.bar).to eq 1
+        expect(records.last.bar).to eq 4
+      end
+
+      it 'should return records in reverse order when given false' do
+        records = TestClassWithRange.query(hash_key: 'foo', scan_index_forward: false)
+        expect(records.length).to eq 4
+        expect(records.first.bar).to eq 4
+        expect(records.last.bar).to eq 1
+      end
+    end
   end
 
   describe '.exists?' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamini
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Greg Ward
@@ -15,110 +15,110 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-shell
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: |-
@@ -130,9 +130,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -170,17 +170,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: DynamoDB interface