devise_referable 0.1.0 → 0.2.0

data/CHANGES

@@ -0,0 +1,3 @@
+0.2.0
+Removed the Referral model, since users may want to add their own behavior.
+Now that it is created separately, the acts_as_referral method adds the necessary behavior for the Devise gem.

data/README.rdoc

@@ -23,7 +23,7 @@ Configure devise_referable inside your app (and warden and devise if you weren't
 
 Follow the walkthrough for devise with the following modifications.
 
-Create a migration for the referrals table:
+Create a migration for the referrals table, minimally:
 
     create_table :referrals, :force => true do |t|
       t.integer   :referrer_id
@@ -34,6 +34,12 @@ Create a migration for the referrals table:
       t.timestamps
     end
 
+And create a Referral class, minimally:
+
+    class Referral < ActiveRecord::Base
+        acts_as_referral
+    end
+
 Add a referrer_token column to your referrer classes.
 
     add_column :table_name1, :referrer_token, :string

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/devise_referable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{devise_referable}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Van Horn, based on work by Sergio Cambra"]
-  s.date = %q{2010-03-16}
+  s.date = %q{2010-03-22}
   s.description = %q{It tracks the referring entity via cookie, and creates a record when user registers.}
   s.email = %q{mattvanhorn@gmail.com}
   s.extra_rdoc_files = [
@@ -19,17 +19,18 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGES",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "app/controllers/referrals_controller.rb",
-     "app/models/referral.rb",
      "devise_referable.gemspec",
      "init.rb",
      "lib/devise/hooks/referable.rb",
      "lib/devise_referable.rb",
      "lib/devise_referable/model.rb",
+     "lib/devise_referable/referral.rb",
      "lib/devise_referable/routes.rb",
      "rails/init.rb",
      "test/integration/referable_test.rb",
@@ -43,6 +44,7 @@ Gem::Specification.new do |s|
      "test/rails_app/app/controllers/users_controller.rb",
      "test/rails_app/app/helpers/application_helper.rb",
      "test/rails_app/app/models/blog.rb",
+     "test/rails_app/app/models/referral.rb",
      "test/rails_app/app/models/user.rb",
      "test/rails_app/app/views/home/index.html.erb",
      "test/rails_app/config/boot.rb",
@@ -78,6 +80,7 @@ Gem::Specification.new do |s|
      "test/rails_app/app/controllers/users_controller.rb",
      "test/rails_app/app/helpers/application_helper.rb",
      "test/rails_app/app/models/blog.rb",
+     "test/rails_app/app/models/referral.rb",
      "test/rails_app/app/models/user.rb",
      "test/rails_app/config/boot.rb",
      "test/rails_app/config/environment.rb",

data/lib/devise_referable/referral.rb

@@ -0,0 +1,57 @@
+require 'devise/hooks/referable'
+
+module Devise
+  module Referable
+    module Referral
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module InstanceMethods
+        def generate_token
+          self.referral_token ||= Devise.friendly_token
+        end
+      end
+      
+      module ClassMethods
+        def acts_as_referral(options = {})
+          class_eval <<-EOV
+            include Devise::Referable::Referral::InstanceMethods
+
+            def self.referrer_types
+              User.referrer_types
+            end
+
+            def self.lookup_referrer(token)
+              unless token.blank?
+                referrer_types.map{ |type| type.to_s.classify.constantize }.each do |klass|
+                  ref = klass.find_by_referrer_token(token)
+                  return ref unless ref.nil?
+                end
+              end
+              return nil
+            end
+
+            def self.from_token(token)
+              sender = lookup_referrer(token)
+              if sender
+                self.create do |ref|
+                  ref.referrer = sender
+                end
+              end
+            end
+
+            belongs_to :referrer, :polymorphic => true
+            belongs_to :recipient, :class_name => 'User'
+            before_create :generate_token
+            
+          EOV
+        end
+      end
+    end
+  end
+end
+
+
+

data/lib/devise_referable.rb

@@ -7,6 +7,5 @@ Devise.add_module :referable, :controller => :referrals, :model => 'devise_refer
 
 module DeviseReferable; end
 
-require File.join(File.dirname(__FILE__), '..', 'app', 'models', 'referral')
-
 require 'devise_referable/routes'
+require 'devise_referable/referral'

data/rails/init.rb

@@ -1 +1,3 @@
-require 'devise_referable'
+require 'devise_referable'
+
+ActiveRecord::Base.class_eval { include Devise::Referable::Referral }

data/test/models/referral_test.rb

@@ -19,6 +19,7 @@ class ReferableTest < ActiveSupport::TestCase
   test 'should create referral from token' do
     Blog.expects(:find_by_referrer_token).with('abc123').returns(create_user) # I just need an AR obj here to avoid massive stubbing. 
                                                                               # Should be a blog not a user.
+                                                                                                                                                            
     result = Referral.from_token('abc123')
     assert result.is_a?( Referral)
     assert_not_nil result.referral_token

data/test/rails_app/app/models/referral.rb

@@ -0,0 +1,4 @@
+class Referral < ActiveRecord::Base
+  acts_as_referral
+
+end

data/test/test_helper.rb

@@ -44,7 +44,7 @@ ActionController::Routing::Routes.draw do |map|
 end
 
 require File.join(File.dirname(__FILE__), '..', 'app', 'controllers', 'referrals_controller')
-require File.join(File.dirname(__FILE__), '..', 'app', 'models', 'referral')
+# require File.join(File.dirname(__FILE__), '..', 'app', 'models', 'referral')
 
 Webrat.configure do |config|
   config.mode = :rails

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Matt Van Horn, based on work by Sergio Cambra
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 -04:00
+date: 2010-03-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,17 +67,18 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGES
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - app/controllers/referrals_controller.rb
-- app/models/referral.rb
 - devise_referable.gemspec
 - init.rb
 - lib/devise/hooks/referable.rb
 - lib/devise_referable.rb
 - lib/devise_referable/model.rb
+- lib/devise_referable/referral.rb
 - lib/devise_referable/routes.rb
 - rails/init.rb
 - test/integration/referable_test.rb
@@ -91,6 +92,7 @@ files:
 - test/rails_app/app/controllers/users_controller.rb
 - test/rails_app/app/helpers/application_helper.rb
 - test/rails_app/app/models/blog.rb
+- test/rails_app/app/models/referral.rb
 - test/rails_app/app/models/user.rb
 - test/rails_app/app/views/home/index.html.erb
 - test/rails_app/config/boot.rb
@@ -150,6 +152,7 @@ test_files:
 - test/rails_app/app/controllers/users_controller.rb
 - test/rails_app/app/helpers/application_helper.rb
 - test/rails_app/app/models/blog.rb
+- test/rails_app/app/models/referral.rb
 - test/rails_app/app/models/user.rb
 - test/rails_app/config/boot.rb
 - test/rails_app/config/environment.rb

data/app/models/referral.rb

@@ -1,38 +0,0 @@
-require 'devise/hooks/referable'
-
-class Referral < ActiveRecord::Base
-  belongs_to :referrer, :polymorphic => true
-  belongs_to :recipient, :class_name => 'User'
-  
-  before_create :generate_token
-  
-  class << self
-    def referrer_types
-      User.referrer_types
-    end
-
-    def lookup_referrer(token)
-      unless token.blank?
-        referrer_types.map{ |type| type.to_s.classify.constantize }.each do |klass|
-          ref = klass.find_by_referrer_token(token)
-          return ref unless ref.nil?
-        end
-      end
-      return nil
-    end
-
-    def from_token(token)
-      sender = lookup_referrer(token)
-      if sender
-        Referral.create do |ref|
-          ref.referrer = sender
-        end
-      end
-    end
-  end
-  
-  def generate_token
-    self.referral_token ||= Devise.friendly_token
-  end
-  
-end