umbrellio-sequel-plugins 0.4.0.114 → 0.4.0.164

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8c7ff5ac5ebea27eafa18c31cd1d662265d4f482ef5918cadf94d0aa4f08f7f
-  data.tar.gz: 3fa003eb8fa8c4f8fe5b0f5bb5bc43305a14248f02eeece91013329dfe7be17d
+  metadata.gz: 6bd4394bf53fcf0c95a1c67b2268c5def71d15f2a64fec6e30cb70fcb281caed
+  data.tar.gz: 57178f6c6365073e28bb3787f6253a774c6b134d6cd4a84656725e2d6400d373
 SHA512:
-  metadata.gz: 0b252fd339fa0b4fc0c48861ae344b199cec544b81ad1b39524fc3a787e7a92ddcd7f8bf7160f5b97255ee99cdf08a1c9887872c2d4b28a0878adec9f3de41a6
-  data.tar.gz: 077edb4f06abb73764d73eaab2ef3ee5a9bad1897e5faf9e7b1c892b775ff487b8d3273a74613aad4822336a180f59bd38aa83f50a7e10330007f386ffd8f534
+  metadata.gz: f34fda6b627aed0be50ae0a3fa6bc3978d7186f8477748870ff1871868ddbca2c0175b6bd4a7471b617406b28c0efee4ace1096d94795e40e402d7e0b2d0a1e9
+  data.tar.gz: b440a1b8b808c71b8c52fee03d0ead284dbbdf963cf3391fba385392703db6744b0aad41268e298430641709270f1f595edcabc63e3184ad0ec0d157beb8cecd

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 
 os: linux
+
 dist: xenial
 
 jobs:
@@ -43,10 +44,6 @@ install: bundle install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}
 before_script:
 - psql -c 'create database sequel_plugins;' -U postgres
 
-script:
-- bundle exec rspec
-- bundle exec rubocop
-
 deploy:
   provider: rubygems
   api_key:

data/Gemfile.lock

@@ -8,78 +8,81 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    ast (2.4.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.6)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    i18n (1.8.2)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
+    json (2.3.1)
     method_source (1.0.0)
-    minitest (5.14.0)
-    money (6.13.7)
+    minitest (5.14.2)
+    money (6.13.8)
       i18n (>= 0.6.4, <= 2)
-    parallel (1.19.1)
-    parser (2.7.1.0)
-      ast (~> 2.4.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     pg (1.2.3)
-    pry (0.13.0)
+    pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (2.0.0)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.81.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (0.90.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-config-umbrellio (0.81.0.78)
-      rubocop (= 0.81.0)
-      rubocop-performance (= 1.5.2)
-      rubocop-rails (= 2.5.0)
-      rubocop-rspec (= 1.38.1)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.5.0)
-      activesupport
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    rubocop-config-umbrellio (0.90.0.93)
+      rubocop (= 0.90.0)
+      rubocop-performance (= 1.7.1)
+      rubocop-rails (= 2.7.0)
+      rubocop-rspec (= 1.42.0)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    rubocop-rails (2.7.0)
+      activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.72.0)
-    rubocop-rspec (1.38.1)
-      rubocop (>= 0.68.1)
+      rubocop (>= 0.87.0)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
     ruby-progressbar (1.10.1)
-    sequel (5.31.0)
+    sequel (5.39.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -91,12 +94,12 @@ GEM
       tins (~> 1.0)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tins (1.24.1)
+    tins (1.26.0)
       sync
-    tzinfo (1.2.7)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -13,29 +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`
-- `MoneyAccessors`
-- `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
 
@@ -203,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`
@@ -302,7 +336,7 @@ Example:
 
 ```ruby
 class User < Sequel::Model
-   store :data, :first_name
+  store :data, :first_name
 end
 
 user = User.create(first_name: "John")
@@ -354,7 +388,7 @@ Example:
 ```ruby
 user = User.first
 user.with_lock do
-    user.update(name: "James")
+  user.update(name: "James")
 end
 ```
 

data/Rakefile

@@ -2,7 +2,9 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
 
-task default: :spec
+task default: %i[lint spec]

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.new("aes-256-gcm")
+    yield(result)
+    result.key = key
+    result
+  end
+
+  def parse(string)
+    string.split(SEPARATOR).map { |x| Base64.strict_decode64(x) }
+  end
+
+  def dump(*values)
+    Array(values).map { |x| Base64.strict_encode64(x) }.join(SEPARATOR)
+  end
+end

data/lib/sequel/timestamp_migrator_undo_extension.rb

@@ -8,10 +8,10 @@ module Sequel
     # Rollback a migration
     def undo(version)
       path = files.find { |file| migration_version_from_file(get_filename(file)) == version }
-      raise "Migration #{version} does not exist in the filesystem" unless path
+      error!("Migration #{version} does not exist in the filesystem") unless path
 
       filename = get_filename(path)
-      raise "Migration #{version} is not applied" unless applied_migrations.include?(filename)
+      error!("Migration #{version} is not applied") unless applied_migrations.include?(filename)
 
       migration = get_migration(path)
 
@@ -41,7 +41,7 @@ module Sequel
       end
     end
 
-    Sequel::TimestampMigrator.prepend TimestampMigratorLogger
+    Sequel::TimestampMigrator.prepend(TimestampMigratorLogger)
 
     private
 
@@ -57,6 +57,10 @@ module Sequel
     def get_filename(path)
       File.basename(path).downcase
     end
+
+    def error!(message)
+      raise Sequel::Migrator::Error, message
+    end
   end
 end
 # rubocop:enable Layout/ClassStructure

data/lib/umbrellio-sequel-plugins.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require_relative "umbrellio_sequel_plugins.rb"
+require_relative "umbrellio_sequel_plugins"

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.114
+  version: 0.4.0.164
 platform: ruby
 authors:
 - nulldef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-12-02 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