umbrellio-sequel-plugins 0.4.0.112 → 0.4.0.152

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a60c4a9f3ea7a1e632f44ba475c8523c65eb693e5b92f6d8f36825510af59e8c
-  data.tar.gz: aba42c9f420d1b042cb37b5410e76a9dc6eadcc2d8d38af1e97a8ae7b10f22a8
+  metadata.gz: 7c457e432fd30ccbc7eea5a66e94ce828c179dc25e45f403ee8a7cc78d23d8f1
+  data.tar.gz: 3fee2f7af3fedb7ed161964ce6a1bdd4b115b88d8d4faa67bc14f9d0317c74b8
 SHA512:
-  metadata.gz: 7ac48cc499a39b5f42fa9eb264ba2afe095a4aa5d367730db5843397f2f97a70ac37a7911a81f0c62bd5d8ba049361b3cb87678b91ed96fb7c3d0074f8787431
-  data.tar.gz: 8cc13c34e85496374c70b464f624cee2667d40c567c493f6261f9b6f4d60dfc28fb3e9df9fc5369e2bd3a73fdf45d9a4b96d8a0c88a2eed35595bb127b9e5bd8
+  metadata.gz: '093103fc7ae3108cc818312319d63ef2229073bfa48453a71d764de9f498bc597b09c5148219c12b930a334824ed6ef828c44b4a814470a90739bf41cca3e12e'
+  data.tar.gz: 416ed5d8f41e6d947fc8b82d4752e8caf55dd985f639d8b347b15e3e523fc067c133c14f4d21838c0b3221eb847ba3fe2433907d0349f4b42dfe865545511dee

data/README.md

@@ -13,28 +13,30 @@ gem 'umbrellio-sequel-plugins'
 
 And then execute:
 
-    $ bundle
+$ bundle
 
 # Extensions
 
-- `CurrencyRates`
-- `PGTools`
-- `Slave`
-- `Synchronize`
-- `methods_in_migrations`
-- `deferrable_foreign_keys`
+- [`CurrencyRates`](#CurrencyRates)
+- [`PGTools`](#PGTools)
+- [`Slave`](#Slave)
+- [`Synchronize`](#Synchronize)
+- [`Methods in Migrations`](#Methods-in-Migrations)
+- [`Deferrable Foreign Keys`](#Deferrable-Foreign-Keys)
 
 # Plugins
 
-- `Duplicate`
-- `GetColumnValue`
-- `StoreAccessors`
-- `Synchronize`
-- `Upsert`
-- `WithLock`
+- [`AttrEncrypted`](#AttrEncrypted)
+- [`Duplicate`](#Duplicate)
+- [`GetColumnValue`](#GetColumnValue)
+- [`MoneyAccessors`](#MoneyAccessors)
+- [`StoreAccessors`](#StoreAccessors)
+- [`Synchronize`](#Synchronize)
+- [`Upsert`](#Upsert)
+- [`WithLock`](#WithLock)
 
 # Tools
-- `TimestampMigratorUndoExtension`
+- [`TimestampMigratorUndoExtension`](#TimestampMigratorUndoExtension)
 
 ## CurrencyRates
 
@@ -202,6 +204,39 @@ end
 #   => <Husband @attributes={id:1, wife_id: 1}>
 ```
 
+## AttrEncrypted
+
+Enable: `Sequel::Model.plugin :attr_encrypted`
+
+Plugin for storing encrypted model attributes.
+
+Example:
+
+```ruby
+Sequel.migration do
+  change do
+    alter_table :orders do
+      add_column :encrypted_first_name, :text
+      add_column :encrypted_last_name, :text
+      add_column :encrypted_secret_data, :text
+    end
+  end
+end
+
+class Order < Sequel::Model
+  attr_encrypted :first_name, :last_name, key: Settings.private_key
+  attr_encrypted :secret_data, key: Settings.another_private_key
+end
+
+Order.create(first_name: "Ivan")
+# => INSERT INTO "orders" ("encrypted_first_name") VALUES ('/sTi9Q==$OTpuMRq5k8R3JayQ$WjSManQGP9UaZ3C40yDjKg==')
+
+order = Order.create(first_name: "Ivan", last_name: "Smith",
+                      secret_data: { "some_key" => "Some Value" })
+order.first_name # => "Ivan"
+order.secret_data # => { "some_key" => "Some Value" }
+```
+
 ## Duplicate
 
 Enable: `Sequel::Model.plugin :duplicate`
@@ -239,14 +274,14 @@ item.get_column_value(:amount) # => 0.5e2
 
 ## MoneyAccessors
 
-**Important:** requires `money` gem described above.
+**Important:** requires `money` gem described below.
 
 Plugin for using money field keys as model properties.
 
 Enable:
 
 ```ruby
-add_runtime_dependency "money"
+gem "money"
 Sequel::Model.plugin :money_accessors
 ````
 
@@ -301,7 +336,7 @@ Example:
 
 ```ruby
 class User < Sequel::Model
-   store :data, :first_name
+  store :data, :first_name
 end
 
 user = User.create(first_name: "John")
@@ -311,7 +346,7 @@ user.data # => {"first_name": "John"}
 
 ## Synchronize
 
-**Important:** requires a `synchronize` extension described above.
+**Important:** requires a `synchronize` extension described below.
 
 Same as `DB#synchronize_with`
 
@@ -353,7 +388,7 @@ Example:
 ```ruby
 user = User.first
 user.with_lock do
-    user.update(name: "James")
+  user.update(name: "James")
 end
 ```
 

data/lib/sequel/plugins/attr_encrypted.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Creates encrypted attribute storing
+module Sequel::Plugins::AttrEncrypted
+  SEPARATOR = "$"
+  require "sequel/plugins/attr_encrypted/simple_crypt"
+
+  module ClassMethods
+    # Setup attr encrypted
+    #
+    # @param attrs [Array<Symbol>] column names
+    # @param key [String] 32 bytes key
+    # @example
+    #   Sequel.migration do
+    #     change do
+    #       alter_table :orders do
+    #         add_column :encrypted_first_name, :text
+    #         add_column :encrypted_last_name, :text
+    #         add_column :encrypted_secret_data, :text
+    #       end
+    #     end
+    #   end
+    #
+    #   class Order < Sequel::Model
+    #     attr_encrypted :first_name, :last_name, key: Settings.private_key
+    #     attr_encrypted :secret_data, key: Settings.another_private_key
+    #   end
+
+    #   Order.create(first_name: "Ivan")
+    #   # => INSERT INTO "orders" ("encrypted_first_name")
+    #               VALUES ('/sTi9Q==$OTpuMRq5k8R3JayQ$WjSManQGP9UaZ3C40yDjKg==')
+    #
+    #   order = Order.create(first_name: "Ivan", last_name: "Smith",
+    #                        secret_data: { "some_key" => "Some Value" })
+    #   order.first_name # => "Ivan"
+    #   order.last_name # => "Smith"
+    #   order.secret_data # => { "some_key" => "Some Value" }
+    def attr_encrypted(*attrs, key:)
+      include_encrypted_module!
+      attrs.each do |attr|
+        define_encrypted_setter(attr, key)
+        define_encrypted_getter(attr, key)
+        @_encrypted_attributes << attr
+      end
+    end
+
+    private
+
+    def define_encrypted_setter(attr, key)
+      @_attr_encrypted_module.module_eval do
+        define_method("#{attr}=") do |value|
+          instance_variable_set("@#{attr}", value)
+
+          send("encrypted_#{attr}=", SimpleCrypt.encrypt(value.to_json, key))
+        end
+      end
+    end
+
+    def define_encrypted_getter(attr, key)
+      @_attr_encrypted_module.module_eval do
+        define_method(attr.to_s) do
+          instance_variable_get("@#{attr}") || begin
+            decrypted = SimpleCrypt.decrypt(send("encrypted_#{attr}"), key)
+
+            result = !decrypted.nil? ? JSON.parse(decrypted) : decrypted
+            instance_variable_set("@#{attr}", result)
+          end
+        end
+      end
+    end
+
+    def include_encrypted_module!
+      return if defined?(@_attr_encrypted_module)
+
+      @_encrypted_attributes ||= []
+      @_attr_encrypted_module = Module.new
+      prepend @_attr_encrypted_module
+    end
+  end
+
+  module InstanceMethods
+    def save(*)
+      super.tap { _reset_encrypted_attrs_ivars }
+    end
+
+    def refresh(*)
+      super.tap { _reset_encrypted_attrs_ivars }
+    end
+
+    private
+
+    def _reset_encrypted_attrs_ivars
+      self.class.instance_variable_get(:@_encrypted_attributes)&.each do |attr|
+        instance_variable_set("@#{attr}", nil)
+      end
+    end
+  end
+end

data/lib/sequel/plugins/attr_encrypted/simple_crypt.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Sequel::Plugins::AttrEncrypted::SimpleCrypt
+  extend self
+  require "base64"
+
+  SEPARATOR = "$"
+
+  def encrypt(string, key)
+    return unless string.is_a?(String) && !string.empty?
+
+    encryptor = new_cipher(key, &:encrypt)
+    iv = encryptor.random_iv
+
+    encrypted = encryptor.update(string) + encryptor.final
+    dump(encrypted, iv, encryptor.auth_tag)
+  end
+
+  def decrypt(string, key)
+    encrypted, iv, auth_tag = parse(string) if string.is_a?(String)
+    return if [encrypted, iv, auth_tag].any?(&:nil?)
+
+    decryptor = new_cipher(key, &:decrypt)
+    decryptor.iv = iv
+    decryptor.auth_tag = auth_tag
+
+    decryptor.update(encrypted) + decryptor.final
+  end
+
+  private
+
+  def new_cipher(key)
+    result = OpenSSL::Cipher::AES256.new(:gcm)
+    yield(result)
+    result.key = key
+    result
+  end
+
+  def parse(string)
+    string.split(SEPARATOR).map { |x| Base64.strict_decode64(x) }
+  end
+
+  def dump(*values)
+    [*values].map { |x| Base64.strict_encode64(x) }.join(SEPARATOR)
+  end
+end

data/utils/database.rb

@@ -22,6 +22,7 @@ Sequel.extension :pg_array_ops
 Sequel.extension :pg_json_ops
 Sequel.extension :pg_range_ops
 
+Sequel::Model.plugin :attr_encrypted
 Sequel::Model.plugin :duplicate
 Sequel::Model.plugin :get_column_value
 Sequel::Model.plugin :money_accessors

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: umbrellio-sequel-plugins
 version: !ruby/object:Gem::Version
-  version: 0.4.0.112
+  version: 0.4.0.152
 platform: ruby
 authors:
 - nulldef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -190,6 +190,8 @@ files:
 - lib/sequel/extensions/pg_tools.rb
 - lib/sequel/extensions/slave.rb
 - lib/sequel/extensions/synchronize.rb
+- lib/sequel/plugins/attr_encrypted.rb
+- lib/sequel/plugins/attr_encrypted/simple_crypt.rb
 - lib/sequel/plugins/duplicate.rb
 - lib/sequel/plugins/get_column_value.rb
 - lib/sequel/plugins/money_accessors.rb
@@ -224,8 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Sequel plugins