tokenie 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format documentation
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2011 Andrew Djoga
+
+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.rdoc

@@ -0,0 +1,32 @@
+= Tokenie
+
+Tokenie gem provides generation friendly token randomically.
+
+== Installation
+
+Install as a gem from GemCutter:
+
+  gem install tokenie
+
+== Getting Started
+
+Generate a token:
+
+  Tokenie.friendly # => "De6paD"
+
+By default it uses 6 characters for end string. To change it use :length option:
+
+  Tokenie.friendly(:length => 8) # => "gRaxwBg7"
+
+If you want to ensure uniqueness you should provide a block which returns false in the case that means a token is not included in your storage:
+
+  existing_tokens = ['qwerty1', 'qwerty2', 'qwerty3']
+  Tokenie.friendly { |token| existing_tokens.include?(token) }
+
+Example with ActiveRecord:
+
+  Tokenie.friendly { |t| self.class.exists?(:token => t) }
+
+== Maintainers
+
+* Andrew Djoga <andrew.djoga@gmail.com>

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tokenie/version.rb

@@ -0,0 +1,3 @@
+module Tokenie
+  VERSION = "0.0.1"
+end

data/lib/tokenie.rb

@@ -0,0 +1,15 @@
+require "tokenie/version"
+require 'securerandom'
+
+module Tokenie
+  # Generates a friendly string randomically
+  def self.friendly(options = {})
+    length = options[:length] || 6
+    raise ArgumentError, "'length' must be in range (2..16)" if length < 2 || length > 16
+
+    loop do
+      token = SecureRandom.base64(15).tr('+/=lIO0o', 'abcdefgh')[0, length]
+      break token unless block_given? && yield(token)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'tokenie'
+require 'rspec/mocks'
+RSpec::Mocks::setup(Object)

data/spec/tokenie_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Tokenie do
+  describe ".friendly" do
+    it "generates a token with 6 characters by default" do
+      SecureRandom.stub(:base64) { 'qwertytoken' }
+      Tokenie.friendly.should eq('qwerty')
+    end
+
+    it "generates a token with 2 characters as passed" do
+      SecureRandom.stub(:base64) { 'qwerty' }
+      Tokenie.friendly(:length => 2).should eq('qw')
+    end
+
+    it "generates a friendly token" do
+      SecureRandom.stub(:base64) { '+/=lIO0o' }
+      Tokenie.friendly(:length => 8).should eq('abcdefgh')
+    end
+
+    it "generates an unique token" do
+      existing_tokens = ['qwerty', 'abcdef']
+      generation_line = ['qwerty', 'abcdef', 'abcde1', 'abcde2']
+      SecureRandom.stub(:base64) { generation_line.shift }
+
+      token = Tokenie.friendly { |t| existing_tokens.include?(t) }
+      token.should eq('abcde1')
+    end
+
+    it "raises an argument error if length is greater than 16" do
+      expect {
+        Tokenie.friendly(:length => 17)
+      }.to raise_error("'length' must be in range (2..16)")
+    end
+
+    it "raises an argument error if length is less than 2" do
+      expect {
+        Tokenie.friendly(:length => 1)
+      }.to raise_error("'length' must be in range (2..16)")
+    end
+  end
+end

data/tokenie.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tokenie/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tokenie"
+  s.version     = Tokenie::VERSION
+  s.authors     = ["Andrew Djoga"]
+  s.email       = ["andrew.djoga@gmail.com"]
+  s.homepage    = "http://github.com/Djo/tokenie/"
+  s.summary     = %q{Token generation}
+  s.description = %q{Generation a friendly token randomically}
+
+  s.rubyforge_project = "tokenie"
+
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency 'rspec', '~> 2.6'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: tokenie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Djoga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70225010708200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70225010708200
+description: Generation a friendly token randomically
+email:
+- andrew.djoga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- LICENSE
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/tokenie.rb
+- lib/tokenie/version.rb
+- spec/spec_helper.rb
+- spec/tokenie_spec.rb
+- tokenie.gemspec
+homepage: http://github.com/Djo/tokenie/
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: tokenie
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Token generation
+test_files:
+- spec/spec_helper.rb
+- spec/tokenie_spec.rb