daffy_lib 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83018eb7ecab966f8b2735dfdf734799b847e275b53c0c744cf11ea3cbb090f9
-  data.tar.gz: b7d09dad2fb06cd398ac783b7dec39b6fa0891098691a5c95d41efbd459e4848
+  metadata.gz: faba74eda53723e334c18a034844f7800d5ddce97a924fb2178eb415f6ed49fe
+  data.tar.gz: ee433a137161339be70a78ef005f5f09e0bfbe4f0d8da3212efeb60ce06ebbb5
 SHA512:
-  metadata.gz: 1a2708f077f87e1d3b316449b387114f82315ab4983e733bcda749c2b59cf8cd9fc9c4d0a9956b68f4f7b67e7c3ad40777869ecca58a80645502715c279050d2
-  data.tar.gz: bf09073a430ad69567c4069727d5d9f3fab1cf8afa01f8de7cc8cdd205f21cf757cc8e39914aad7b6cc0ad22ba7c0484fc91907152c9c3cc99ad386c77007506
+  metadata.gz: b93f7a314777375667919219dab46f84e76d39dfe2f0d0f394a8351eee057ed57a424816e5d936163779fa7bed6001602843df6c289cfc4bb68c4b2944ab8e01
+  data.tar.gz: f00b7e4c6300d8ae5d4982339eb7fbc4af089faf9f5ae15956339aaef05b05d3b63d2852b98d3f1b7041da203dbeded747a4858a2a22a72798be88053a24c89f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    daffy_lib (0.1.1)
+    daffy_lib (0.1.2)
       porky_lib
       rails
       redis
@@ -68,7 +68,7 @@ GEM
     attr_encrypted (3.1.0)
       encryptor (~> 3.0.0)
     aws-eventstream (1.0.3)
-    aws-partitions (1.263.0)
+    aws-partitions (1.265.0)
     aws-sdk-core (3.89.1)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
@@ -102,7 +102,7 @@ GEM
     factory_bot_rails (5.1.1)
       factory_bot (~> 5.1.0)
       railties (>= 4.2.0)
-    ffi (1.11.3)
+    ffi (1.12.1)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.7.1)

data/README.md

@@ -66,46 +66,11 @@ t.index [:guid], name: :index_encryption_keys_on_guid, unique: true
 t.index [:partition_guid, :key_epoch], name: :index_encryption_keys, unique: true
 
 ```
-Next, if the models do not have existing records, one can run `rake db:migrate:add_encryption_fields[modelname]` to add the `partition_guid` and `encryption_epoch` columns.
+Next, run `rake db:migrate:add_encryption_fields['modelname']` to add the `partition_guid` and `encryption_epoch` columns to each model.
 
-However, if there may already be existing records, then the `generate_partition_guid` and `generate_encryption_epoch` methods need to be invoked before the new columns can be set to required.  Below is a sample migration file for our example above, where one should replace `models` with their own.
-```
-  def up
-    models = %i[users users/attributes]
-
-    models.each do |model|
-
-      model_classname = model.to_s.camelize.singularize.constantize
-      model_tablename = model.to_s.gsub('/', '_')
-
-      add_column model_tablename, :partition_guid, :string
-      add_column model_tablename, :encryption_epoch, :datetime
-
-      model_classname.reset_column_information
-      model_classname.find_each do |record|
-        record.generate_partition_guid
-        record.generate_encryption_epoch
-
-        record.save!(validate: false)
-      end
+Run `rake generate_encryption_attributes['modelname','limit']` to populate existing records of each model with the encryption attributes.  The limit specifies the maximum number of records updated per execution; a limit of 0 means no limit.
 
-      change_column model_tablename, :partition_guid, :string, null: false
-      change_column model_tablename, :encryption_epoch, :datetime, null: false
-    end
-  end
-
-  def down
-    models = %i[users users/attributes]
-
-    models.each do |model|
-      model_tablename = model.to_s.gsub('/', '_')
-
-      remove_column model_tablename, :partition_guid
-      remove_column model_tablename, :encryption_epoch
-    end
-  end
-end
-```
+Finally, once existing records have been populated, it is advisable to perform a final migration to set `partition_guid` and `encryption_epoch` columns to mandatory.
 
 
 ## Development

data/lib/daffy_lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DaffyLib
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/tasks/generate_encryption_attributes.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# :nocov:
+desc 'this task generates partition guid and encryption epoch for the specified model'
+task :generate_encryption_attributes, %i[model limit] => :environment do |_t, args|
+  model = args[:model].camelize
+  limit = args[:limit] || 1000
+  limit = limit.to_i
+
+  abort 'Need to provide `model` as argument' if model.blank?
+
+  model_classname = model.to_s.camelize.singularize.constantize
+
+  model_classname.instance_eval do
+    # Find all records that don't yet have a partition_guid
+    scope :pending_migration, -> { where(partition_guid: nil) }
+  end
+
+  model_classname.reset_column_information
+
+  records = limit.zero? ? model_classname.pending_migration : model_classname.pending_migration.limit(limit)
+
+  records.each do |record|
+    record.generate_partition_guid
+    record.generate_encryption_epoch
+
+    record.save!(validate: false)
+  end
+end
+# :nocov:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: daffy_lib
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Benoît Jeaurond, Weiyun Lu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-17 00:00:00.000000000 Z
+date: 2020-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attr_encrypted
@@ -324,7 +324,6 @@ files:
 - SECURITY.MD
 - bin/console
 - bin/setup
-- daffy_lib-0.1.0.gem
 - daffy_lib.gemspec
 - lib/daffy_lib.rb
 - lib/daffy_lib/caching_encryptor.rb
@@ -338,6 +337,7 @@ files:
 - lib/daffy_lib/validators/string_validator.rb
 - lib/daffy_lib/version.rb
 - lib/tasks/db_tasks.rake
+- lib/tasks/generate_encryption_attributes.rb
 homepage: https://github.com/Zetatango/daffy_lib
 licenses: []
 metadata: {}