id_generator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37e5398140f12ae7caa2db2c35878c213471d05572324a1da557fce3be36df8a
-  data.tar.gz: 386736c3d6ce69cd9b2755d5f01c0efe020652ade9cabf804e98ec8ce30d309b
+  metadata.gz: 6c2e271fb50e9a96d53b92c70fa45d55f8a8dc85aee47410868cb6ef33f239d4
+  data.tar.gz: 26ea59ebc7009adb5e2ca9fc5ac02af9d243e3a4b0a82efee6ad1b4f65296dc3
 SHA512:
-  metadata.gz: e0e138ca63cfd6cbb86228d85be5942686b26d8117886e4ed07d6b99107fc72d2a1b980a76e7c4393ea6d09b37af48093ee11388d3ed3345541dc4bb2587ba6b
-  data.tar.gz: fe98cb7ad9c71fcd0515a9da8f33f4914fd73986cefd657be08d028799624ed2953977df7807fa345258a1e9dda9dfa2311f09e6026db7fbbb46f7b94de40b17
+  metadata.gz: edc950a375068320a1a6e4d478fde583f4677263103d3f391f5e7a4bbee1db2eda2a78fd63d1b1f98401088d4faec278a8b9e9b833c444cf79d427536d1a143f
+  data.tar.gz: bf47f173ee92b65f56a799654e39fc096c15a0cad660620bbb8e72ccce8884b253cdd72eae4693c55f6a3ec46974b69a9133b52fb848d1e44618143567cba1d3

data/.rubocop.yml

@@ -5,6 +5,9 @@ require: rubocop-rspec
 
 #Example: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
 
+Metrics/LineLength:
+  Max: 120
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 
@@ -12,5 +15,6 @@ Style/Documentation:
   Enabled: false
 
 Metrics/BlockLength:
+  ExcludedMethods: ['describe']
   Exclude:
   - 'id_generator.gemspec'

data/Gemfile.lock

@@ -7,9 +7,13 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    codacy-coverage (2.1.0)
+      simplecov
     coderay (1.1.2)
     diff-lcs (1.3)
+    docile (1.3.1)
     jaro_winkler (1.5.1)
+    json (2.1.0)
     method_source (0.9.0)
     parallel (1.12.1)
     parser (2.5.1.2)
@@ -45,6 +49,11 @@ GEM
     rubocop-rspec (1.30.0)
       rubocop (>= 0.58.0)
     ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     unicode-display_width (1.4.0)
 
 PLATFORMS
@@ -52,6 +61,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  codacy-coverage
   id_generator!
   pry
   rake (~> 10.0)

data/README.md

@@ -1,38 +1,68 @@
-# Id::Generator
+# IdGenerator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/id/generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/matic-insurance/id_generator.svg?branch=master)](https://travis-ci.org/matic-insurance/id_generator)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ff827f62fb034d3b8ff71d69a9f0e233)](https://www.codacy.com/app/Matic/id_generator?utm_source=github.com&utm_medium=referral&utm_content=matic-insurance/id_generator&utm_campaign=Badge_Grade)
 
-TODO: Delete this and the text above, and describe your gem
+This gem provides uniq and random ids generation in distributed services 
+but at the same time gives some ordering (timestamp) and debug (context) information
 
-## Installation
+The gem is inspired by [Twitter Snowflake](https://github.com/twitter-archive/snowflake/tree/snowflake-2010) and other algorithms.
 
-Add this line to your application's Gemfile:
+The main difference is that ids generated by gem are not fully sequenced. 
+We want to have large random part that can be used as a simple guard against enumeration attack.
 
-```ruby
-gem 'id_generator'
-```
+## Goals & Assumptions
 
-And then execute:
+While we designed format and gem we used these as requirements:
 
-    $ bundle
+-   Every system should be able to independently (without coordination) generate id that will never (with reasonable chances) be duplicated
+-   ID allows partial time ordering (timestamp in seconds)
+-   ID has easy system identifier (context)
+-   ID is human readable 
+-   ID size is not a concern
+-   ID format should not be used for business/application logic - thus it remains flexible for future changes
 
-Or install it yourself as:
+## ID Format
 
-    $ gem install id_generator
+Suggested algorithm is based on the Twitter snowflake and other similar alghorithms:
 
-## Usage
+`TTTTTTTT-II-RRRRRRRRRRRRRRRRRRRRRR`
 
-TODO: Write usage instructions here
+-   `TTTTTTTT` - time in seconds since 2000 (just cool number) represented as hex - Gives us ~150 years of uniq sequences
+-   `II` - 1 byte for System Identification in hex
+-   `RRRRRRRRRRRRRRRRRRRRRR` - 11 bytes secure random number as hex
 
-## Development
+Code to generate is pretty straightforward: 
+
+```ruby
+time = format('%08x', Time.now.to_i - Time.new(2000).to_i)
+id = '6a'
+random = SecureRandom.hex(11)
+id = "#{time}-#{id}-#{random}" # "21dc3680-6a-910df0665e5e29b9f89e21"
+```
+
+## Installation
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Add gem to your application's Gemfile:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+gem 'id_generator'
+```
+
+## Usage
+
+```ruby
+# Somewhere during project start
+context_id = 165 # value from 0 to 255
+ID_GENERATOR = IdGenerator.new(context_id)
+
+#Inside of the actual code
+ID_GENERATOR.generate
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/id_generator.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/matic-insurance/id_generator]().
 
 ## License
 

data/id_generator.gemspec

@@ -5,11 +5,12 @@ require 'id_generator'
 Gem::Specification.new do |spec|
   spec.name          = 'id_generator'
   spec.version       = IdGenerator::VERSION
-  spec.authors       = ['vnovitskyi']
+  spec.authors       = ['Viktor Novitskyi']
   spec.email         = ['vnovitskyi@gmail.com']
 
-  spec.summary       = 'Generate unique id'
-  spec.description   = 'Generate unique id'
+  spec.summary       = 'Generator of random but at the same time timestamped and system identifiable ids'
+  spec.description   = 'Ruby Gem that allow to generate random ids in distributed systems (micro-services)
+                        and include debug information like timestamp and system id'
   spec.homepage      = 'https://github.com/matic-insurance/id_generator'
   spec.license       = 'MIT'
 
@@ -36,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'codacy-coverage'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/id_generator.rb

@@ -1,38 +1,46 @@
 require 'securerandom'
 
 class IdGenerator
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
+
+  COUNTER_PART_SIZE = 8
+  CONTEXT_PART_SIZE = 2
+
+  RANDOM_PART_BYTES = 11
+  COUNTER_START = Time.new(2000).to_i
 
   class Error < StandardError
   end
 
   def initialize(context_id)
-    @context_id = context_id.to_i
+    raise(IdGenerator::Error, 'Invalid project id') unless context_id_valid?(context_id)
+
+    @context_id = value_to_hex(context_id, CONTEXT_PART_SIZE)
   end
 
   def generate
-    validate_context_id
-
     "#{time}-#{@context_id}-#{random_number}"
   end
 
   private
 
-  def validate_context_id
-    return if context_id_valid?
+  def context_id_valid?(context_id)
+    return false unless context_id.is_a?(Integer)
+    return false unless context_id.between?(0, 255)
 
-    raise(IdGenerator::Error, 'Invalid project id')
-  end
-
-  def context_id_valid?
-    @context_id.positive?
+    true
   end
 
   def time
-    (Time.now.to_i - Time.new(2014).to_i).to_s(16)
+    timestamp = Time.now.to_i - COUNTER_START
+    value_to_hex(timestamp, COUNTER_PART_SIZE)
   end
 
   def random_number
-    SecureRandom.hex(11)
+    SecureRandom.hex(RANDOM_PART_BYTES)
+  end
+
+  def value_to_hex(value, size)
+    format("%0#{size}x", value)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: id_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- vnovitskyi
+- Viktor Novitskyi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: codacy-coverage
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +122,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate unique id
+description: |-
+  Ruby Gem that allow to generate random ids in distributed systems (micro-services)
+                          and include debug information like timestamp and system id
 email:
 - vnovitskyi@gmail.com
 executables: []
@@ -149,8 +165,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Generate unique id
+summary: Generator of random but at the same time timestamped and system identifiable
+  ids
 test_files: []