due_credit 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+.idea
+.idea/workspace.xml
+.idea*
+.idea/**
+*.gem

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.2.13"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/Gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    capybara (2.1.0)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    erubis (2.7.0)
+    hike (1.2.2)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.8.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.23)
+    multi_json (1.7.3)
+    nokogiri (1.5.9)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (>= 0.4.0)
+  rails (~> 3.2.13)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tom Hanley
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,51 @@
+# DueCredit
+
+A rails engine to give credit to your users for referring people back to your site. For instance if you have someone sign up, you give them a unique link back to your site for them to share on Twitter, Facebook, Emails, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'due_credit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install due_credit
+
+## Usage
+
+# Generate the migrations
+
+    $ bundle exec rails g due_credit
+
+# Run the migration. This should create the following tables: Campaigns, Referrers, Referrals
+
+# From your app
+
+    DueCredit::Campaign.create!(name: 'something', threshold: 5, endpoint: '/welcome')
+    DueCredit::Referrer.create!(campaign: DueCredit::Campaign.first, token: 'unique-token-1234', model: 'User', model_id: User.first.id)
+    DueCredit::Referral.create!(referrer: DueCredit::Referrer.first)
+
+# Routes added
+
+    get "due-credit/:token" => "due_credit/credit#click_through" , :as => :due_credit
+
+## TODO
+
+A shit ton. basic link through working.
+
+## Reference
+
+http://coding.smashingmagazine.com/2011/06/23/a-guide-to-starting-your-own-rails-engine-gem/
+
+## Contributing
+
+1. Fork it
+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,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rdoc/task'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DueCredit'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/due_credit/credit_controller.rb

@@ -0,0 +1,9 @@
+module DueCredit
+  class CreditController < ::ApplicationController
+    def click_through
+      @referrer = Referrer.find_by_token(params[:token])
+      Referral.create!(referrer: @referrer)
+      redirect_to @referrer.campaign.endpoint
+    end
+  end
+end

data/app/models/due_credit/campaign.rb

@@ -0,0 +1,8 @@
+module DueCredit
+  class Campaign < ActiveRecord::Base
+    attr_accessible :name, :threshold, :endpoint
+    has_many :referrers
+    validates_presence_of :name, :endpoint
+    validates_numericality_of :threshold
+  end
+end

data/app/models/due_credit/referral.rb

@@ -0,0 +1,7 @@
+module DueCredit
+  class Referral < ActiveRecord::Base
+    attr_accessible :referrer
+    belongs_to :referrer
+    validates_presence_of :referrer_id
+  end
+end

data/app/models/due_credit/referrer.rb

@@ -0,0 +1,9 @@
+module DueCredit
+  class Referrer < ActiveRecord::Base
+    attr_accessible :token, :model, :model_id, :campaign
+    belongs_to :campaign
+    has_many :referrals
+    validates_presence_of :token, :model, :model_id, :campaign_id
+    validates_uniqueness_of :token
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get "due-credit/:token" => "due_credit/credit#click_through" , :as => :due_credit
+end

data/due_credit.gemspec

@@ -0,0 +1,21 @@
+# Provide a simple gemspec so you can easily use your enginex
+# project in your rails apps through git.
+require File.expand_path("../lib/due_credit/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "due_credit"
+  s.version = DueCredit::VERSION
+  s.authors = [ "Thomas Hanley" ]
+  s.email = [ "tjhanleyx@gmail.com" ]
+  s.homepage = "http://github.com/tjhanley"
+  s.summary = "#{s.name}-#{s.version}"
+  s.description = "The system will give the user credit for the referral. You can set a threshold on a campaign so the user gets full credit"
+  #s.files = Dir["{app,lib,config}/**/*"] + ["MIT-LICENSE", "Rakefile", "Gemfile", "README.rdoc"]
+  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'
+  s.required_rubygems_version = "> 1.3.6"
+
+  s.add_dependency "activesupport" , "~> 3.2.13"
+  s.add_dependency "rails"         , "~> 3.2.13"
+end

data/lib/due_credit.rb

@@ -0,0 +1,16 @@
+# CURRENT FILE :: lib/due_credit.rb
+# Requires
+require "active_support/dependencies"
+module DueCredit
+  # Our host application root path
+  # We set this when the engine is initialized
+  mattr_accessor :app_root
+
+  # Yield self on setup for nice config blocks
+  def self.setup
+    yield self
+  end
+
+end
+# Require our engine
+require "due_credit/engine"

data/lib/due_credit/engine.rb

@@ -0,0 +1,15 @@
+module DueCredit
+  class Engine < Rails::Engine
+
+    initializer "due_credit.load_app_instance_data" do |app|
+      DueCredit.setup do |config|
+        config.app_root = app.root
+      end
+    end
+
+    initializer "due_credit.load_static_assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+
+  end
+end

data/lib/due_credit/version.rb

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

data/lib/generators/due_credit/due_credit_generator.rb

@@ -0,0 +1,23 @@
+# CURRENT FILE :: lib/generators/due_credit/due_credit_generator.rb
+# Requires
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class DueCreditGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_due_credit_tables.rb'
+  end
+end

data/lib/generators/due_credit/templates/migration.rb

@@ -0,0 +1,40 @@
+# CURRENT FILE :: lib/generators/due_credit/templates/migration.rb
+class CreateDueCreditTables < ActiveRecord::Migration
+  def self.up
+    create_table :campaigns do |t|
+      t.string :name
+      t.integer :threshold, :default => 0
+      t.string :endpoint
+      t.timestamps
+    end
+
+    create_table :referrers do |t|
+      t.string :token
+      t.string :model
+      t.integer :model_id
+      t.references :campaign
+      t.timestamps
+    end
+
+    create_table :referrals do |t|
+      t.references :referrer
+      t.timestamps
+    end
+
+    add_index :campaigns, :name
+    add_index :referrers, :token
+    add_index :referrals, :referrer_id
+  end
+
+  def self.down
+
+    remove_index :campaigns, :name
+    remove_index :referrers, :token
+    remove_index :referrals, :referrer_id
+
+    drop_table :campaigns
+    drop_table :referrers
+    drop_table :referrals
+
+  end
+end

data/test/due_credit_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class DueCreditTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, DueCredit
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end