dogtag 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3873a444c41218413a933994fd93c9683588e6f5
-  data.tar.gz: 561a47c6e821efc9d602d04b985ae1e05e1f1809
+  metadata.gz: f8cab26a320943028ef31bc9c2d2f9822a7b39e9
+  data.tar.gz: 0dcf654f1701ee9fdab5226334a3b891c2763d02
 SHA512:
-  metadata.gz: 0ddf7a7f873c0c3b6a31c80b189cde967aea42569afbec71aeb95ae3361049176d43a525d4270da2ad4dc701fdab2f64b2f9c9aa69da67cbfbeda5f10a79e9db
-  data.tar.gz: dd72cbd167d3c91f5fd530108a17f1ab4ecf6fe50fd4efca81aaee763bbd5c69a8904d98ab947f2dd7e070a12b828b9bedbec78e543330013a7e544bf319cdb8
+  metadata.gz: cb0b80cd108a4d764b2c3687a023d3b98c6c5e94b41589bf225f8248e6faa35d7ec6db4874235f05ceeb3ccaae93d7d9dadb502f4747d36790c2173c74a5147c
+  data.tar.gz: e42789e6244c87af765a0d235e874c089a3d33e0c90f230fb7796645a6a8e15b18998f6e7ec87dbb33e314f49bbc61ea3e71da33c9beaff4372b9d27f37a9d75

data/README.md

@@ -0,0 +1,51 @@
+Dogtag
+======
+
+A Redis-powered Ruby client for generating unique IDs with Redis for use in distributed systems. Based heavily off of [Icicle](https://github.com/intenthq/icicle/) and [Twitter Snowflake](https://github.com/intenthq/icicle/)
+
+Requirements
+------------
+- [Ruby](https://www.ruby-lang.org)
+- [Redis](https://redis.io/)
+
+Installation
+------------
+
+Simply add `gem 'dogtag'` to your `Gemfile` and run `bundle`
+
+Configuration
+-------------
+
+To configure the connection to your Redis server simply set the `REDIS_URL` environment variable. By default it will connect to `redis://localhost:6379`.
+
+To set the range of logical shard IDs this server should manage, run the command below replacing the number range with a range of numbers, of which none can be shared with another Redis server. If a logical shard ID is shared a separate Redis instance, you may get ID collisions.
+
+```shell
+bundle exec ruby -e 'require "dogtag"; Dogtag.logical_shard_id_range = 0..31'
+```
+
+*Note: The available shard ID numbers are current 0 - 31.*
+
+Usage
+-------
+
+```ruby
+data_type = 0
+Dogtag.generate_id data_type
+```
+
+```ruby
+data_type = 42
+count = 100
+Dogtag.generate_id data_type, count
+```
+
+*Note: The available data type ID numbers are current 0 - 255.*
+
+Related Projects
+----------------
+- __[dogtag-web](https://github.com/zillyinc/dogtag-web)__ - Web API for dogtag
+
+TODO
+----
+- Support multiple Redis servers

data/lib/dogtag.rb

@@ -69,6 +69,7 @@ end
 
 require 'dogtag/generator'
 require 'dogtag/id'
+require 'dogtag/lua_script'
 require 'dogtag/request'
 require 'dogtag/response'
 require 'dogtag/timestamp'

data/lib/dogtag/lua_script.rb

@@ -0,0 +1,13 @@
+module Dogtag
+  module LuaScript
+    LUA_SCRIPT_PATH = 'lua/id-generation.lua.erb'.freeze
+
+    def self.to_s
+      @rendered_script ||= ERB.new(
+        File.read(
+          File.expand_path "../../#{LUA_SCRIPT_PATH}", File.dirname(__FILE__)
+        )
+      ).result
+    end
+  end
+end

data/lib/dogtag/request.rb

@@ -2,7 +2,6 @@ module Dogtag
   class Request
     include Dogtag::Mixins::Redis
 
-    LUA_SCRIPT_PATH = 'lua/id-generation.lua'.freeze
     MAX_TRIES = 5
 
     def initialize(data_type, count = 1)
@@ -26,14 +25,12 @@ module Dogtag
 
     attr_reader :data_type, :count
 
-    def lua_script
-      File.read(
-        File.expand_path "../../#{LUA_SCRIPT_PATH}", File.dirname(__FILE__)
-      )
+    def lua_script_sha
+      @@lua_script_sha ||= redis.script(:load, LuaScript.to_s)
     end
 
-    def lua_args
-      lua_args = [ MAX_SEQUENCE, data_type, count ]
+    def lua_keys
+      @lua_keys ||= [ data_type, count ]
     end
 
     # NOTE: If too many requests come in inside of a millisecond the Lua script
@@ -54,7 +51,7 @@ module Dogtag
     end
 
     def redis_response
-      @redis_response ||= redis.eval(lua_script, keys: lua_args)
+      @redis_response ||= redis.evalsha(lua_script_sha, keys: lua_keys)
     end
   end
 end

data/lib/dogtag/version.rb

@@ -1,3 +1,3 @@
 module Dogtag
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/lua/{id-generation.lua → id-generation.lua.erb}

@@ -1,9 +1,9 @@
-local logical_shard_id_range_key = 'dogtag-generator-logical-shard-id-range'
+local logical_shard_id_range_key = '<%= Dogtag::LOGICAL_SHARD_ID_RANGE_KEY %>'
 local last_logical_shard_id_key = 'dogtag-generator-last-logical-shard-id'
+local max_sequence = <%= Dogtag::MAX_SEQUENCE %>
 
-local max_sequence = tonumber(KEYS[1])
-local data_type = tonumber(KEYS[2])
-local num_ids = tonumber(KEYS[3])
+local data_type = tonumber(KEYS[1])
+local num_ids = tonumber(KEYS[2])
 
 -- Allow one server to acts as multiple shards
 local logical_shard_id_range = redis.call('SORT', logical_shard_id_range_key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogtag
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -45,15 +45,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/dogtag.rb
 - lib/dogtag/generator.rb
 - lib/dogtag/id.rb
+- lib/dogtag/lua_script.rb
 - lib/dogtag/mixins/redis.rb
 - lib/dogtag/request.rb
 - lib/dogtag/response.rb
 - lib/dogtag/timestamp.rb
 - lib/dogtag/version.rb
-- lua/id-generation.lua
+- lua/id-generation.lua.erb
 homepage: https://github.com/zillyinc/dogtag
 licenses: []
 metadata: {}