snowflakey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f58d10fa9eeef4755b60ef18deff6a4d58850206
+  data.tar.gz: 43db5c3e1027b07cd459663a074f93c063c85102
+SHA512:
+  metadata.gz: 4636f31b093cf76e08e0783a272a0171199a342a63d19a6f2875e30e4fe300ae7fc540fb0e8bb9ce366db0218f99a53e0d317aae0bc9616da62ee961e0f0ac6a
+  data.tar.gz: cb1ce094d7f206450d97a39d6e5635d0ef3a23f69be3b5f34a5c6f670fb07f5000518e7e7037e1588738948f4bf3887fe605504aa0a20af3282008f81d1ba5de

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in snowflakey.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Robin Clart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Snowflakey
+
+Unique ID generator.
+
+## Generation
+
+You can generate a simple snowflake by calling `#generate` without
+any arguments.
+
+```ruby
+Snowflakey.generate # => "567wz82coauesrlb522"
+```
+
+You can also pass a prefix that will be prepended to the snowflake.
+
+```ruby
+Snowflakey.generate("snow") # => "snow_567wz9ox8b8p58tngzu"
+```
+
+Finally it also works with multiple prefixes.
+
+```ruby
+Snowflakey.generate(["snow", "flake"]) # => "snow_flake_567wz6ecywb6d6ruor9"
+```
+
+You can also change the size of the snowflake.
+
+```ruby
+Snowflakey.generate("snow", size: 64) # => "snow_2mdov6imct3o4"
+```
+
+You can also use another base.
+
+```ruby
+Snowflakey.generate("snow", base: 16) # => "snow_ac6591aa22063660af0e05d4"
+```
+
+## Verification
+
+```ruby
+snowflake = Snowflakey.verify("snow_567z7pfvdq47fswkt52")
+```
+
+This will return the snowflake as if it had been created with the low level API.
+You can then fetch the size, the time, the ID, the base, etc.
+
+Note that if the snowflake was created with another base than 36 and with another size than 96 you will have to declare those when calling `#verify`.
+
+## Manual Initialization
+
+If you need you can also initialize a snowflake without using the `#generate` method. This gives you more control over every parameters.
+
+```ruby
+prefix = "snow"
+size   = 96
+time   = Time.parse("2016-12-04T22:22:22Z").utc
+id     = 3104654282887302
+base   = 36
+
+snowflake = Snowflakey.new(prefix, size, time, id, base)
+```
+
+You can then call `#to_s` to get the snowflake as a string.
+
+```ruby
+snowflake.to_s # => "snow_567z7pfvdq47fswkt52"
+```
+
+## Important Remark
+
+> You are not special. You're not a beautiful and unique snowflake. You're the same decaying organic matter as everything else. We're all part of the same compost heap. We're all singing, all dancing crap of the world.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "snowflakey"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/snowflakey

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "snowflakey"
+
+prefix = ARGV[0].to_s.gsub(/[[:space:]]/, "")
+size   = ARGV[1].to_i
+
+if prefix == ""
+  prefix = nil
+end
+
+if size.zero?
+  size = 96
+end
+
+puts Snowflakey.generate(prefix, size: size)

data/lib/snowflakey/snowflake.rb

@@ -0,0 +1,27 @@
+module Snowflakey
+  class Snowflake
+    BASE = 36
+
+    def initialize(prefix, size, time, id, base)
+      @prefix = prefix
+      @size   = size
+      @time   = time
+      @id     = id
+      @base   = base.to_i
+    end
+
+    attr_reader :prefix, :size, :time, :id, :base
+    def to_s
+      t  = (@time.to_f * 1e3).round
+      id = t << (@size - 41)
+      id = id | @id % (2 ** (@size - 41))
+      id = Baseconv.convert(id, from_base: 10, to_base: @base)
+
+      [*@prefix, id].compact.join("_")
+    end
+
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/snowflakey/version.rb

@@ -0,0 +1,3 @@
+module Snowflakey
+  VERSION = "0.1.0"
+end

data/lib/snowflakey.rb

@@ -0,0 +1,25 @@
+require "time"
+require "securerandom"
+require "baseconv"
+require "snowflakey/snowflake"
+require "snowflakey/version"
+
+module Snowflakey
+  module_function
+
+  def generate(prefix = nil, size: 96, time: Time.now, base: Snowflake::BASE)
+    r = (SecureRandom.random_number * 1e16).round
+
+    Snowflake.new(prefix, size, time.utc, r, base).to_s
+  end
+
+  def verify(snowflake, size: 96, base: Snowflake::BASE)
+    id, prefix = snowflake.reverse.split("_", 2).map { |s| s.reverse }
+    ms         = id.to_i(base) >> (size - 41)
+    time       = Time.at((ms / 1e3)).utc
+    id         = Baseconv.convert(id, from_base: base.to_i, to_base: 10)
+    id         = id.to_i % (2 ** (size - 41))
+
+    Snowflake.new(prefix, size, time, id, base)
+  end
+end

data/snowflakey.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snowflakey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "snowflakey"
+  spec.version       = Snowflakey::VERSION
+  spec.authors       = ["Robin Clart"]
+  spec.email         = ["robin@omise.co"]
+
+  spec.summary       = %q{Unique ID Generator}
+  spec.homepage      = "https://github.com/robinclart/snowflakey"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "baseconv", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: snowflakey
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robin Clart
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: baseconv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- robin@omise.co
+executables:
+- snowflakey
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/snowflakey
+- lib/snowflakey.rb
+- lib/snowflakey/snowflake.rb
+- lib/snowflakey/version.rb
+- snowflakey.gemspec
+homepage: https://github.com/robinclart/snowflakey
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Unique ID Generator
+test_files: []