flexkey 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Devin McCabe
+
+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,169 @@
+## Flexkey
+
+Flexkey is a Ruby gem for generating unique, random strings for use as product keys, redemption codes, invoice numbers, passwords, etc.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flexkey'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flexkey
+
+##### Dependencies
+
+None. Flexkey has been tested with Ruby 1.9.3 and 2.0.
+
+### Usage
+
+##### Basic usage
+
+Instantiate a new generator with `Flexkey::Generator.new` and provide a `format` and `char_pool`. Then, generate a single key or multiple unique keys with the `generate` method:
+
+```ruby
+keygen = Flexkey::Generator.new(format: 'aaaa-aa', char_pool: { 'a' => :alpha_upper })
+# => #<Flexkey::Generator @format="aaaa-aa", @char_pool={"a"=>:alpha_upper}, @n_possible_keys=308915776>
+keygen.generate
+# => "KBND-NR"
+keygen.generate(3)
+# => ["IVXT-LB", "BFZB-LM", "WIVG-ZJ"]
+```
+
+In this example, Flexkey generates a key by replacing each instance of `'a'` in the string `'aaaa-aa'` with a character
+randomly drawn from a pool of uppercase letters while leaving unspecified characters (i.e. `'-'`) alone.
+
+Since you're most likely persisting generated keys in a database, even though `generate(n)` will return `n` _unique_ keys, you'll still want to validate them for uniqueness against keys you've previously saved.
+
+##### Built-in character types
+
+| **Character type** | **Description** |
+|-------------------|--------------------------------------------------------|
+| alpha_upper | uppercase letters |
+| alpha_lower | lowercase letters |
+| numeric | numerals |
+| alpha_upper_clear | alpha_upper without ambiguous letters ("S", "O", etc.) |
+| alpha_lower_clear | alpha_lower without ambiguous letters ("l", "O", etc.) |
+| numeric_clear | numeric without ambiguous numerals ("0", "1", and "5") |
+| symbol | symbols on a standard U.S. keyboard |
+| basic_symbol | basic symbols on a standard U.S. keyboard |
+
+The names and characters present in each type can be retrieved as such:
+
+```ruby
+Flexkey::CharPool.available_char_types
+# => [:alpha_upper, :alpha_lower, :numeric, :alpha_upper_clear, :alpha_lower_clear, :numeric_clear, :symbol, :basic_symbol]
+Flexkey::CharPool.available_char_pools
+# => {:alpha_upper=>"ABCDEFGHIJKLMNOPQRSTUVWXYZ", :alpha_lower=>"abcdefghijklmnopqrstuvwxyz", :numeric=>"0123456789", :alpha_upper_clear=>"ABCDEFGHJKLMNPQRTUVWXYZ", :alpha_lower_clear=>"abcdefghjkmnpqrtuvwxyz", :numeric_clear=>"2346789", :symbol=>"!@\#$%^&*;:()_+-=[]{}\\|'\",.<>/?", :basic_symbol=>"!@\#$%^&*;:"}
+```
+
+##### Examples
+
+```ruby
+Flexkey::Generator.new(format: 'a-nnnn', char_pool: {
+  'a' => :alpha_upper, 'n' => :numeric
+}).generate
+# => "Y-1145"
+```
+
+```ruby
+Flexkey::Generator.new(format: 'SN-nnnnnnnnn', char_pool: {
+  'n' => :numeric
+}).generate
+# => "SN-181073470"
+```
+
+```ruby
+Flexkey::Generator.new(format: 'AA.aa.nn.ss', char_pool: {
+  'A' => :alpha_upper_clear, 'a' => :alpha_lower_clear, 'n' => :numeric_clear, 's' => :basic_symbol
+}).generate
+# => "MX.mh.33.*:"
+```
+
+You can also specify a custom string instead of using a built-in type.
+
+```ruby
+Flexkey::Generator.new(format: 'annn/c', char_pool: {
+  'a' => :alpha_upper, 'n' => :numeric, 'c' => 'LMN'
+}).generate(5)
+# => ["X905/N", "F865/L", "M423/N", "V564/L", "V874/M"]
+```
+
+```ruby
+Flexkey::Generator.new(format: 'mnnnnnnn', char_pool: {
+  'm' => '123456789', 'n' => :numeric
+}).generate(5)
+# => ["45862188", "23054329", "36248220", "56044911", "49873464"]
+```
+
+##### Selecting from multiple character types
+
+To replace a character in the `format` from a pool of multiple character types, specify the both the types and proportions in the `char_pool`. For example, to generate keys of length 10 where each character is randomly selected from a pool of uppercase letters and numerals with equal proportions, do the following:
+
+```ruby
+Flexkey::Generator.new(format: '..........', char_pool: {
+  '.' => { alpha_upper: 0.5, numeric: 0.5 }
+}).generate(5)
+# => ["OXAEXC2O87", "3D95JXQ60P", "8F28OX31Y8", "65ZY7IM6TL", "B971Q602SO"]
+```
+
+You can specify proportions with any positive numbers:
+
+```ruby
+Flexkey::Generator.new(format: 'U-ccccc-ccccc', char_pool: {
+  'U' => :alpha_upper_clear, 'c' => { numeric_clear: 1, alpha_upper_clear: 7 }
+}).generate(5)
+# => ["H-KYLYK-DQLK3", "U-7QUXV-6DXNW", "X-REYAX-LL489", "L-8ABNJ-ZW3A7", "M-TPVTW-VEMTE"]
+```
+
+```ruby
+Flexkey::Generator.new(format: 'UUUUU.LLLLL', char_pool: {
+  'U' => { 'WXYZ' => 3, 'FGH' => 1 }, 'L' => :alpha_lower_clear
+}).generate(5)
+# => ["XZYYF.kwkth", "HHFYW.nkpdr", "WXXGW.fvyeu", "HWFXW.xzgeq", "WXWXW.twrdk"]
+```
+
+##### Number of possible keys
+
+Flexkey will raise an exception if you try to request more keys than are possible with the `format` you provided:
+
+```ruby
+keygen = Flexkey::Generator.new(format: 'annn', char_pool: {
+  'a' => :alpha_upper, 'n' => :numeric
+})
+keygen.generate(3)
+# => ["F202", "U811", "W802"]
+keygen.generate(26001)
+# Flexkey::GeneratorError: There are only 26000 possible keys
+keygen.n_possible_keys
+# => 26000
+```
+
+The instance method `n_possible_keys` is available for reference.
+
+##### CharPool
+
+If you're only interested in using the proportional sampling feature of Flexkey and will generate keys yourself, use `Flexkey::CharPool.generate` with a single hash argument:
+
+```ruby
+char_pool = Flexkey::CharPool.generate({ alpha_upper: 0.75, numeric: 0.25 })
+10.times.map { char_pool.sample }.join
+=> "XC3RPKKWKA"
+```
+
+### Additional documentation
+
+Somewhere.
+
+### Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)

data/flexkey.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flexkey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flexkey'
+  spec.version       = Flexkey::VERSION
+  spec.authors       = ['Devin McCabe']
+  spec.email         = ['devin.mccabe@gmail.com']
+  spec.description   = %q{Flexible product key generation}
+  spec.summary       = %q{Use Flexkey to generate random product keys for use in software licenses,
+    invoices, etc.}
+  spec.homepage      = 'https://github.com/dpmccabe/flexkey'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
+end

data/lib/flexkey.rb

@@ -0,0 +1,3 @@
+require 'flexkey/version'
+require 'flexkey/generator'
+require 'flexkey/char_pool'

data/lib/flexkey/char_pool.rb

@@ -0,0 +1,108 @@
+module Flexkey
+  class CharPoolError < StandardError; end
+
+  module CharPool
+    extend self
+
+    # Generates an array of characters of the specified types and proportions
+    #
+    # @param arg [Hash{ Symbol, String => Fixnum }, Symbol, String] a single character type or a
+    #   hash of several character types and their proportions
+    #
+    # @return [Array<String>] the requested character pool
+    #
+    # @example
+    #   Flexkey::CharPool.generate(:numeric)
+    #   Flexkey::CharPool.generate('XYZ01234')
+    #   Flexkey::CharPool.generate({ numeric: 0.25, alpha_upper: 0.75 })
+    #   Flexkey::CharPool.generate({ alpha_lower_clear: 1, alpha_upper_clear: 3 })
+    #   Flexkey::CharPool.generate({ 'AEIOU' => 1, 'BCDFGHJKLMNPQRSTVWXYZ' => 1, symbol: 0.5 })
+    def generate(arg)
+      if arg.is_a?(Hash)
+        # Extract character types and proportions.
+        char_arrays = arg.keys.map { |t| single_pool(t) }
+        char_props = arg.values.each do |p|
+          raise CharPoolError.new("Invalid char_pool proportion #{p.inspect}") unless
+            p.is_a?(Numeric) && p >= 0
+        end
+
+        # Standardize the proportions if they don't sum to 1.
+        total_prop = char_props.inject(:+).to_f
+        char_props = char_props.map { |prop| prop / total_prop }
+
+        multiple_pool(char_arrays, char_props)
+      else
+        single_pool(arg)
+      end
+    end
+
+    # Provides a list of the available built-in character pool types.
+    #
+    # @return [Array<Symbol>] the list of character pool types
+    #
+    # @example
+    #   Flexkey::CharPool.available_char_types
+    def available_char_types
+      character_types.keys
+    end
+
+    # Provides a list of the available built-in character pool types with the characters of each
+    #   type.
+    #
+    # @return [Hash{ Symbol => String }] a hash of character pool types and their characters
+    #
+    # @example
+    #   Flexkey::CharPool.available_char_pools
+    def available_char_pools
+      character_types.inject({}) { |acc, (k, v)| acc[k] = v.join; acc }
+    end
+
+    private
+
+    def character_types
+      {
+        alpha_upper: 'A'.upto('Z').to_a,
+        alpha_lower: 'a'.upto('z').to_a,
+        numeric: '0'.upto('9').to_a,
+        alpha_upper_clear: 'A'.upto('Z').to_a - 'IOS'.chars.to_a,
+        alpha_lower_clear: 'a'.upto('z').to_a - 'ilos'.chars.to_a,
+        numeric_clear: '2346789'.chars.to_a,
+        symbol: "!@#\$%^&*;:()_+-=[]{}\\|'\",.<>/?".chars.to_a,
+        basic_symbol: '!@#$%^&*;:'.chars.to_a
+      }
+    end
+
+    # Return an array of characters from either a custom pool or a built-in type
+    def single_pool(char_type)
+      if char_type.respond_to?(:chars)
+        if char_type.empty?
+          raise CharPoolError.new('A custom char_pool was blank')
+        else
+          char_type.chars.to_a
+        end
+      elsif character_types.keys.include?(char_type)
+        character_types[char_type]
+      else
+        raise CharPoolError.new("Invalid char_pool #{char_type.inspect}")
+      end
+    end
+
+    # Return a flat array of characters from the provided character pools and proportions
+    def multiple_pool(char_arrays, char_props)
+      # Compute LCM of sizes of char type arrays
+      char_array_sizes = char_arrays.map(&:size)
+      char_array_sizes_lcm = char_array_sizes.inject(:lcm)
+
+      # Compute approximate number of multiples needed for each char type array
+      char_array_multiples = char_array_sizes.zip(char_props).map { |arr|
+        (char_array_sizes_lcm / arr[0] * arr[1] * 100).round }
+
+      # Construct combined array of all char types with correct proportions
+      char_array_multiples_gcd = char_array_multiples.inject(:gcd)
+      char_arrays_mult = char_arrays.zip(char_array_multiples).map { |arr|
+        arr[0] * (arr[1] / char_array_multiples_gcd) }
+
+      char_arrays_mult.flatten    
+    end
+  end
+end

data/lib/flexkey/generator.rb

@@ -0,0 +1,120 @@
+module Flexkey
+  class GeneratorError < StandardError; end
+
+  class Generator
+    # @return [String] the format of the keys to be generated
+    attr_accessor :format
+
+    # @return [Hash{ String => Symbol, String }] a pool of available character types specified in
+    #   the format
+    attr_accessor :char_pool
+
+    # @return [Fixnum] the number of possible keys for a Flexkey instance with given format and
+    #   character pool
+    attr_reader :n_possible_keys
+
+    # Initializes and validates a new Flexkey key generator.
+    #
+    # @param args [Hash{ Symbol => String, Hash{ String => Symbol, String }}] the format of the keys
+    #   to be generated and a pool of available character types specified in the format
+    #
+    # @return [Flexkey] the Flexkey instance
+    #
+    # @example
+    #   Flexkey::Generator.new(format: 'nnn-aaa',
+    #                          char_pool: { 'n' => :numeric, 'a' => :alpha_upper_clear })
+    #   Flexkey::Generator.new(format: 'ccccc-ccccc',
+    #                          char_pool: { 'c' => { alpha_upper: 0.75, alpha_lower: 0.25 } })
+    #   Flexkey::Generator.new(format: 'key_#######', char_pool: { '#' => :numeric_clear })
+    #   Flexkey::Generator.new(format: 'a-nnnn', char_pool: { 'a' => :alpha_upper, 'n' => '12345' })
+    def initialize(args = {})
+      @format, @char_pool = args[:format], args[:char_pool]
+      validate!
+      set_char_pool
+      calculate_n_possible_keys
+    end
+
+    def format=(new_format)
+      @format = new_format
+      validate!
+      calculate_n_possible_keys
+    end
+
+    def char_pool=(new_char_pool)
+      @char_pool = new_char_pool
+      validate!
+      set_char_pool
+      calculate_n_possible_keys
+    end
+
+    # Generates a single key or an array of `n` keys.
+    #
+    # @param n [Integer] the number of keys to generate
+    #
+    # @return [String] a single key
+    # @return [Array<String>] `n` keys
+    #
+    # @example
+    #   fk = Flexkey::Generator.new(format: 'nnn-aaa',
+    #                               char_pool: { 'n' => :numeric, 'a' => :alpha_upper_clear })
+    #   fk.generate
+    #   fk.generate(10)
+    def generate(n = 1)
+      validate_n!(n)
+
+      if n == 1
+        generate_one
+      elsif n > 1
+        keys = []
+        new_key = nil
+
+        n.times do
+          loop do
+            new_key = generate_one
+            break unless keys.include?(new_key)
+          end
+
+          keys << new_key
+        end
+
+        keys
+      end
+    end
+
+    def inspect
+      %Q{#<#{self.class} @format="#{format}", @char_pool=#{@char_pool}, } +
+      %Q{@n_possible_keys=#{@n_possible_keys}>}
+    end
+    alias to_s inspect
+
+    private
+
+    def validate!
+      raise GeneratorError.new('format is required') if @format.nil? || @format.empty?
+      raise GeneratorError.new('char_pool is required') if @char_pool.nil? || @char_pool.empty?
+      raise GeneratorError.new('char_pool letters must each be strings of length 1') unless
+        @char_pool.keys.all? { |letter| letter.is_a?(String) && letter.length == 1 }
+      raise GeneratorError.new('No char_pool letters present in format') if
+        (@format.chars.to_a & @char_pool.keys).empty?
+    end
+
+    def set_char_pool
+      @_char_pool = @char_pool.inject({}) { |h, (k, v)| h[k] = CharPool.generate(v); h }
+    end
+
+    def calculate_n_possible_keys
+      @n_possible_keys = @format.chars.to_a.map do |c|
+        @_char_pool[c].nil? ? 1 : @_char_pool[c].size
+      end.inject(:*)
+    end
+
+    def generate_one
+      @format.chars.to_a.map { |c| @_char_pool[c].nil? ? c : @_char_pool[c].sample }.join
+    end
+
+    def validate_n!(n)
+      raise GeneratorError.new("There are only #{@n_possible_keys} possible keys") if
+        n > @n_possible_keys
+    end
+  end
+end

data/lib/flexkey/version.rb

@@ -0,0 +1,3 @@
+module Flexkey
+  VERSION = '1.0.0'
+end

data/spec/flexkey/char_pool_spec.rb

@@ -0,0 +1,188 @@
+require 'spec_helper'
+
+module CharPoolSpecHelpers
+  def cpj(arg)
+    Flexkey::CharPool.generate(arg).join
+  end
+end
+
+describe Flexkey::CharPool do
+  include CharPoolSpecHelpers
+
+  describe 'utility methods' do
+    it 'should provide a list of available character types' do
+      expect(Flexkey::CharPool.available_char_types).to eq([
+        :alpha_upper, :alpha_lower, :numeric, :alpha_upper_clear, :alpha_lower_clear,
+        :numeric_clear, :symbol, :basic_symbol])
+    end
+
+    it 'should provide a list of character pools for available character types' do
+      expect(Flexkey::CharPool.available_char_pools).to eq({
+        alpha_upper: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
+        alpha_lower: 'abcdefghijklmnopqrstuvwxyz',
+        numeric: '0123456789',
+        alpha_upper_clear: 'ABCDEFGHJKLMNPQRTUVWXYZ',
+        alpha_lower_clear: 'abcdefghjkmnpqrtuvwxyz',
+        numeric_clear: '2346789',
+        symbol: "!@\#$%^&*;:()_+-=[]{}\\|'\",.<>/?",
+        basic_symbol: "!@\#$%^&*;:"
+      })
+    end
+  end
+
+  context 'when a single type is requested' do
+    describe 'validations' do
+      it 'raises an exception for an unknown character pool symbol' do
+        expect {
+          Flexkey::CharPool.generate(:bad)
+        }.to raise_error(Flexkey::CharPoolError, 'Invalid char_pool :bad')
+      end
+
+      it 'raises an exception for an nil character pool symbol' do
+        expect {
+          Flexkey::CharPool.generate(nil)
+        }.to raise_error(Flexkey::CharPoolError, 'Invalid char_pool nil')
+      end
+
+      it 'raises an exception for a non-symbol type' do
+        expect {
+          Flexkey::CharPool.generate(123)
+        }.to raise_error(Flexkey::CharPoolError, 'Invalid char_pool 123')
+      end
+
+      it 'raises an exception for a blank custom type' do
+        expect {
+          Flexkey::CharPool.generate('')
+        }.to raise_error(Flexkey::CharPoolError, 'A custom char_pool was blank')
+      end
+    end
+
+    it 'generates an uppercase alphabetical character pool' do
+      expect(cpj(:alpha_upper)).to eq('ABCDEFGHIJKLMNOPQRSTUVWXYZ')
+    end
+
+    it 'generates a lowercase alphabetical character pool' do
+      expect(cpj(:alpha_lower)).to eq('abcdefghijklmnopqrstuvwxyz')
+    end
+
+    it 'generates a numeric character pool' do
+      expect(cpj(:numeric)).to eq('0123456789')
+    end
+
+    it 'generates an uppercase and clear alphabetical character pool' do
+      expect(cpj(:alpha_upper_clear)).to eq('ABCDEFGHJKLMNPQRTUVWXYZ')
+    end
+
+    it 'generates a lowercase and clear alphabetical character pool' do
+      expect(cpj(:alpha_lower_clear)).to eq('abcdefghjkmnpqrtuvwxyz')
+    end
+
+    it 'generates a numeric and clear character pool' do
+      expect(cpj(:numeric_clear)).to eq('2346789')
+    end
+
+    it 'generates a full symbol character pool' do
+      expect(cpj(:symbol)).to eq("!@#\$%^&*;:()_+-=[]{}\\|'\",.<>/?")
+    end
+
+    it 'generates a basic symbol character pool' do
+      expect(cpj(:basic_symbol)).to eq('!@#$%^&*;:')
+    end
+
+    it 'generates a custom character pool' do
+      expect(cpj('ABC123')).to eq('ABC123')
+    end
+  end
+
+  context 'when multiple types are requested' do
+    describe 'validations' do
+      it 'raises an exception for an unknown character pool symbol' do
+        expect {
+          Flexkey::CharPool.generate({ alpha_upper: 0.5, bad: 0.5 })
+        }.to raise_error(Flexkey::CharPoolError, 'Invalid char_pool :bad')
+      end
+
+      it 'raises an exception for a non-symbol type' do
+        expect {
+          Flexkey::CharPool.generate({ alpha_upper: 0.5, 123 => 0.5 })
+        }.to raise_error(Flexkey::CharPoolError, 'Invalid char_pool 123')
+      end
+
+      it 'raises an exception for a negative proportion' do
+        expect {
+          Flexkey::CharPool.generate({ alpha_upper: 0.5, numeric: -0.5 })
+        }.to raise_error(Flexkey::CharPoolError, 'Invalid char_pool proportion -0.5')
+      end
+
+      it 'raises an exception for a non-numeric proportion' do
+        expect {
+          Flexkey::CharPool.generate({ alpha_upper: 0.5, numeric: 'test' })
+        }.to raise_error(Flexkey::CharPoolError, 'Invalid char_pool proportion "test"')
+      end
+
+      it 'raises an exception for missing proportion' do
+        expect {
+          Flexkey::CharPool.generate({ alpha_upper: 0.5, numeric: nil })
+        }.to raise_error(Flexkey::CharPoolError, 'Invalid char_pool proportion nil')
+      end
+    end
+
+    it 'generates a pool of upper and lowercase alphabetical types in equal proportions' do
+      expect(cpj({ alpha_upper: 0.5, alpha_lower: 0.5 })).to eq(
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')
+    end
+
+    it 'generates a pool of upper and lowercase alphabetical types in a 1:1 proportion' do
+      expect(cpj({ alpha_upper: 1, alpha_lower: 1 })).to eq(
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')
+    end
+
+    it 'generates a pool of upper and lowercase alphabetical types in a 3:1 proportion' do
+      expect(cpj({ alpha_upper: 0.75, alpha_lower: 0.25 })).to eq(
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ' +
+        'abcdefghijklmnopqrstuvwxyz')
+    end
+
+    it 'generates a pool of upper and lowercase alphabetical types in a 3:1 proportion' do
+      expect(cpj({ alpha_upper: 3, alpha_lower: 1 })).to eq(
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ' +
+        'abcdefghijklmnopqrstuvwxyz')
+    end
+
+    it 'generates a pool of upper and lowercase alphabetical types in a 1:3 proportion' do
+      expect(cpj({ alpha_upper: 0.25, alpha_lower: 0.75 })).to eq(
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz' + 
+        'abcdefghijklmnopqrstuvwxyz')
+    end
+
+    it 'generates a pool of upper and lowercase alphabetical types in a 0:1 proportion' do
+      expect(cpj({ alpha_upper: 0, alpha_lower: 99 })).to eq('abcdefghijklmnopqrstuvwxyz')
+    end
+
+    it 'generates a pool of upper and lowercase alphabetical types in a 0.2:0.2 proportion' do
+      expect(cpj({ alpha_upper: 0.2, alpha_lower: 0.2 })).to eq(
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz')
+    end
+
+    it 'generates a pool of uppercase and numeric character types in equal proportions' do
+      expect(cpj({ alpha_upper: 0.5, numeric: 0.5 })).to eq(
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ' + 
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ0' +
+        '1234567890123456789012345678901234567890123456789012345678901234567890123456789' +
+        '01234567890123456789012345678901234567890123456789')
+    end
+
+    it 'generates a pool of numeric and a custom type in equal proportions' do
+      expect(cpj({ numeric: 0.5, 'ABCDE' => 0.5 })).to eq('0123456789ABCDEABCDE')
+    end
+
+    it 'generates a pool of uppercase and another custom type in equal proportions' do
+      expect(cpj({ alpha_upper: 1, '0123456789!@#' => 1 })).to eq(
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#0123456789!@#')
+    end
+
+    it 'generates a pool of two custom types in a 1:4 proportion' do
+      expect(cpj({ 'ABCD' => 1, 'WXYZ' => 4 })).to eq('ABCDWXYZWXYZWXYZWXYZ')
+    end
+  end
+end

data/spec/flexkey/generator_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+
+describe Flexkey::Generator do
+  describe '#new' do
+    describe 'validations' do
+      it 'raises an exception when format is missing' do
+        expect {
+          Flexkey::Generator.new(char_pool: { 'n' => :numeric })
+        }.to raise_error(Flexkey::GeneratorError, 'format is required')
+      end
+
+      it 'raises an exception when format is blank' do
+        expect {
+          Flexkey::Generator.new(format: '', char_pool: { 'n' => :numeric })
+        }.to raise_error(Flexkey::GeneratorError, 'format is required')
+      end
+
+      it 'raises an exception when char_pool is missing' do
+        expect {
+          Flexkey::Generator.new(format: 'nnn')
+        }.to raise_error(Flexkey::GeneratorError, 'char_pool is required')
+      end
+
+      it 'raises an exception when char_pool has non-string letters' do
+        expect {
+          Flexkey::Generator.new(format: 'nnn', char_pool: { 123 => :numeric })
+        }.to raise_error(Flexkey::GeneratorError,
+          'char_pool letters must each be strings of length 1')
+      end
+
+      it 'raises an exception when char_pool has letters longer than 1 character' do
+        expect {
+          Flexkey::Generator.new(format: 'nnn', char_pool: { 'nn' => :numeric })
+        }.to raise_error(Flexkey::GeneratorError,
+          'char_pool letters must each be strings of length 1')
+      end
+
+      it 'raises an exception when char_pool has blank letters' do
+        expect {
+          Flexkey::Generator.new(format: 'nnn', char_pool: { '' => :numeric })
+        }.to raise_error(Flexkey::GeneratorError,
+          'char_pool letters must each be strings of length 1')
+      end
+
+      it 'raises an exception when no char_pool letters found in format' do
+        expect {
+          Flexkey::Generator.new(format: 'nnn', char_pool: { 'a' => :numeric })
+        }.to raise_error(Flexkey::GeneratorError, 'No char_pool letters present in format')
+      end
+    end
+
+    context 'when a valid format and char_pool is provided' do
+      subject { Flexkey::Generator.new(format: 'nnn', char_pool: { 'n' => :numeric }) }
+
+      its(:format) { is_expected.to eq('nnn') }
+      its(:char_pool) { is_expected.to eq({ 'n' => :numeric }) }
+      its(:n_possible_keys) { is_expected.to eq(10**3) }
+    end
+  end
+
+  describe 'accessors' do
+    let(:key_gen) {
+      Flexkey::Generator.new(format: 'nnn-aaa', char_pool: {
+        'n' => :numeric, 'a' => :alpha_upper }) }
+
+    it 'updates the format' do
+      key_gen.format = 'aaa-nnn'
+      expect(key_gen.format).to eq('aaa-nnn')
+    end
+
+    it 'updates the char_pool' do
+      key_gen.char_pool = { 'n' => :numeric, 'a' => :alpha_lower }
+      expect(key_gen.char_pool).to eq({ 'n' => :numeric, 'a' => :alpha_lower })
+    end
+
+    it 'updates the number of possible keys' do
+      key_gen.format = 'aaaa-nnnn-0000'
+      key_gen.char_pool = { 'n' => :numeric, 'a' => :alpha_lower_clear }
+      expect(key_gen.n_possible_keys).to eq(10**4 * 22**4)
+    end
+  end
+
+  describe '#generate' do
+    context 'when a single key is requested' do
+      context 'with alphabetical and numeric character types' do
+        subject { Flexkey::Generator.new(format: 'aaaaa-nnnn', char_pool: {
+          'a' => :alpha_lower, 'n' => :numeric }).generate }
+
+        it { is_expected.not_to be_nil }
+        it { is_expected.to match(/^[a-z]{5}-\d{4}$/) }
+      end
+
+      context 'with all character types' do
+        subject { Flexkey::Generator.new(format: 'u-l-n-v-m-o-s-b', char_pool: {
+          'u' => :alpha_upper, 'l' => :alpha_lower, 'n' => :numeric, 'v' => :alpha_upper_clear,
+          'm' => :alpha_lower_clear, 'o' => :numeric_clear, 's' => :symbol, 'b' => :basic_symbol
+          }).generate }
+
+        it { is_expected.to match(%r{
+          ^[A-Z]-[a-z]-[0-9]-[ABCDEFGHJKLMNPQRTUVWXYZ]-[abcdefghjkmnpqrtuvwxyz]-
+          [2346789]-[!@#\$%\^&*;:\(\)_\+-=\[\]{}\\\|'",.<>\/?]-[!@#\$%\^&\*;\:]$
+          }x) }
+      end
+    end
+
+    context 'when the format and char_pool change' do
+      let(:key_gen) { Flexkey::Generator.new(format: 'aaa-nnn', char_pool: {
+        'n' => :numeric, 'a' => :alpha_upper }) }
+
+      it 'generates a key with the new format and char_pool' do
+        key_gen.format = 'nnn-aaa'
+        key_gen.char_pool = { 'n' => :numeric, 'a' => :alpha_lower }
+        expect(key_gen.generate).to match(/^\d{3}-[a-z]{3}$/)
+      end
+    end
+
+    context 'when multiple keys are requested' do
+      let(:new_keys) { Flexkey::Generator.new(format: 'aaaaa-nnnn/cc', char_pool: {
+        'a' => :alpha_lower, 'n' => :numeric, 'c' => 'LMN' }).generate(5) }
+
+      it 'generates the specified number of keys' do
+        expect(new_keys.size).to eq(5)
+      end
+
+      it 'generates unique keys' do
+        expect(new_keys.uniq.size).to eq(5)
+      end
+
+      it 'generates keys with the specified format' do
+        expect(new_keys.count { |key| key =~ /^[a-z]{5}-\d{4}\/[LMN]{2}$/ }).to eq(5)
+      end
+    end
+
+    it 'raises an exception when too many keys are requested' do
+      expect {
+        Flexkey::Generator.new(format: 'nnn', char_pool: { 'n' => :numeric }).generate(1001)
+      }.to raise_error(Flexkey::GeneratorError, "There are only 1000 possible keys")
+    end
+  end
+
+  it 'allows inspection of an instance' do
+    fk = Flexkey::Generator.new(format: 'nnn', char_pool: { 'n' => :numeric })
+    expect(fk.inspect).to eq(%q{#<Flexkey::Generator @format="nnn", @char_pool={"n"=>:numeric}, } +
+      %q{@n_possible_keys=1000>})
+  end
+
+  it 'displays an instance as a string' do
+    fk = Flexkey::Generator.new(format: 'nnn', char_pool: { 'n' => :numeric })
+    expect(fk.to_s).to eq(%q{#<Flexkey::Generator @format="nnn", @char_pool={"n"=>:numeric}, } +
+      %q{@n_possible_keys=1000>})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'rspec/its'
+require 'flexkey'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: flexkey
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors:
+- Devin McCabe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+description: Flexible product key generation
+email:
+- devin.mccabe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flexkey.gemspec
+- lib/flexkey.rb
+- lib/flexkey/char_pool.rb
+- lib/flexkey/generator.rb
+- lib/flexkey/version.rb
+- spec/flexkey/char_pool_spec.rb
+- spec/flexkey/generator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dpmccabe/flexkey
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 3377894280690752207
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 3377894280690752207
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Use Flexkey to generate random product keys for use in software licenses,
+  invoices, etc.
+test_files:
+- spec/flexkey/char_pool_spec.rb
+- spec/flexkey/generator_spec.rb
+- spec/spec_helper.rb