short_url_token_generator 0.1.0

data/README.md

@@ -0,0 +1,44 @@
+Short url token generator
+=========================
+
+Use to generate/decode tokens for urls
+
+Install
+-------
+
+Just add this to your Gemfile:
+  `gem 'short_url_token_generator'` (not yet published in RubyGems.org)
+
+And run your bundler:
+  `bundle install`
+
+Usage
+-----
+
+pending
+
+Example
+-------
+
+    class Url < ActiveRecord::Base
+        before_create do
+          if self.token.nil? or self.token.empty?
+            self.token = generate_token Url.count(conditions: {:custom => false})
+          else
+            self.custom = true
+          end
+        end
+      private
+        def generate_token num
+          token = ShortUrlTokenGenerator::generate num
+          if Url.count(conditions: {:token => token}) > 0
+            token = generate_token num + 1
+          end
+          token
+        end
+    end
+
+License
+-------
+
+Copyright (C) 2012 Josemar Davi Luedke <josemarluedke@gmail.com>, released under the MIT license.

data/lib/short_url_token_generator.rb

@@ -0,0 +1,26 @@
+module ShortUrlTokenGenerator
+  def self.generate num
+    token = ""
+    base_notation(num).split('-').each { |position| token += "#{mapping[position.to_i]}" }
+    token
+  end
+  
+  def self.decode token
+    return -1 if token.length > 15
+    num = i = 0
+    token.chars.to_a.reverse_each do |t|
+      num += mapping.index(t) * mapping.length**i unless mapping.index(t).nil?
+      i += 1
+    end
+    num
+  end
+  
+  def self.base_notation num, base = nil
+    base = mapping.length if base.nil?
+    num < base ? "#{num}" : "#{base_notation (num/base).floor, base}-#{num % base}"
+  end
+  
+  def self.mapping
+    'oJC8RZuYg2pTrAIkjWHN1nxQ3c4yVKP5X9LBbaisDdfqv6heU7zGFSOlEw0mMt'.chars.to_a
+  end
+end

data/short_url_token_generator.gemspec

@@ -0,0 +1,10 @@
+Gem::Specification.new do |s|
+  s.name        = "short_url_token_generator"
+  s.version     = "0.1.0"
+  s.description = "Short url token generator, use to generate/decode tokens for urls"
+  s.summary     = "Short url token generator"
+  s.author      = "Josemar Davi Luedke"
+  s.email      = "josemarluedke@gmail.com"
+  s.homepage    = "https://github.com/josemarluedke/short_url_token_generator"
+  s.files       = Dir["{lib/*.rb,README.md,spec/*.rb,*.gemspec}"]
+end

data/spec/short_url_token_generator_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe ShortUrlTokenGenerator do
+
+  describe 'mapping' do
+    it "should be array" do
+      ShortUrlTokenGenerator::mapping.should be_instance_of(Array)
+    end
+  end
+  
+  describe 'base notation' do
+    it 'should be return 10' do
+      ShortUrlTokenGenerator::base_notation(10).should eq "10"
+    end
+    
+    it 'should be return 1-0' do
+      ShortUrlTokenGenerator::base_notation(62).should eq "1-0"
+    end
+    
+    it 'should be return 1-1' do
+      ShortUrlTokenGenerator::base_notation(63).should eq "1-1"
+    end
+    
+    it 'should be return 2-2' do
+      ShortUrlTokenGenerator::base_notation(26, 12).should eq "2-2"
+    end
+  end
+  
+  describe 'generate' do
+    it "should be return the first character" do
+      ShortUrlTokenGenerator::generate(0).should eq ShortUrlTokenGenerator::mapping[0]
+    end
+    
+    it "should be return the correct characters" do
+      ShortUrlTokenGenerator::generate(134).should eq "#{ShortUrlTokenGenerator::mapping[2]}#{ShortUrlTokenGenerator::mapping[10]}"
+    end
+  end
+  
+  describe "decode" do
+    it 'should be return correct num of token' do
+      ShortUrlTokenGenerator::decode("#{ShortUrlTokenGenerator::mapping[2]}#{ShortUrlTokenGenerator::mapping[10]}").should eq 134
+    end
+    
+    it 'should be return -1, because token is > 15' do
+      ShortUrlTokenGenerator::decode("oJC8RZuYg2pTrAIK").should eq -1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require './lib/short_url_token_generator.rb'
+require 'rspec'

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: short_url_token_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Josemar Davi Luedke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-18 00:00:00.000000000Z
+dependencies: []
+description: Short url token generator, use to generate/decode tokens for urls
+email: josemarluedke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/short_url_token_generator.rb
+- README.md
+- spec/short_url_token_generator_spec.rb
+- spec/spec_helper.rb
+- short_url_token_generator.gemspec
+homepage: https://github.com/josemarluedke/short_url_token_generator
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Short url token generator
+test_files: []