id_service 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2013 The Ready Project, LLC
+
+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,65 @@
+ID Service
+==========
+
+[![Build Status](https://travis-ci.org/readyproject/IDService.png?branch=master)](https://travis-ci.org/readyproject/IDService)
+
+This gem provides both client and server classes for running an ID generation service, based on the Thrift framework.
+The overall architecture is based on Twitter's Snowflake service, but written in Ruby. The core ID Generator is very
+fast (10,000 IDs/sec) and the server is designed to be very fast as well (1,000 IDs/sec).
+
+**WARNING** :: The IDs returned by the server, whether you use the pre-built one or customize will always return
+sequential and unique IDs, except in the case that you run multiple servers with the same host and worker identifiers.
+In that case you will not be guaranteed uniqueness of the IDs.
+
+Running the Server
+------------------
+
+This gem comes with a pre-made server executable that can be used in lieu of building your own server implementation. To
+start the provided server simple run the following command:
+
+    id_server
+
+The server is designed to run in the foreground by default. It also accepts a number of options. You can check the
+available options by passing the `--help` switch to the command.
+
+Custom Server
+-------------
+
+Some may want to build their own server implementation. This is very simple. Just pass the relevant options when
+initializing an instance of IdService::Server and then call `#serve` on your server instance.
+
+    require 'id_service/server'
+
+    options = {
+      hostname: 'localhost',
+      port:     9000,
+      host:     1,
+      worker:   1,
+      debug:    false
+    }
+
+    server = IdService::Server.new(options)
+    server.serve
+
+That's all there is to it.
+
+Using the Client
+----------------
+
+Using the client is just as easy. If your server is running on localhost and port 9000 you can skip supplying the
+options to client initialization.
+
+    require 'id_service'
+
+    options = {
+      host: 'localhost',
+      port: 9000
+    }
+
+    client = IdService::Client.new(options)
+    client.open
+
+    client.get_id
+
+The `#get_id` method will always return sequential and unique IDs, given you don't have multiple servers using the same
+host and worker identifiers responding to multiple clients.

data/bin/id_server

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'rubygems'
+require 'id_service/server'
+
+opts = OptionParser.new do |opts|
+  opts.banner = "IDServer: a Thrift-based ID generation service"
+  opts.define_head "Usage: id_server [options]"
+  opts.separator ""
+  opts.separator "Examples:"
+  opts.separator "  id_server --port 9000"
+  opts.separator "  id_server --host 25 --worker 2"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on('--host [HOST]') do |v|
+    @host = v
+  end
+
+  opts.on('--port [PORT]') do |v|
+    @port = v
+  end
+
+  opts.on('--host_id [ID]') do |v|
+    @host_id = v
+  end
+
+  opts.on('--worker_id [ID]') do |v|
+    @worker_id = v
+  end
+
+  opts.on('--debug') do |v|
+    @debug = true unless v.nil?
+  end
+end
+opts.parse!
+
+options = {
+    hostname: @host,
+    port:     @port,
+    host:     @host_id,
+    worker:   @worker_id,
+    debug:    @debug
+}.delete_if {|key, value| value.nil? }
+
+server = IdService::Server.new(options)
+server.serve

data/ext/IdService.thrift

@@ -0,0 +1,9 @@
+/* Copyright 2013 The Ready Project, LLC */
+
+exception InvalidSystemClock {
+  1: string message,
+}
+
+service IdService {
+  i64 get_id()
+}

data/lib/id_generator.rb

@@ -0,0 +1,78 @@
+require 'active_support/core_ext'
+
+#require 'celluloid'
+
+require 'id_service/types'
+
+class IdGenerator
+  #include Celluloid
+
+  # Project Epoch: Midnight, Mountain Time, January 1st, 2013
+  EPOCH = 1357023600
+
+  # Field Bit Lengths
+  TIMESTAMP_BIT_LENGTH  = 40
+  HOST_ID_BIT_LENGTH    = 5
+  WORKER_ID_BIT_LENGTH  = 5
+  SEQUENCE_BIT_LENGTH   = 14
+
+  # Field Shifts
+  TIMESTAMP_SHIFT = HOST_ID_BIT_LENGTH + WORKER_ID_BIT_LENGTH + SEQUENCE_BIT_LENGTH
+  HOST_ID_SHIFT   = WORKER_ID_BIT_LENGTH + SEQUENCE_BIT_LENGTH
+  WORKER_ID_SHIFT = SEQUENCE_BIT_LENGTH
+
+  # Field Masks
+  TIMESTAMP_MASK  = 0xFFFFFFFFFF000000
+  HOST_ID_MASK    = 0x0000000000F80000
+  WORKER_ID_MASK  = 0x000000000007C000
+  SEQUENCE_MASK   = 0x0000000000003FFF
+
+  def initialize(options = {})
+    options.symbolize_keys!
+
+    raise ArgumentError, 'missing host id' if options[:host].nil?
+    raise ArgumentError, 'missing worker id' if options[:worker].nil?
+
+    @debug      = options[:debug]
+    @host       = options[:host].to_i
+    @worker     = options[:worker].to_i
+    @sequence   = 0
+    @last_stamp = -1
+
+    puts 'Initialized IdGenerator' if @debug
+  end
+
+  def get_id
+    now = get_timestamp
+
+    raise InvalidSystemClock if now < @last_stamp
+
+    if @last_stamp == now
+      @sequence = (@sequence + 1) & SEQUENCE_MASK
+
+      if @sequence == 0
+        sleep_until_next_millisecond
+        now = get_timestamp
+      end
+    else
+      @sequence = 0
+    end
+
+    @last_stamp = now
+
+    id = (now << TIMESTAMP_SHIFT) | (@host << HOST_ID_SHIFT) | (@worker << WORKER_ID_SHIFT) | @sequence
+    puts "Generated ID: #{id}" if @debug
+    id
+  end
+
+  def get_timestamp
+    Time.now.to_i - EPOCH
+  end
+
+  private
+
+  def sleep_until_next_millisecond
+    puts 'Waiting for next milliseconds' if @debug
+    false until get_timestamp > @last_stamp
+  end
+end

data/lib/id_service.rb

@@ -0,0 +1,4 @@
+require 'id_service/client'
+
+module IdService end
+

data/lib/id_service/client.rb

@@ -0,0 +1,55 @@
+require 'thrift'
+
+require 'active_support/core_ext'
+
+require 'id_service/types'
+require 'id_service/helpers'
+
+module IdService
+  class Client
+    include ::Thrift::Client
+
+    def initialize(options = {})
+      options.symbolize_keys!
+      options = default_options.merge(options)
+
+      @transport = Thrift::BufferedTransport.new(Thrift::Socket.new(options[:host], options[:port]))
+      protocol = Thrift::BinaryProtocol.new(@transport)
+
+      @iprot = protocol
+      @oprot = options[:oprot] || protocol
+      @seqid = 0
+    end
+
+    def open
+      @transport.open
+    end
+
+    def get_id()
+      send_get_id()
+      return recv_get_id()
+    end
+
+private
+
+    def default_options
+      {
+          host:   'localhost',
+          port:   9000,
+          oprot:  nil
+      }
+    end
+
+    def send_get_id()
+      send_message('get_id', Get_id_args)
+    end
+
+    def recv_get_id()
+      result = receive_message(Get_id_result)
+      return result.success unless result.success.nil?
+      raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'get_id failed: unknown result')
+    end
+
+  end
+
+end

data/lib/id_service/constants.rb

@@ -0,0 +1,8 @@
+#
+# Autogenerated by Thrift Compiler (0.9.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+require 'id_service/types'

data/lib/id_service/helpers.rb

@@ -0,0 +1,34 @@
+require 'thrift'
+
+module IdService
+  class Get_id_args
+    include ::Thrift::Struct, ::Thrift::Struct_Union
+
+    FIELDS = {
+
+    }
+
+    def struct_fields; FIELDS; end
+
+    def validate
+    end
+
+    ::Thrift::Struct.generate_accessors self
+  end
+
+  class Get_id_result
+    include ::Thrift::Struct, ::Thrift::Struct_Union
+    SUCCESS = 0
+
+    FIELDS = {
+        SUCCESS => {:type => ::Thrift::Types::I64, :name => 'success'}
+    }
+
+    def struct_fields; FIELDS; end
+
+    def validate
+    end
+
+    ::Thrift::Struct.generate_accessors self
+  end
+end

data/lib/id_service/processor.rb

@@ -0,0 +1,12 @@
+module IdService
+  class Processor
+    include ::Thrift::Processor
+
+    def process_get_id(seqid, iprot, oprot)
+      args = read_args(iprot, Get_id_args)
+      result = Get_id_result.new()
+      result.success = @handler.get_id()
+      write_result(result, oprot, 'get_id', seqid)
+    end
+  end
+end

data/lib/id_service/server.rb

@@ -0,0 +1,34 @@
+require 'thrift'
+require 'active_support/core_ext'
+
+require 'id_service/helpers'
+require 'id_service/processor'
+require 'id_service/types'
+
+require 'id_generator'
+
+module IdService
+  class Server < Thrift::SimpleServer
+    def initialize(options = {})
+      options.symbolize_keys!
+      options = default_options.merge(options)
+
+      @handler = IdGenerator.new(options)
+      @processor = IdService::Processor.new(@handler)
+      @server_transport = Thrift::ServerSocket.new(options[:hostname], options[:port].to_s)
+      @transport_factory = Thrift::BufferedTransportFactory.new()
+      @protocol_factory = Thrift::BinaryProtocolFactory.new
+    end
+
+  private
+    def default_options
+      {
+          hostname: 'localhost',
+          port:     9000,
+          host:     1,
+          worker:   1,
+          debug:    false,
+      }
+    end
+  end
+end

data/lib/id_service/types.rb

@@ -0,0 +1,23 @@
+require 'thrift'
+
+class InvalidSystemClock < ::Thrift::Exception
+  include ::Thrift::Struct, ::Thrift::Struct_Union
+  def initialize(message=nil)
+    super()
+    self.message = message
+  end
+
+  MESSAGE = 1
+
+  FIELDS = {
+      MESSAGE => {:type => ::Thrift::Types::STRING, :name => 'message'}
+  }
+
+  def struct_fields; FIELDS; end
+
+  def validate
+  end
+
+  ::Thrift::Struct.generate_accessors self
+end
+

data/lib/id_service/version.rb

@@ -0,0 +1,4 @@
+module IdService
+  # The version of IdService you are using
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: id_service
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- James Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thrift
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: IdService provides a client and server for setting up a sequential &
+  unique id generation service.
+email:
+- jamest@thereadyproject.com
+executables:
+- id_server
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/id_server
+- lib/id_generator.rb
+- lib/id_service/client.rb
+- lib/id_service/constants.rb
+- lib/id_service/helpers.rb
+- lib/id_service/processor.rb
+- lib/id_service/server.rb
+- lib/id_service/types.rb
+- lib/id_service/version.rb
+- lib/id_service.rb
+- ext/IdService.thrift
+- LICENSE
+- README.md
+homepage: http://github.com/readyproject/IDService
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2474586230224755016
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A client and server for sequential & unique id generation
+test_files: []