has_a_token 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8491d9a4c3075b49a847c5a08f6ba5fcbf024cd
+  data.tar.gz: 0c03816f73b77e85ddc57803b5396041cdb4412e
+SHA512:
+  metadata.gz: f1cfb8c4c0359d7cd768531ecc01f13ddae17c2df935caf31931bbc891869125353c42c9a2c5422abf29fa514a14e0e1ef00f9e2a93c42b6f77d8d8124a176e0
+  data.tar.gz: 88806e63ce3b213416e22ce7005fb4e3bbd8923ecb34acb69a0cef54d12eae814531a9595dc01e15855382bb513756f951f558a345aee1d4b24032a81128d737

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,65 @@
+AllCops:
+  Exclude:
+    - 'lib/has_a_token/version.rb'
+    - 'Guardfile'
+  DisplayStyleGuide: true
+  RunRailsCops: true
+
+Metrics/LineLength:
+  Max: 100
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/IndentationConsistency:
+  EnforcedStyle: normal
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/ClassLength:
+  Max: 200 # lenient
+
+Metrics/ModuleLength:
+  Max: 200 # lenient
+
+Style/CommandLiteral:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Style/StringLiterals:
+  Enabled: false
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+2.2.1

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,55 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 James Phillips
+
+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,51 @@
+# HasAToken
+
+Generate simple/complex/readable tokens in Rails models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_a_token'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Basic usage:
+
+```ruby
+# Setup your model
+class User < ActiveRecord::Base
+  include HasAToken::Concern
+
+  # ...
+
+  has_a_token :invite_code, charset: :unambiguous # generates an easily readable token
+  has_a_token :password_reset, length: 32 # generates a 32 character secure token
+
+  # ...
+
+  # You can use the generate_* methods to fetch a token when records are created
+  before_create :generate_invite_code
+  before_save :generate_password_reset_token, if: "password_reset_token.nil?"
+
+  # ...
+end
+
+# Reset a token
+user = User
+user.reset_password_reset_token! # creates a new token and persists the changes
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/has_a_token/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 @@
+require "bundler/gem_tasks"

data/has_a_token.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_a_token/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_a_token"
+  spec.version       = HasAToken::VERSION
+  spec.authors       = ["James Phillips"]
+  spec.email         = ["jamesdphillips@gmail.com"]
+  spec.summary       = "Generate simple/complex/readable tokens in Rails models"
+  spec.homepage      = "https://www.github.com/jamesdphillips/has_a_token"
+  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.require_paths = ["lib"]
+
+  spec.add_dependency "contracts", "~> 0.9.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov-html"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "guard-rubocop"
+end

data/lib/has_a_token/concern.rb

@@ -0,0 +1,50 @@
+require "active_support/all"
+
+module HasAToken
+
+  # Model concern
+  # @example unambiguous token
+  #   class Workspace < ActiveRecord::Base
+  #     # ...
+  #     has_a_token :invite_code, charset: :unambiguous
+  #     has_a_token :password_reset_token, length: 32
+  module Concern
+    extend ActiveSupport::Concern
+
+    module ClassMethods # rubocop:disable all
+      # @param name [Symbol] name of the column
+      # @param opts [Hash] generator options
+      # @option opts [Symbol] :charset
+      # @option opts [Symbol] :length
+      # @example
+      #   has_a_token :invite_code, charset: unambiguous # generates easily readable token
+      #   has_a_token :password_reset, length: 32  # generates a secure token of 32 length
+      #
+      #   before_create :generate_invite_code
+      #   before_save :generate_password_reset_token, if: "password_reset_token.nil?"
+      #
+      #   user = User.first
+      #   user.reset_password_reset_token!
+      # @see https://github.com/jamesdphillips/has_a_token/blob/master/lib/has_a_token/generator.rb
+      def has_a_token(name = :token, opts = {}) # rubocop:disable all
+        if String(name).match(/(_token|_code)$/)
+          method_name = name.to_s
+        else
+          method_name = "#{name}_token"
+        end
+
+        define_method "generate_#{method_name}" do
+          self[method_name] = loop do
+            random_token = HasAToken::Generator.new(opts).generate
+            break random_token unless self.class.exists?(Hash[method_name, random_token])
+          end
+        end
+
+        define_method "reset_#{method_name}!" do
+          send("generate_#{method_name}")
+          save!
+        end
+      end
+    end
+  end
+end

data/lib/has_a_token/generator.rb

@@ -0,0 +1,60 @@
+module HasAToken
+
+  # Configurable generator for build unique tokens
+  class Generator
+    include Contracts
+
+    UNAMBIGUOUS_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 ).freeze
+
+    # @option [Symbol] :charset charset to token
+    #    :unambiguous token will only contain unambiguous letters and numbers
+    #    :urlsafe_base64 will return base64 token with '/' & '+' replaced w/ '-' & '_'
+    # @option [Fixnum] :length of the resulting token; defaults to 24 (or 8 for unambiguous sets)
+    def initialize(charset: :urlsafe_base64, length: nil)
+      @length = length || (charset == :unambiguous ? 5 : 24)
+      @charset = charset
+    end
+
+    # Generate a unique token
+    #
+    # @return [String] unique token
+    Contract None => String
+    def generate
+      case @charset
+      when :unambiguous
+        generate_unambiguous_token
+      else
+        generate_secure_token
+      end
+    end
+
+    private
+
+    Contract None => String
+    def generate_unambiguous_token
+      # Fetch a random set of bytes
+      randset = SecureRandom.random_number(UNAMBIGUOUS_CHARSET.size**@length)
+
+      # Assign to ambiguous charset
+      @length
+        .times
+        .map do |i|
+          UNAMBIGUOUS_CHARSET.to_a[
+            (randset / UNAMBIGUOUS_CHARSET.size**i) % UNAMBIGUOUS_CHARSET.size
+          ]
+        end.join
+    end
+
+    Contract None => String
+    def generate_secure_token
+      case @charset
+      when :hex
+        SecureRandom.send(@charset, Integer(@length * Rational(1, 2)))
+      when :urlsafe_base64, :base64
+        SecureRandom.send(@charset, Integer(@length / Rational(4, 3)))
+      else
+        fail ArgumentError, "Unsupported charset #{@charset}"
+      end
+    end
+  end
+end

data/lib/has_a_token/version.rb

@@ -0,0 +1,3 @@
+module HasAToken
+  VERSION = "0.3.0"
+end

data/lib/has_a_token.rb

@@ -0,0 +1,9 @@
+require "contracts"
+
+require "has_a_token/version"
+require "has_a_token/generator"
+require "has_a_token/concern" if defined?(Rails)
+
+module HasAToken
+  # ...
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require "simplecov"
+require "simplecov-html"
+require "coveralls"
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter,
+]
+
+SimpleCov.start do
+  add_filter "test/"
+end
+
+require "minitest"
+require "minitest/unit"
+require "minitest/autorun"
+require "has_a_token"

data/test/test_token_generator.rb

@@ -0,0 +1,32 @@
+require "test_helper"
+
+# Test Generator class
+class GeneratorTests < Minitest::Test
+  def test_unambiguous_length
+    assert HasAToken::Generator.new(charset: :unambiguous, length: 8).generate.length == 8
+    assert HasAToken::Generator.new(charset: :unambiguous, length: 10).generate.length == 10
+  end
+
+  def test_unambiguous_charset
+    SecureRandom.stub :random_number, 456_975 do # ZZZZ
+      assert_instance_of String, HasAToken::Generator.new(charset: :unambiguous, length: 1).generate
+      assert_equal "ZZZZ", HasAToken::Generator.new(charset: :unambiguous, length: 4).generate
+    end
+  end
+
+  def test_secure_token_length
+    assert HasAToken::Generator.new(charset: :urlsafe_base64, length: 8).generate.length == 8
+    assert HasAToken::Generator.new(charset: :base64, length: 8).generate.length == 8
+    assert HasAToken::Generator.new(charset: :hex, length: 8).generate.length == 8
+  end
+
+  def test_secure_token_charset
+    assert_raises(ArgumentError) { HasAToken::Generator.new(charset: :squidward).generate }
+    SecureRandom.stub :base64, "ABCD" do
+      assert_equal "ABCD", HasAToken::Generator.new(charset: :base64).generate
+    end
+    SecureRandom.stub :hex, "1234" do
+      assert_equal "1234", HasAToken::Generator.new(charset: :hex).generate
+    end
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: has_a_token
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- James Phillips
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-html
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  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: 
+email:
+- jamesdphillips@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- has_a_token.gemspec
+- lib/has_a_token.rb
+- lib/has_a_token/concern.rb
+- lib/has_a_token/generator.rb
+- lib/has_a_token/version.rb
+- test/test_helper.rb
+- test/test_token_generator.rb
+homepage: https://www.github.com/jamesdphillips/has_a_token
+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 simple/complex/readable tokens in Rails models
+test_files:
+- test/test_helper.rb
+- test/test_token_generator.rb