rtoken 0.0.1

data/lib/rtoken.rb

@@ -0,0 +1,83 @@
+# Generates Random Tokens for general purposes.
+# 
+# @example Generate 8 length token
+#   RToken.rtoken #=> Random sequence 8 chars
+#
+# @example Generate 10 length token
+#   RToken.rtoken(:size => 10) #=> Random sequence 10 chars
+#
+# @example Generate 16 length token with special chars
+#   RToken.rtoken(:size => 16, :special_chars => '!@#$%%&')
+#
+# @example Generate 32 length token with uppercase chars
+#   RToken.rtoken(:size => 32, :uppercase => true)
+#
+# @see RToken.rtoken
+class RToken
+  
+  UPPER_ALPHA_CHARS   = ('A'..'Z').to_a.freeze
+  LOWER_ALPHA_CHARS   = ('a'..'z').to_a.freeze
+
+  NUMERIC_CHARS       = ('0'..'9').to_a.freeze
+
+  DEAFULT_OPTIONS = {
+    :size         => 8,
+    :uppercase    => false,
+    :lowercase    => false,
+    :numeric      => true,
+    :special_cars => ''
+  }.freeze
+
+  # Creates an instance of RToken and handle the options for later calls
+  # It is useful when you have many settings and don't want to repeat them
+  #
+  # @example Generates tokens with special chars
+  #   rtkn = RToken.new(:special_chars => '+-*/')
+  #   # All next calls keeps the same options
+  #   rtkn.rtoken #=> Same as Rtoken.rtoken(:special_chars => '+-*/')
+  #
+  # @param [Hash] opts same as rtoken
+  def initialize(opts=nil)
+    @options = opts || {}
+  end
+  
+  # Generates a token with previews options
+  # 
+  # @see RToken.rtoken
+  #
+  # @param [Hash] opts options that will be merged to the predefined on initialize
+  # @return [String] token
+  def rtoken(opts=nil)
+    RToken.rtoken @options.merge(opts || {})
+  end
+  
+  # Generates a token
+  #
+  # @param [Hash] opts The options to configure the token generator
+  # @param opts [Fixnum] :size The size of token string. Default 8
+  # @param opts :uppercase if true all chars will be replaced by uppercase. Default false
+  # @param opts :lowercase if true all chars will be replaced by lowercase. Has priority against :uppercase definition. Default false
+  # @param opts :numeric if true include numeric chars ('0'..'9') on tokens. Default true
+  # @param opts [String] :special_chars special chars to be include on token generation, by default include alphanumeric chars
+  # @return [String] token
+  def self.rtoken(opts=nil)
+    options = DEAFULT_OPTIONS.merge(opts || {})
+    size = options[:size] || 8
+    # Merge available chars
+    chars_array = options[:numeric] ? Array.new(NUMERIC_CHARS) : [] 
+    if options[:uppercase] || options[:lowercase]
+      chars_array += (options[:lowercase] ? LOWER_ALPHA_CHARS : UPPER_ALPHA_CHARS)
+    else
+      chars_array += LOWER_ALPHA_CHARS
+      chars_array += UPPER_ALPHA_CHARS
+    end
+    chars_array += options[:special_chars].split('') if options[:special_chars]
+    chars_array_size = chars_array.size
+    # creates token
+    token_chars = Array.new(size)
+    size.times do |i|
+      token_chars[i] = chars_array[rand(chars_array_size)]
+    end
+    token_chars.join
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+name: rtoken
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thiago Lewin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-02 00:00:00 Z
+dependencies: []
+
+description: "RToken generates random tokens, of any length, for multiple purposes, ex: web urls, data identification, etc."
+email: thiago_lewin@yahoo.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rtoken.rb
+homepage: https://github.com/tlewin/rtoken
+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.11
+signing_key: 
+specification_version: 3
+summary: Simple Random Token Generator
+test_files: []
+
+has_rdoc: