friendly_key 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0edcba1c30b66f336e4c7b535a447165a3a8667
+  data.tar.gz: 85d489186bf0243efd4e31065ab9e3de41a2e216
+SHA512:
+  metadata.gz: ba8c8a17ef0144907f36b4e72587642ed9854bc8f08d40687d1d2375a3a9ef7cf634c4a9c0c7c86c6668deeb808775b86d678103a257aecd492eedc750604574
+  data.tar.gz: 7750c3da5fdc09873a85315f99ffebc8c4f11e4ba65fd89ec41f4f5f188050e00009759e6a750b92d2f937b213dc13a049f8a03e466d13818a27b8de5c075f56

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yamaguchi.Tomoki
+
+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,41 @@
+# FriendlyKey
+
+FriendlyKey lets you generate human friendly random strings. It generates random alphanumeric strings without letters and digits that are hard to distinguish from each other, such as I, l and 1.
+You can use FriendlyKey when you need random strings that you don't want your users to copy and paste but rather enter by themselves, like  product keys and random passwords.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'friendly_key'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install friendly_key
+
+## Usage
+
+```ruby
+# Generate a rondom string
+FriendlyKey.generate # => "QNZD9H8FU5UDM848"
+
+# Specify the length of a random string
+FriendlyKey.generate(length: 8) #=> "9AFN87ES"
+
+# Include small letters
+FriendlyKey.generate(small_letters: true) # => "qK8fLq2REprjHxvG"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/tyamagu2/friendly_key/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/friendly_key.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'friendly_key/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "friendly_key"
+  spec.version       = FriendlyKey::VERSION
+  spec.authors       = ["tyamagu2"]
+  spec.email         = ["tyamagu2@gmail.com"]
+  spec.summary       = %q{Human friendly random key generator}
+  spec.description   = %q{FriendlyKey lets you generate human friendly random strings. It generates random alphanumeric strings without letters and digits that are hard to distinguish from each other, such as I, l and 1.
+You can use FriendlyKey when you need random strings that you don't want your users to copy and paste but rather enter by themselves, like  product keys and random passwords.}
+  spec.homepage      = "https://github.com/tyamagu2/friendly_key"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/friendly_key.rb

@@ -0,0 +1,24 @@
+require 'securerandom'
+
+# FriendlyKey lets you generate human friendly random strings. It generates random alphanumeric strings
+# excluding letters and digits that are hard to distinguish from each other, such as I, l and 1.
+# You can use FriendlyKey when you need random strings that you don't want your users to copy and paste
+# but rather enter by themselves, such as product keys and random passwords.
+module FriendlyKey
+  DEFAULT_SOURCE = [(2..9), ('A'..'H'), ('J'..'N'), ('P'..'Z')].map(&:to_a).flatten.freeze
+  SMALL_LETTERS = [['a'], ('c'..'k'), ['m', 'n'], ('p'..'z')].map(&:to_a).flatten.freeze
+  SOURCE_WITH_SMALL_LETTERS = (DEFAULT_SOURCE + SMALL_LETTERS).freeze
+
+  # Generates a random alphanumeric string excluding letters that are hard for human to distinguish from each otehr.
+  # More specifically, it returns a random string composed of alphabets and digits excluding
+  # 0 (digit zero), 1 (digit one), I (capital letter I), O (capital letter O), b (small letter b), l (small letter l) and o (small letter o).
+  # @option options [Integer] :length length of the string to be generated. Default is 16
+  # @option options [Boolean] :small_letters Include small letters if true. Default is false
+  # @return [String] random string of given length
+  def self.generate(options = {})
+    options = { length: 16, small_letters: false }.merge(options)
+
+    source = options[:small_letters] ? SOURCE_WITH_SMALL_LETTERS : DEFAULT_SOURCE
+    options[:length].times.map { source[SecureRandom.random_number(source.length)] }.join
+  end
+end

data/lib/friendly_key/version.rb

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

data/spec/friendly_key_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+RSpec.describe FriendlyKey do
+  describe '.DEFAULT_SOURCE' do
+    let(:expected_source) { [2, 3, 4, 5, 6, 7, 8, 9, *%w(A B C D E F G H J K L M N P Q R S T U V W X Y Z)] }
+    subject { FriendlyKey::DEFAULT_SOURCE }
+
+    it 'contains numbers and capital letters excluding 0, 1, I and O' do
+      is_expected.to match_array(expected_source)
+    end
+  end
+
+  describe '.SOURCE_WITH_SMALL_LETTERS' do
+    let(:expected_source) { [2, 3, 4, 5, 6, 7, 8, 9, *%w(A B C D E F G H J K L M N P Q R S T U V W X Y Z a c d e f g h i j k m n p q r s t u v w x y z)] }
+    subject { FriendlyKey::SOURCE_WITH_SMALL_LETTERS }
+
+    it 'contains numbers and capital letters excluding 0, 1, I, O, b, l and o' do
+      is_expected.to match_array(expected_source)
+    end
+  end
+
+  describe '.generate' do
+    let(:length) { 10000 }
+    let(:another_key) { FriendlyKey.generate(length: length, small_letters: small_letters) }
+    subject { FriendlyKey.generate(length: length, small_letters: small_letters) }
+
+    context 'without small letters' do
+      let(:small_letters) { false }
+      let(:expected_regexp) { Regexp.new("\\A[2-9A-HJ-NP-Z]{#{length}}\\z") }
+
+      it 'generates a random string of given length without 0, 1, I and O' do
+        is_expected.to match(expected_regexp)
+      end
+
+      # Theoretically, this example could fail. Pratcically, we can ignore that possibility.
+      it 'generates a different string every time' do
+        is_expected.not_to eq another_key
+      end
+    end
+
+    context 'with small letters' do
+      let(:small_letters) { true }
+      let(:expected_regexp) { Regexp.new("\\A[2-9A-HJ-NP-Zac-kmnp-z]{#{length}}\\z") }
+
+      it 'generates a random string of given length without 0, 1, I, O, b, l and o' do
+        is_expected.to match(expected_regexp)
+      end
+
+      # Theoretically, this example could fail. Pratcically, we can ignore that possibility.
+      it 'contains small letters' do
+        is_expected.to match(/[a-z]/)
+      end
+
+      # Theoretically, this example could fail. Pratcically, we can ignore that possibility.
+      it 'generates a different string every time' do
+        is_expected.not_to eq another_key
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'friendly_key'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: friendly_key
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tyamagu2
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |-
+  FriendlyKey lets you generate human friendly random strings. It generates random alphanumeric strings without letters and digits that are hard to distinguish from each other, such as I, l and 1.
+  You can use FriendlyKey when you need random strings that you don't want your users to copy and paste but rather enter by themselves, like  product keys and random passwords.
+email:
+- tyamagu2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- friendly_key.gemspec
+- lib/friendly_key.rb
+- lib/friendly_key/version.rb
+- spec/friendly_key_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tyamagu2/friendly_key
+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: Human friendly random key generator
+test_files:
+- spec/friendly_key_spec.rb
+- spec/spec_helper.rb
+has_rdoc: