token_attribute 0.0.4

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree

data/Gemfile

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

data/README.md

@@ -0,0 +1,90 @@
+# token_attribute [<img src="https://secure.travis-ci.org/fujimura/token_attribute.png"/>](http://travis-ci.org/fujimura/token_attribute)
+
+Small macro to define unique random token generator for ActiveRecord.
+
+## How to Use
+
+```ruby
+
+## Basic
+
+class User < ActiveRecord::Base
+  include TokenAttribute
+  token_attribute :access_token
+end
+
+user = User.new
+user.access_token # => nil
+user.generate_access_token # =>  'random string'
+user.set_access_token # access_token will be set here
+user.access_token # => 'some unique random string'
+
+
+## Use own random string generator
+
+class Coupon < ActiveRecord::Base
+  include TokenAttribute
+  token_attribute :code
+  def generate_code # Override this method
+    'my code'
+  end
+end
+
+coupon = Coupon.new
+coupon.set_code
+coupon.code # => 'my code'
+
+
+## Scoping
+
+class Ticket < ActiveRecord::Base
+  include TokenAttribute
+  token_attribute :token, :scope => :title # token will be unique per title
+end
+
+
+## Make attributes attr_protected
+
+class Post < ActiveRecord::Base
+  include TokenAttribute
+  token_attribute :secret_key, :protected => true
+end
+
+post = Post.new(:secret_key => 'abcdefg')
+post.secret_key # => nil
+```
+
+## Install
+
+```
+$ gem install token_attribute
+```
+
+or
+
+```
+gem 'token_attribute'
+```
+
+## Supported Versions
+
+Ruby 1.8.7, 1.9.2, REE
+
+Rails 3.0.x, 3.1.x
+
+## Motivation
+
+Someday I felt it's time to stop writing this kind of code in every project.
+
+
+## Copyright
+
+(The MIT License)
+
+Copyright © 2011 Fujimura Daisuke
+
+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/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc "Default Task"
+task :default => [ :test ]
+
+# Run the unit tests
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.warning = true
+}
+

data/TODO.md

@@ -0,0 +1,3 @@
+# Todo
+
+1. Documentation

data/lib/token_attribute/version.rb

@@ -0,0 +1,3 @@
+module TokenAttribute
+  VERSION = "0.0.4"
+end

data/lib/token_attribute.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), 'token_attribute', 'version')
+require 'active_record'
+require 'active_support'
+
+module TokenAttribute
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    # Macro-ish method to define token-setter.
+    # #set_#{attribute_name} will be defined to set unique token.
+    #
+    def token_attribute(*args)
+      options = args.extract_options!
+      attribute_names = args
+
+      if options[:protected]
+        attr_protected *attribute_names
+      end
+
+      attribute_names.each do |attribute|
+
+        generator_method_name = "generate_#{attribute}"
+
+        define_method generator_method_name do
+          key = SecureRandom.hex(10)
+        end
+        scope_items = Array.wrap(options[:scope])
+
+        setter_method_name = "set_#{attribute}"
+
+        define_method setter_method_name do
+
+          key = send generator_method_name
+
+          cond = {}
+          scope_items.each do |scope_item|
+            cond[scope_item] = self.send(scope_item)
+          end
+          cond.merge!(attribute => key)
+
+          unless self.class.where(cond).exists?
+            self[attribute] = key
+          else
+            send setter_method_name
+          end
+        end
+
+      end
+    end
+  end
+
+end

data/test/lib/token_attribute_test.rb

@@ -0,0 +1,82 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class TokenAttributeTest < Test::Unit::TestCase
+
+  setup do
+    @user = User.new
+  end
+
+  teardown do
+    User.delete_all
+  end
+
+  describe '.token_attribute' do
+    test 'can token_attribute-ize multiple attributes' do
+      klass = User.dup
+      klass.class_eval do
+        include TokenAttribute
+        token_attribute :download_ticket, :password_recovery
+      end
+      [:download_ticket, :password_recovery].each do |a|
+        method_name = ('set_' + a.to_s).to_sym
+        assert klass.new.methods.map(&:to_sym).include? method_name
+      end
+    end
+    test 'can make attr_protected with option' do
+      klass = User.dup
+      klass.class_eval do
+        include TokenAttribute
+        token_attribute :download_ticket, :protected => true
+      end
+      assert klass.protected_attributes.include? :download_ticket
+    end
+    test 'can be scoped' do
+      klass = User.dup
+      klass.class_eval do
+        include TokenAttribute
+        token_attribute :download_ticket, :scope => :name
+        before_save :set_download_ticket
+      end
+      one = klass.new :name => 'fujimura'
+      two = klass.new :name => 'tanaka'
+      [one, two].each {|u| stub(u).generate_download_ticket.once { 'a' } }
+      [one, two].each {|u| u.save }
+      assert one.download_ticket == two.download_ticket
+    end
+  end
+
+  context 'class with access_token as token_attribute' do
+
+    describe '#generate_access_token' do
+      test 'returns random string' do
+        stub(SecureRandom).hex(10) { 'abcde' }
+        assert_equal @user.generate_access_token, 'abcde'
+      end
+    end
+
+    describe '#set_access_token' do
+      test 'sets access_token' do
+        @user.set_access_token
+        assert @user.access_token != nil
+      end
+      test 'set again if it duplicates' do
+        dup = 'duplicating'
+        User.create :access_token => dup
+        uniq = 'notduplicating'
+        mock(@user).generate_access_token.times(1) { dup }
+        mock(@user).generate_access_token.times(1) { uniq }
+        @user.set_access_token
+      end
+    end
+
+  end
+
+  describe 'class with its own random string generator' do
+    test 'will use it instead of TokenAttribute#generate_random_string' do
+      coupon = Coupon.new
+      coupon.set_code
+      assert coupon.code == 'my code'
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require File.expand_path('../../lib/token_attribute', __FILE__)
+require 'minitest/unit'
+require 'contest'
+require 'rr'
+require 'ruby-debug'
+require 'turn'
+Test::Unit::TestCase.send :include, RR::Adapters::TestUnit
+
+ActiveRecord::Base.configurations = {
+  'test' => {
+    :adapter => 'sqlite3',
+    :database => ':memory:'
+  }
+}
+ActiveRecord::Base.establish_connection('test')
+
+class User < ActiveRecord::Base
+  include TokenAttribute
+  token_attribute :access_token
+end
+
+class Coupon < ActiveRecord::Base
+  include TokenAttribute
+  token_attribute :code
+  def generate_code
+    'my code'
+  end
+end
+
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:users) do |t|
+      t.string "name"
+      t.string "access_token"
+      t.string "download_ticket"
+      t.string "password_recovery"
+    end
+    create_table(:coupons) do |t|
+      t.string "code"
+    end
+  end
+end
+
+CreateAllTables.up

data/token_attribute.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "token_attribute/version"
+
+Gem::Specification.new do |s|
+  s.name        = "token_attribute"
+  s.version     = TokenAttribute::VERSION
+  s.authors     = ["Fujimura Daisuke"]
+  s.email       = ["me@fujimuradaisuke.com"]
+  s.homepage    = "https://github.com/fujimura/token_attribute"
+  s.summary     = %q{Small macro to generate unique random token attribute for ActiveRecord}
+  s.description = %q{Small macro to generate unique random token attribute for ActiveRecord}
+
+  s.rubyforge_project = "token_attribute"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_dependency "activerecord", '>= 3.0.0'
+  s.add_dependency "activesupport", '>= 3.0.0'
+  s.add_development_dependency "rake"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "contest"
+  s.add_development_dependency "turn", '>= 0.8.3'
+  s.add_development_dependency "rr"
+  if RUBY_VERSION.to_f == 1.9
+    s.add_development_dependency "ruby-debug19"
+  else
+    s.add_development_dependency "ruby-debug"
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: token_attribute
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Fujimura Daisuke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70158298353140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70158298353140
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70158298352680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70158298352680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70158298352300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158298352300
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70158298351880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158298351880
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70158298351460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158298351460
+- !ruby/object:Gem::Dependency
+  name: contest
+  requirement: &70158298351040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158298351040
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70158298350540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70158298350540
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70158298350160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158298350160
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70158298349720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158298349720
+description: Small macro to generate unique random token attribute for ActiveRecord
+email:
+- me@fujimuradaisuke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- TODO.md
+- lib/token_attribute.rb
+- lib/token_attribute/version.rb
+- test/lib/token_attribute_test.rb
+- test/test_helper.rb
+- token_attribute.gemspec
+homepage: https://github.com/fujimura/token_attribute
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: token_attribute
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Small macro to generate unique random token attribute for ActiveRecord
+test_files:
+- test/lib/token_attribute_test.rb
+- test/test_helper.rb