dynamodb_framework 1.7.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e8d0250d290cb006f3cbfecaffcd35a3c61819c7
-  data.tar.gz: 98398a2a0aae655ef04ba9ccd01155bd320c5cf1
+SHA256:
+  metadata.gz: 684b8ee781de8cd470c33dcc3faf97381381b96ca1f206f844f8aa415b713ea9
+  data.tar.gz: f8a3f678f62b0c2630c7168520821026d6665443bebc7de929be42881756859f
 SHA512:
-  metadata.gz: d46aac43125f003b06522522790d87dcf201728af48f80e64effe39812bb53a83895aefd331b341b6e4437788f2de9642d74c126b257d8991e2feeaae2d67e69
-  data.tar.gz: 71428f806932374f1c52a81f04f9cddc6aaafcdce0c11e0c6899825bd12644b663a319b5dbe93a212a164fc9238ef35596306d53df93e0c97ae3d30f3593524d
+  metadata.gz: b11aff7b20d0c65a307952f6661e19c1640bcbdebd22c09afa17aa6548288add75d1732c3fd90b11f7a4fa8be08b81655781a81c18a7cbb20ad363b9842ef811
+  data.tar.gz: e7bf59c3dc18ef7fe1e8ecaa50c738ac5fe1ce12ebf494b1760441d43e53e34b8b79efd371cd6faee61e589eaef5382e40dd61986daba02544390e0db1bc9392

data/lib/dynamodb_framework/dynamodb_index.rb

@@ -46,7 +46,7 @@ module DynamoDbFramework
       self.instance_variable_set(:@range_key, { field: field, type: type })
     end
 
-    def create(store: DynamoDbFramework.default_store, read_capacity: 25, write_capacity: 25, submit: true)
+    def create(store: DynamoDbFramework.default_store, read_capacity: 25, write_capacity: 25, submit: true, billing_mode: 'PROVISIONED')
       unless self.instance_variable_defined?(:@table)
         raise DynamoDbFramework::Index::InvalidConfigException.new('Table must be specified.')
       end
@@ -84,10 +84,10 @@ module DynamoDbFramework
 
       range_key_field = range_key[:field] unless range_key == nil
 
-      index =table_manager.create_global_index(full_index_name, partition_key[:field], range_key_field, read_capacity, write_capacity)
+      index =table_manager.create_global_index(full_index_name, partition_key[:field], range_key_field, read_capacity, write_capacity, billing_mode)
 
       if submit
-        table_manager.add_index(table_name, builder.attributes, index)
+        table_manager.add_index(table_name, builder.attributes, index, billing_mode)
       end
 
       index

data/lib/dynamodb_framework/dynamodb_table_manager.rb

@@ -66,7 +66,7 @@ module DynamoDbFramework
 
     end
 
-    def add_index(table_name, attributes, global_index)
+    def add_index(table_name, attributes, global_index, billing_mode = 'PROVISIONED')
 
       attribute_definitions = []
 
@@ -79,7 +79,8 @@ module DynamoDbFramework
           :attribute_definitions => attribute_definitions,
           :global_secondary_index_updates => [
               :create => global_index
-          ]
+          ],
+          :billing_mode => billing_mode
       }
 
       dynamodb.client.update_table(table)
@@ -115,6 +116,33 @@ module DynamoDbFramework
       DynamoDbFramework.logger.info "[#{self.class}] -Table: [#{table_name}] updated."
     end
 
+    def update_ttl_attribute(table_name, enabled, attribute_name)
+      table = {
+          :table_name => table_name,
+          :time_to_live_specification => {
+            :enabled => enabled,
+            :attribute_name => attribute_name
+          }
+      }
+
+      DynamoDbFramework.logger.info "[#{self.class}] -Updating TTL Attribute: #{attribute_name}."
+      dynamodb.client.update_time_to_live(table)
+
+      # wait for table to be updated
+      DynamoDbFramework.logger.info "[#{self.class}] -Waiting for table: [#{table_name}] to be updated."
+      wait_until_ttl_changed(table_name)
+
+      DynamoDbFramework.logger.info "[#{self.class}] -Table: [#{table_name}] updated."
+    end
+
+    def get_ttl_status(table_name)
+      table = {
+        :table_name => table_name
+      }
+
+      dynamodb.client.describe_time_to_live(table)['time_to_live_description']
+    end
+
     def drop_index(table_name, index_name)
       unless has_index?(table_name, index_name)
         return
@@ -235,7 +263,25 @@ module DynamoDbFramework
 
     end
 
-    def create(table_name, attributes, partition_key, range_key = nil, read_capacity = 20, write_capacity = 10, global_indexes = nil)
+    def wait_until_ttl_changed(table_name)
+
+      end_time = wait_timeout
+      while Time.now < end_time do
+
+        status = get_ttl_status(table_name)['time_to_live_status']
+
+        if status == 'ENABLED' || status == 'DISABLED'
+          return
+        end
+
+        sleep(5)
+      end
+
+      raise "Timeout occurred while waiting for table: #{table_name}, to update TTL status."
+
+    end
+
+    def create(table_name, attributes, partition_key, range_key = nil, read_capacity = 20, write_capacity = 10, global_indexes = nil, billing_mode = 'PROVISIONED')
 
       if exists?(table_name)
         return
@@ -257,11 +303,17 @@ module DynamoDbFramework
           :table_name => table_name,
           :attribute_definitions => attribute_definitions,
           :key_schema => key_schema,
+          :billing_mode => billing_mode
+      }
+
+      unless billing_mode == 'PAY_PER_REQUEST'
+        table = table.merge(
           :provisioned_throughput => {
-              :read_capacity_units => read_capacity,
-              :write_capacity_units => write_capacity
+            :read_capacity_units => read_capacity,
+            :write_capacity_units => write_capacity
           }
-      }
+        )
+      end
 
       if global_indexes != nil
         table[:global_secondary_indexes] = global_indexes
@@ -316,11 +368,17 @@ module DynamoDbFramework
           :table_name => table_name,
           :attribute_definitions => attribute_definitions,
           :key_schema => key_schema,
+          :billing_mode => options[:billing_mode] || 'PROVISIONED'
+      }
+
+      unless options[:billing_mode] == 'PAY_PER_REQUEST'
+        table = table.merge(
           :provisioned_throughput => {
-              :read_capacity_units => options[:read_capacity],
-              :write_capacity_units => options[:write_capacity]
+            :read_capacity_units => options[:read_capacity],
+            :write_capacity_units => options[:write_capacity]
           }
-      }
+        )
+      end
 
       if options[:global_indexes] != nil
         table[:global_secondary_indexes] = options[:global_indexes]
@@ -338,7 +396,7 @@ module DynamoDbFramework
       DynamoDbFramework.logger.info "[#{self.class}] - Table: [#{table_name}] created."
     end
 
-    def create_global_index(name, partition_key, range_key = nil, read_capacity = 20, write_capacity = 10)
+    def create_global_index(name, partition_key, range_key = nil, read_capacity = 20, write_capacity = 10, billing_mode = 'PROVISIONED')
 
       key_schema = []
 
@@ -352,13 +410,18 @@ module DynamoDbFramework
           :key_schema => key_schema,
           :projection => {
               :projection_type => :ALL
-          },
-          :provisioned_throughput => {
-              :read_capacity_units => read_capacity,
-              :write_capacity_units => write_capacity,
           }
       }
 
+      if billing_mode == 'PROVISIONED'
+        index = index.merge(
+          :provisioned_throughput => {
+            :read_capacity_units => read_capacity,
+            :write_capacity_units => write_capacity,
+          }
+        )
+      end
+
       return index
     end
 

data/lib/dynamodb_framework/version.rb

@@ -1,3 +1,3 @@
 module DynamoDbFramework
-  VERSION = '1.7.0'
+  VERSION = '2.0.1'
 end

data/lib/dynamodb_framework.rb

@@ -1,3 +1,4 @@
+require 'aws-sdk-dynamodb'
 require 'hash_kit'
 require 'json'
 require_relative 'dynamodb_framework/version'

data/spec/{dynamodb_table_manager_spec.rb → dynamodb_framework/dynamodb_table_manager_spec.rb}

@@ -117,6 +117,56 @@ RSpec.describe DynamoDbFramework::TableManager do
 
   end
 
+  it 'can update the TTL attribute' do
+
+    exists = subject.exists?('update_ttl_test')
+
+    if exists
+      subject.drop('update_ttl_test')
+    end
+
+    builder = DynamoDbFramework::AttributesBuilder.new
+    builder.add(:ttl_date, :N)
+
+    subject.create('update_ttl_test', builder.attributes, :ttl_date)
+
+    subject.update_ttl_attribute('update_ttl_test', true, 'ttl_date')
+
+    expect(subject.get_ttl_status('update_ttl_test')['time_to_live_status']).to eq('ENABLED')
+
+    subject.drop('update_ttl_test')
+
+  end
+
+  it 'can disable the TTL attribute' do
+
+    exists = subject.exists?('update_ttl_test')
+
+    if exists
+      subject.drop('update_ttl_test')
+    end
+
+    builder = DynamoDbFramework::AttributesBuilder.new
+    builder.add(:ttl_date, :N)
+
+    subject.create('update_ttl_test', builder.attributes, :ttl_date)
+
+    subject.update_ttl_attribute('update_ttl_test', true, 'ttl_date')
+
+    subject.update_ttl_attribute('update_ttl_test', false, 'ttl_date')
+
+    expect(subject.get_ttl_status('update_ttl_test')['time_to_live_status']).to eq('DISABLED')
+
+    subject.drop('update_ttl_test')
+
+  end
+
+  it 'handles timeouts when dynamodb fails to respond' do
+    allow(subject).to receive('wait_timeout').and_return(Time.now)
+
+    expect{subject.wait_until_ttl_changed('update_ttl_test')}.to raise_error("Timeout occurred while waiting for table: update_ttl_test, to update TTL status.")
+  end
+
   it 'can drop an existing global secondary index' do
 
     exists = subject.exists?('drop_index_test')

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
 require "rubygems"
 require "bundler"
-require 'aws-sdk-core'
 require 'dynamodb_framework'
 require_relative '../spec/test_migration_script1'
 require_relative '../spec/test_migration_script2'
@@ -9,12 +13,7 @@ require_relative '../spec/example_table'
 require_relative '../spec/example_index'
 require 'pry'
 
-require 'simplecov'
-SimpleCov.start do
-  add_filter '/spec/'
-end
-
-DYNAMODB_STORE_ENDPOINT = 'http://dynamodb:8000'
+DYNAMODB_STORE_ENDPOINT = ENV.fetch('DYNAMODB_ENDPOINT', 'http://localhost:8000')
 
 Aws.config[:credentials] = Aws::Credentials.new('test_key', 'test_secret')
 Aws.config[:region] = 'eu-west-1'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb_framework
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.1
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,23 +95,37 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-core
+  name: aws-sdk-dynamodb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 description: A lightweight framework to provide managers for working with aws dynamodb
   (incuding local version).
 email:
-- vaughanbritton@gmail.com
+- vaughan.britton@sage.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -132,16 +146,16 @@ files:
 - lib/dynamodb_framework/dynamodb_table_manager.rb
 - lib/dynamodb_framework/hash_helper.rb
 - lib/dynamodb_framework/version.rb
-- spec/dynamodb_index_spec.rb
-- spec/dynamodb_migration_manager_spec.rb
-- spec/dynamodb_namespace_migration_manager_spec.rb
-- spec/dynamodb_query_spec.rb
-- spec/dynamodb_repository_spec.rb
-- spec/dynamodb_table_manager_spec.rb
-- spec/dynamodb_table_spec.rb
+- spec/dynamodb_framework/dynamodb_index_spec.rb
+- spec/dynamodb_framework/dynamodb_migration_manager_spec.rb
+- spec/dynamodb_framework/dynamodb_namespace_migration_manager_spec.rb
+- spec/dynamodb_framework/dynamodb_query_spec.rb
+- spec/dynamodb_framework/dynamodb_repository_spec.rb
+- spec/dynamodb_framework/dynamodb_table_manager_spec.rb
+- spec/dynamodb_framework/dynamodb_table_spec.rb
+- spec/dynamodb_framework/hash_helper_spec.rb
 - spec/example_index.rb
 - spec/example_table.rb
-- spec/hash_helper_spec.rb
 - spec/spec_helper.rb
 - spec/test_item.rb
 - spec/test_migration_script1.rb
@@ -165,8 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A lightweight framework to provide managers for working with aws dynamodb