idgen32 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a128d8041ae090d56ba20dcd4983b0ea8185268
+  data.tar.gz: d3bc3efefdadf48d337af78d8e137e4e752e6421
+SHA512:
+  metadata.gz: 8281573f1250662875abe7a786dc24d4393a1ed45af747c3b8550d1a1f4917827374c1cfabb156e48aa21864e2a3cedace92890cce92b4f36494bee2127ebd64
+  data.tar.gz: 2a0fce9375da89171919edf2c34ec65f5077124aab6437e84e1168452886952c429717db0c31488082a34807f4413621f39a55160252695c3172a9e22f1e0da4

data/.gitignore

@@ -0,0 +1,12 @@
+ext/rlibidgen32/rlibidgen32_wrap.c
+*.swp
+.bundle
+ext/*.o
+ext/*.bundle
+lib/*.bundle
+.ruby-version
+tmp/
+Gemfile.lock
+pkg/
+idgen32-0.1.0.gem
+html/

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+    - 1.9.3
+    - 2.1.0
+    - 2.2.2
+addons:
+    apt:
+        packages:
+            - swig
+            - libbsd-dev
+before_script:
+    - bundle exec rake compile

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Manifest

@@ -0,0 +1,15 @@
+ext/extconf.rb
+ext/idgen.c
+ext/idgen.h
+ext/rlibidgen32.i
+ext/rlibidgen32_wrap.c
+idgen32.gemspec
+init.rb
+lib/idgen32.rb
+Manifest
+Rakefile
+README.rdoc
+test/bench.rb
+test/test_helper.rb
+test/unit/binding.rb
+test/unit/test_idgen32.rb

data/README.md

@@ -0,0 +1,54 @@
+# Idgen32
+
+[![Build Status](https://travis-ci.org/hellvinz/idgen32.png)](https://travis-ci.org/hellvinz/idgen32)
+
+Idgen32 functions provide a facility to generate a stream of 32-bit
+numbers that are strongly unpredictable and have a repetition cycle close
+to 2^32.  Such numbers are useful as protocol identifiers where there are
+negative consequences to reusing an ID within a short time period, as may
+happen if they are simply assigned at random.
+
+Note that this function will never return 0 as it often has a special 
+meaning in network protocols.
+
+## DEPENDENCIES
+
+No dependencies. Require a compiler and the standard C library.
+
+If you want to run the tests you'll need to have the following dependencies installed:
+
+* minitest
+
+## USAGE
+
+```
+require 'idgen32'
+
+Idgen32.instance.generate
+```
+
+## LICENSE:
+
+Copyright (c) 2008 Vincent Hellot
+
+Parts of the C extension are borrowed from the OpenBsd project.
+crypto/idgen.h
+crypto/idgen.c
+
+Copyright (c) 2008 Damien Miller <djm@mindrot.org>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+IDGEN32: non-repeating ID generation covering an almost maximal
+32 bit range.
+Based on public domain SKIP32 by Greg Rose.

data/Rakefile

@@ -0,0 +1,29 @@
+# Rakefile
+require 'rake/clean'
+require 'rake/testtask'
+require 'rdoc/task'
+
+CLEAN.include('ext/**/*{.o,.log,.so,.bundle}')  
+CLEAN.include('ext/**/Makefile')  
+CLOBBER.include('lib/*{.so,.bundle}')
+
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new('rlibidgen32')
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :bench do
+  ruby "test/bench.rb"
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "lib/*.rb")
+end
+
+task :default => [:test]

data/ext/rlibidgen32/extconf.rb

@@ -0,0 +1,23 @@
+require 'mkmf'
+
+swig = [ 'swig2', 'swig2.0', 'swig' ].select { |swig_name| find_executable(swig_name) }.first
+
+if swig
+  $stdout.write "Using '#{swig}' to generate wrapper code... "
+  `#{swig} -ruby #{File.dirname(File.realpath(__FILE__))}/rlibidgen32.i`
+  $stdout.write "done\n"
+else
+  $stderr.write "You need SWIG to compile this extension.\n"
+  exit 1
+end
+
+if /linux$/ =~ RUBY_PLATFORM
+  if !find_header('bsd/stdlib.h') or !find_library('bsd', 'arc4random')
+    $stderr.write 'function arc4random is needed please install libbsd-dev'
+    exit 1
+  end
+end
+
+have_func('arc4random_buf')
+
+create_makefile 'rlibidgen32'

data/ext/rlibidgen32/idgen.c

@@ -0,0 +1,157 @@
+/*
+ * Copyright (c) 2008 Damien Miller <djm@mindrot.org>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+/*
+ * IDGEN32: non-repeating ID generation covering an almost maximal 32-bit
+ * range.
+ *
+ * IDGEN32 is based on public domain SKIP32 by Greg Rose.
+ */
+
+#include <stdlib.h>
+#include <sys/types.h>
+#include <sys/time.h>
+#include <strings.h>
+
+#include "idgen.h"
+
+static const u_int8_t idgen32_ftable[256] = { 
+	0xa3, 0xd7, 0x09, 0x83, 0xf8, 0x48, 0xf6, 0xf4,
+	0xb3, 0x21, 0x15, 0x78, 0x99, 0xb1, 0xaf, 0xf9,
+	0xe7, 0x2d, 0x4d, 0x8a, 0xce, 0x4c, 0xca, 0x2e,
+	0x52, 0x95, 0xd9, 0x1e, 0x4e, 0x38, 0x44, 0x28,
+	0x0a, 0xdf, 0x02, 0xa0, 0x17, 0xf1, 0x60, 0x68,
+	0x12, 0xb7, 0x7a, 0xc3, 0xe9, 0xfa, 0x3d, 0x53,
+	0x96, 0x84, 0x6b, 0xba, 0xf2, 0x63, 0x9a, 0x19,
+	0x7c, 0xae, 0xe5, 0xf5, 0xf7, 0x16, 0x6a, 0xa2,
+	0x39, 0xb6, 0x7b, 0x0f, 0xc1, 0x93, 0x81, 0x1b,
+	0xee, 0xb4, 0x1a, 0xea, 0xd0, 0x91, 0x2f, 0xb8,
+	0x55, 0xb9, 0xda, 0x85, 0x3f, 0x41, 0xbf, 0xe0,
+	0x5a, 0x58, 0x80, 0x5f, 0x66, 0x0b, 0xd8, 0x90,
+	0x35, 0xd5, 0xc0, 0xa7, 0x33, 0x06, 0x65, 0x69,
+	0x45, 0x00, 0x94, 0x56, 0x6d, 0x98, 0x9b, 0x76,
+	0x97, 0xfc, 0xb2, 0xc2, 0xb0, 0xfe, 0xdb, 0x20,
+	0xe1, 0xeb, 0xd6, 0xe4, 0xdd, 0x47, 0x4a, 0x1d,
+	0x42, 0xed, 0x9e, 0x6e, 0x49, 0x3c, 0xcd, 0x43,
+	0x27, 0xd2, 0x07, 0xd4, 0xde, 0xc7, 0x67, 0x18,
+	0x89, 0xcb, 0x30, 0x1f, 0x8d, 0xc6, 0x8f, 0xaa,
+	0xc8, 0x74, 0xdc, 0xc9, 0x5d, 0x5c, 0x31, 0xa4,
+	0x70, 0x88, 0x61, 0x2c, 0x9f, 0x0d, 0x2b, 0x87,
+	0x50, 0x82, 0x54, 0x64, 0x26, 0x7d, 0x03, 0x40,
+	0x34, 0x4b, 0x1c, 0x73, 0xd1, 0xc4, 0xfd, 0x3b,
+	0xcc, 0xfb, 0x7f, 0xab, 0xe6, 0x3e, 0x5b, 0xa5,
+	0xad, 0x04, 0x23, 0x9c, 0x14, 0x51, 0x22, 0xf0,
+	0x29, 0x79, 0x71, 0x7e, 0xff, 0x8c, 0x0e, 0xe2,
+	0x0c, 0xef, 0xbc, 0x72, 0x75, 0x6f, 0x37, 0xa1,
+	0xec, 0xd3, 0x8e, 0x62, 0x8b, 0x86, 0x10, 0xe8,
+	0x08, 0x77, 0x11, 0xbe, 0x92, 0x4f, 0x24, 0xc5,
+	0x32, 0x36, 0x9d, 0xcf, 0xf3, 0xa6, 0xbb, 0xac,
+	0x5e, 0x6c, 0xa9, 0x13, 0x57, 0x25, 0xb5, 0xe3,
+	0xbd, 0xa8, 0x3a, 0x01, 0x05, 0x59, 0x2a, 0x46
+};
+
+#ifndef HAVE_ARC4RANDOM_BUF
+void
+arc4random_buf(void *_buf, size_t n)
+{
+	size_t i;
+	u_int32_t r = 0;
+	char *buf = (char *)_buf;
+
+	for (i = 0; i < n; i++) {
+		if (i % 4 == 0)
+			r = arc4random();
+		buf[i] = r & 0xff;
+		r >>= 8;
+	}
+	i = r = 0;
+}
+#endif /* !HAVE_ARC4RANDOM_BUF */
+
+
+static u_int16_t
+idgen32_g(u_int8_t *key, int k, u_int16_t w)
+{
+	u_int8_t g1, g2, g3, g4, g5, g6;
+	u_int o = k * 4;
+
+	g1 = (w >> 8) & 0xff;
+	g2 = w & 0xff;
+
+	g3 = idgen32_ftable[g2 ^ key[o++ & (IDGEN32_KEYLEN - 1)]] ^ g1;
+	g4 = idgen32_ftable[g3 ^ key[o++ & (IDGEN32_KEYLEN - 1)]] ^ g2;
+	g5 = idgen32_ftable[g4 ^ key[o++ & (IDGEN32_KEYLEN - 1)]] ^ g3;
+	g6 = idgen32_ftable[g5 ^ key[o++ & (IDGEN32_KEYLEN - 1)]] ^ g4;
+
+	return (g5 << 8) | g6;
+}
+
+static u_int32_t
+idgen32_permute(struct Idgen32_ctx *ctx, u_int32_t in)
+{
+	u_int i, r;
+	u_int16_t wl, wr;
+
+	wl = (in >> 16) & 0x7fff;
+	wr = in & 0xffff;
+
+	/* Doubled up rounds, with an odd round at the end to swap */
+	for (i = r = 0; i < IDGEN32_ROUNDS / 2; ++i) {
+		wr ^= (idgen32_g(ctx->id32_key, r, wl) ^ r);
+		r++;
+		wl ^= (idgen32_g(ctx->id32_key, r, wr) ^ r) & 0x7fff;
+		r++;
+	}
+	wr ^= (idgen32_g(ctx->id32_key, r, wl) ^ r);
+
+	return (wl << 16) | wr;
+}
+
+static void
+idgen32_rekey(struct Idgen32_ctx *ctx)
+{
+	ctx->id32_counter = 0;
+	ctx->id32_hibit ^= 0x80000000;
+	ctx->id32_offset = arc4random();
+	arc4random_buf(ctx->id32_key, sizeof(ctx->id32_key));
+	ctx->id32_rekey_time = time(NULL) + IDGEN32_REKEY_TIME;
+}
+
+void
+idgen32_init(struct Idgen32_ctx *ctx)
+{
+	bzero(ctx, sizeof(*ctx));
+	ctx->id32_hibit = arc4random() & 0x80000000;
+	idgen32_rekey(ctx);
+}
+
+u_int32_t
+idgen32(struct Idgen32_ctx *ctx)
+{
+	u_int32_t ret;
+
+	do {
+		/* Rekey a little early to avoid "card counting" attack */
+		if (ctx->id32_counter > IDGEN32_REKEY_LIMIT ||
+		    ctx->id32_rekey_time < time(NULL))
+			idgen32_rekey(ctx);
+		ret = ctx->id32_hibit | idgen32_permute(ctx,
+		    (ctx->id32_offset + ctx->id32_counter++) & 0x7fffffff);
+	} while (ret == 0); /* Zero IDs are often special, so avoid */
+
+	return ret;
+}
+

data/ext/rlibidgen32/idgen.h

@@ -0,0 +1,33 @@
+/*	$OpenBSD: idgen.h,v 1.3 2013/06/05 05:45:54 djm Exp $	*/
+/*
+ * Copyright (c) 2008 Damien Miller <djm@mindrot.org>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#define IDGEN32_ROUNDS		31
+#define IDGEN32_KEYLEN		32
+#define IDGEN32_REKEY_LIMIT	0x60000000
+#define IDGEN32_REKEY_TIME	600
+
+struct Idgen32_ctx {
+	u_int32_t id32_counter;
+	u_int32_t id32_offset;
+	u_int32_t id32_hibit;
+	u_int8_t id32_key[IDGEN32_KEYLEN];
+	time_t id32_rekey_time;
+};
+
+void idgen32_init(struct Idgen32_ctx *);
+u_int32_t idgen32(struct Idgen32_ctx *);
+

data/ext/rlibidgen32/rlibidgen32.i

@@ -0,0 +1,11 @@
+%module(docstring="Wrapper of Openbsd idgen32 function") rlibidgen32
+%{
+#include "idgen.h"
+%}
+
+%apply unsigned int {u_int32_t};
+
+%feature("autodoc", "3");
+
+%include "typemaps.i"
+%include "idgen.h"

data/idgen32.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/idgen32/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = %q{idgen32}
+  s.version = Idgen32::VERSION
+  s.required_rubygems_version = ">= 2.0"
+  s.authors = ["Vincent Hellot"]
+  s.email = %q{hellvinz@gmail.com}
+  s.date = %q{2008-11-23}
+  s.summary = %q{Non-repeating ID generation}
+  s.description = %q{non-repeating ID generation covering an almost maximal 32-bit range.}
+  s.extensions = ["ext/rlibidgen32/extconf.rb"]
+  s.extra_rdoc_files = ["README.md"]
+  s.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  s.executables   = s.files.grep(/^bin\//).map { |f| File.basename(f) }
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/hellvinz/idgen32}
+  s.rdoc_options = ["--line-numbers", "--inline-source","--exclude", "ext/*", "--title", "Idgen32", "--main", "README.md"]
+  s.require_paths = ["lib", "ext"]
+  s.test_files = ["test/test_helper.rb", "test/idgen32_test.rb", "test/binding_test.rb", "test/bench.rb"]
+
+  s.add_development_dependency 'rake-compiler', '~>0.9.5'
+  s.add_development_dependency 'rake', '>= 0.8.7'
+  s.add_development_dependency 'minitest', '~> 5.0', '>= 5.0.0'
+end

data/init.rb

@@ -0,0 +1 @@
+require 'idgen32'

data/lib/idgen32.rb

@@ -0,0 +1,16 @@
+require 'singleton'
+require 'rlibidgen32'
+
+class Idgen32
+  include Singleton
+  
+  def initialize #:nodoc:
+    @struct = Rlibidgen32::Idgen32_ctx.new
+    Rlibidgen32.idgen32_init(@struct)
+  end
+  
+  # Generate the unique id
+  def generate
+    Rlibidgen32.idgen32(@struct)
+  end
+end

data/lib/idgen32/version.rb

@@ -0,0 +1,3 @@
+class Idgen32
+  VERSION = '0.1.0'
+end

data/test/bench.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby -wU
+
+HERE = File.dirname(__FILE__)
+$LOAD_PATH << "#{HERE}/../lib/"
+require 'idgen32'
+
+require 'benchmark'
+require 'rubygems'
+
+
+class Bench
+  def run
+      benchmark
+  end
+  
+  private
+  def benchmark    
+    Benchmark.bm(30) do |x|
+        @m = Idgen32.instance
+        n = 1000000
+        x.report("idgen32:#{n}:generate") do
+          n.times {@m.generate}
+        end
+    end
+  end
+end
+
+Bench.new.run

data/test/binding_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class BindingTest < MiniTest::Spec
+  describe 'binary module' do
+    it 'should not raise when loading Rlibidgen32' do
+      Rlibidgen32
+    end
+  end
+end

data/test/idgen32_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class Idgen32Test < MiniTest::Spec
+  describe '#generate' do
+    it 'should generate an integer on #generate' do
+      Idgen32.instance.generate.must_be_kind_of(Integer)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'idgen32'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: idgen32
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vincent Hellot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2008-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: non-repeating ID generation covering an almost maximal 32-bit range.
+email: hellvinz@gmail.com
+executables: []
+extensions:
+- ext/rlibidgen32/extconf.rb
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Manifest
+- README.md
+- Rakefile
+- ext/rlibidgen32/extconf.rb
+- ext/rlibidgen32/idgen.c
+- ext/rlibidgen32/idgen.h
+- ext/rlibidgen32/rlibidgen32.i
+- idgen32.gemspec
+- init.rb
+- lib/idgen32.rb
+- lib/idgen32/version.rb
+- test/bench.rb
+- test/binding_test.rb
+- test/idgen32_test.rb
+- test/test_helper.rb
+homepage: http://github.com/hellvinz/idgen32
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--line-numbers"
+- "--inline-source"
+- "--exclude"
+- ext/*
+- "--title"
+- Idgen32
+- "--main"
+- README.md
+require_paths:
+- lib
+- ext
+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: '2.0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Non-repeating ID generation
+test_files:
+- test/test_helper.rb
+- test/idgen32_test.rb
+- test/binding_test.rb
+- test/bench.rb