unidom-common 1.5 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e44a8b8ccece3288519276076c2131e12741b95
-  data.tar.gz: 9b3ae6a040a4049c4fbfdaf933e6f20fa38a5ff6
+  metadata.gz: 1ca73aa2b3b39d5cd33bf7e5a3b6a31605cedfd6
+  data.tar.gz: 6b0d9ab155ff7a442e19d754cc1a78417ffbd3d4
 SHA512:
-  metadata.gz: 078a2f58cc191dd3bafe0b54ba141314b092f3868d9f9e3a870a4f4f48f9c7ad409ed24110498775e633dbef8387649b3c5d770ee3ce29dac597f31c0b66844b
-  data.tar.gz: f24e6d3d7a65872cd0910b3aa7c098a1cbb2e1b7d41e84b50f86f0bd15e5dc351920de85eeed7b3b33fdc4895204332503cf33f37d6935d94b5bd0fc4efe782f
+  metadata.gz: 5ba36cf153a52b1f321b4a97279fce29b33b7b891652d45c3afe96304491337cb3065ebb81df668e6d3c8cac649fd6020a77dd3e7c874f6fb38d990f901eff4e
+  data.tar.gz: c39c2db1e0bad0c883cea0dfafdd5cf84c20050c88414bc8b8966f46ca43fff4d5f96f4491fdf49b41a5d3cc1c2bf9938ae09bdd71833f8cf09678514a940fc6

data/README.md

@@ -164,6 +164,126 @@ Person.passport_number_is('E00000000').first==person                # true
 
 
 
+## Secure Column
+
+```ruby
+# db/migrate/YYYYMMDDHHMMSS_create_orderings.rb
+class CreateOrderings < ActiveRecord::Migration[5.0]
+
+  def change
+
+    create_table :orderings, id: :uuid do |t|
+
+      t.string :placer_name,   null: false, default: nil, limit: 200
+      t.string :taker_name,    null: false, default: nil, limit: 200
+      t.string :receiver_name, null: false, default: nil, limit: 200
+
+      t.jsonb :placer
+      t.jsonb :taker
+      t.jsonb :receiver
+
+      t.binary :placer_identification_number_exact_signature,   null: false, default: nil, limit: 80
+      t.binary :placer_mobile_phone_number_exact_signature,     null: false, default: nil, limit: 80
+      t.binary :taker_identification_number_exact_signature,    null: false, default: nil, limit: 80
+      t.binary :taker_mobile_phone_number_exact_signature,      null: false, default: nil, limit: 80
+      t.binary :receiver_identification_number_exact_signature, null: false, default: nil, limit: 80
+      t.binary :receiver_mobile_phone_number_exact_signature,   null: false, default: nil, limit: 80
+
+      t.column   :state, 'char(1)', null: false, default: 'C'
+      t.datetime :opened_at,        null: false, default: Time.utc(1970)
+      t.datetime :closed_at,        null: false, default: Time.utc(3000)
+      t.boolean  :defunct,          null: false, default: false
+      t.jsonb    :notation,         null: false, default: {}
+
+      t.timestamps
+
+    end
+
+    add_index :orderings, :placer_identification_number_exact_signature,   name: :index_orderings_on_placer_identification_number
+    add_index :orderings, :placer_mobile_phone_number_exact_signature,     name: :index_orderings_on_placer_mobile_phone_number
+    add_index :orderings, :taker_identification_number_exact_signature,    name: :index_orderings_on_taker_identification_number
+    add_index :orderings, :taker_mobile_phone_number_exact_signature,      name: :index_orderings_on_taker_mobile_phone_number
+    add_index :orderings, :receiver_identification_number_exact_signature, name: :index_orderings_on_receiver_identification_number
+    add_index :orderings, :receiver_mobile_phone_number_exact_signature,   name: :index_orderings_on_receiver_mobile_phone_number
+
+  end
+
+end
+
+# app/models/orderings.rb
+class Ordering < ApplicationRecord
+
+  include Unidom::Common::Concerns::ModelExtension
+
+  validates :placer_name,   presence: true, length: { in: 2..columns_hash['placer_name'].limit   }
+  validates :taker_name,    presence: true, length: { in: 2..columns_hash['taker_name'].limit    }
+  validates :receiver_name, presence: true, length: { in: 2..columns_hash['receiver_name'].limit }
+
+  validates :placer_address,   presence: true, length: { in: 2..200 }
+  validates :taker_address,    presence: true, length: { in: 2..200 }
+  validates :receiver_address, presence: true, length: { in: 2..200 }
+
+  validates :placer_identification_number,   presence: true, length: { is: 18 }, format: Unidom::Certificate::China::IdentityCard::FORMAT_VALIDATION_REGEX
+  validates :taker_identification_number,    presence: true, length: { is: 18 }, format: Unidom::Certificate::China::IdentityCard::FORMAT_VALIDATION_REGEX
+  validates :receiver_identification_number, presence: true, length: { is: 18 }, format: Unidom::Certificate::China::IdentityCard::FORMAT_VALIDATION_REGEX
+
+  validates :placer_mobile_phone_number,   presence: true, length: { is: 11 }, numericality: { integer_only: true }, format: Unidom::Contact::China::MobilePhoneNumber::FORMAT_VALIDATION_REGEX
+  validates :taker_mobile_phone_number,    presence: true, length: { is: 11 }, numericality: { integer_only: true }, format: Unidom::Contact::China::MobilePhoneNumber::FORMAT_VALIDATION_REGEX
+  validates :receiver_mobile_phone_number, presence: true, length: { is: 11 }, numericality: { integer_only: true }, format: Unidom::Contact::China::MobilePhoneNumber::FORMAT_VALIDATION_REGEX
+
+  exact_column :placer_identification_number,   :placer_mobile_phone_number
+  exact_column :taker_identification_number,    :taker_mobile_phone_number
+  exact_column :receiver_identification_number, :receiver_mobile_phone_number
+
+  secure_column :placer,   fields: [ :placer_name,   :placer_address,   :placer_identification_number,   :placer_mobile_phone_number   ]
+  secure_column :taker,    fields: [ :taker_name,    :taker_address,    :taker_identification_number,    :taker_mobile_phone_number    ]
+  secure_column :receiver, fields: [ :receiver_name, :receiver_address, :receiver_identification_number, :receiver_mobile_phone_number ]
+
+end
+
+# in any controller or rails console:
+@placer_name   = 'Tim'
+@taker_name    = 'Bob'
+@receiver_name = 'Roy'
+
+@placer_identification_number   = '11022119801231999X'
+@taker_identification_number    = '350105199006184567'
+@receiver_identification_number = '532307200001010003'
+
+@placer_mobile_phone_number   = '13987654321'
+@taker_mobile_phone_number    = '18812345678'
+@receiver_mobile_phone_number = '17101020304'
+
+@placer_address   = 'Beijing'
+@taker_address    = 'Jiangsu'
+@receiver_address = 'Guizhou'
+
+@ordering = Ordering.new opened_at: Time.now,
+  placer_name:      @placer_name,
+  taker_name:       @taker_name,
+  receiver_name:    @receiver_name,
+  placer_address:   @placer_address,
+  taker_address:    @taker_address,
+  receiver_address: @receiver_address,
+  placer_identification_number:   @placer_identification_number,
+  taker_identification_number:    @taker_identification_number,
+  receiver_identification_number: @receiver_identification_number,
+  placer_mobile_phone_number:     @placer_mobile_phone_number,
+  taker_mobile_phone_number:      @taker_mobile_phone_number,
+  receiver_mobile_phone_number:   @receiver_mobile_phone_number
+@ordering.save!
+
+ordering_1 = Ordering.placer_identification_number_is(@placer_identification_number).valid_at.alive.first
+ordering_2 = Ordering.taker_identification_number_is(@taker_identification_number).valid_at.alive.first
+ordering_3 = Ordering.receiver_identification_number_is(@receiver_identification_number).valid_at.alive.first
+ordering_4 = Ordering.placer_mobile_phone_number_is(@placer_mobile_phone_number).valid_at.alive.first
+ordering_5 = Ordering.taker_mobile_phone_number_is(@taker_mobile_phone_number).valid_at.alive.first
+ordering_6 = Ordering.receiver_mobile_phone_number_is(@receiver_mobile_phone_number).valid_at.alive.first
+# @ordering should be identical to any of ordering_1, ordering_2, ordering_3, ordering_4, ordering_5, or ordering_6
+```
+
+
+
 ## Numeration
 
 ```ruby

data/app/models/unidom/common/concerns/argument_validation.rb

@@ -0,0 +1,21 @@
+module Unidom::Common::Concerns::ArgumentValidation
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    def assert_present!(name, value)
+      raise ArgumentError.new("The #{name} argument is required.") if value.blank?
+    end
+
+  end
+
+  module ClassMethods
+
+    def assert_present!(name, value)
+      raise ArgumentError.new("The #{name} argument is required.") if value.blank?
+    end
+
+  end
+
+end

data/app/models/unidom/common/concerns/exact_column.rb

@@ -0,0 +1,35 @@
+module Unidom::Common::Concerns::ExactColumn
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    cattr_accessor :exact_column_names
+
+  end
+
+  module ClassMethods
+
+    def exact_column(*names)
+
+      exact_column_names = exact_column_names||[]
+      exact_column_names += names
+
+      names.each do |name|
+        name = name.to_s
+        instance_eval do
+          scope :"#{name}_is", ->(value) { where "#{name}_exact_signature" => exact_signature(self, name, value) }
+          before_save do send "#{name}_exact_signature=", self.class.exact_signature(self.class, name, send(name)) end
+        end
+      end
+
+    end
+
+    def exact_signature(klass, name, value)
+      text = "#{Rails.application.secrets[:secret_key_base]}@#{Rails.root}/#{klass.table_name}##{name}=#{value}"
+      "#{Digest::MD5.digest(text)}#{Digest::SHA512.digest(text)}"
+    end
+
+  end
+
+end

data/app/models/unidom/common/concerns/model_extension.rb

@@ -2,6 +2,11 @@ module Unidom::Common::Concerns::ModelExtension
 
   extend ActiveSupport::Concern
 
+  include Unidom::Common::Concerns::ArgumentValidation
+  include Unidom::Common::Concerns::NotationColumn
+  include Unidom::Common::Concerns::ExactColumn
+  include Unidom::Common::Concerns::SecureColumn
+
   included do |includer|
 
     validates :state, presence: true, length: { is: columns_hash['state'].limit }
@@ -17,6 +22,7 @@ module Unidom::Common::Concerns::ModelExtension
     scope :alive, ->(living:  true) { where defunct: !living }
     scope :dead,  ->(defunct: true) { where defunct: defunct }
 
+=begin
     scope :notation_column_where, ->(name, operator, value) do
       operation = :like==operator ? { operator: 'ILIKE', value: "%#{value}%" } : { operator: operator.to_s, value: value }
       where "#{table_name}.notation -> 'columns' ->> '#{name}' #{operation[:operator]} :value", value: operation[:value]
@@ -25,6 +31,7 @@ module Unidom::Common::Concerns::ModelExtension
     scope :notation_boolean_column_where, ->(name, value) do
       where "(#{table_name}.notation -> 'columns' ->> '#{name}')::boolean = :value", value: (value ? true : false)
     end
+=end
 
     if columns_hash['ordinal'].present?&&:integer==columns_hash['ordinal'].type
       validates :ordinal, presence: true, numericality: { integer_only: true, greater_than: 0 }
@@ -136,9 +143,11 @@ module Unidom::Common::Concerns::ModelExtension
       end
     end
 
+=begin
     def assert_present!(name, value)
       raise ArgumentError.new("The #{name} argument is required.") if value.blank?
     end
+=end
 
   end
 
@@ -147,7 +156,7 @@ module Unidom::Common::Concerns::ModelExtension
     def to_id(model)
       model.respond_to?(:id) ? model.id : model
     end
-
+=begin
     def notation_column(*names)
       names.each do |name|
         name = name.to_s
@@ -177,7 +186,9 @@ module Unidom::Common::Concerns::ModelExtension
         end
       end
     end
+=end
 
+=begin
     def exact_column(*names)
       names.each do |name|
         name = name.to_s
@@ -189,15 +200,20 @@ module Unidom::Common::Concerns::ModelExtension
         end
       end
     end
+=end
 
+=begin
     def assert_present!(name, value)
       raise ArgumentError.new("The #{name} argument is required.") if value.blank?
     end
+=end
 
+=begin
     def exact_signature(klass, name, value)
       text = "#{Rails.application.secrets[:secret_key_base]}@#{Rails.root}/#{klass.table_name}##{name}=#{value}"
       "#{Digest::MD5.digest(text)}#{Digest::SHA512.digest(text)}"
     end
+=end
 
   end
 

data/app/models/unidom/common/concerns/notation_column.rb

@@ -0,0 +1,52 @@
+module Unidom::Common::Concerns::NotationColumn
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    scope :notation_column_where, ->(name, operator, value) do
+      operation = :like==operator ? { operator: 'ILIKE', value: "%#{value}%" } : { operator: operator.to_s, value: value }
+      where "#{table_name}.notation -> 'columns' ->> '#{name}' #{operation[:operator]} :value", value: operation[:value]
+    end
+
+    scope :notation_boolean_column_where, ->(name, value) do
+      where "(#{table_name}.notation -> 'columns' ->> '#{name}')::boolean = :value", value: (value ? true : false)
+    end
+
+  end
+
+  module ClassMethods
+
+    def notation_column(*names)
+      names.each do |name|
+        name = name.to_s
+        instance_eval do
+          define_method(name) do
+            notation.try(:[], 'columns').try(:[], name)
+          end
+          define_method("#{name}=") do |value|
+            notation['columns'] ||= {}
+            notation['columns'][name] = value
+          end
+        end
+      end
+    end
+
+    def notation_boolean_column(*names)
+      names.each do |name|
+        name = name.to_s
+        instance_eval do
+          define_method("#{name}?") do
+            notation.try(:[], 'columns').try(:[], name)
+          end
+          define_method("#{name}=") do |value|
+            notation['columns'] ||= {}
+            notation['columns'][name] = value
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/app/models/unidom/common/concerns/secure_column.rb

@@ -0,0 +1,58 @@
+module Unidom::Common::Concerns::SecureColumn
+
+  extend  ActiveSupport::Concern
+  include Unidom::Common::Concerns::ExactColumn
+  include Unidom::Common::Concerns::Aes256Cryptor
+
+  included do |includer|
+
+    cattr_accessor :secure_columns
+
+  end
+
+  module ClassMethods
+
+    def secure_column(name, fields: [])
+
+      name           = name.to_s
+      secure_columns = secure_columns||{}
+      if secure_columns[name].present?
+        raise ArgumentError.new("The #{name} column was defined as a secure column already.")
+      else
+        secure_columns[name] = fields
+      end
+      fields.each do |field| attr_accessor field.to_sym if columns_hash[field.to_s].blank? end
+
+      instance_eval do
+
+        before_save do
+          content = { 'nonce' => SecureRandom.hex(8), 'timestamp' => Time.now.to_i }
+          secure_columns[name].each do |field| content[field.to_s] = send(field) end
+          content = content.sort.to_h.to_json
+          aes_key = Digest::SHA512::digest self.class.exact_signature(self.class, name, '')
+          encoded = hex_encrypt content, key: aes_key
+          json = {
+              encoded:   encoded,
+              signature: Unidom::Common::Numeration.hex(self.class.exact_signature self.class, name, content)
+            }
+          send "#{name}=", json
+        end
+
+        after_find do
+          json = send(name)
+          return if json['encoded'].blank?||json['signature'].blank?
+          aes_key = Digest::SHA512::digest self.class.exact_signature(self.class, name, '')
+          content = decrypt Unidom::Common::Numeration.rev_hex(json['encoded']), key: aes_key
+          actual_signature = self.class.exact_signature(self.class, name, content)
+          return if Unidom::Common::Numeration.rev_hex(json['signature'])!=actual_signature
+          parsed = JSON.parse content
+          parsed.each do |key, value| send "#{key}=", value unless [ 'nonce', 'timestamp' ].include? key end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/app/views/layouts/unidom/common/application.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Common</title>
+  <title>Unidom Common</title>
   <%= stylesheet_link_tag 'unidom/common/application', media: 'all' %>
   <%= csrf_meta_tags %>
 </head>

data/lib/unidom/common/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Common
-    VERSION = '1.5'.freeze
+    VERSION = '1.6'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-common
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: '1.6'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,8 +82,12 @@ files:
 - app/controllers/unidom/common/application_controller.rb
 - app/helpers/unidom/common/application_helper.rb
 - app/models/unidom/common/concerns/aes256_cryptor.rb
+- app/models/unidom/common/concerns/argument_validation.rb
+- app/models/unidom/common/concerns/exact_column.rb
 - app/models/unidom/common/concerns/md5_digester.rb
 - app/models/unidom/common/concerns/model_extension.rb
+- app/models/unidom/common/concerns/notation_column.rb
+- app/models/unidom/common/concerns/secure_column.rb
 - app/models/unidom/common/concerns/sha1_digester.rb
 - app/models/unidom/common/concerns/sha256_digester.rb
 - app/models/unidom/common/concerns/sha2_digester.rb