short_url_token_generator 0.1.0 → 0.2.0

data/README.md

@@ -7,7 +7,7 @@ Install
 -------
 
 Just add this to your Gemfile:
-  `gem 'short_url_token_generator'` (not yet published in RubyGems.org)
+  `gem 'short_url_token_generator'`
 
 And run your bundler:
   `bundle install`
@@ -15,7 +15,13 @@ And run your bundler:
 Usage
 -----
 
-pending
+Generate
+--------
+    ShortUrlTokenGenerator.generate(134) # => "Cp"
+
+Decode
+------
+    ShortUrlTokenGenerator.decode("Cp") # => 134
 
 Example
 -------
@@ -30,7 +36,7 @@ Example
         end
       private
         def generate_token num
-          token = ShortUrlTokenGenerator::generate num
+          token = ShortUrlTokenGenerator.generate num
           if Url.count(conditions: {:token => token}) > 0
             token = generate_token num + 1
           end
@@ -38,6 +44,15 @@ Example
         end
     end
 
+Changelog
+-------
+
+* 0.2.0
+  Migrated from Module to Class, because use Module don't make sense.
+
+* 0.1.0
+  Released firt version
+
 License
 -------
 

data/lib/short_url_token_generator.rb

@@ -1,10 +1,22 @@
-module ShortUrlTokenGenerator
+class ShortUrlTokenGenerator
+  # Mapping of string to use for generate tokens
+  @mapping = :oJC8RZuYg2pTrAIkjWHN1nxQ3c4yVKP5X9LBbaisDdfqv6heU7zGFSOlEw0mMt
+  
+  # Get mapping
+  def self.mapping
+    @mapping.to_s.split //
+  end
+  
+  # Generate token (using alpha-numeric mapping)
+  # Param: num (index of the URL)
   def self.generate num
     token = ""
     base_notation(num).split('-').each { |position| token += "#{mapping[position.to_i]}" }
     token
   end
   
+  # Decode token (for correct decoding, the token must be generated using this class)
+  # Param: token
   def self.decode token
     return -1 if token.length > 15
     num = i = 0
@@ -15,12 +27,9 @@ module ShortUrlTokenGenerator
     num
   end
   
+  # Calculate base notation
   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

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "short_url_token_generator"
-  s.version     = "0.1.0"
+  s.version     = "0.2.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"

data/spec/short_url_token_generator_spec.rb

@@ -1,48 +1,47 @@
 require 'spec_helper'
 
 describe ShortUrlTokenGenerator do
-
   describe 'mapping' do
     it "should be array" do
-      ShortUrlTokenGenerator::mapping.should be_instance_of(Array)
+      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"
+      ShortUrlTokenGenerator.base_notation(10).should eq "10"
     end
     
     it 'should be return 1-0' do
-      ShortUrlTokenGenerator::base_notation(62).should eq "1-0"
+      ShortUrlTokenGenerator.base_notation(62).should eq "1-0"
     end
     
     it 'should be return 1-1' do
-      ShortUrlTokenGenerator::base_notation(63).should eq "1-1"
+      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"
+      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]
+      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]}"
+      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
+      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
+      ShortUrlTokenGenerator.decode("oJC8RZuYg2pTrAIK").should eq -1
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: short_url_token_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-18 00:00:00.000000000Z
+date: 2012-02-07 00:00:00.000000000Z
 dependencies: []
 description: Short url token generator, use to generate/decode tokens for urls
 email: josemarluedke@gmail.com