active_uxid 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ef45b0b1fd32eb33f6849dd019edd5ade93154d
-  data.tar.gz: 84e9719c661f3f18b6e3abf624cd0d64d7355237
+  metadata.gz: c6581582e44cdb2170d2092d6d10132ac017d1f9
+  data.tar.gz: 42c9aa6394ef2dd4d6638ea2d1f246c229151361
 SHA512:
-  metadata.gz: 71eaa94fffd906a47ef8002e0e76f807538792ea525105ed2a4010197bc70421fc66635a784155d19494d2bdc77c57228c2c8cf8d1e29c4a2cbc95573b92cc7e
-  data.tar.gz: 860754811c07d43929748a8633b17e7b1a9a82ef4bd748f33d672d5d6ca2993356d0f8eaf660eb445095545db3deb847ea6df5832bb064cd30ac92e27ece5224
+  metadata.gz: 7a3f3a40376af3eb4769770b45f83b3c9bb2f2918526aba632f7f32e2fdce86a4f23e9e7dcb423d6a42100d1dc6ee74732a368af775827a66ef49102db2fa8bd
+  data.tar.gz: 1769ec243f802d44dceca2418e3bff8ea83cc063af8c93261fdcb02cea3984d8c77c80e36979a9bd4ffbd1263b6d469693cb5dffd26f9e3448bdbcd4c3ad7ffd

data/README.md

@@ -1,10 +1,9 @@
-# ActiveRegulation
+# ActiveUxid
 
 [![Gem Version](https://badge.fury.io/rb/active_uxid.svg)](http://badge.fury.io/rb/active_uxid)
 [![Build Status](https://travis-ci.org/drexed/active_uxid.svg?branch=master)](https://travis-ci.org/drexed/active_uxid)
-[![Coverage Status](https://coveralls.io/repos/github/drexed/active_uxid/badge.svg?branch=master)](https://coveralls.io/github/drexed/active_uxid?branch=master)
 
-ActiveRegulation is a library for commonly used record states.
+ActiveUxid is a library for generating obfuscated UXid's.
 
 ## Installation
 
@@ -24,53 +23,56 @@ Or install it yourself as:
 
 ## Table of Contents
 
-* [Methods](#methods)
-* [Usage](#usage)
+* [Configuration](#configuration)
+* [Hash](#hash)
+* [Ulid](#ulid)
+* [ActiveRecord](#active_record)
 
-## Methods
+## Configuration
 
-**Modules:**
- * `activation`
- * `containment`
- * `expiration`
- * `quarantine`
- * `suspension`
- * `visibility`
+`rails generate active_uxid:install` will generate the following file:
+`../config/initalizers/active_uxid.rb`
 
-**Attributes:**
- * `:inactivated_at`
- * `:contained_at`
- * `:expires_at`
- * `:invisible_at`
- * `:quarantined_at`
- * `:suspended_at`
+```ruby
+ActiveUxid::Settings.configure do |config|
+  config.encoder_type = 'ulid'
+  config.encoding_chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  config.encoding_length = 26
+  config.encoding_length = 1369136
+end
+```
 
+## Hash
 ```ruby
-class User < ActiveRecord::Base
+# Hash ID's are reversible but less performant
+# than ULID
 
-  # Add one of the datetime attributes
-  # above to the corresponding table.
+ActiveUxid::Hash.encode(10)         #=> 'q5D8inm0'
+ActiveUxid::Hash.decode('q5D8inm0') #=> 10
+```
 
-  include ActiveRegulation::Containment
+## Ulid
+```ruby
+# ULID are secure as they are not reversible
+# They are also more performant than Hash ID's
 
-end
+ActiveUxid::Ulid.encode #=> '1mqfg9qa96s8s5f02o1ucf8lcc'
 ```
 
-## Usage
+## ActiveRecord
 ```ruby
-user.active?       #=> true
-user.inactive?     #=> false
-
-user.inactive!
-user.active?       #=> false
+class User < ActiveRecord::Base
+  # Add a uxid binary attribute to the corresponding table.
+  # This will include the proper UXid format from your settings
 
-user.active!
-user.active?       #=> true
+  include ActiveUxid::Record
+end
 
-user.to_activation #=> 'Active'
+# Hash UXid's type only
+User.find_by_uxid('x123') #=> find record by uxid
 
-User.active        #=> retrieves all active records
-User.inactive      #=> retrieves all inactive records
+user = User.new
+user.uxid_to_id          #=> decodes the records uxid to id
 ```
 
 ## Contributing

data/active_uxid.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |spec|
   spec.authors = ['Juan Gomez']
   spec.email = ['j.gomez@drexed.com']
 
-  spec.summary = "Gem for generating lexicographical UXid's."
-  spec.description = 'Generate lexicographical UXids.'
+  spec.summary = "Gem for generating obfuscated UXid's."
+  spec.description = "Generate obfuscated UXid's."
   spec.homepage = 'http://drexed.github.io/active_uxid'
   spec.license = 'MIT'
 
@@ -27,7 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'dry-configurable'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'sqlite3'

data/lib/active_uxid/record/hash.rb

@@ -7,6 +7,11 @@ module ActiveUxid
 
       included do
         after_create :callback_generate_uxid!, if: proc { respond_to?(:uxid) }
+
+        def self.find_by_uxid(uxid)
+          iden = ActiveUxid::Hash.decode(uxid)
+          find(iden)
+        end
       end
 
       def uxid_to_id

data/lib/active_uxid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRegulation
-  VERSION ||= '1.0.0'
+  VERSION ||= '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_uxid
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Juan Gomez
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -192,14 +178,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate lexicographical UXids.
+description: Generate obfuscated UXid's.
 email:
 - j.gomez@drexed.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
 - ".fasterer.yml"
 - ".gitignore"
 - ".reek"
@@ -250,5 +235,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Gem for generating lexicographical UXid's.
+summary: Gem for generating obfuscated UXid's.
 test_files: []

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci