ocean-dynamo 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9093b06c18bfab10ad838fabcfa6b193cbd8bfe7
-  data.tar.gz: 8343febaa0690023516a27585d2d1857710b94ff
+  metadata.gz: d3c55ae49ff1ad852246e6af0b6727f284a10acc
+  data.tar.gz: 17c013a3f22302b9a48a117a83e800e35297fb35
 SHA512:
-  metadata.gz: 1cc8858fec48e9796f12d60120989f0fad06a04cbcc15805b8af58551efb2d673fc56360efea679d1ebd4453d32aa417c18a30a1a40a2fbc17ee0573db3dd8be
-  data.tar.gz: f1246850490184ce41e24044207924ec2ecc24aeb1dd180e1f3c8c42c671ca446161d2ed67ed93c154ad98d3b18f288b17fb08eb89fddee83b09153831f746fb
+  metadata.gz: 16351feeb2ff2d90ea76d87c9c352c752fc0d29eab5c77d8dc522d39779c69835ce90b88599823ffed8a638c01d26c1556807f91533c0a71337d0600bbc1a93a
+  data.tar.gz: b9cdc4ea2f37f4dabd048264e61bc96f79b504b4d9fc6f89e94519e6f9c5f66a6bd097f614f35a2698296ba72ff55b756395752dac95b3bed0c0823f2fe1edd7

data/README.rdoc

@@ -216,12 +216,10 @@ the possibility to define both local and secondary indices for Tables.
 
 == Secondary Indices
 
-We now have basic support for secondary indices. 
-
-We will add high-level support for specifying that a secondary index is to be used 
-in +in_batches+ and +find_each+ etc, but for now you will have to specify that a
-secondary index is to be used explicitly in the options passed to +in_batches+, 
-+query+, and +scan+. 
+We now have basic support for secondary indices. High-level support for global secondary indices
+is also available; we will add high-level support for local secondary indices very soon.
+For now you will have to specify that a secondary index is to be used explicitly in the options 
+passed to +in_batches+, +query+, and +scan+. 
 * +query+: http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Table.html#query-instance_method
 * +scan+: http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Table.html#scan-instance_method
 * +in_batches+, +find_each+: lib/ocean-dynamo/queries.rb
@@ -277,6 +275,30 @@ Each +global_secondary_index+ clause takes the following arguments:
 * +:read_capacity_units+ (defaults to the table's read capacity, normally 10)
 * +:write_capacity_units+ (default to the table's write capacity, normally 5)
 
+High-level support for global secondary indices is now available through
++find_global_each+ and +find_global+. They take the same arguments; the former
+yields to a block for each item, the other returns all items in an array.
+
+The following finds all Authentications whose +:token+ is "quux"
+
+ Authentication.find_global(:token, "quux")
+
+This retrieves all Authentications belonging to the user with the ID "dfstw-ruyhdf-ewijf", 
+sorted in ascending order of the +:expires_at+ attribute:
+
+ Authentication.find_global(:api_user_id, "dfstw-ruyhdf-ewijf", 
+                            :expires_at, ">=", 0)
+
+To get the highest +:expires_at+ record, execute the following:
+
+ Authentication.find_global(:api_user_id, "dfstw-ruyhdf-ewijf", 
+                            :expires_at, ">=", 0,
+                            scan_index_forward: false, limit: 1)
+
+The combination of hash and range key must have been explicitly declared using
++global_secondary_index+. For more information, see the documentation of
++find_global_each+ and +find_global+.
+
 
 == Installation
 

data/lib/ocean-dynamo/associations/has_many.rb

@@ -113,10 +113,7 @@ module OceanDynamo
     def condition_options(child_class)
       hash_key = child_class.table_hash_key
       range_key = child_class.table_range_key
-      { expression_attribute_names: { "#H" => hash_key, "#R" => range_key },
-        key_condition_expression: "#H = :hashval AND #R >= :rangeval",
-        expression_attribute_values: { ":hashval" => id, ":rangeval" => "0" }
-      }
+      child_class.condition_builder(hash_key, id, range_key, ">=", "0", consistent: true)
     end
 
 

data/lib/ocean-dynamo/queries.rb

@@ -111,5 +111,89 @@ module OceanDynamo
     # def find_in_batches(start: nil, batch_size: 1000)
     #   []
     # end
+
+
+    def condition_builder(hash_key, hash_value,
+                          range_key=nil, comparator=nil, range_value=nil,
+                          limit: nil, consistent: false, scan_index_forward: true)
+      if range_key
+        options = { 
+          expression_attribute_names: { "#H" => hash_key, "#R" => range_key },
+          key_condition_expression: "#H = :hashval AND #R #{comparator} :rangeval",
+          expression_attribute_values: { ":hashval" => hash_value, ":rangeval" => range_value }
+        }
+      else
+        options = { 
+          expression_attribute_names: { "#H" => hash_key },
+          key_condition_expression: "#H = :hashval",
+          expression_attribute_values: { ":hashval" => hash_value }
+        }
+      end
+      options[:limit] = limit if limit
+      options[:consistent_read] = consistent if consistent
+      options[:scan_index_forward] = scan_index_forward if !scan_index_forward
+      options
+    end
+
+
+    #
+    # This method finds each item of a global secondary index, sequentially yielding each item
+    # to the given block (required). The parameters are as follows:
+    #
+    # +hash_key+    The name of the hash key to use (required).
+    # +hash_value+  The value of the hash key to match (required).
+    # +range_key+   The name of the range key to use (optional).
+    # +comparator+  The comparator to use. "=", "<", ">", "<=", ">=". (optional).
+    # +range-value+ The value of the range key to match (optional).
+    # 
+    # Note that +range_key+ is optional, but if it's present, then the +comparator+ and
+    # the +range_value+ must also be given. They must either all be present or absent.
+    #
+    # The following keyword arguments are accepted:
+    # 
+    # +:limit+              The maximum number of items to read.
+    # +:scan_index_forward+ If false, items will be in reverse order.
+    #
+    # If the index contains all attributes, no extra read will be performed. If it doesn't,
+    # the entire item will be fetched using an extra read operation.
+    #
+    def find_global_each(hash_key, hash_value,
+                         range_key=nil, comparator=nil, range_value=nil,
+                         limit: nil, scan_index_forward: true,
+                         &block)
+      hash_value = hash_value.to_i if hash_value.is_a?(Time)
+      range_value = range_value.to_i if range_value.is_a?(Time)
+      options = condition_builder(hash_key, hash_value, range_key, comparator, range_value,
+                                  limit: limit, scan_index_forward: scan_index_forward)
+      index_name = (range_key ? "#{hash_key}_#{range_key}" : hash_key.to_s) + "_global"
+      options[:index_name] = index_name
+      raise "Undefined global index: #{index_name}" unless global_secondary_indexes[index_name]
+      all_projected = global_secondary_indexes[index_name]["projection_type"] == "ALL"
+      in_batches :query, options do |attrs|
+        if limit
+          return if limit <= 0
+          limit = limit - 1
+        end
+        if all_projected
+          yield new._setup_from_dynamo(attrs)
+        else
+          yield find(attrs[table_hash_key.to_s], table_range_key && attrs[table_range_key.to_s])
+        end
+      end
+    end
+
+
+    #
+    # This method takes the same args as +find_global_each+ but returns all found items as
+    # an array.
+    #
+    def find_global(*args)
+      result = []
+      find_global_each(*args) do |item|
+        result << item
+      end
+      result
+    end
+
   end
 end

data/lib/ocean-dynamo/schema.rb

@@ -44,10 +44,10 @@ module OceanDynamo
                                read_capacity_units: table_read_capacity_units,
                                write_capacity_units: table_write_capacity_units)
       if range_key
-        name = "#{hash_key}_#{range_key}"
+        name = "#{hash_key}_#{range_key}_global"
         keys = [hash_key.to_s, range_key.to_s]
       else
-        name = "#{hash_key}"
+        name = "#{hash_key}_global"
         keys = [hash_key.to_s]
       end
       self.global_secondary_indexes[name] = { 

data/lib/ocean-dynamo/version.rb

@@ -1,3 +1,3 @@
 module OceanDynamo
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Peter Bengtson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk