verifiable 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+*.swp
+test/.verifiable.sqlite3
+test/test.log

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in verifiable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    verifiable (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.11)
+      activesupport (= 2.3.11)
+    activesupport (2.3.11)
+    columnize (0.3.2)
+    linecache (0.43)
+    rake (0.8.7)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    sqlite3 (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 2.3.11)
+  bundler (>= 1.0.0)
+  rake (= 0.8.7)
+  ruby-debug
+  sqlite3 (= 1.3.3)
+  verifiable!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Evan Petrie
+
+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.rdoc

@@ -0,0 +1,80 @@
+= Verifiable
+
+* http://github.com/kuinak/verifiable
+
+== Description
+
+Creates verified associations. Verified associations are similar to regular
+associations, except that a step has been taken to verify the integrity of the
+association.
+
+== Usage
+
+Add verifiable to your Gemfile (or whatever if you're not using bundler):
+
+  gem "verifiable"
+
+Run the generator to create the necessary database migration and run it:
+
+  script/generate verifiable_migration
+  rake db:migrate
+
+Include Verifiable::Associations in your classes and specify the correct type
+of association:
+
+  class User < ActiveRecord::Base
+
+    include Verifiable::Associations
+    has_many_verifiable :phone_numbers
+
+  end
+
+  class PhoneNumber < ActiveRecord::Base
+
+    include Verifiable::Associations
+    verifiable_for :users
+
+  end
+
+Create some associations that need verification:
+
+  user = User.create
+  phone_number = user.phone_numbers.create
+
+Associated objects don't show up until they're verified:
+
+  >> user.phone_numbers == []
+  => true
+
+Get unverified objects like this:
+
+  >> user.unverified_phone_numbers == [phone_number]
+  => true
+
+Get the verification code for an association (code is a random 4 digit string):
+
+  code = user.verification_code_for(phone_number)
+
+Verify the association (returns true if code is correct):
+
+  user.verify!(phone_number, code)
+
+Once verified, the associated objects show up:
+
+  >> user.phone_numbers == [phone_number]
+  => true
+
+To create a verification that has a different type of code:
+
+  user = User.create
+  phone_number = PhoneNumber.create
+  Verifiable::Verification.create(:code => "abcd", :object => user, :verifiable => phone_number)
+
+== LICENSE
+
+The MIT License, see LICENSE
+
+== TODO
+
+* Make singular associations work (has_one)
+* Figure out a way to make association specific verification code generators

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'rake'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new("test") { |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.warning = true
+}

data/lib/verifiable/associations.rb

@@ -0,0 +1,41 @@
+module Verifiable
+  module Associations
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def verify!(object, code)
+      verification = verification_for(object)
+      if code == verification.code
+        verification.update_attributes(:verified_at => Time.now)
+        true
+      else
+        false
+      end
+    end
+
+    def verification_code_for(object)
+      verification_for(object).code
+    end
+
+    def verification_for(object)
+      Verification.find(:first, :conditions => {:object_id => object.id, :object_type => object.class.to_s, :verifiable_id => self.id, :verifiable_type => self.class.to_s}) || Verification.find(:first, :conditions => {:object_id => self.id, :object_type => self.class.to_s, :verifiable_id => object.id, :verifiable_type => object.class.to_s})
+    end
+
+    module ClassMethods
+      def has_many_verifiable(things, options = {})
+        source_type = things.to_s.singularize.camelize
+        has_many :verifications, :as => :object, :dependent => :destroy, :class_name => "Verifiable::Verification" unless reflect_on_association(:verifications)
+        has_many things, :through => :verifications, :source => :verifiable, :source_type => source_type, :conditions => "verified_at IS NOT NULL"
+        has_many "unverified_#{things}", :through => :verifications, :source => :verifiable, :source_type => source_type, :conditions => "verified_at IS NULL"
+      end
+
+      def verifiable_for(things, options = {})
+        source_type = things.to_s.singularize.camelize
+        has_many :verifications, :as => :verifiable, :dependent => :destroy, :class_name => "Verifiable::Verification" unless reflect_on_association(:verifications)
+        has_many things, :through => :verifications, :source => :object, :source_type => source_type, :conditions => "verified_at IS NOT NULL"
+        has_many "unverified_#{things}", :through => :verifications, :source => :object, :source_type => source_type, :conditions => "verified_at IS NULL"
+      end
+    end
+  end
+end

data/lib/verifiable/verification.rb

@@ -0,0 +1,21 @@
+require "active_record"
+
+module Verifiable
+  class Verification < ActiveRecord::Base
+
+    belongs_to :object, :polymorphic => true
+    belongs_to :verifiable, :polymorphic => true
+
+    validates_uniqueness_of :object_id, :scope => [:object_type, :verifiable_id, :verifiable_type]
+    validates_presence_of :code
+
+    def initialize(attrs = {})
+      super({:code => sprintf("%04d", rand(10000))}.merge(attrs || {}))
+    end
+
+    def verified?
+      !verified_at.nil?
+    end
+
+  end
+end

data/lib/verifiable/version.rb

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

data/lib/verifiable.rb

@@ -0,0 +1,4 @@
+module Verifiable
+  require "verifiable/associations"
+  require "verifiable/verification"
+end

data/rails_generators/verifiable/templates/verifiable_migration.rb

@@ -0,0 +1,18 @@
+class VerifiableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :verifications do |t|
+      t.integer :object_id
+      t.string :object_type
+      t.integer :verifiable_id
+      t.string :verifiable_type
+      t.datetime :verified_at
+      t.string :code
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :verifications
+  end
+end

data/rails_generators/verifiable/verifiable_migration_generator.rb

@@ -0,0 +1,7 @@
+class VerifiableMigrationGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'verifiable_migration.rb', 'db/migrate', :migration_file_name => "verifiable_migration"
+    end
+  end
+end

data/test/phone_number.rb

@@ -0,0 +1,6 @@
+class PhoneNumber < ActiveRecord::Base
+
+  include Verifiable::Associations
+  verifiable_for :users
+
+end

data/test/schema.rb

@@ -0,0 +1,22 @@
+ActiveRecord::Schema.define :version => 0 do
+
+  create_table "users", :force => true do |t|
+    t.integer "id"
+  end
+
+  create_table "phone_numbers", :force => true do |t|
+    t.integer "id"
+  end
+
+  create_table "verifications", :force => true do |t|
+    t.integer  "object_id"
+    t.string   "object_type"
+    t.integer  "verifiable_id"
+    t.string   "verifiable_type"
+    t.datetime "verified_at"
+    t.string   "code"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require "verifiable"
+require "test/unit"
+require "test/user"
+require "test/phone_number"
+require "sqlite3"
+require "ruby-debug"
+
+module Test::Unit
+  class TestCase
+    def setup
+      $VERBOSE = nil
+      ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => "test/.verifiable.sqlite3")
+      ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "test.log"))
+
+      ActiveRecord::Base.silence do
+        ActiveRecord::Migration.verbose = false
+        load(File.join(File.dirname(__FILE__), "schema.rb"))
+      end
+    end
+  end
+end

data/test/user.rb

@@ -0,0 +1,6 @@
+class User < ActiveRecord::Base
+
+  include Verifiable::Associations
+  has_many_verifiable :phone_numbers
+
+end

data/test/verifiable_test.rb

@@ -0,0 +1,60 @@
+require "test/test_helper"
+
+class VerifiableTest < Test::Unit::TestCase
+
+  def test_has_many_verifiable
+    u = User.create!
+    p = u.phone_numbers.create!
+    assert_equal [], u.phone_numbers
+    assert_equal [p], u.unverified_phone_numbers
+    code = p.verification_code_for(u)
+    u.verify!(p, code)
+    assert_equal [p], u.phone_numbers(true)
+    assert_equal [], u.unverified_phone_numbers(true)
+  end
+
+  def test_custom_code
+    u = User.create!
+    p = PhoneNumber.create!
+    v = Verifiable::Verification.create!(:code => "abcd", :object => u, :verifiable => p)
+    assert_equal [], u.phone_numbers
+    assert_equal [p], u.unverified_phone_numbers
+    code = p.verification_code_for(u)
+    assert_equal "abcd", code
+    u.verify!(p, code)
+    assert_equal [p], u.phone_numbers(true)
+    assert_equal [], u.unverified_phone_numbers(true)
+  end
+
+  def test_verifiable_for
+    u = User.create!
+    p = u.phone_numbers.create!
+    assert_equal [], p.users
+    assert_equal [u], p.unverified_users
+    code = u.verification_code_for(p)
+    p.verify!(u, code)
+    assert_equal [u], p.users(true)
+    assert_equal [], p.unverified_users(true)
+  end
+
+  def test_verification_code_for
+    u = User.create!
+    p = u.phone_numbers.create!
+    assert_equal u.verification_code_for(p), p.verification_code_for(u)
+  end
+
+  def test_verify
+    u = User.create!
+    p = u.phone_numbers.create!
+    code = u.verification_code_for(p)
+    assert u.verify!(p, code)
+  end
+
+  def test_verify_with_bad_code
+    u = User.create!
+    p = u.phone_numbers.create!
+    code = u.verification_code_for(p)
+    assert_equal false, u.verify!(p, "xxxx")
+  end
+
+end

data/verifiable.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/verifiable/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "verifiable"
+  s.version     = Verifiable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Evan Petrie"]
+  s.email       = ["ejp@yahoo.com"]
+  s.homepage    = "http://rubygems.org/gems/verifiable"
+  s.summary     = "Creates verified associations"
+  s.description = "Allows associatons to be create that require verification, i.e. email addresses or phone numbers"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "verifiable"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rake", "0.8.7"
+  s.add_development_dependency "sqlite3", "1.3.3"
+  s.add_development_dependency "activerecord", "2.3.11"
+  s.add_development_dependency "ruby-debug"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+name: verifiable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Evan Petrie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-03 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 11
+        version: 2.3.11
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Allows associatons to be create that require verification, i.e. email addresses or phone numbers
+email: 
+- ejp@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/verifiable.rb
+- lib/verifiable/associations.rb
+- lib/verifiable/verification.rb
+- lib/verifiable/version.rb
+- rails_generators/verifiable/templates/verifiable_migration.rb
+- rails_generators/verifiable/verifiable_migration_generator.rb
+- test/phone_number.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/user.rb
+- test/verifiable_test.rb
+- verifiable.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/verifiable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: verifiable
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Creates verified associations
+test_files: []
+