dynamini 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc4e5ccebe6f491cae52d735aa59d15b307e93ab
-  data.tar.gz: fc6340c78b0597b67c870e4aa75837c38e2d7c2f
+  metadata.gz: 4966ab1242cf3fffce9c1282d02f71c87e9c143f
+  data.tar.gz: e9e93317d5d05ae0589ef6f1c01a67325bdc9b4f
 SHA512:
-  metadata.gz: f75b4504629a2dbcd718c0fb5c150a7c9911cbd255046fbc180704c13f7350d409beb2567939f4c1ace8d808692ed1ac7d835e615c09f8719f3657a81159ecdc
-  data.tar.gz: dd4b0336585dfb376f51f4a142a278aaaa8814713aa5c363b50928c70b4ee20ee85d9ec14e6c48ec62581e30789b9e78c54b664b7f4bca1f5b2554943f76fe53
+  metadata.gz: 4c971de76f66f13bb5df42b644ba170230d68c07da574d3bed1ecec0a2294984a7fc0eae73bf7d0ea1dead39586a37aaf584df5db3e539503541f7108258a461
+  data.tar.gz: a141f1ead3c262ac92274aade2eb0aadf135054bc302ace6a0b7cda74a6f0f229d90917d6148c6fa30447267ee0a1a1f6245be6ae92f87f40f5880b2c9c3f0d3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dynamini (2.2.0)
+    dynamini (2.2.1)
       activemodel (>= 3, < 5.0)
       aws-sdk (~> 2)
 

data/dynamini.gemspec

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

data/lib/dynamini/querying.rb

@@ -51,10 +51,12 @@ module Dynamini
     def dynamo_query(args)
       expression_attribute_values = build_expression_attribute_values(args)
       key_condition_expression = build_key_condition_expression(args)
+      expression_attribute_names = build_expression_attribute_names(args)
       query = set_extra_parameters(
           {
-              table_name: table_name,
+          table_name: table_name,
           key_condition_expression: key_condition_expression,
+          expression_attribute_names: expression_attribute_names,
           expression_attribute_values: expression_attribute_values
       },
           args)
@@ -69,14 +71,21 @@ module Dynamini
       expression_values
     end
 
+    def build_expression_attribute_names(args)
+      expression_values = {}
+      expression_values['#H'] = current_index_hash_key(args)
+      expression_values['#R'] = current_index_range_key(args) if args[:end] || args[:start]
+      expression_values
+    end
+
     def build_key_condition_expression(args)
-      expression = "#{current_index_hash_key(args)} = :h"
+      expression = "#H = :h"
       if args[:start] && args[:end]
-        expression += " AND #{current_index_range_key(args)} BETWEEN :s AND :e"
+        expression += " AND #R BETWEEN :s AND :e"
       elsif args[:start]
-        expression += " AND #{current_index_range_key(args)} >= :s"
+        expression += " AND #R >= :s"
       elsif args[:end]
-        expression += " AND #{current_index_range_key(args)} <= :e"
+        expression += " AND #R <= :e"
       end
       expression
     end

data/lib/dynamini/test_client.rb

@@ -106,15 +106,18 @@ module Dynamini
       # "foo = val AND bar >= val2"
       # "foo = val AND bar BETWEEN val2 AND val3"
 
-      args[:expression_attribute_values].each do |symbol, value|
-        args[:key_condition_expression].gsub!(symbol, value.to_s)
-      end
+      attr_placeholders = args[:expression_attribute_values].merge(args[:expression_attribute_names])
+      attr_placeholders.each { |symbol, value| args[:key_condition_expression].gsub!(symbol, value.to_s) }
 
       tokens = args[:key_condition_expression].split(/\s+/)
+
+      hash_key_name, range_key_name = determine_hash_and_range(args)
+
+      inspect_for_correct_keys?(tokens, hash_key_name, range_key_name)
       start_val, end_val = range_key_limits(tokens)
 
       if args[:index_name]
-        secondary_index_query(args)
+        secondary_index_query(args, start_val, end_val)
       else
         hash_key = hash_key_value(args).is_a?(Integer) ? tokens[2].to_i : tokens[2]
 
@@ -126,6 +129,15 @@ module Dynamini
       end
     end
 
+    def determine_hash_and_range(args)
+      if args[:index_name]
+        index = secondary_index[args[:index_name].to_s]
+        [index[:hash_key_name].to_s, index[:range_key_name].to_s]
+      else
+        [@hash_key_attr.to_s, @range_key_attr.to_s]
+      end
+    end
+
     def range_key_limits(tokens)
       case tokens[5]
         when ">=" then [tokens[6], nil]
@@ -144,14 +156,10 @@ module Dynamini
       records
     end
 
-
-    def secondary_index_query(args = {})
-      index = secondary_index[args[:index_name]]
+    def secondary_index_query(args = {}, start_val = nil, end_val = nil)
+      index = secondary_index[args[:index_name].to_s]
       table = get_table(args[:table_name])
 
-      tokens = args[:key_condition_expression].split(/\s+/)
-      start_val, end_val = range_key_limits(tokens)
-
       records = @range_key_attr ? get_values(table) : table.values
       selected = sort_records(records, index, args, start_val, end_val)
       OpenStruct.new(items: selected)
@@ -214,5 +222,16 @@ module Dynamini
 
       attribute_hash
     end
+
+    def inspect_for_correct_keys?(tokens, hash_key_name, range_key_name)
+      missed_keys = []
+      missed_keys << hash_key_name unless tokens[0] == hash_key_name
+      missed_keys << range_key_name unless (tokens.length < 4 || tokens[4] == range_key_name)
+      raise missed_key_dynamodb_error(missed_keys) if missed_keys.length > 0
+    end
+
+    def missed_key_dynamodb_error(missed_keys)
+      Aws::DynamoDB::Errors::ValidationException.new(400,"Query condition missed key schema element: #{missed_keys.join(', ')}")
+    end
   end
 end

data/spec/dynamini/querying_spec.rb

@@ -105,7 +105,7 @@ describe Dynamini::Querying do
 
     context 'hash key does not exist' do
       it 'should return an empty array' do
-        expect(TestClassWithRange.query(hash_key: 'non-existent key')).to eq([])
+        expect(TestClassWithRange.query(hash_key: 'non-existent-key')).to eq([])
       end
     end
 
@@ -178,9 +178,8 @@ describe Dynamini::Querying do
       end
 
       it 'should return no results if none are found with the secondary index' do
-        expect(TestClassWithRange.query(hash_key: 'non-existent key', index_name: :secondary_index)).to eq([])
+        expect(TestClassWithRange.query(hash_key: 'non-existent-key', index_name: :secondary_index)).to eq([])
       end
-
     end
   end
 

data/spec/dynamini/test_client_spec.rb

@@ -112,7 +112,8 @@ describe Dynamini::TestClient do
         test_client.update_item(table_name: 'integer_table', key: {hash_key_field: 1, range_key_field: 1}, attribute_updates: {abc: {value: 'abc', action: 'PUT'}})
         response = test_client.query(
           table_name: 'integer_table',
-          key_condition_expression: "hash_key_field = :h",
+          key_condition_expression: "#H = :h",
+          expression_attribute_names: {'#H' => 'hash_key_field'},
           expression_attribute_values: {
             ":h" => 1
           }
@@ -123,11 +124,12 @@ describe Dynamini::TestClient do
       end
     end
 
-    context 'with LE operator' do
+    context 'with LE operator' do # broken
       it 'should return all items with range key less than or equal to the provided value' do
         response = test_client.query(
           table_name: table_name,
-          key_condition_expression: "hash_key_field = :h AND user_id <= :e",
+          key_condition_expression: "#H = :h AND #R <= :e",
+          expression_attribute_names: {'#H' => 'hash_key_field', '#R' => 'range_key_field'},
           expression_attribute_values: {
             ":h" => 'foo',
             ":e" => 2
@@ -143,7 +145,8 @@ describe Dynamini::TestClient do
       it 'should return all items with range key greater than or equal to the provided value' do
         response = test_client.query(
           table_name: table_name,
-          key_condition_expression: "hash_key_field = :h AND user_id >= :s",
+          key_condition_expression: "#H = :h AND #R >= :s",
+          expression_attribute_names: {'#H' => 'hash_key_field', '#R' => 'range_key_field'},
           expression_attribute_values: {
             ":h" => 'foo',
             ":s" => 2
@@ -159,7 +162,8 @@ describe Dynamini::TestClient do
       it 'should return all items with range key between the provided values' do
         response = test_client.query(
           table_name: table_name,
-          key_condition_expression: "hash_key_field = :h AND user_id BETWEEN :s AND :e",
+          key_condition_expression: "#H = :h AND #R BETWEEN :s AND :e",
+          expression_attribute_names: {'#H' => 'hash_key_field', '#R' => 'range_key_field'},
           expression_attribute_values: {
             ":h" => 'foo',
             ":s" => 2,
@@ -176,7 +180,8 @@ describe Dynamini::TestClient do
       it 'should return all items with range key between the provided values' do
         response = test_client.query(
           table_name: table_name,
-          key_condition_expression: "hash_key_field = :h",
+          key_condition_expression: "#H = :h",
+          expression_attribute_names: {'#H' => 'hash_key_field'},
           expression_attribute_values: {
             ":h" => 'foo'
           }
@@ -187,6 +192,31 @@ describe Dynamini::TestClient do
       end
     end
 
+    context 'with invalid expression_attribute_names' do
+      it 'should raise an error about an invalid hash_key' do
+        expect{ test_client.query(
+          table_name: table_name,
+          key_condition_expression: "#H = :h",
+          expression_attribute_names: {'#H' => 'not_hash_key_field'},
+          expression_attribute_values: {
+            ':h' => 'foo'
+          }
+        ) }.to raise_error(Aws::DynamoDB::Errors::ValidationException, "Query condition missed key schema element: hash_key_field")
+      end
+
+      it 'should raise an error about an invalid range_key' do
+        expect{ test_client.query(
+            table_name: table_name,
+            key_condition_expression: "#H = :h AND #R >= :s",
+            expression_attribute_names: {'#H' => 'not_hash_key_field', '#R' => 'not_range_key_field'},
+            expression_attribute_values: {
+                ':h' => 'foo',
+                ':s' => 30
+            }
+        ) }.to raise_error(Aws::DynamoDB::Errors::ValidationException, "Query condition missed key schema element: hash_key_field, range_key_field")
+      end
+    end
+
     context 'with secondary index' do
       before do
         test_client.update_item(table_name: table_name,
@@ -199,7 +229,8 @@ describe Dynamini::TestClient do
         it 'should return all items with secondary range key less than or equal to the provided value' do
           response = test_client.query(
               table_name: table_name,
-              key_condition_expression: "abc = :h AND secondary_range_key <= :e",
+              key_condition_expression: "#H = :h AND #R <= :e",
+              expression_attribute_names: {'#H' => 'abc', '#R' => 'secondary_range_key'},
               expression_attribute_values: {
                 ":h" => 'abc',
                 ":e" => 8
@@ -216,7 +247,8 @@ describe Dynamini::TestClient do
         it 'should return all items with secondary range key greater than or equal to the provided value' do
           response = test_client.query(
               table_name: table_name,
-              key_condition_expression: "abc = :h AND secondary_range_key >= :s",
+              key_condition_expression: "#H = :h AND #R >= :s",
+              expression_attribute_names: {'#H' => 'abc', '#R' => 'secondary_range_key'},
               expression_attribute_values: {
                 ":h" => 'abc',
                 ":s" => 8
@@ -233,7 +265,8 @@ describe Dynamini::TestClient do
         it 'should return all items with secondary range key between the provided values' do
           response = test_client.query(
               table_name: table_name,
-              key_condition_expression: "abc = :h AND secondary_range_key BETWEEN :s AND :e",
+              key_condition_expression: "#H = :h AND #R BETWEEN :s AND :e",
+              expression_attribute_names: {'#H' => 'abc', '#R' => 'secondary_range_key'},
               expression_attribute_values: {
                 ":h" => 'abc',
                 ":s" => 8,
@@ -251,7 +284,8 @@ describe Dynamini::TestClient do
         it 'should return all items sorted by their secondary index' do
           response = test_client.query(
               table_name: table_name,
-              key_condition_expression: "abc = :h",
+              key_condition_expression: "#H = :h",
+              expression_attribute_names: {'#H' => 'abc'},
               expression_attribute_values: {
                 ":h" => 'abc'
               },
@@ -264,6 +298,32 @@ describe Dynamini::TestClient do
         end
       end
 
+      context 'with invalid expression_attribute_names' do
+        it 'should raise an error about an invalid hash_key' do
+          expect{ test_client.query(
+              table_name: table_name,
+              key_condition_expression: "#H = :h",
+              expression_attribute_names: {'#H' => 'not_hash_key_field'},
+              expression_attribute_values: {
+                  ':h' => 'abc'
+              },
+              index_name: 'secondary_index'
+          ) }.to raise_error(Aws::DynamoDB::Errors::ValidationException, "Query condition missed key schema element: abc")
+        end
+
+        it 'should raise an error about an invalid range_key' do
+          expect{ test_client.query(
+              table_name: table_name,
+              key_condition_expression: "#H = :h AND #R >= :s",
+              expression_attribute_names: {'#H' => 'not_hash_key_field', '#R' => 'not_range_key_field'},
+              expression_attribute_values: {
+                  ':h' => 'abc',
+                  ':s' => 3
+              },
+              index_name: 'secondary_index'
+          ) }.to raise_error(Aws::DynamoDB::Errors::ValidationException, "Query condition missed key schema element: abc, secondary_range_key")
+        end
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamini
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Greg Ward
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-08 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel