token_generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b74288c8c87213819be7c9de52aa831a2affcd07
+  data.tar.gz: 30bd4722005dfda85c9e4f298ff12c0893dbbc37
+SHA512:
+  metadata.gz: c3d930eddc6e41ab32c99fffe52c8cc3c168ffedea4c86b4e502747b44154fe6ae6e79298851741084b630850f8a53aa00978fa66d8c328da82c2094d807aeb2
+  data.tar.gz: 6c03ee0a5d4fda822e271acc0a7b2501adafc77df35df6a5c3932352b0dc5177e9b30ad41e705520be5a3e45f61a93ff8227f342c3ed4003b710d3cd72fa3857

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ian White
+
+MIT License
+
+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.md

@@ -0,0 +1,78 @@
+# TokenGenerator
+
+Tiny class that generates friendly tokens using SecureRandom.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'token_generator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install token_generator
+
+## Usage
+
+`TokenGenerator` acts as a namespace for the `token` method (see below about customising the generator).
+
+The `token` method takes an integer (default `20`) which is the number of characters.
+
+Its second argument is the group size (default `5`).  If you don't want groups, pass `0`.
+
+    require 'token_generator'
+
+    TokenGenerator.token
+    # => "PXQE2-ZQWTN-PVFQ9-KYWNC"
+
+    TokenGenerator.token(12)
+    # => "KFAE2-YWJQC-PX"
+
+    TokenGenerator.token(12,3)
+    # => "EYV-XAZ-VFF-47N"
+
+    TokenGenerator.token(50,0)
+    # => "XN76KFH9AC2AA66AXJAPT6RNMVCYJ22E4AD4ZK7E9PNFH6XDGC"
+
+### Customising the generator
+
+include `TokenGenerator` in your own class, and override `charset`, `length`, `group_size`
+
+Or, to customise the global TokenGenerator by setting accessors.
+
+
+    class DNAGen
+      include TokenGenerator
+
+      def charset
+        ['C', 'G', 'T', 'A']
+      end
+
+      def group_size
+        3
+      end
+
+      def length
+        21
+      end
+    end
+
+    gen = DNAGen.new
+
+    gen.token
+    # => "TTT-CGT-TTT-AAA-GTG-AGA-TCC"
+
+    gen.token(120)
+    # => "CTC-ACT-TGC-GTG-ATG-AGA-AAA-GCT-AGG-GAC-AAT-CCC-AAC-GTT-AGA-TAA-TCA-TCG-CCT-TCT-ACG-CAT-ATG-AAG-ACA-TGA-CCT-TGC-AAT-TCA-CCA-GGT-CTC-CAG-TAC-GAT-AGT-ATC-TCC-TCC"
+
+## Contributing
+
+1. Fork it ( https://github.com/i2w/token_generator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/token_generator.rb

@@ -0,0 +1,34 @@
+require "securerandom"
+require "token_generator/version"
+
+module TokenGenerator
+  extend self
+
+  def token(length = self.length, group_size = self.group_size)
+    token = (1..length).map{ random_char }.join
+    hyphenize(token, group_size)
+  end
+
+  def hyphenize(input, group_size = self.group_size)
+    return input if group_size < 1
+    input.split('').each_slice(group_size).map(&:join).join('-')
+  end
+
+  def random_char
+    charset[SecureRandom.random_number(charset.size)]
+  end
+
+  attr_writer :charset, :group_size, :length
+
+  def charset
+    @charset ||= %w{2 3 4 6 7 9 A C D E F G H J K M N P Q R T V W X Y Z}
+  end
+
+  def group_size
+    @group_size ||= 5
+  end
+
+  def length
+    @length ||= 20
+  end
+end

data/lib/token_generator/version.rb

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

data/token_generator.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'token_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "token_generator"
+  spec.version       = TokenGenerator::VERSION
+  spec.authors       = ["Ian White"]
+  spec.email         = ["ian.w.white@gmail.com"]
+  spec.summary       = %q{Generate a token}
+  spec.description   = %q{Generates friendly (to urls and humans) tokens}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: token_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ian White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates friendly (to urls and humans) tokens
+email:
+- ian.w.white@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/token_generator.rb
+- lib/token_generator/version.rb
+- token_generator.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generate a token
+test_files: []