barrage 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3642f34f25aae142789e33a2cf4c1d5a01648212
+  data.tar.gz: 3e71ac939f14b17c6c9d1d1407efda603392ea77
+SHA512:
+  metadata.gz: 6b6f8a47d16b21d6160a79b007e45622564953fc680a5f98d4acc9ca437af42fbb42d2f8c545409968c6b72b26002b9cc210646cea2068c1ff797dff3d4c1d1f
+  data.tar.gz: 5f182c40631fe62015e9365eda727011a24943da8e1280a6bf7dc19aac1bcd959f3c5e2e79232a76d2874cd06f6714c734304abdf926ee083bcc085266f99689

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# CHANGELOG
+
+## 0.0.3
+
+  * Fix critical bug on redis_worker_id generator
+
+## 0.0.2(yanked)
+
+  * Thread-safety
+
+## 0.0.1 - First Release(yanked)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Drecom Co., Ltd.
+
+MIT License
+
+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,70 @@
+# Barrage
+
+Distributed ID generator(like twitter/snowflake)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'barrage'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install barrage
+
+## Usage
+
+### Example
+
+```ruby
+# 39bit: msec (17.4 years from start_at)
+# 16bit: worker_id
+# 9bit:  sequence
+require 'barrage'
+
+barrage = Barrage.new(
+  "generators" => [
+    {"name" => "msec", "length" => 39, "start_at" => 1396278000000},
+    {"name" => "redis_worker_id", "length" => 16, "ttl" => 300},
+    {"name" => "sequence", "length" => 9}
+  ]
+)
+barrage.next
+# => Generated ID
+```
+
+### Generators
+
+#### msec
+#### redis_worker_id
+#### sequence
+
+### Creating your own generator
+
+```ruby
+module Barrage::Generators
+  class YourOwnGenerator < Base
+    def generate
+	  # generated code
+	end
+
+    def your_option_value
+	  options["your_option_value"]
+	end
+  end
+end
+
+barrage = Barrage.new("generators" => [{"name"=>"your_own", "length" => 8, "your_option_value"=>"xxx"}])
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/drecom/barrage/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "pry console"
+task :console do
+  require "pry"
+  require "barrage"
+  binding.pry
+end

data/barrage.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'barrage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "barrage"
+  spec.version       = Barrage::VERSION
+  spec.authors       = ["gussan"]
+  spec.email         = ["egussan@gmail.com"]
+  spec.summary       = %q{Distributed id generator}
+  spec.description   = %q{Distributed id generator}
+  spec.homepage      = "http://github.com/drecom/barrage"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "3.0.0.beta2"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "redis"
+end

data/lib/barrage.rb

@@ -0,0 +1,52 @@
+require "barrage/version"
+require "active_support/core_ext/string/inflections"
+
+class Barrage
+  class InvalidOption < StandardError; end
+  attr_reader :generators
+
+  #
+  # generators:
+  #   - name: msec
+  #     length: 40
+  #     start_at: 1396278000000 # 2014-04-01 00:00:00 +0900 (msec)
+  #   - name: pid
+  #     length: 16
+  #   - name: sequence
+  #     length: 8
+
+  def initialize(options = {})
+    @options = options
+    @lock = Mutex.new
+    @generators = @options["generators"].map do |h|
+      generator_name = h["name"]
+      require "barrage/generators/#{generator_name}"
+      "Barrage::Generators::#{generator_name.classify}".constantize.new(h)
+    end
+  end
+
+  def generate
+    @lock.synchronize {
+      shift_size = length
+      @generators.inject(0) do |result, generator|
+        shift_size = shift_size - generator.length
+        result += generator.generate << shift_size
+      end
+    }
+  end
+  alias_method :next, :generate
+
+  def current
+    @lock.synchronize {
+      shift_size = length
+      @generators.inject(0) do |result, generator|
+        shift_size = shift_size - generator.length
+        result += generator.current << shift_size
+      end
+    }
+  end
+
+  def length
+    @generators.inject(0) {|sum, g| sum += g.length }
+  end
+end

data/lib/barrage/generators.rb

@@ -0,0 +1,4 @@
+class Barrage
+  module Generators
+  end
+end

data/lib/barrage/generators/base.rb

@@ -0,0 +1,23 @@
+class Barrage
+  module Generators
+    class Base
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def length
+        options["length"]
+      end
+
+      def generate
+        raise NotImplemented, "Please Override"
+      end
+
+      def current
+        raise NotImplemented, "Please Override"
+      end
+    end
+  end
+end

data/lib/barrage/generators/msec.rb

@@ -0,0 +1,17 @@
+require 'barrage/generators/base'
+
+class Barrage
+  module Generators
+    class Msec < Base
+      def generate
+        ((Time.now.to_f * 1000).round - start_at) & (2 ** length - 1)
+      end
+
+      alias_method :current, :generate
+
+      def start_at
+        options["start_at"]
+      end
+    end
+  end
+end

data/lib/barrage/generators/pid.rb

@@ -0,0 +1,13 @@
+require 'barrage/generators/base'
+
+class Barrage
+  module Generators
+    class Pid < Base
+      def generate
+        Process.pid & (2 ** length-1)
+      end
+
+      alias_method :current, :generate
+    end
+  end
+end

data/lib/barrage/generators/redis_worker_id.rb

@@ -0,0 +1,88 @@
+require 'redis'
+require 'barrage/generators/base'
+
+class Barrage
+  module Generators
+    class RedisWorkerId < Base
+      RACE_CONDITION_TTL = 30
+
+      def initialize(options = {})
+        @worker_id = nil
+        @worker_ttl = 0
+        super
+        @data = []
+        @finalizer_proc = Finalizer.new(@data)
+        ObjectSpace.define_finalizer(self, @finalizer_proc)
+      end
+
+      def generate
+        now = Time.now.to_i
+        if @worker_ttl - now <= 0
+          @data[1] = @worker_id = renew_worker_id
+          # check redis when passed half of real ttl
+          @worker_ttl = now + ttl / 2
+        end
+        @worker_id
+      end
+      alias_method :current, :generate
+
+      def redis
+        @redis ||= @data[0] = Redis.new(options["redis"] || {})
+      end
+
+      def ttl
+        options["ttl"]
+      end
+
+      class Finalizer
+        def initialize(data)
+          @pid = $$
+          @data = data
+        end
+
+        def call(*args)
+          return if @pid != $$
+          redis, worker_id = *@data
+
+          if redis.is_a?(Redis) and redis.connected?
+            redis.del("barrage:worker:#{worker_id}")
+            redis.client.disconnect
+          end
+        end
+      end
+
+      private
+
+      def renew_worker_id
+        new_worker_id = redis.evalsha(
+          script_sha,
+          argv: [2 ** length, rand(2 ** length), @worker_id, ttl, RACE_CONDITION_TTL]
+        ).to_i
+        new_worker_id
+      end
+
+      def script_sha
+        @script_sha ||=
+          redis.script(:load, <<-EOF.gsub(/^ {12}/, ''))
+            local max_value = ARGV[1]
+            local new_worker_id = ARGV[2]
+            local old_worker_id = ARGV[3]
+            local ttl = ARGV[4]
+            local race_condition_ttl = ARGV[5]
+
+            if type(old_worker_id) == "string" and string.len(old_worker_id) > 0 and redis.call('EXISTS', "barrage:worker:" .. old_worker_id) == 1 then
+              redis.call("EXPIRE", "barrage:worker:" .. old_worker_id, ttl + race_condition_ttl)
+              new_worker_id = old_worker_id
+            else
+              while redis.call("SETNX", "barrage:worker:" .. new_worker_id, 1) == 0
+              do
+                new_worker_id = (new_worker_id + 1) % max_value
+              end
+              redis.call("EXPIRE", "barrage:worker:" .. new_worker_id, ttl + race_condition_ttl)
+            end
+            return new_worker_id
+          EOF
+      end
+    end
+  end
+end

data/lib/barrage/generators/sequence.rb

@@ -0,0 +1,20 @@
+require 'barrage/generators/base'
+
+class Barrage
+  module Generators
+    class Sequence < Base
+      def initialize(options)
+        @sequence = 0
+        super
+      end
+
+      def generate
+        @sequence = (@sequence + 1) & (2 ** length - 1)
+      end
+
+      def current
+        @sequence
+      end
+    end
+  end
+end

data/lib/barrage/generators/timestamp.rb

@@ -0,0 +1,8 @@
+class Barrage
+  module Generators
+    class Timestamp
+      def initialize
+      end
+    end
+  end
+end

data/lib/barrage/version.rb

@@ -0,0 +1,3 @@
+class Barrage
+  VERSION = "0.0.3"
+end

data/spec/barrage_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Barrage do
+  it 'has a version number' do
+    expect(Barrage::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'barrage'
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: barrage
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- gussan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: guard-rspec
+  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: redis
+  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'
+description: Distributed id generator
+email:
+- egussan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- barrage.gemspec
+- lib/barrage.rb
+- lib/barrage/generators.rb
+- lib/barrage/generators/base.rb
+- lib/barrage/generators/msec.rb
+- lib/barrage/generators/pid.rb
+- lib/barrage/generators/redis_worker_id.rb
+- lib/barrage/generators/sequence.rb
+- lib/barrage/generators/timestamp.rb
+- lib/barrage/version.rb
+- spec/barrage_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/drecom/barrage
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Distributed id generator
+test_files:
+- spec/barrage_spec.rb
+- spec/spec_helper.rb