unidom-common 1.0.1 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3c6231223712d3808bfee184367ed13f469b595
-  data.tar.gz: 4e823a4abc9a6ca13cea6131ea930a0a77f389d0
+  metadata.gz: 95243ebeb2e8156ec28f4ca6c76d1bda4b2dfb9a
+  data.tar.gz: c6dd4045999cb395eb98659c01895480df1bba1f
 SHA512:
-  metadata.gz: 56b4d701590ec977fd1c071ad694920d5e28009d6dfb10162bb5d34e03cbd11c728447939e9f12514ba75dc70e79214d05ca17be79265910bbf2c9fd54875e45
-  data.tar.gz: 39f9a4dcfa3ba40b26e241675ea80e439bdec876fbfbd6453f099dccd0142f38eaaf40f44ed1dbefa959bd39d28a17541ed024218c346e0e7a7c1c8d9920a23e
+  metadata.gz: bcde6b74d223e1371ffe43e04a555edbcdb6c9acec410a1112a7d360feedda7635450ef3d7573b7478e069c1fdf1d4762be55a13037a8935eb5e9f62d5259ac4
+  data.tar.gz: d05202257ad1d5ae256a866c58d6da0785050b32dfe104f1654337ea5d3ada6c0a4fc748154bc6c4b73ca1ab16eb8ca56866ecb5e8b036dc6a0d316c5a14569b

data/README.md

@@ -28,7 +28,7 @@ The migration enabled the PostgreSQL uuid-ossp extension.
 include Unidom::Common::Concerns::ModelExtension
 ```
 
-## Auto Generated Methods
+## Model Extension concern
 ```ruby
 class Project < ActiveRecord::Base
 
@@ -81,28 +81,104 @@ project.enabled? # true
 Project.notation_boolean_column_where(:enabled, true) # All enabled projects
 ```
 
+## Numeration
+```ruby
+binary = 'some string'
+hex = Unidom::Common::Numeration.hex binary # "736f6d6520737472696e67"
+# convert a binary (usually a string) to it's hex string
+
+text = Unidom::Common::Numeration.rev_hex hex # "some string"
+# convert a hex string to its text value
+```
+
+## AES 256 Cryptor
+```ruby
+class IdentityCard
+
+  include Unidom::Common::Concerns::Aes256Cryptor
+  attr_accessor :identification_number, :encrypted_identification_number
+
+  def initialize(identification_number)
+    self.identification_number = identification_number
+    @aes_256_key = OpenSSL::Cipher::AES.new(256, 'CBC').random_key
+  end
+
+  def encrypt_identification_number
+    encrypt identification_number, key: @aes_256_key
+  end
+
+  def decrypt_identification_number
+    decrypt encrypted_identification_number, key: @aes_256_key
+  end
+
+  def cryption_padding
+    8
+  end
+  # If the #cryption_padding method is missed, the default padding 9 is used instead
+
+end
+
+identification_number = '9527'
+identity_card = IdentityCard.new '9527'
+encrypted     = identity_card.encrypt_identification_number
+decrypted     = identity_card.decrypt_identification_number
+# The decrypted should equal to identification_number
+# The AES 256 Cryptor also has the #hex_encrypt and the #hex_decrypt methods
+```
+
+## SHA 512 Digester
+```ruby
+class IdentityCard
+
+  include Unidom::Common::Concerns::Sha512Digester
+  attr_accessor :identification_number
+
+  def initialize(identification_number)
+    self.identification_number = identification_number
+  end
+
+  def digest_identification_number
+    digest identification_number, pepper: self.class.name
+  end
+
+  def hex_digest_identification_number
+    hex_digest identification_number, pepper: self.class.name
+  end
+
+end
+
+identity_card = IdentityCard.new '9527'
+digested      = identity_card.digest_identification_number
+hex_digested  = identity_card.hex_digest_identification_number
+hex_digested == Unidom::Common::Numeration.hex digested # true
+```
+
 ## ActiveRecord Migration Naming Convention
 ### Domain Models (200YMMDDHHMMSS)
 
 <table class='table table-striped table-hover'>
   <caption></caption>
   <thead>
+
     <tr>
       <th>Ruby Gem</th>
       <th>Migration</th>
       <th>Model</th>
       <th>Description</th>
     </tr>
+
   </thead>
   <tbody>
+
     <tr>
-      <td>unidom-common [![Gem Version](https://badge.fury.io/rb/unidom-common.svg)](https://badge.fury.io/rb/unidom-common)</td>
+      <td>[![unidom-common](https://badge.fury.io/rb/unidom-common.svg)](https://github.com/topbitdu/unidom-common)</td>
       <td>200001DDHHMMSS</td>
       <td>-</td>
       <td>The Common domain model engine includes the common models. 常用领域模型引擎包括一些常用的模型。</td>
     </tr>
+
     <tr>
-      <td>unidom-visitor [![Gem Version](https://badge.fury.io/rb/unidom-visitor.svg)](https://badge.fury.io/rb/unidom-visitor)</td>
+      <td>[![unidom-visitor](https://badge.fury.io/rb/unidom-visitor.svg)](https://github.com/topbitdu/unidom-visitor)</td>
       <td>200002DDHHMMSS</td>
       <td>
         - Identificating
@@ -114,33 +190,158 @@ Project.notation_boolean_column_where(:enabled, true) # All enabled projects
       </td>
       <td>The Visitor domain model engine includes Identificating, Authenticating, Recognization, Visitor (User &amp; Guest), and Password models. 访问者领域模型引擎包括身份标识、身份鉴别、身份识别、访问者（用户和游客）、密码的模型。</td>
     </tr>
+
+    <tr>
+      <td>[![unidom-category](https://badge.fury.io/rb/unidom-category.svg)](https://github.com/topbitdu/unidom-category)</td>
+      <td>200003DDHHMMSS</td>
+      <td>
+        - Category
+        - Categorizing
+        - Category Rollup
+        - Category Associating
+      </td>
+      <td>The Category domain model engine includes Category and its relative models. 类别领域模型引擎包括类别及其相关的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-authorization](https://badge.fury.io/rb/unidom-authorization.svg)](https://github.com/topbitdu/unidom-authorization)</td>
+      <td>200004DDHHMMSS</td>
+      <td>
+        - Permission
+        - Authorizing
+      </td>
+      <td>The Authorization domain model engine includes the Permission and Authorizing models. 授权领域模型引擎包括权限、授权的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-standard](https://badge.fury.io/rb/unidom-standard.svg)](https://github.com/topbitdu/unidom-standard)</td>
+      <td>200006DDHHMMSS</td>
+      <td>
+        - Standard
+        - Standard Associating
+      </td>
+      <td>The Standard domain model engine includes the Standard model and the Standard Associating model. 标准领域模型引擎包括行为标准和标准关联的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-party](https://badge.fury.io/rb/unidom-party.svg)](https://github.com/topbitdu/unidom-party)</td>
+      <td>200101DDHHMMSS</td>
+      <td>
+        - Person
+        - Shop
+        - Company
+        - Government Agency
+        - Party Relation
+      </td>
+      <td>The Party domain model engine includes the Person, Shop, Company, Government Agency, and the Party Relation models. 参与者领域模型引擎包括个人、店铺、公司、政府机构、参与者关系的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-certificate](https://badge.fury.io/rb/unidom-certificate.svg)](https://github.com/topbitdu/unidom-certificate)</td>
+      <td>200102DDHHMMSS</td>
+      <td>
+        - Certificating
+      </td>
+      <td>The Certificate domain model engine includes the Certificating model.
+证书领域模型引擎包括证书认证的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-contact](https://badge.fury.io/rb/unidom-contact.svg)](https://github.com/topbitdu/unidom-contact)</td>
+      <td>200103DDHHMMSS</td>
+      <td>
+        - Contact Subscription
+        - Email Address
+      </td>
+      <td>The Contact domain model engine includes the Contact Subscription and Email Address models. 联系方式领域模型引擎包括联系方式订阅和电子邮箱地址的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-geo](https://badge.fury.io/rb/unidom-geo.svg)](https://github.com/topbitdu/unidom-geo)</td>
+      <td>200104DDHHMMSS</td>
+      <td>
+        - Location
+        - Locating
+      </td>
+      <td>The Geo domain model engine includes the Location and Locating models. 地理领域模型引擎包括位置和定位的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-article_number](https://badge.fury.io/rb/unidom-article_number.svg)](https://github.com/topbitdu/unidom-article_number)</td>
+      <td>200201DDHHMMSS</td>
+      <td>
+        - Marking
+        - EAN 13 Barcode
+        - EAN 8 Barcode
+      </td>
+      <td>The Article Number domain model engine includes Marking, EAN-13, and EAN-8 models. 物品编码领域模型引擎包括打码、EAN-13和EAN-8的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-product](https://badge.fury.io/rb/unidom-product.svg)](https://github.com/topbitdu/unidom-product)</td>
+      <td>200202DDHHMMSS</td>
+      <td>
+        - Product
+        - Product Associating
+      </td>
+      <td>The Product domain model engine includes Product and Produt Associating models. 产品领域模型引擎包括产品和产品关联的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-price](https://badge.fury.io/rb/unidom-price.svg)](https://github.com/topbitdu/unidom-price)</td>
+      <td>200203DDHHMMSS</td>
+      <td>
+        - Price
+      </td>
+      <td>The Price domain model engine includes Price and its relative models. 价格领域模型引擎包括定价及其相关的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-shopping](https://badge.fury.io/rb/unidom-shopping.svg)](https://github.com/topbitdu/unidom-shopping)</td>
+      <td>200205DDHHMMSS</td>
+      <td>
+        - Shopping Cart
+        - Shopping Item
+      </td>
+      <td>The Shopping domain model engine includes Shopping Cart and Shopping Item models. 购物领域模型引擎包括购物车和购物项的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-order](https://badge.fury.io/rb/unidom-order.svg)](https://github.com/topbitdu/unidom-order)</td>
+      <td>200206DDHHMMSS</td>
+      <td>
+        - Order
+        - Order Item
+        - Order Adjustment
+      </td>
+      <td>The Order domain model engine includes Order, Order Item, and Order Adjustment models. 订单领域模型引擎包括订单、订单项和订单调整的模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-position](https://badge.fury.io/rb/unidom-position.svg)](https://github.com/topbitdu/unidom-position)</td>
+      <td>200402DDHHMMSS</td>
+      <td>
+        - Occupation
+        - Position
+        - Post
+        - Position Reporting Structure
+      </td>
+      <td>The Position domain model engine includes the Occupation, Position, Post, and Position Reporting Structure models.
+职位领域模型引擎包括职业、职位、岗位及岗位报告关系模型。</td>
+    </tr>
+
+    <tr>
+      <td>[![unidom-accession](https://badge.fury.io/rb/unidom-accession.svg)](https://github.com/topbitdu/unidom-accession)</td>
+      <td>200405DDHHMMSS</td>
+      <td>
+        - Post Fulfillment
+      </td>
+      <td>The Position domain model engine includes the Post Fulfillment and its relative models. 就职领域模型引擎包括岗位履行及其相关的模型。</td>
+    </tr>
+
   </tbody>
 </table>
 
-* unidom-common:         200001DDHHMMSS
-* unidom-visitor:        200002DDHHMMSS
-* unidom-category:       200003DDHHMMSS
-* unidom-authorization:  200004DDHHMMSS
-* unidom-accounting:     200005DDHHMMSS
-* unidom-standard:       200006DDHHMMSS
-
-* unidom-party:          200101DDHHMMSS
-* unidom-certificate:    200102DDHHMMSS
-* unidom-contact:        200103DDHHMMSS
-* unidom-geo:            200104DDHHMMSS
-* unidom-property:       200105DDHHMMSS
-
-* unidom-article_number: 200201DDHHMMSS
-* unidom-product:        200202DDHHMMSS
-* unidom-price:          200203DDHHMMSS
-* unidom-commodity:      200204DDHHMMSS
-* unidom-shopping:       200205DDHHMMSS
-* unidom-order:          200206DDHHMMSS
-* unidom-promotion:      200207DDHHMMSS
-* unidom-payment:        200208DDHHMMSS
-
-* unidom-position:       200402DDHHMMSS
-
 ### Country Extensions (200YMM9NNNMMSS)
 The YMM part should be identical to the relative part of the Domain Models.
 The NNN is the numeric code of [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1 "codes for the names of countries, dependent territories, and special areas of geographical interest").

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

@@ -0,0 +1,49 @@
+module Unidom::Common::Concerns::Aes256Cryptor
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    def encrypt(message, key: nil)
+
+      raise ArgumentError.new('The message argument is required.') if message.blank?
+      raise ArgumentError.new('The key argument is required.')     if key.blank?
+
+      cipher = OpenSSL::Cipher::AES.new(256, 'CBC')
+      cipher.encrypt
+      cipher.padding = aes_256_padding
+      cipher.key     = key
+
+      cipher.update(message)+cipher.final
+
+    end
+
+    def decrypt(encoded, key: nil)
+
+      raise ArgumentError.new('The encoded argument is required.') if encoded.blank?
+      raise ArgumentError.new('The key argument is required.')     if key.blank?
+
+      cipher = OpenSSL::Cipher::AES.new(256, 'CBC')
+      cipher.decrypt
+      cipher.padding = aes_256_padding
+      cipher.key     = key
+
+      cipher.update(encoded)+cipher.final
+
+    end
+
+    def aes_256_padding
+      respond_to?(:cryption_padding) ? cryption_padding : 9
+    end
+
+    def hex_encrypt(message, key: nil)
+      Unidom::Common::Numeration.hex encrypt(message, key: key)
+    end
+
+    def hex_decrypt(encoded, key: nil)
+      Unidom::Common::Numeration.hex decrypt(Unidom::Common::Numeration.rev_hex(encoded), key: key)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,29 @@
+module Unidom::Common::Concerns::Sha512Digester
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    def digest(message, pepper: nil)
+      self.class.digest message, pepper: pepper
+    end
+
+    def hex_digest(message, pepper: nil)
+      self.class.hex_digest message, pepper: pepper
+    end
+
+  end
+
+  module ClassMethods
+
+    def digest(message, pepper: nil)
+      message.present? ? Digest::SHA512.digest("#{message}_#{Rails.application.secrets[:secret_key_base]}_#{pepper}") : nil
+    end
+
+    def hex_digest(message, pepper: nil)
+      message.present? ? Unidom::Common::Numeration.hex(digest(message, pepper: pepper)) : nil
+    end
+
+  end
+
+end

data/lib/unidom/common.rb

@@ -1,5 +1,7 @@
 require 'unidom/common/engine'
 
+require 'unidom/common/numeration'
+
 module Unidom
   module Common
 

data/lib/unidom/common/numeration.rb

@@ -0,0 +1,11 @@
+class Unidom::Common::Numeration
+
+  def self.hex(data)
+    data.present? ? data.unpack('H*')[0] : nil
+  end
+
+  def self.rev_hex(hex)
+    hex.present? ? hex.scan(/../).map(&:hex).pack('c*') : nil
+  end
+
+end

data/lib/unidom/common/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Common
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-common
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: '1.1'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -81,7 +81,9 @@ files:
 - app/assets/stylesheets/unidom/common/application.css
 - 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/model_extension.rb
+- app/models/unidom/common/concerns/sha512_digester.rb
 - app/views/layouts/unidom/common/application.html.erb
 - config/routes.rb
 - db/migrate/20000101000000_enable_uuid_extension.rb
@@ -89,6 +91,7 @@ files:
 - lib/unidom/common.rb
 - lib/unidom/common/data_helper.rb
 - lib/unidom/common/engine.rb
+- lib/unidom/common/numeration.rb
 - lib/unidom/common/version.rb
 homepage: http://github.com/topbitdu/unidom-common
 licenses: