dynamo-record 0.2.0 → 0.3.0

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

@@ -0,0 +1,72 @@
+module Dynamo
+  module Record
+    module TaskHelpers
+      class MigrationRunner
+        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|
+            migration = migration(f, filename_regexp, constants)
+
+            # starts the migration
+            yield "Migrating: #{migration}"
+
+            begin
+              status = table_config_check(migration)
+              yield status if status
+
+              status = up(migration)
+              yield status if status
+
+              status = update(migration)
+              yield status if status
+            rescue StandardError => e
+              yield "Migration failed: #{e}"
+            end
+          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.status_message(status)
+          case status
+          when :exists
+            'Table already exists'
+          when :migrated
+            'Migration successful'
+          else
+            raise 'Migration failed'
+          end
+        end
+
+        def self.up(migration)
+          return unless migration.respond_to? :up
+          status_message migration.up
+        end
+
+        def self.table_config_check(migration)
+          return unless migration.respond_to? :table_config
+          status_message migration.table_config_check
+        end
+
+        def self.update(migration)
+          return unless migration.respond_to? :update
+          status = migration.update
+          return 'Migration successful' if status == :updated
+          status
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+module Dynamo
+  module Record
+    module TaskHelpers
+      class Scale
+        attr_reader :model, :attribute_selector, :new_throughput
+        attr_reader :migration, :existing_throughput, :model_name
+
+        def initialize(model_name, attribute_selector, new_throughput)
+          @model_name = model_name
+          @attribute_selector = attribute_selector
+          @new_throughput = new_throughput
+        end
+
+        def run
+          return description if [model_name, attribute_selector, new_throughput].any?(&:nil?)
+
+          @model = model_name.constantize
+          @migration = Aws::Record::TableMigration.new(model)
+          @existing_throughput = model.provisioned_throughput
+
+          update_throughput
+          success_message
+        end
+
+        private
+
+        def success_message
+          "Successfully updated #{model.table_name} throughput to #{update_instructions[:provisioned_throughput]}"
+        end
+
+        def update_throughput
+          raise_attribute_error if !read? && !write?
+
+          migration.update!(update_instructions)
+        end
+
+        def update_instructions
+          {
+            provisioned_throughput: {
+              write_capacity_units: (write? && new_throughput) || existing_write,
+              read_capacity_units: (read? && new_throughput) || existing_read
+            }
+          }
+        end
+
+        def existing_write
+          existing_throughput[:write_capacity_units]
+        end
+
+        def existing_read
+          existing_throughput[:read_capacity_units]
+        end
+
+        def both?
+          attribute_selector.to_sym == :both
+        end
+
+        def read?
+          both? || attribute_selector.to_sym == :read
+        end
+
+        def write?
+          both? || attribute_selector.to_sym == :write
+        end
+
+        def raise_attribute_error
+          raise ArgumentError, <<~MESSAGE
+            You didn't provide an appropriate attribute selection. We accept [:both, :read, :write]
+          MESSAGE
+        end
+
+        def description
+          <<~DESCRIPTION
+            ----------------------------------------------------------------------
+            Here's some usage information:
+              Scale a dynamo table.  Requires three inputs.
+                - ModelName
+                  ruby class of the model
+                - attribute
+                  valid values include "both", "read" and "write"
+                - new_throughput
+                  numerical value for the new read/write capacity units
+              Example: `rake dynamo:scale[MySuperDynamoModel,both,50]`
+            ----------------------------------------------------------------------
+          DESCRIPTION
+        end
+      end
+    end
+  end
+end

data/lib/dynamo/record/version.rb

@@ -0,0 +1,5 @@
+module Dynamo
+  module Record
+    VERSION = '0.3.0'.freeze
+  end
+end

data/lib/tasks/dynamo.rake

@@ -1,7 +1,7 @@
 namespace :dynamo do
   desc 'Run dynamo migrations'
   task migrate: :environment do
-    DynamoRecord::TaskHelpers::MigrationRunner.run { |msg| puts msg }
+    Dynamo::Record::TaskHelpers::MigrationRunner.run { |msg| puts msg }
   end
 
   desc 'Drops all dynamo tables and re-runs migrations'
@@ -12,27 +12,27 @@ namespace :dynamo do
 
   desc 'Drop all dynamo tables'
   task :drop_all, [:override] => :environment do |_t, args|
-    puts DynamoRecord::TaskHelpers::DropAllTables.run args[:override]
+    puts Dynamo::Record::TaskHelpers::DropAllTables.run args[:override]
   end
 
   desc 'Drop a specified dynamo table'
   task :drop, [:table_name] => :environment do |_t, args|
-    puts DynamoRecord::TaskHelpers::DropTable.run args[:table_name]
+    puts Dynamo::Record::TaskHelpers::DropTable.run args[:table_name]
   end
 
   desc 'List all tables with dynamo prefix'
   task list_tables: :environment do
-    puts DynamoRecord::TaskHelpers::ListTables.run
+    puts Dynamo::Record::TaskHelpers::ListTables.run
   end
 
   desc 'Delete all records in all DyanmoDB tables.'
   task cleanup: :environment do
-    DynamoRecord::TaskHelpers::Cleanup.run
+    Dynamo::Record::TaskHelpers::Cleanup.run
     puts 'Finished deleting all records in all DynamoDB tables.'
   end
 
   desc 'Scale a dynamo table read/write capacity to the new capacity value provided'
-  task :scale, [:model_name, :attribute, :new_throughput] => :environment do |_t, args|
-    puts DynamoRecord::TaskHelpers::Scale.new(args[:model_name], args[:attribute], args[:new_throughput].to_i).run
+  task :scale, %i[model_name attribute new_throughput] => :environment do |_t, args|
+    puts Dynamo::Record::TaskHelpers::Scale.new(args[:model_name], args[:attribute], args[:new_throughput].to_i).run
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamo-record
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Davis McClellan
@@ -12,9 +12,9 @@ authors:
 - Augusto Callejas
 - Frank Murphy
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-record
@@ -31,33 +31,79 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -92,56 +138,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.44.1
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.44.1
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +202,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-description: A set of extensions simplifying database operations in aws-record
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
 email:
 - dmcclellan@instructure.com
 - rtaylor@instructure.com
@@ -169,35 +229,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
-- Dockerfile.test
+- Dockerfile
 - Gemfile
-- Gemfile.lock
+- LICENSE.txt
 - README.md
 - build.sh
-- doc/testing.md
-- docker-compose.dev.override.yml
+- docker-compose.override.example.yml
 - docker-compose.yml
 - dynamo-record.gemspec
-- lib/dynamo-record.rb
-- lib/dynamo-record/marshalers.rb
-- lib/dynamo-record/model.rb
-- lib/dynamo-record/record.rb
-- lib/dynamo-record/record/railtie.rb
-- lib/dynamo-record/record/version.rb
-- lib/dynamo-record/table_migration.rb
-- lib/dynamo-record/task_helpers/cleanup.rb
-- lib/dynamo-record/task_helpers/drop_all_tables.rb
-- lib/dynamo-record/task_helpers/drop_table.rb
-- lib/dynamo-record/task_helpers/list_tables.rb
-- lib/dynamo-record/task_helpers/migration_runner.rb
-- lib/dynamo-record/task_helpers/scale.rb
-- lib/model_existence_validator.rb
+- lib/dynamo/record.rb
+- lib/dynamo/record/marshalers.rb
+- lib/dynamo/record/model.rb
+- lib/dynamo/record/model_existence_validator.rb
+- lib/dynamo/record/railtie.rb
+- lib/dynamo/record/table_migration.rb
+- lib/dynamo/record/task_helpers/cleanup.rb
+- lib/dynamo/record/task_helpers/drop_all_tables.rb
+- lib/dynamo/record/task_helpers/drop_table.rb
+- lib/dynamo/record/task_helpers/list_tables.rb
+- lib/dynamo/record/task_helpers/migration_runner.rb
+- lib/dynamo/record/task_helpers/scale.rb
+- lib/dynamo/record/version.rb
 - lib/tasks/dynamo.rake
-homepage: https://instructure.com
+homepage: https://github.com/instructure/dynamo-record
 licenses:
 - MIT
 metadata: {}
@@ -220,5 +279,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Extensions for working with dynamo via aws-record
+summary: Extensions to Aws::Record for working with DynamoDB.
 test_files: []