dynamodb_framework 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92cddfb4858c3bc9d655d4ddb353d437a4bb3e417695c23053ce426be35d3056
-  data.tar.gz: cc8e3f7286350e88f09b7a9f68efb57d7220a82c6cc513e54bcb110182e10e3d
+  metadata.gz: a38a1f91daf2b721a7f09e6f4ff5d9a796f8d0b22f09908d46717f96e9a0661b
+  data.tar.gz: 46d2c82a0ab2042abaf0e3dd317038eda3861e40006ac4eed1067b9da9d4fd01
 SHA512:
-  metadata.gz: bd3de1be8d514d5af939c48737d0316c02bb27367fba8b7819c43a7f30e529b88529f975716eca5e005f24449a201a09c260c247a4b4668ce9a9dc520e659ee3
-  data.tar.gz: a441ff92489712e5218d20e6957508426aa9445a9dc91cfdee727dce1f23e7accd26928e142d348a16148fee6a88e3bc2bbd037dd4870e57d826abff12d72167
+  metadata.gz: 4e4c59111999afe7ae06282a121e0c46c2ac5935dc006e2630d83a4c26a9afd760d9a7f120c720e4471d633f4f4db83d5609bb0b1b48aaebf517b8b8a6698208
+  data.tar.gz: 2e3161f248e86fe8d65145c9b9483b0f7f90f179a8fd1c93e60b4b7c6eaf571387754c9dabb89def3b015755f61d87e9faad66a1267ca5454b9cfce00562f937

data/lib/dynamodb_framework/dynamodb_table_manager.rb

@@ -116,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
@@ -236,6 +263,24 @@ module DynamoDbFramework
 
     end
 
+    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)

data/lib/dynamodb_framework/version.rb

@@ -1,3 +1,3 @@
 module DynamoDbFramework
-  VERSION = '1.8.0'
+  VERSION = '1.9.0'
 end

data/spec/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')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb_framework
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -165,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A lightweight framework to provide managers for working with aws dynamodb