iuid 0.0.2

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+bin/*
+- 
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "moneta", ">= 0.6.1", :git => 'git://github.com/duritong/moneta.git'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "rdoc", "~> 3.8"
+  gem "mocha"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GIT
+  remote: git://github.com/duritong/moneta.git
+  revision: 38125d0d598891f27fa6836cbc57cb928831ac4f
+  specs:
+    moneta (0.6.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.12)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rdoc (3.8)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  mocha
+  moneta (>= 0.6.1)!
+  rcov
+  rdoc (~> 3.8)
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,15 @@
+Trocla - a simple password generator and storage
+Copyright (C) 2011 Marcel Haerry
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,74 @@
+# iuid
+
+iuid is a simple username / uid storage that can autogenerate uids.
+
+iuid will either retrieve an existing uid for a category/key or generate the next available
+uid. If this uid collides with a range of the next category an exception is raised.
+For each category a starting uid is configured, which will then also set the max uid by the
+next category. The global max uid is 4294967295 but can be configured via the configuration
+option `max_uid`.
+
+You can use any kind of key/value based storage supported by moneta for
+iuid. By default it uses a simple yaml file.
+
+## Usage
+
+### create
+
+Assuming that we have an empty iuid storage.
+
+    trocla create user1 category1
+
+This will create (if not already stored in iuid) a random uid for the key
+user1 and use category1 as a range information from which within a uid should
+should be created.
+
+If the uid already exists it will simply return the matching uid.
+
+### get
+
+Get simply returns a stored uid. It will not create a new uid.
+
+Assuming that we are still working with the same storage
+
+    iuid get user1
+
+will return the generated uid, while
+
+    iuid get user3
+
+This will return nothing, as no uid has been generated so far for that user.
+
+### set
+
+    iuid set user3 1024
+
+This will set the uid 1024 for the key user3
+
+### delete
+
+    iuid delete user1 plain
+
+This will delete the stored uid and return it.
+
+## Installation
+
+Simply build and install the gem. BUT trocla is based on a not yet published
+version of [moneta](https://github.com/wycats/moneta). You can build a new
+moneta version based on the latest master as version 0.6.1 and instal that one.
+
+## Contributing to iuid
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 mh. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+
+require 'jeweler'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'iuid'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "iuid"
+  gem.homepage = "http://www.immerda.ch"
+  gem.license = "GPLv3"
+  gem.summary = "Iuid a simple uid generator and storage"
+  gem.description = "Iuid generates and keeps uids stored. It generates the next unique uid based on a category range"
+  gem.email = "mh+iuid@immerda.ch"
+  gem.authors = ["mh"]
+  gem.version = Iuid::VERSION::STRING
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+gem 'rdoc'
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = Iuid::VERSION::STRING
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "iuid #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/iuid

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+# CLI client for Trocla.
+#
+require 'rubygems'
+require 'iuid'
+require 'optparse'
+require 'yaml'
+
+options = { :config_file => nil }
+
+OptionParser.new do |opts|
+  opts.on("--version", "-V", "Version information") do
+    puts Trocla::VERSION::STRING
+    exit
+  end
+
+  opts.on("--config CONFIG", "-c", "Configuration file") do |v|
+    if File.exist?(v)
+      options[:config_file] = v
+    else
+      STDERR.puts "Cannot find config file: #{v}"
+      exit 1
+    end
+  end
+end.parse!
+
+def create(options)
+  miss('category') unless options[:category]
+  Iuid.new(options.delete(:config_file)).create(
+    options.delete(:name),
+    options.delete(:category)
+  )
+end
+
+def get(options)
+  Iuid.new(options.delete(:config_file)).get(
+    options.delete(:name)
+  )
+end
+def set(options)
+  miss('uid') unless options[:category]  # this is actually the uid
+  Iuid.new(options.delete(:config_file)).set(
+    options.delete(:name),
+    options.delete(:category)
+  )
+end
+
+def delete(options)
+  Iuid.new(options.delete(:config_file)).delete(
+    options.delete(:name)
+  )
+end
+
+def miss(what)
+  STDERR.puts "Missing #{what}, exiting..."
+  exit 1
+end
+
+actions=['create','get','set','delete']
+
+if !(ARGV.length < 2) && (action=ARGV.shift) && actions.include?(action)
+    options[:name] = ARGV.shift
+    options[:category] = ARGV.shift
+    begin
+      if result = send(action,options)
+        puts result.is_a?(String) ? result : result.inspect
+      end
+    rescue Exception => e
+      STDERR.puts "Action failed with the following message: #{e.message}" unless e.message == 'exit'
+      exit 1
+    end
+else
+    STDERR.puts "Please supply one of the following actions: #{actions.join(', ')}"
+    exit 1
+end
+

data/iuid.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{iuid}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mh"]
+  s.date = %q{2012-01-05}
+  s.default_executable = %q{iuid}
+  s.description = %q{Iuid generates and keeps uids stored. It generates the next unique uid based on a category range}
+  s.email = %q{mh+iuid@immerda.ch}
+  s.executables = ["iuid"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "bin/iuid",
+    "iuid.gemspec",
+    "lib/VERSION",
+    "lib/iuid.rb",
+    "lib/iuid/default_config.yaml",
+    "lib/iuid/version.rb",
+    "spec/data/.keep",
+    "spec/iuid_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://www.immerda.ch}
+  s.licenses = ["GPLv3"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Iuid a simple uid generator and storage}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<moneta>, [">= 0.6.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.8"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<moneta>, [">= 0.6.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.8"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<moneta>, [">= 0.6.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.8"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/VERSION

@@ -0,0 +1,4 @@
+major:0
+minor:0
+patch:2
+build:

data/lib/iuid.rb

@@ -0,0 +1,93 @@
+require 'iuid/version'
+
+class Iuid
+  
+  def initialize(config_file=nil)
+    if config_file
+      @config_file = File.expand_path(config_file)
+    elsif File.exists?(def_config_file=File.expand_path('~/.iuid.yaml')) || File.exists?(def_config_file=File.expand_path('/etc/iuid.yaml')) 
+      @config_file = def_config_file
+    end
+  end
+
+  def create(name,category)
+    unless (uid=get(name)).nil?
+      return uid
+    end
+
+    set(name,next_uid(category))
+  end
+  
+  def get(name)
+    cache.fetch(name)
+  end
+  
+  def delete(name)
+    cache.delete(name)
+  end
+  
+  def set(name,uid)
+    cache[name] = uid
+    cache['_all_uids'] = (alluids | [ uid ])
+    uid
+  end
+
+  protected
+
+  def next_uid(category)
+    raise "Category #{category} is not configured!" unless max_uid=categories[category]
+    if (curr_uid = cache["_category_#{category}_curr_uid"]) || max_uid && alluids.include?(curr_uid=max_uid)
+      uid=curr_uid + 1
+      while alluids.include?(uid) 
+        uid = curr_uid + 1
+      end
+      raise "Max uid is 4294967295" if uid > 4294967295
+      if coll_category = categories.keys.find{|c| categories[c] > max_uid && uid >= categories[c] }
+        raise "Next available uid (uid) collides with category #{coll_category}"
+      end
+    else
+      uid = max_uid
+    end
+    cache["_category_#{category}_curr_uid"] = uid
+    uid
+  end
+  
+  private
+  def cache
+    @cache ||= build_cache
+  end
+
+  def alluids
+    cache.fetch('_all_uids',[])
+  end
+
+  def categories
+    config['categories'] || {}
+  end
+  
+  def build_cache
+    require 'moneta'
+    require "moneta/adapters/#{config['adapter'].downcase}"
+    lconfig = config
+    Moneta::Builder.new { run eval( "Moneta::Adapters::#{lconfig['adapter']}"), lconfig['adapter_options'] }
+  end
+  
+  def config
+    @config ||= read_config
+  end
+  
+  def read_config
+    if @config_file.nil?
+      default_config
+    else
+      raise "Configfile #{@config_file} does not exist!" unless File.exists?(@config_file)
+      default_config.merge(YAML.load(File.read(@config_file)))
+    end
+  end
+  
+  def default_config
+      require 'yaml'
+      YAML.load(File.read(File.expand_path(File.join(File.dirname(__FILE__),'iuid','default_config.yaml'))))
+  end
+  
+end

data/lib/iuid/default_config.yaml

@@ -0,0 +1,6 @@
+---
+options:
+    max_uid: 4294967295
+adapter: YAML
+adapter_options:
+    :path: '/tmp/iuid.yaml'

data/lib/iuid/version.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+class Iuid
+  class VERSION
+    version = {}
+    File.read(File.join(File.dirname(__FILE__), '../', 'VERSION')).each_line do |line|
+      type, value = line.chomp.split(":")
+      next if type =~ /^\s+$/ || value =~ /^\s+$/
+      version[type] = value
+    end
+    
+    MAJOR = version['major']
+    MINOR = version['minor']
+    PATCH = version['patch']
+    BUILD = version['build']
+    
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+    
+    def self.version
+      STRING
+    end
+  end
+end

data/spec/iuid_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Iuid" do
+  
+  before(:each) do
+    Iuid.any_instance.expects(:read_config).returns(test_config)
+    @iuid = Iuid.new
+  end
+
+  describe "get" do
+    it "should return nil as default" do
+      @iuid.get('get_test').should be_nil
+    end
+  end
+  
+  describe "create" do
+    it "should create a new uid if not yet present" do
+      @iuid.get('create_test').should be_nil
+      @iuid.create('create_test','global').should eql(100)
+      @iuid.get('create_test').should eql(100)
+    end
+
+    it "should increase the next uid by one" do
+      @iuid.get('create_test2').should be_nil
+
+      @iuid.create('create_test2','global').should eql(100)
+      @iuid.get('create_test2').should eql(100)
+
+      @iuid.create('create_test3','global').should eql(101)
+      @iuid.get('create_test3').should eql(101)
+    end
+
+    it "should raise an exception if the next category is reached" do
+      @iuid.create('create_test4','global2').should eql(200)
+      lambda { @iuid.create('create_test5','global2') }.should raise_error(Exception)
+    end
+
+    it "should not create an existing uid" do
+      @iuid.set('double_test1',100).should eql(100)
+      @iuid.create('double_test2','global').should eql(101)
+    end
+
+    it "should not create an uid > 4294967295" do
+      @iuid.create('max_test1','max').should eql(4294967295)
+      lambda { @iuid.create('max_test2','max') }.should raise_error(Exception)
+    end
+  end
+  
+  describe "set" do
+    it "should set an uid and return it" do
+      @iuid.get('set_test1').should be_nil
+      @iuid.set('set_test1',100).should eql(100)
+      @iuid.get('set_test1').should_not be_nil
+      @iuid.get('set_test1').should be(100)
+    end
+  end
+  
+  describe "delete" do
+    it "should delete a given uid" do
+      @iuid.create('delete_test1','global').should_not be_nil
+      @iuid.get('delete_test1').should_not be_nil
+      @iuid.delete('delete_test1').should_not be_nil
+      @iuid.get('delete_test1').should be_nil
+    end
+  end
+  
+  describe "VERSION" do
+    it "should return a version" do
+      Iuid::VERSION::STRING.should_not be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'mocha'
+require 'iuid'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+
+def default_config
+  @default_config ||= YAML.load(File.read(File.expand_path(base_dir+'/lib/iuid/default_config.yaml')))
+end
+
+def test_config
+  return @config unless @config.nil?
+  @config = default_config
+  yaml_path = File.expand_path(base_dir+'/spec/data/test_config.yaml')
+  File.unlink(yaml_path) if File.exists?(yaml_path)
+  @config['categories'] = {
+    'global' => 100,
+    'global2' => 200,
+    'global3' => 201,
+    'max' => 4294967295
+  }
+  @config['adapter_options'][:path] = yaml_path
+  @config
+end
+
+def base_dir
+  File.dirname(__FILE__)+'/../'
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: iuid
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- mh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-05 00:00:00 +01:00
+default_executable: iuid
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  version_requirements: *id001
+  name: moneta
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  version_requirements: *id002
+  name: rspec
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 3
+        - 8
+        version: "3.8"
+  version_requirements: *id003
+  name: rdoc
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: mocha
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id005
+  name: bundler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id006
+  name: jeweler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
+  name: rcov
+  prerelease: false
+description: Iuid generates and keeps uids stored. It generates the next unique uid based on a category range
+email: mh+iuid@immerda.ch
+executables: 
+- iuid
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/iuid
+- iuid.gemspec
+- lib/VERSION
+- lib/iuid.rb
+- lib/iuid/default_config.yaml
+- lib/iuid/version.rb
+- spec/data/.keep
+- spec/iuid_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.immerda.ch
+licenses: 
+- GPLv3
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Iuid a simple uid generator and storage
+test_files: []
+