token_attr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27e5d3e895c988371564f5bf875ddc5ca127e780
+  data.tar.gz: 79b85868b6e66a37d2641a9afeff44e15cdcd103
+SHA512:
+  metadata.gz: 2285b96a0f45dbe7cc4457ca51f5d6b8180752506a4ca833b87bed229fdeb53c26a0892348d2ed2badd1c8d426a0de00429dd68e3cdbc4231f2c90a30f808d03
+  data.tar.gz: 497a279733f62dc93abea258ceb1934bc02f116d85d47d056be9dc0c85147c5d80b6f8af54f74e06d7a61ba22c8021dab733bb9922dbbb13579b1b207182b078

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    token_attr (0.0.1)
+      activerecord (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+    activerecord (4.1.0)
+      activemodel (= 4.1.0)
+      activesupport (= 4.1.0)
+      arel (~> 5.0.0)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.0)
+    builder (3.2.2)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (5.3.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    slop (3.5.0)
+    sqlite3 (1.3.9)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  pry
+  rake
+  rspec
+  sqlite3
+  token_attr!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michel Billard
+
+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,21 @@
+# token_attr
+
+[Description]
+
+## Installation
+
+Add `token_attr` to your Gemfile:
+
+    gem 'token_attr'
+
+## Usage
+
+[TODO]
+
+## Contributing
+
+1. Fork it ( http://github.com/mbillard/token_attr/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 new Pull Request

data/Rakefile

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

data/lib/token_attr/version.rb

@@ -0,0 +1,3 @@
+module TokenAttr
+  VERSION = '0.0.1'.freeze
+end

data/lib/token_attr.rb

@@ -0,0 +1,78 @@
+require 'token_attr/version'
+require 'active_record'
+require 'active_support/concern'
+
+module TokenAttr
+  extend ActiveSupport::Concern
+
+  DEFAULT_TOKEN_LENGTH  = 8.freeze
+  DEFAULT_SLUG_ALPHABET = [('a'..'z'),('A'..'Z'),(0..9)].map(&:to_a).flatten.freeze
+
+  class TooManyAttemptsError < StandardError
+    attr_reader :attribute, :token
+
+    def initialize(attr_name, token, message = nil)
+      @attribute = attr_name
+      @token = token
+      message ||= "Can't generate unique token for \"#{attr_name}\". Last attempt with \"#{token}\"."
+      super(message)
+    end
+  end
+
+  included do
+    before_validation :generate_tokens
+  end
+
+  module ClassMethods
+    def token_attr(attr_name, options = {})
+      token_attributes << attr_name
+
+      define_method "should_generate_new_#{attr_name}_token?" do
+        send(attr_name).blank?
+      end
+
+      define_method "generate_new_#{attr_name}_token" do
+        token_length = options.fetch(:length, DEFAULT_TOKEN_LENGTH)
+
+        if alphabet = options[:alphabet]
+          alphabet = DEFAULT_SLUG_ALPHABET if alphabet == :slug
+          alphabet_array = alphabet.split('')
+          (0...token_length).map{ alphabet_array.sample }.join
+        else
+          hex_length = (token_length / 2.0).ceil # 2 characters per length
+          SecureRandom.hex(hex_length).slice(0...token_length)
+        end
+      end
+    end
+
+    def token_attributes
+      @token_attributes ||= []
+    end
+  end
+
+  def generate_tokens
+    self.class.token_attributes.each do |attr_name|
+      if send("should_generate_new_#{attr_name}_token?")
+        new_token = nil
+        try_count = 0
+        begin
+          raise TooManyAttemptsError.new(attr_name, new_token) if try_count == 5
+          new_token = send("generate_new_#{attr_name}_token")
+          try_count += 1
+        end until token_is_unique?(attr_name, new_token)
+
+        send "#{attr_name}=", new_token
+      end
+    end
+  end
+
+  def token_is_unique?(attr_name, token)
+    scope = self.class.where(attr_name => token)
+    scope = scope.where(id != self.id) if self.persisted?
+    !scope.exists?
+  end
+
+end
+
+# Uncomment to auto-extend ActiveRecord, probably not a good idea
+# ActiveRecord::Base.send(:extend, TokenAttr)

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'pry'
+require 'token_attr'
+
+# Require this file using `require 'spec_helper'` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.before :each do
+    Model.delete_all
+  end
+end
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
+                                        database: ':memory:')
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :models, force: true do |t|
+    t.string :token
+    t.string :private_token
+  end
+
+end

data/spec/token_attr_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe TokenAttr do
+
+  class Model < ActiveRecord::Base
+    include TokenAttr
+    token_attr :token
+  end
+
+  class ModelWithLength < ActiveRecord::Base
+    self.table_name = 'models'
+    include TokenAttr
+    token_attr :token, length: 13
+  end
+
+  class ModelWithAlphabet < ActiveRecord::Base
+    self.table_name = 'models'
+    include TokenAttr
+    token_attr :token, alphabet: 'abc123'
+  end
+
+  class ModelWithSlugAlphabet < ActiveRecord::Base
+    self.table_name = 'models'
+    include TokenAttr
+    token_attr :token, alphabet: :slug
+  end
+
+  class ModelWithMultipleTokens < ActiveRecord::Base
+    self.table_name = 'models'
+    include TokenAttr
+    token_attr :token
+    token_attr :private_token
+  end
+
+  describe ".token_attr" do
+    let(:model) { Model.new }
+
+    context "when token is blank" do
+      before { model.token = '' }
+
+      it "generates a token on validation" do
+        model.valid?
+        model.token.should_not be_blank
+      end
+
+      it "generates a token of the default length" do
+        stub_const('TokenAttr::DEFAULT_TOKEN_LENGTH', 4)
+        model.valid?
+        model.token.length.should == 4
+      end
+
+      it "generates a unique token" do
+        SecureRandom.should_receive(:hex).twice.with(4).and_return('12345678')
+        SecureRandom.should_receive(:hex).once.with(4).and_return('abcdefgh')
+        existing_model = Model.create
+        model.valid?
+        model.token.should == 'abcdefgh'
+      end
+
+      it "raises an exception if it can't find a unique token" do
+        SecureRandom.should_receive(:hex).exactly(5 + 1).times.with(4).and_return('12345678')
+        existing_model = Model.create
+        expect{ model.valid? }.to raise_error(TokenAttr::TooManyAttemptsError)
+      end
+
+      context "when length is specified" do
+        let(:model) { ModelWithLength.new }
+
+        it "generates a token of the specified length" do
+          model.valid?
+          model.token.length.should == 13
+        end
+      end
+
+      context "when an alphabet is specified" do
+        let(:model) { ModelWithAlphabet.new }
+
+        it "generates a token with characters from that alphabet" do
+          model.valid?
+          model.token.split('').all? do |c|
+            'abc123'.include?(c)
+          end.should be_true
+        end
+
+        it "generates a token of the default length even if lower than the alphabet" do
+          stub_const('TokenAttr::DEFAULT_TOKEN_LENGTH', 12)
+          model.valid?
+          model.token.length.should == 12
+        end
+
+        it "generates a token with the default slug alphabet if the alphabet is :slug" do
+          model = ModelWithSlugAlphabet.new
+          stub_const('TokenAttr::DEFAULT_SLUG_ALPHABET', 'token')
+          model.valid?
+          model.token.split('').all? do |c|
+            'token'.include?(c)
+          end.should be_true
+        end
+      end
+
+      context "when the model has multiple tokens" do
+        let(:model) { ModelWithMultipleTokens.new }
+
+        it "generates each token" do
+          model.valid?
+          model.token.should_not         be_blank
+          model.private_token.should_not be_blank
+        end
+      end
+    end
+
+    context "when token is not blank" do
+      before { model.token = 'not blank' }
+
+      it "does not generate a token on validation" do
+        model.valid?
+        model.token.should == 'not blank'
+      end
+    end
+  end
+
+end

data/token_attr.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'token_attr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "token_attr"
+  spec.version       = TokenAttr::VERSION
+  spec.authors       = ["Michel Billard"]
+  spec.email         = ["michel@mbillard.com"]
+  spec.summary       = "Unique random token generator for ActiveRecord"
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "http://github.com/mbillard/token_attr"
+  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_dependency 'activerecord', '>= 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: token_attr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Billard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: sqlite3
+  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:
+- michel@mbillard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/token_attr.rb
+- lib/token_attr/version.rb
+- spec/spec_helper.rb
+- spec/token_attr_spec.rb
+- token_attr.gemspec
+homepage: http://github.com/mbillard/token_attr
+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: Unique random token generator for ActiveRecord
+test_files:
+- spec/spec_helper.rb
+- spec/token_attr_spec.rb