dynamo-record 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d18ec7a057cdce73f1f6e3f6aafa7b0175580be9
-  data.tar.gz: b12e97171dc6df596a9c787750c463741295c626
+  metadata.gz: 7f61aad11c87426b8d0330bf728967ebfe7e0811
+  data.tar.gz: 04d634aaa02c527fd052585b6b90cfde1c461127
 SHA512:
-  metadata.gz: 509bdcf316a75601110e40ffaf80238d152c077d648f7433f4fef6566f458c9baad55e3cb66f75246166d54f2c9ab6e6f08b31128f92c0be6dac20dce47ff3ec
-  data.tar.gz: baf21793319609920a4526a027ebf2446a2af125e014717cf0493bcaa88ee97a0aad0af687fb1e4d5f892a0c342ed67afed9486006d0bab77c5bde3934010362
+  metadata.gz: bdd7d9f796e1b86a259cc4f59def7e6e022866889ccfd238150684c9dee04f4cac2b9d3f90b6f2c76fe889971e00cb66c031897880cb5eab416050d6b833cf20
+  data.tar.gz: '03964856097c204b9fd484e4ef20a8d86eecdf800374a5a424122544fbb679da079f01213902d4739a8107469d174c0dce93858f05e0408ab67def2e7c7011e5'

data/.gitignore

@@ -2,7 +2,6 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dynamo-record (0.1.0)
+    dynamo-record (0.1.3)
       aws-record (~> 1.1)
       rails (~> 4.2)
 
@@ -45,13 +45,14 @@ GEM
     addressable (2.5.1)
       public_suffix (~> 2.0, >= 2.0.2)
     arel (6.0.4)
+    ast (2.3.0)
     aws-record (1.1.0)
       aws-sdk-resources (~> 2.0)
-    aws-sdk-core (2.9.11)
+    aws-sdk-core (2.9.14)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.9.11)
-      aws-sdk-core (= 2.9.11)
+    aws-sdk-resources (2.9.14)
+      aws-sdk-core (= 2.9.14)
     aws-sigv4 (1.0.0)
     builder (3.2.3)
     byebug (9.0.6)
@@ -73,7 +74,7 @@ GEM
     json (2.1.0)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
-    mail (2.6.4)
+    mail (2.6.5)
       mime-types (>= 1.16, < 4)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
@@ -82,6 +83,9 @@ GEM
     minitest (5.10.1)
     nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     public_suffix (2.0.5)
     rack (1.6.5)
     rack-test (0.6.3)
@@ -110,6 +114,8 @@ GEM
       activesupport (= 4.2.8)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.2.2)
+      rake
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -124,6 +130,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    rubocop (0.44.1)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     safe_yaml (1.0.4)
     simplecov (0.14.1)
       docile (~> 1.1.0)
@@ -141,6 +154,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
+    unicode-display_width (1.2.1)
     webmock (2.3.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -156,6 +170,7 @@ DEPENDENCIES
   dynamo-record!
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.44.1)
   simplecov (~> 0.12)
   webmock (~> 2.1)
 

data/README.md

@@ -1,6 +1,7 @@
 # DynamoRecord
 
-Provides helpful rake tasks and model extensions on top of [aws-record](https://github.com/aws/aws-sdk-ruby-record).
+Provides helpful rake tasks and model extensions on top of
+[aws-record](https://github.com/aws/aws-sdk-ruby-record).
 
 ## Installation
 
@@ -22,18 +23,19 @@ Or install it yourself as:
 
 ### Models
 
-In `app/models`, create a class that includes `DynamoRecord::Model` and contains one or more of the following attribute declarations:
+In `app/models`, create a class that includes `DynamoRecord::Model` and contains
+one or more of the
+[standard set](http://docs.aws.amazon.com/awssdkrubyrecord/api/Aws/Record.html)
+of attribute declarations, along with the following new composite attribute
+types:
 
-* `integer_attr`
-* `float_attr`
-* `map_attr`
 * `composite_string_attr`
 * `composite_integer_attr`
 
 An example file:
 
 ```
-class Model1
+class MyModel
   include DynamoRecord::Model
   composite_string_attr(
     :model_key,
@@ -44,17 +46,20 @@ class Model1
   string_attr  :user_id
   float_attr   :score
   map_attr     :map_value
-  composite_string_attr :quiz_key, parts: [:quiz_id]
 end
 ```
 
-The partition key is labeled with `hash_key: true`. The sort key is labeled with `range_key: true`.
+The partition key is labeled with `hash_key: true`. The sort key is labeled with
+`range_key: true`.
 
-A secondary index can be defined as follows:
+Declaring secondary indexes are included in `aws-record` and are defined
+[here](http://docs.aws.amazon.com/awssdkrubyrecord/api/Aws/Record/SecondaryIndexes/SecondaryIndexesClassMethods.html).
+
+As an example, a global secondary index can be defined as follows:
 
 ```
   global_secondary_index(
-    :secondary_idx,
+    :user_idx,
     hash_key: :user_id,
     range_key: :score,
     projection: {
@@ -66,24 +71,110 @@ A secondary index can be defined as follows:
   )
 ```
 
-The full documentation for `projection_type` and `non_key_attributes` can be found [here](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html).
+As an example, a local secondary index can be defined as follows:
+
+```
+  local_secondary_index(
+    :score_idx,
+    range_key: :score,
+    projection: {
+      projection_type: 'INCLUDE',
+      non_key_attributes: [
+        :map_value
+      ]
+    }
+  )
+```
+
+The full documentation for `projection_type` and `non_key_attributes` can be
+found [here](http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Types/Projection.html).
+
+### Query Helpers
+
+Query helpers are included as class methods.
+
+* `composite_key(*args)`
+
+For models that have composite attributes, create a composite key value from the
+individual attribute parts:
+
+```
+hash_key = MyModel.composite_key('model_1', 'account_1')
+```
+
+* `split_composite(string)`
+
+Split a composite attribute value into its individual attribute parts:
+
+```
+model_id, acccount_id = MyModel.split_composite(hash_key)
+```
+
+* `find_all_by_hash_key(hash_key_value, opts = {})`
+
+Find all item instances that match a given hash key value. `opts` are options
+passed to the underlying query.
+
+```
+MyModel.find_all_by_hash_key(hash_key)
+```
+
+* `find_all_by_gsi_hash_key(gsi_name, hash_key_value, opts = {})`
+
+Find all item instances using a global secondary instance using a hash key
+value. `opts` are options passed to the underlying query.
+
+```
+MyModel.find_all_by_gsi_hash_key('user_idx', 'user_1')
+```
+
+* `find_all_by_gsi_hash_and_range_keys(gsi_name, hash_key_value, range_key_value)`
+
+Find all item instances using a global secondary instance using a hash key value
+and range key value.
+
+```
+MyModel.find_all_by_gsi_hash_key('user_idx', 'user_1', 0.0)
+```
+
+* `find_all_by_lsi_hash_key(lsi_name, hash_key_value, opts = {})`
+
+Find all item instances using a local secondary instance using a hash key value.
+`opts` are options passed to the underlying query.
+
+```
+MyModel.find_all_by_lsi_hash_key('score_idx', 'user_1')
+```
+
+* `find_all_by_lsi_hash_and_range_keys(lsi_name, hash_key_value, range_key_value)`
+
+Find all item instances using a local secondary instance using a hash key value
+and range key value.
+
+```
+MyModel.find_all_by_lsi_hash_key('score_idx', 'user_1', 0.0)
+```
+
 
 ### Migrations
 
-Dynamo migration files are stored in `db/dynamo_migrate`. The name of the file follows the style of standard Rails migration files like `YYYYMMDDHHMMSS_create_model_1.rb`. A migration file that creates a Dynamo table looks like:
+Dynamo migration files are stored in `db/dynamo_migrate`. The name of the file
+follows the style of standard Rails migration files like
+`YYYYMMDDHHMMSS_create_model_1.rb`. A migration file that creates a Dynamo table
+looks like:
 
 ```
 module DynamoMigrate
-  class CreateModel1 < DynamoRecord::TableMigration
+  class CreateMyModel < DynamoRecord::TableMigration
     def self.up
-      migrate(Model1) do |migration|
+      migrate(MyModel) do |migration|
         migration.create!(
           provisioned_throughput: {
             read_capacity_units: 1,
             write_capacity_units: 1
           },
           global_secondary_index_throughput: {
-            secondary_idx: {
+            user_idx: {
               read_capacity_units: 1,
               write_capacity_units: 1
             }
@@ -95,15 +186,16 @@ module DynamoMigrate
 end
 ```
 
-Note that the throughput of the table can be configured separately from the throughput of the secondary index.
+Note that the throughput of the table can be configured separately from the
+throughput of the secondary index.
 
 A migration file that creates a Dynamo stream looks like:
 
 ```
 module DynamoMigrate
-  class AddModel1Stream < DynamoRecord::TableMigration
+  class AddMyModelStream < DynamoRecord::TableMigration
     def self.update
-      add_stream(Model1)
+      add_stream(MyModel)
     end
   end
 end

data/doc/testing.md

@@ -0,0 +1,11 @@
+# Testing
+
+Run rspec in the `test` container:
+
+`docker-compose run --rm test bundle exec rspec`
+
+## Static Code Analysis
+
+Run RuboCop static code analysis in the `test` container:
+
+`docker-compose run --rm test bundle exec rubocop`

data/dynamo-record.gemspec

@@ -8,9 +8,11 @@ Gem::Specification.new do |spec|
   spec.version       = DynamoRecord::Record::VERSION
   spec.license       = 'MIT'
   spec.homepage      = 'https://instructure.com'
-  spec.authors       = ['Davis McClellan', 'Ryan Taylor', 'Bryan Petty', 'Michael Brewer-Davis', 'Marc Phillips', 'Augusto Callejas']
+  spec.authors       = ['Davis McClellan', 'Ryan Taylor', 'Bryan Petty', 'Michael Brewer-Davis', 'Marc Phillips',
+                        'Augusto Callejas', 'Frank Murphy']
   spec.email         = ['dmcclellan@instructure.com', 'rtaylor@instructure.com', 'bpetty@instructure.com',
-                        'mbd@instructure.com', 'mphillips@instructure.com', 'acallejas@instructure.com']
+                        'mbd@instructure.com', 'mphillips@instructure.com', 'acallejas@instructure.com',
+                        'fmurphy@instructure.com']
 
   spec.summary       = 'Extensions for working with dynamo via aws-record'
   spec.description   = 'A set of extensions simplifying database operations in aws-record'
@@ -30,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'combustion', '~> 0.6.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.44.1'
   spec.add_development_dependency 'simplecov', '~> 0.12'
   spec.add_development_dependency 'webmock', '~> 2.1'
 end

data/lib/dynamo-record.rb

@@ -1,4 +1,4 @@
 Gem.find_files("#{File.dirname(__FILE__)}/dynamo-record/**/*.rb").each do |path|
   require path.gsub(/\.rb$/, '')
 end
-require 'model_existence_validator'
+require 'model_existence_validator'

data/lib/dynamo-record/marshalers.rb

@@ -29,7 +29,7 @@ module DynamoRecord
         # rubocop:enable Style/Attr
       end
 
-      def define_readers(name, parts, cast_function, allowed_repeats = [:account_uuid])
+      def define_readers(name, parts, cast_function)
         parts.each_with_index do |part, i|
           raise "#{part} already defined" unless parts.find_index(part) == i
           next if method_defined?(part)

data/lib/dynamo-record/model.rb

@@ -51,6 +51,20 @@ module DynamoRecord
         )
       end
 
+      def find_all_by_lsi_hash_key(lsi_name, hash_key_value, opts = {})
+        hash_key_name = local_secondary_indexes[lsi_name.to_sym][:hash_key]
+        find_all_by_index_and_hash_key(hash_key_name, hash_key_value, opts, lsi_name.to_s)
+      end
+
+      def find_all_by_lsi_hash_and_range_keys(lsi_name, hash_key_value, range_key_value)
+        lsi_config = local_secondary_indexes[lsi_name.to_sym]
+        find_all_by_index_hash_and_range_keys(
+          hash_config: { name: lsi_config[:hash_key], value: hash_key_value },
+          range_config: { name: lsi_config[:range_key], value: range_key_value },
+          index_name: lsi_name.to_s
+        )
+      end
+
       def find_all_by_index_and_hash_key(hash_key_name, hash_key_value, opts = {}, index_name = nil)
         query_options = {
           select: 'ALL_ATTRIBUTES',
@@ -67,9 +81,10 @@ module DynamoRecord
 
       def find_all_by_index_hash_and_range_keys(hash_config:, range_config:, index_name: nil,
         scan_index_forward: true, limit: nil)
+        range_expression = range_config[:expression] || "#{range_config[:name]} = :rkv"
         query_options = {
           select: 'ALL_ATTRIBUTES',
-          key_condition_expression: "#{hash_config[:name]} = :hkv AND #{range_config[:name]} = :rkv",
+          key_condition_expression: "#{hash_config[:name]} = :hkv AND #{range_expression}",
           expression_attribute_values: {
             ':hkv': hash_config[:value],
             ':rkv': range_config[:value]
@@ -89,18 +104,6 @@ module DynamoRecord
         string.split(COMPOSITE_DELIMITER)
       end
 
-      def find_all_by_model(model, opts = {})
-        find_all_by_hash_key(model.dynamo_key, opts)
-      end
-
-      def find_all_by_model_paginated(model, opts = {})
-        find_all_by_model(model, pagination_opts(opts))
-      end
-
-      def pagination_opts(opts = {})
-        { limit: opts[:limit], exclusive_start_key: opts[:exclusive_start_key] }
-      end
-
       # TODO: Create a batch save method.
     end
 

data/lib/dynamo-record/record/railtie.rb

@@ -6,7 +6,7 @@ module DynamoRecord
       railtie_name :dynamo_record
 
       rake_tasks do
-        load "tasks/dynamo.rake"
+        load 'tasks/dynamo.rake'
       end
     end
   end

data/lib/dynamo-record/record/version.rb

@@ -1,5 +1,5 @@
 module DynamoRecord
   module Record
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.3'.freeze
   end
 end

data/lib/dynamo-record/task_helpers/cleanup.rb

@@ -4,13 +4,16 @@ module DynamoRecord
       def self.run
         raise 'Task not available on production' if Rails.env.production?
         Dir[Rails.root.join('app/models/*.rb').to_s].each do |filename|
-          klass = File.basename(filename, '.rb').camelize.constantize
-          if klass.included_modules.include? DynamoRecord::Model
-            puts "Deleting all items in table: #{klass}"
-            klass.scan.each(&:delete!)
-          end
+          delete_by_class(filename)
         end
       end
+
+      def self.delete_by_class(filename)
+        klass = File.basename(filename, '.rb').camelize.constantize
+        return unless klass.included_modules.include? DynamoRecord::Model
+        Rails.logger.info "Deleting all items in table: #{klass}"
+        klass.scan.each(&:delete!)
+      end
     end
   end
 end

data/lib/dynamo-record/task_helpers/migration_runner.rb

@@ -1,19 +1,13 @@
 module DynamoRecord
   module TaskHelpers
     class MigrationRunner
-      def self.run(path='db/dynamo_migrate')
+      def self.run(path = 'db/dynamo_migrate')
         constants = []
         filename_regexp = /\A([0-9]+)_([_a-z0-9]*)\.?([_a-z0-9]*)?\.rb\z/
 
         # Sorts the files located in `db/dynamo_migrate` to ensure order is preserved
         Dir[Rails.root.join("#{path}/*.rb")].sort.each do |f|
-          raise "Non-numeric prefix: #{f}" if File.basename(f).scan(filename_regexp).first.nil?
-          require f
-
-          # finds the constant that was added on the require statement above
-          migration_sym = (DynamoMigrate.constants - constants).first
-          migration = DynamoMigrate.const_get(migration_sym)
-          constants.push migration_sym
+          migration = migration(f, filename_regexp, constants)
 
           # starts the migration
           yield "Migrating: #{migration}"
@@ -30,6 +24,17 @@ module DynamoRecord
         end
       end
 
+      def self.migration(f, filename_regexp, constants)
+        raise "Non-numeric prefix: #{f}" if File.basename(f).scan(filename_regexp).first.nil?
+        require f
+
+        # finds the constant that was added on the require statement above
+        migration_sym = (DynamoMigrate.constants - constants).first
+        migration = DynamoMigrate.const_get(migration_sym)
+        constants.push migration_sym
+        migration
+      end
+
       def self.up(migration)
         return unless migration.respond_to? :up
         case migration.up

data/lib/dynamo-record/task_helpers/scale.rb

@@ -63,7 +63,7 @@ module DynamoRecord
       end
 
       def raise_attribute_error
-        raise ArgumentError, 'You didn\'t provide an appropriate attribute selection.  We  accept [:both, :read, :write]'
+        raise ArgumentError, 'You didn\'t provide an appropriate attribute selection. We accept [:both, :read, :write]'
       end
 
       def description

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamo-record
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Davis McClellan
@@ -10,10 +10,11 @@ authors:
 - Michael Brewer-Davis
 - Marc Phillips
 - Augusto Callejas
+- Frank Murphy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2017-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-record
@@ -113,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +164,7 @@ email:
 - mbd@instructure.com
 - mphillips@instructure.com
 - acallejas@instructure.com
+- fmurphy@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -162,6 +178,7 @@ files:
 - Gemfile.lock
 - README.md
 - build.sh
+- doc/testing.md
 - docker-compose.override.yml
 - docker-compose.yml
 - dynamo-record.gemspec
@@ -200,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Extensions for working with dynamo via aws-record