dynamodb_framework 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc49f68b676b1c89e2ca6dbb4c26d21e55b64e65
-  data.tar.gz: 10048c3d4ca703ed3b5b08af98c6ce82f8e9bdfc
+  metadata.gz: 9f1a20436eb99c2fd68b4026a3cd3f089d071253
+  data.tar.gz: 40b8de349d71b2ec3b518be6ddbead9ad649fbd7
 SHA512:
-  metadata.gz: 6f195b4b78087f0d6b6321224dab72978b7f2acc075c4856fea9c9aa681d4a68ce9267837b3e8bf432c66a2e7bccc6f2bb8f17a0041bee4f3c3e74eaa8791570
-  data.tar.gz: ca6d31d38bebc5937bf70f092f261e5e6af13a96800606bf0206508f8dd85a36db0cca7f7f9698026072115c5c3a779676405a49ddb18251bef3a1c7a9c62708
+  metadata.gz: 2ca18eebc95c0f975c429c8950c89e962ffc512e2a6b6fdfce08dfdbbb066167a487a6bde7950097c28006f32d430861be537d65a0d7c793d503014acb64dec3
+  data.tar.gz: fa8166c654583540e2f2d4289899f618203097ca174f26fbe68eb7c68316ec4ff9c3cd3e100f735a9d7c552905f67ac7061080858d7d811f98529d34aa9f4d8a

data/lib/dynamodb_framework/dynamodb_attributes_builder.rb

@@ -60,5 +60,9 @@ module DynamoDbFramework
 
     end
 
+    def contains(name:)
+      @attributes.detect { |a| a[:name] == name } != nil
+    end
+
   end
 end

data/lib/dynamodb_framework/dynamodb_index.rb

@@ -46,13 +46,19 @@ 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)
+    def create(store: DynamoDbFramework.default_store, read_capacity: 25, write_capacity: 25, submit: true)
       unless self.instance_variable_defined?(:@table)
         raise DynamoDbFramework::Index::InvalidConfigException.new('Table must be specified.')
       end
       table = self.instance_variable_get(:@table)
       table_name = table.config[:table_name]
 
+      #make method idempotent
+      if exists?(store: store)
+        wait_until_active(store: store)
+        return
+      end
+
       unless self.instance_variable_defined?(:@partition_key)
         raise DynamoDbFramework::Index::InvalidConfigException.new('Partition key must be specified.')
       end
@@ -80,7 +86,11 @@ module DynamoDbFramework
 
       index =table_manager.create_global_index(full_index_name, partition_key[:field], range_key_field, read_capacity, write_capacity)
 
-      table_manager.add_index(table_name, builder.attributes, index)
+      if submit
+        table_manager.add_index(table_name, builder.attributes, index)
+      end
+
+      index
     end
 
     def update(store: DynamoDbFramework.default_store, read_capacity:, write_capacity:)
@@ -99,6 +109,10 @@ module DynamoDbFramework
       table = self.instance_variable_get(:@table)
       table_name = table.config[:table_name]
 
+      unless exists?(store: store)
+        return
+      end
+
       DynamoDbFramework::TableManager.new(store).drop_index(table_name, full_index_name)
     end
 
@@ -111,6 +125,15 @@ module DynamoDbFramework
       DynamoDbFramework::TableManager.new(store).has_index?(table_name, full_index_name)
     end
 
+    def wait_until_active(store: DynamoDbFramework.default_store)
+      unless self.instance_variable_defined?(:@table)
+        raise DynamoDbFramework::Index::InvalidConfigException.new('Table must be specified.')
+      end
+      table = self.instance_variable_get(:@table)
+      table_name = table.config[:table_name]
+      DynamoDbFramework::TableManager.new(store).wait_until_index_active(table_name, full_index_name)
+    end
+
     def query(partition:)
       DynamoDbFramework::Query.new(index_name: config[:index_name], table_name: config[:table].config[:table_name], partition_key: config[:partition_key][:field], partition_value: partition)
     end

data/lib/dynamodb_framework/dynamodb_table.rb

@@ -41,7 +41,14 @@ 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)
+    def create(store: DynamoDbFramework.default_store, read_capacity: 25, write_capacity: 25, indexes: [])
+
+      #make method idempotent
+      if exists?(store: store)
+        wait_until_active(store: store)
+        return
+      end
+
       unless self.instance_variable_defined?(:@partition_key)
         raise DynamoDbFramework::Table::InvalidConfigException.new('Partition key must be specified.')
       end
@@ -57,7 +64,26 @@ module DynamoDbFramework
         builder.add({ name: range_key[:field], type: range_key[:type], key: :range })
       end
 
-      DynamoDbFramework::TableManager.new(store).create_table({ name: full_table_name, attributes: builder.attributes, read_capacity: read_capacity, write_capacity: write_capacity })
+      global_indexes = nil
+      if indexes != nil && indexes.length > 0
+        global_indexes = []
+        indexes.each do |i|
+          global_indexes << i.create(store: store, submit: false)
+          index_partition_key = i.instance_variable_get(:@partition_key)
+          unless builder.contains(name: index_partition_key[:field])
+            builder.add({ name: index_partition_key[:field], type: index_partition_key[:type] })
+          end
+          if i.instance_variable_defined?(:@range_key)
+            index_range_key = i.instance_variable_get(:@range_key)
+            unless builder.contains(name: index_range_key[:field])
+              builder.add({ name: index_range_key[:field], type: index_range_key[:type] })
+            end
+          end
+
+        end
+      end
+
+      DynamoDbFramework::TableManager.new(store).create_table({ name: full_table_name, attributes: builder.attributes, read_capacity: read_capacity, write_capacity: write_capacity, global_indexes: global_indexes })
     end
 
     def update(store: DynamoDbFramework.default_store, read_capacity:, write_capacity:)
@@ -65,6 +91,9 @@ module DynamoDbFramework
     end
 
     def drop(store: DynamoDbFramework.default_store)
+      unless exists?(store: store)
+        return
+      end
       DynamoDbFramework::TableManager.new(store).drop(full_table_name)
     end
 
@@ -72,6 +101,18 @@ module DynamoDbFramework
       DynamoDbFramework::TableManager.new(store).exists?(full_table_name)
     end
 
+    def wait_until_active(store: DynamoDbFramework.default_store)
+      DynamoDbFramework::TableManager.new(store).wait_until_active(full_table_name)
+    end
+
+    def get_status(store: DynamoDbFramework.default_store)
+      DynamoDbFramework::TableManager.new(store).get_status(full_table_name)
+    end
+
+    def active?(store: DynamoDbFramework.default_store)
+      DynamoDbFramework::TableManager.new(store).get_status(full_table_name) == 'ACTIVE'
+    end
+
     def query(partition:)
       DynamoDbFramework::Query.new(table_name: config[:table_name], partition_key: config[:partition_key][:field], partition_value: partition)
     end

data/lib/dynamodb_framework/dynamodb_table_manager.rb

@@ -116,6 +116,10 @@ module DynamoDbFramework
     end
 
     def drop_index(table_name, index_name)
+      unless has_index?(table_name, index_name)
+        return
+      end
+
       table = {
           :table_name => table_name,
           :global_secondary_index_updates => [
@@ -130,6 +134,7 @@ module DynamoDbFramework
       # wait for table to be updated
       DynamoDbFramework.logger.info "[#{self.class}] -Deleting global index: #{index_name}."
       wait_until_index_dropped(table_name, index_name)
+
       DynamoDbFramework.logger.info "[#{self.class}] -Index: [#{index_name}] dropped."
     end
 
@@ -154,9 +159,13 @@ module DynamoDbFramework
       return nil
     end
 
+    def wait_timeout
+      Time.now + 900 #15 minutes
+    end
+
     def wait_until_active(table_name)
 
-      end_time = Time.now + 300
+      end_time = wait_timeout
       while Time.now < end_time do
 
         status = get_status(table_name)
@@ -168,13 +177,31 @@ module DynamoDbFramework
         sleep(5)
       end
 
-      raise "Timeout occured while waiting for table: #{table_name}, to become active."
+      raise "Timeout occurred while waiting for table: #{table_name}, to become active."
+
+    end
+
+    def wait_until_dropped(table_name)
+
+      end_time = wait_timeout
+      while Time.now < end_time do
+
+        status = get_status(table_name)
+
+        if status == nil
+          return
+        end
+
+        sleep(5)
+      end
+
+      raise "Timeout occurred while waiting for table: #{table_name}, to be dropped."
 
     end
 
     def wait_until_index_active(table_name, index_name)
 
-      end_time = Time.now + 300
+      end_time = wait_timeout
       while Time.now < end_time do
 
         status = get_index_status(table_name, index_name)
@@ -186,13 +213,13 @@ module DynamoDbFramework
         sleep(5)
       end
 
-      raise "Timeout occured while waiting for table: #{table_name}, index: #{index_name}, to become active."
+      raise "Timeout occurred while waiting for table: #{table_name}, index: #{index_name}, to become active."
 
     end
 
     def wait_until_index_dropped(table_name, index_name)
 
-      end_time = Time.now + 300
+      end_time = wait_timeout
       while Time.now < end_time do
 
         status = get_index_status(table_name, index_name)
@@ -204,7 +231,7 @@ module DynamoDbFramework
         sleep(5)
       end
 
-      raise "Timeout occured while waiting for table: #{table_name}, index: #{index_name}, to be dropped."
+      raise "Timeout occurred while waiting for table: #{table_name}, index: #{index_name}, to be dropped."
 
     end
 

data/lib/dynamodb_framework/version.rb

@@ -1,3 +1,3 @@
 module DynamoDbFramework
-  VERSION = '1.5.2'
+  VERSION = '1.6.0'
 end

data/spec/dynamodb_table_spec.rb

@@ -22,6 +22,22 @@ RSpec.describe DynamoDbFramework::Table do
         end
       end
 
+      context 'with an index specified' do
+        let(:table_name) { ExampleTable.config[:table_name] }
+        let(:index_name) { ExampleIndex.config[:index_name] }
+        before do
+          table_manager.drop(table_name)
+          table_manager.drop_index(table_name, index_name)
+        end
+        it 'should create the table and index' do
+          expect(table_manager.exists?(table_name)).to be false
+          expect(ExampleIndex.exists?(store: store)).to be false
+          ExampleTable.create(store: store, indexes: [ExampleIndex])
+          expect(table_manager.exists?(table_name)).to be true
+          expect(ExampleIndex.exists?(store: store)).to be true
+        end
+      end
+
       context 'without a range key' do
         let(:table_name) { ExampleTableWithoutRangeKey.config[:table_name] }
         before do
@@ -33,6 +49,19 @@ RSpec.describe DynamoDbFramework::Table do
           expect(table_manager.exists?(table_name)).to be true
         end
       end
+
+      context 'when already exists' do
+        let(:table_name) { ExampleTableWithoutRangeKey.config[:table_name] }
+        before do
+          table_manager.drop(table_name)
+          ExampleTableWithoutRangeKey.create(store: store)
+        end
+        it 'should return without error' do
+          expect(table_manager.exists?(table_name)).to be true
+          expect { ExampleTableWithoutRangeKey.create(store: store) }.not_to raise_error
+          expect(table_manager.exists?(table_name)).to be true
+        end
+      end
     end
     context 'when an invalid table class calls the create method' do
       context 'without a table_name specified' do
@@ -111,6 +140,29 @@ RSpec.describe DynamoDbFramework::Table do
     end
   end
 
+  describe '#wait_until_active' do
+    context 'when a table exists' do
+      let(:table_name) { ExampleTable.config[:table_name] }
+      before do
+        table_manager.drop(table_name)
+        ExampleTable.create(store: store)
+      end
+      it 'should not raise timeout error' do
+        expect { ExampleTable.wait_until_active(store: store) }.not_to raise_error
+      end
+    end
+    context 'when a table does NOT exist' do
+      let(:table_name) { ExampleTable.config[:table_name] }
+      before do
+        table_manager.drop(table_name)
+        allow_any_instance_of(DynamoDbFramework::TableManager).to receive(:wait_timeout).and_return(Time.now)
+      end
+      it 'should raise timeout error' do
+        expect { ExampleTable.wait_until_active(store: store) }.to raise_error
+      end
+    end
+  end
+
   describe '#query' do
 
     let(:repository) do

data/spec/example_index.rb

@@ -30,7 +30,7 @@ class ExampleIndexWithoutPartitionKey
   extend DynamoDbFramework::Index
 
   table ExampleTable
-  index_name 'example_index'
+  index_name 'example_index.without.partition'
   range_key :id, :S
 
 end
@@ -38,7 +38,7 @@ end
 class ExampleIndexWithoutRangeKey
   extend DynamoDbFramework::Index
 
-  index_name 'example_index'
+  index_name 'example_index.without.range'
   table ExampleTable
   partition_key :name, :S
 

data/spec/example_table.rb

@@ -27,7 +27,7 @@ end
 class ExampleTableWithoutPartitionKey
   extend DynamoDbFramework::Table
 
-  table_name 'example'
+  table_name 'example.without.partition'
   range_key :timestamp, :N
 
 end
@@ -35,7 +35,7 @@ end
 class ExampleTableWithoutRangeKey
   extend DynamoDbFramework::Table
 
-  table_name 'example'
+  table_name 'example.without.range'
   partition_key :id, :S
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb_framework
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,16 +98,16 @@ dependencies:
   name: aws-sdk-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.10'
 description: A lightweight framework to provide managers for working with aws dynamodb
   (incuding local version).
 email: