dynamodb_helpers 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29c20443dd559e7466b424511888b5cd689042c6
-  data.tar.gz: 106fb0bf1cf2e334c536cbcd72ab3c891c44792c
+  metadata.gz: 799b8b0b74b057cd60136e9edff897f0d1ef2689
+  data.tar.gz: 57a56363cf62f42625b1456965c0dc3dd2757275
 SHA512:
-  metadata.gz: 8d3d856506e490c57bd7d443a15520ef7bf8e0a1455182ed50e59cb19d45cb86ad620c1fc6a2b6a4576e0a893aa681a73afa2e4f4126917469086fa23144ed92
-  data.tar.gz: 4fc0d8703991a0de17b0c1b123dfd76615d218dce4d17784aabcf8ec178149c0a47141dd19e852a6a0724ad04776d869c92a52bff3a47585da49eb0fb157a815
+  metadata.gz: e55d62e619c0e7282d3195d3e4790116147763e66638abb3d3cca8c2cbd16b60eea3ea48955d4f0cefccaa31bb627bd94658f26fc8e49f45ccb4151e9fdf1d38
+  data.tar.gz: ffedaaca92f9f7dc83f6a0960ca422ae29638144a290079ed6262e8ed6053faf301d2ff96aa86d75a95d9b08809b1ade5a79d48d5b4f1fc0fd750931005fe271

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,23 +1,25 @@
 PATH
   remote: .
   specs:
-    dynamodb_helpers (0.1.0)
+    dynamodb_helpers (0.3.0)
       aws-sdk-dynamodb (>= 1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-partitions (1.27.0)
-    aws-sdk-core (3.6.0)
+    aws-eventstream (1.0.0)
+    aws-partitions (1.91.0)
+    aws-sdk-core (3.21.2)
+      aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.2.0)
+    aws-sdk-dynamodb (1.6.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sigv4 (1.0.2)
     diff-lcs (1.3)
-    jmespath (1.3.1)
+    jmespath (1.4.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -43,4 +45,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/README.md

@@ -1,7 +1,7 @@
 # DynamoDB helpers
 
 Currently only the scan finder is implemented. It will issue multiple scans for each 1MB and combine them into a single result.
-Dataset returned is a plain ruby hash which gives you significant speed-up if you are only interested in reading the data.
+Dataset returned is a plain ruby hash which gives you significant speed-up over aws-record gem if you are only interested in reading the data.
 
 ## Installation
 
@@ -23,7 +23,10 @@ Or install it yourself as:
 
 
 ```ruby
-# extend your class and provide table_name method
+# Instantiate the client which will require table_name option on each call
+DynamoClient = Class.new.extend(DynamodbHelpers)
+
+# or extend your class and provide table_name method
 class User
   extend DynamodbHelpers
 
@@ -34,7 +37,11 @@ end
 
 # Find by multiple keys:
 User.scan_and_find_by(name: 'Joe', email: 'joe@example.com')
-# => {"name"  => "Joe", "email" => "joe@example.com", ... other attributes}
+# => [{"name"  => "Joe", "email" => "joe@example.com", ... other attributes}, ...]
+
+# Return specific fields:
+User.scan_and_find_by({name: 'Joe', email: 'joe@example.com'}, select: [:email])
+# => [{"email" => "joe@example.com"}, ...]
 
 # Find by scanning in parallel with multiple threads:
 User.scan_and_find_by({name: 'Joe'}, segments: 5)

data/dynamodb_helpers.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  # spec.add_dependency "aws-sdk-dynamodb", ">= 1.2.0"
+  spec.add_dependency "aws-sdk-dynamodb", ">= 1.2.0"
   # spec.add_dependency "aws-sdk", "~> 2.0"
 end

data/lib/dynamodb_helpers.rb

@@ -1,11 +1,15 @@
 require "dynamodb_helpers/version"
 
 module DynamodbHelpers
-  def scan_and_find_by(query_opts, opts = {segments: false})
-    query = {table_name: table_name, select: 'ALL_ATTRIBUTES', scan_filter: {}}
+  def scan_and_find_by(query_opts, opts = {segments: false, select: false, table_name: false})
+
+    query = {table_name: opts[:table_name] ? opts[:table_name] : self.table_name, select: 'ALL_ATTRIBUTES', scan_filter: {}}
 
     query_opts.each do | key, value |
-      if(!value.nil?)
+      if value.nil?
+        # raise "Detected nil value for #{key}"
+        return []
+      else
         query[:scan_filter].merge!(key.to_s => {:comparison_operator => "EQ", :attribute_value_list => [value]})
       end
     end
@@ -14,6 +18,9 @@ module DynamodbHelpers
       query.merge!(:conditional_operator => "AND")
     end
 
+    # field selection
+    query.merge!(select: "SPECIFIC_ATTRIBUTES", attributes_to_get: opts[:select]) if opts[:select]
+
     return scan_in_parallel(query, opts) if opts[:segments]
     return scan_sequentialy(query)
   end

data/lib/dynamodb_helpers/version.rb

@@ -1,3 +1,3 @@
 module DynamodbHelpers
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb_helpers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Damir Roso
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: Lightweight wrapper for some aws-sdk-dynamodb features
 email:
 - damir.roso@nih.gov
@@ -93,9 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Utility methods for dynamodb
 test_files: []
-has_rdoc: