spree_reffiliate 2.3.1

data/app/views/spree/admin/affiliates/index.html.erb

@@ -0,0 +1,55 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:listing_affiliates) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li>
+    <%= button_link_to Spree.t(:new_affiliate), new_admin_affiliate_url, :icon => 'plus', :id => 'admin_new_affiliate_link' %>
+  </li>
+<% end %>
+<% if @affiliates.any? %>
+  <table class="index" id="listing_affiliates" data-hook>
+    <colgroup>
+      <col style="width: 15%">
+      <col style="width: 20%">
+      <col style="width: 15%">
+      <col style="width: 15%">
+      <col style="width: 15%">
+      <col style="width: 20%">
+    </colgroup>
+    <thead>
+      <tr data-hook="admin_affiliates_index_headers">
+        <th><%= Spree.t('affiliate.name') %></th>
+        <th><%= Spree.t('affiliate.path') %></th>
+        <th><%= Spree.t('affiliate.count') %></th>
+        <th><%= Spree.t('affiliate.status') %></th>
+        <th data-hook="admin_affiliates_index_header_actions" class="actions"></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @affiliates.each do |affiliate|%>
+        <tr id="<%= spree_dom_id affiliate %>" data-hook="admin_affiliates_index_rows" class="<%= cycle('odd', 'even')%>">
+          <td class='affiliate_name'><%=link_to affiliate.name, edit_admin_affiliate_url(affiliate) %></td>
+          <td class='affiliate_path align-center'><%= affiliate_url(affiliate.path) %></td>
+          <td class='affiliate_count align-center'><%= affiliate.referred_count %></td>
+          <% if affiliate.partial.blank? or !affiliate_partial_exists?(affiliate.partial) %>
+            <td class='affiliate_status align-center' style="color: red">Not found</td>
+          <% elsif affiliate_partial_exists?(affiliate.partial) %>
+            <td class='affiliate_status align-center' style="color: green">Found</td>
+          <% end %>
+          <td data-hook="admin_affiliates_index_row_actions" class="actions">
+            <%= link_to_edit affiliate, :no_text => true %>
+            <%= link_to_delete affiliate, :no_text => true %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+
+  <%= paginate @affiliates %>
+<% else %>
+  <div class="alpha twelve columns no-objects-found">
+    <%= Spree.t(:no_resource_found, resource: "affiliates") %>,
+    <%= link_to Spree.t(:add_one), spree.new_admin_affiliate_path %>!
+  </div>
+<% end %>

data/app/views/spree/admin/affiliates/new.html.erb

@@ -0,0 +1,23 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:new_affiliate) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li>
+    <%= button_link_to Spree.t(:back_to_affiliates_list), spree.admin_affiliates_path, :icon => 'arrow-left' %>
+  </li>
+<% end %>
+
+<div data-hook="admin_affiliate_new_form_header">
+  <%= render :partial => 'spree/shared/error_messages', :locals => { :target => @affiliate } %>
+</div>
+
+<div data-hook="admin_affiliate_new_form">
+  <%= form_for [:admin, @affiliate], url: admin_affiliates_url, method: :post do |f| %>
+    <%= render :partial => 'form', :locals => { :f => f } %>
+
+    <div data-hook="admin_affiliate_new_form_buttons">
+      <%= render :partial => 'spree/admin/shared/new_resource_links' %>
+    </div>
+  <% end %>
+</div>

data/app/views/spree/admin/promotions/rules/_affiliated_promotion_rule.erb

@@ -0,0 +1,6 @@
+<div class="field alpha omega eight columns">
+  <label><%= Spree.t('affiliates_promotion_rule.choose_affiliates') %></label><br>
+  <% Spree::Affiliate.all.each do |r| %>
+    <p><label><input type='checkbox' name='<%= param_prefix %>[affiliate_list][]' id='affiliate_list_<%= r.id %>' value='<%= r.id %>' <%= 'checked="checked"' if promotion_rule.affiliate_list.include?(r.id) %> /> <%= r.name %></label></p>
+  <% end %>
+</div>

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_reffiliate/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/initializers/spree.rb

@@ -0,0 +1,6 @@
+Spree::PermittedAttributes.user_attributes.push :referral_code, :affiliate_code
+config = Rails.application.config
+config.after_initialize do
+  config.spree.promotions.rules << Spree::Promotion::Rules::ReferredPromotionRule
+  config.spree.promotions.rules << Spree::Promotion::Rules::AffiliatedPromotionRule
+end

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  spree:
+    promotion_rule_types:
+      referred_promotion_rule:
+        name: "Referred User"
+        description: "Must be a referred user"
+      affiliated_promotion_rule:
+        name: "Affiliate User"
+        description: "Must be an affiliated user"
+    editing_affiliate: "Editing Affiliate:" 

data/config/routes.rb

@@ -0,0 +1,8 @@
+Spree::Core::Engine.routes.draw do
+  get 'r/:code' => 'reffiliate#referral', as: 'referral'
+  get 'a/:path' => 'reffiliate#affiliate', as: 'affiliate'
+
+  namespace :admin do
+    resources :affiliates
+  end
+end

data/db/migrate/20140907041850_create_spree_referrals.rb

@@ -0,0 +1,8 @@
+class CreateSpreeReferrals < ActiveRecord::Migration
+  def change
+    create_table :spree_referrals do |t|
+      t.string :code
+      t.integer :user_id
+    end
+  end
+end

data/db/migrate/20140907042024_create_spree_affiliates.rb

@@ -0,0 +1,9 @@
+class CreateSpreeAffiliates < ActiveRecord::Migration
+  def change
+    create_table :spree_affiliates do |t|
+      t.string :name
+      t.string :path
+      t.string :partial
+    end
+  end
+end

data/db/migrate/20140907042102_create_spree_referred_records.rb

@@ -0,0 +1,9 @@
+class CreateSpreeReferredRecords < ActiveRecord::Migration
+  def change
+    create_table :spree_referred_records do |t|
+      t.integer :user_id
+      t.integer :referral_id
+      t.integer :affiliate_id
+    end
+  end
+end

data/db/migrate/20140907062121_add_index_to_spree_referrals.rb

@@ -0,0 +1,5 @@
+class AddIndexToSpreeReferrals < ActiveRecord::Migration
+  def change
+    add_index :spree_referrals, :user_id
+  end
+end

data/db/migrate/20140907062422_add_index_to_spree_referred_record.rb

@@ -0,0 +1,5 @@
+class AddIndexToSpreeReferredRecord < ActiveRecord::Migration
+  def change
+    add_index :spree_referred_records, [:user_id, :referral_id, :affiliate_id], name: 'index_spree_referred_record_on_u_r_a'
+  end
+end

data/db/migrate/20140912003727_create_spree_promotion_rules_affiliates.rb

@@ -0,0 +1,10 @@
+class CreateSpreePromotionRulesAffiliates < ActiveRecord::Migration
+  def change
+    create_table :spree_affiliates_promotion_rules do |t|
+      t.integer :affiliate_id
+      t.integer :promotion_rule_id
+    end
+    add_index :spree_affiliates_promotion_rules, :affiliate_id
+    add_index :spree_affiliates_promotion_rules, :promotion_rule_id
+  end
+end

data/db/migrate/20140913042034_add_layout_to_spree_affiliate.rb

@@ -0,0 +1,5 @@
+class AddLayoutToSpreeAffiliate < ActiveRecord::Migration
+  def change
+    add_column :spree_affiliates, :layout, :string
+  end
+end

data/lib/generators/spree_reffiliate/install/install_generator.rb

@@ -0,0 +1,21 @@
+module SpreeReffiliate
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_reffiliate'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_reffiliate/engine.rb

@@ -0,0 +1,20 @@
+module SpreeReffiliate
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_reffiliate'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_reffiliate/factories.rb

@@ -0,0 +1,12 @@
+FactoryGirl.define do
+  factory :affiliate, class: Spree::Affiliate do
+    name Faker::Name.first_name
+    path Faker::Name.first_name
+    partial Faker::Name.first_name
+    layout nil
+  end
+
+  factory :referral, class: Spree::Referral
+  factory :referred_promotion_rule, class: Spree::Promotion::Rules::ReferredPromotionRule
+  factory :affiliated_promotion_rule, class: Spree::Promotion::Rules::AffiliatedPromotionRule
+end

data/lib/spree_reffiliate.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_reffiliate/engine'

data/lib/tasks/spree_reffiliate.rake

@@ -0,0 +1,10 @@
+namespace :reffiliate do
+  task :generate => :environment do
+    Spree.user_class.all.each do |user|
+      if user.referral.nil?
+        user.create_referral
+      end
+    end
+    puts "Referrals generated."
+  end
+end

data/spec/assets/spree/affiliates/corona.html.erb

@@ -0,0 +1 @@
+corona.html.erb

data/spec/controllers/spree/reffiliate_controller_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Spree::ReffiliateController, :type => :controller do
+  context "referral hyperlink" do
+    it "redirects to root path" do
+      spree_get :referral
+      expect(response).to redirect_to('/')
+    end
+    it "creates session variable with referral code" do
+      code = 'referral-code'
+      spree_get :referral, code: code
+      expect(session[:referral]).to eq(code)
+    end
+  end
+  context "affiliate hyperlink" do
+    before (:each) do
+      @affiliate = FactoryGirl.create(:affiliate)
+    end
+    it "creates session variable with affiliate path" do
+      path = 'affiliate'
+      spree_get :affiliate, :path => path
+      expect(session[:affiliate]).to eq(path)
+    end
+    it "redirects to root path if path params is nil" do
+      spree_get :affiliate
+      expect(response).to redirect_to('/')
+    end
+    it "redirects to root path if affiliate has no partial" do
+      spree_get :affiliate, path: @affiliate.path
+      expect(response).to redirect_to('/')
+    end
+    it "redirects to root path if affiliate partial is not found" do
+      spree_get :affiliate, path: @affiliate.path
+      expect(response).to redirect_to('/')
+    end
+    it "renders a partial if affiliate partial is found" do
+      @affiliate.update_attribute :partial, 'corona'
+      controller.prepend_view_path 'spec/assets'
+      spree_get :affiliate, path: @affiliate.path
+      response.should render_template('spree/affiliates/corona')
+    end
+    context "layout options" do
+      @options = Hash[Spree::Affiliate.layout_options]
+      @options.each do |layout, option|
+        it "#{layout}" do
+          option = 'layouts/application' if option.nil?
+          @affiliate = FactoryGirl.create(:affiliate, name: layout, path: layout, partial: 'corona', layout: option)
+          controller.prepend_view_path 'spec/assets'
+          allow(controller).to receive(:partial_exists).and_return(true)
+          spree_get :affiliate, path: @affiliate.path
+          response.should render_template(layout: @affiliate.get_layout)
+        end
+      end 
+    end
+  end
+end

data/spec/controllers/spree/user_controller_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Spree::UserRegistrationsController, :type => :controller do
+  before { @request.env['devise.mapping'] = Devise.mappings[:spree_user] }
+
+  context "#create" do
+    it "should add referral_code param" do
+      code = 'referral-code'
+      session[:referral] = code
+      spree_post :create, { spree_user: { email: 'foobar@example.com', password: 'foobar123', password_confirmation: 'foobar123' } }
+      expect(controller.params[:spree_user][:referral_code]).to eql(code)
+    end
+    it "should add affiliate_code param" do
+      code = 'affiliate-code'
+      session[:affiliate] = code
+      spree_post :create, { spree_user: { email: 'foobar@example.com', password: 'foobar123', password_confirmation: 'foobar123' } }
+      expect(controller.params[:spree_user][:affiliate_code]).to eql(code)
+    end
+  end
+end

data/spec/models/spree/affiliate_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Spree::Affiliate, :type => :model do
+  it "should have a name" do
+    affiliate = FactoryGirl.build(:affiliate, name: nil)
+    expect(affiliate).to_not be_valid
+  end
+  it "should have a path" do
+    affiliate = FactoryGirl.build(:affiliate, path: nil)
+    expect(affiliate).to_not be_valid
+  end
+
+  context "with user" do
+    before do
+      @affiliate = FactoryGirl.create(:affiliate)
+      @affiliated = FactoryGirl.create(:user, affiliate_code: @affiliate.path)
+      @order = FactoryGirl.create(:order, :user => @affiliated)
+    end
+
+    it "returns an array of user records" do
+      expect(@affiliate.referred_users).to eq([@affiliated])
+    end
+    it "returns an array of referred orders" do
+      expect(@affiliate.referred_orders).to eq([@order])
+    end
+    it "returns referred count" do
+      expect(@affiliate.referred_count).to eq(1)
+    end
+    it "returns an array of referred orders" do
+      expect(@affiliate.referred_records).to eq([@affiliated.affiliate_record])
+    end
+  end
+end

data/spec/models/spree/promotion/rules/affiliated_promotion_rule_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Spree::Promotion::Rules::AffiliatedPromotionRule, :type => :model do
+  before do
+    @affiliate = FactoryGirl.create(:affiliate, path: 'corona')
+    @affiliated = FactoryGirl.create(:user, email:  Faker::Internet.email, affiliate_code: @affiliate.path)
+    @affiliated_order = FactoryGirl.create(:order, :user_id => @affiliated.id)
+
+    @falsy_affiliate = FactoryGirl.create(:affiliate, path: 'victoria')
+    @falsy_affiliated = FactoryGirl.create(:user, email:  Faker::Internet.email, affiliate_code: @falsy_affiliate.path)
+    @falsy_affiliated_order = FactoryGirl.create(:order, :user_id => @falsy_affiliated.id)
+
+    @user = FactoryGirl.create(:user, email: Faker::Internet.email)
+    @organic_order = FactoryGirl.create(:order, :user_id => @user)
+
+    @rule = FactoryGirl.build(:affiliated_promotion_rule)
+    @rule.affiliate_list = [@affiliate.id]
+  end
+
+  it "is applicable for an order" do
+    expect(@rule.applicable?(@affiliated_order)).to be_truthy
+  end
+  it "is elegible for affiliated user" do
+    expect(@rule.eligible?(@affiliated_order)).to be_truthy
+  end
+  it "is not elegible for organic user" do
+    expect(@rule.eligible?(@organic_order)).to be_falsy
+  end
+  it "is not elegible for falsy affiliated user" do
+    expect(@rule.eligible?(@falsy_affiliated_order)).to be_falsy
+  end
+  it "returns string selected affiliate ids" do
+    expect(@rule.affiliate_ids_string).to eq(@affiliate.id.to_s)
+  end
+  it "accepts string to assign affiliate ids" do
+    @rule.affiliate_ids_string = "1"
+    expect(@rule.affiliate_ids_string).to eq(@affiliate.id.to_s)
+  end
+  it "returns an array of affiliate ids" do
+    expect(@rule.affiliate_list).to eq([@affiliate.id])
+  end
+  it "accepts an array to assign affiliate ids" do
+    @rule.affiliate_list << [1]
+    expect(@rule.affiliate_list).to eq([@affiliate.id])
+  end
+end

data/spec/models/spree/promotion/rules/referred_promotion_rule_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Spree::Promotion::Rules::ReferredPromotionRule, :type => :model do
+  before(:each) do
+    @rule = FactoryGirl.build(:referred_promotion_rule)
+    @user = FactoryGirl.create(:user, email: Faker::Internet.email)
+    @referred = FactoryGirl.create(:user, email: Faker::Internet.email, referral_code: @user.referral.code)
+    @organic_order = FactoryGirl.create(:order, :user => @user)
+    @referred_order = FactoryGirl.create(:order, :user => @referred)
+  end
+  it "is applicable for an order" do
+    expect(@rule.applicable?(@referred_order)).to be_truthy
+  end
+  it "is elegible for referred user" do
+    expect(@rule.eligible?(@referred_order)).to be_truthy
+  end
+  it "is not elegible for organic user" do
+    expect(@rule.eligible?(@organic_order)).to be_falsy
+  end
+end

data/spec/models/spree/referral_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Spree::Referral, :type => :model do
+  it "generates a code after created" do
+    referral = FactoryGirl.build(:referral)
+    expect{referral.save}.to change{referral.code}
+  end
+
+  it "returns a code" do
+    user = FactoryGirl.create(:user)
+    referral = FactoryGirl.create(:referral, user: user)
+    expect(referral.code).to_not be_nil
+  end
+
+  context "with user" do
+    before(:each) do
+      @user = FactoryGirl.create(:user)
+      @referred = FactoryGirl.create(:user, referral_code: @user.referral.code)
+      @order = FactoryGirl.create(:order, user: @referred)
+      @referred_no_purchase = FactoryGirl.create(:user, referral_code: @user.referral.code)
+    end
+
+    it "returns an associated user record" do
+      expect(@user.referral.user).to_not be_nil
+    end
+    it "returns referred records" do
+      expect(@user.referral.referred_records.count).to eq(2)
+    end
+    it "returns an array of referred users" do
+      expect(@user.referral.referred_users).to eq([@referred, @referred_no_purchase])
+    end
+    it "returns an array of referred orders" do
+      expect(@user.referral.referred_orders).to eq([@order])
+    end
+    it "returns an array of referral activated users with completed_orders" do
+      referred_user_with_completed_order = FactoryGirl.create(:user, referral_code: @user.referral.code)
+      completed_order = FactoryGirl.create(:order, completed_at: @user.created_at + 1.second, user: referred_user_with_completed_order)
+      expect(@user.referral.referral_activated_users).to eq([referred_user_with_completed_order])
+    end
+  end
+end

data/spec/models/spree/referred_record_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Spree::ReferredRecord, :type => :model do
+  before(:each) do
+    @user = FactoryGirl.create(:user, email: Faker::Internet.email)
+    @referred = FactoryGirl.create(:user, email:  Faker::Internet.email, referral_code: @user.referral.code)
+    @referral_record = @referred.referred_record
+  end
+
+  it "has a user id" do
+    expect(@referral_record.user_id).not_to be_nil
+  end
+
+  it "has a referral id" do
+    expect(@referral_record.referral_id).not_to be_nil
+  end
+
+  it "returns an associated user record" do
+    expect(@referral_record.referral.user).to eq(@user)
+  end
+
+  it "returns an associated referred user record" do
+    expect(@referral_record.user).to eq(@referred)
+  end
+
+  it "returns an associated referral record" do
+    expect(@referral_record.referral).to eq(@user.referral)
+  end
+end

data/spec/models/spree/user_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Spree::User, type: :model do
+  before(:each) do
+    @user = FactoryGirl.create(:user, email: Faker::Internet.email)
+    @referred = FactoryGirl.create(:user, email:  Faker::Internet.email, referral_code: @user.referral.code)
+    @affiliate = Spree::Affiliate.create(name: Faker::Name.name, path: Faker::Name.name)
+    @affiliated = FactoryGirl.create(:user, email:  Faker::Internet.email, affiliate_code: @affiliate.path)
+  end
+  context "referral user" do
+    it "has a referral record" do
+      expect(@user.referral).not_to be_nil
+    end
+    it "has a referral code" do
+      expect(@user.referral.code).not_to be_nil
+    end
+    it "has a referral count" do
+      expect(@user.referred_count).to eq(1)
+    end
+    it "has referred users" do
+      expect(@user.referral.referred_users).to eq([@referred])
+    end
+    it "has referred records" do
+      expect(@user.referral.referred_records).to eq([@referred.referred_record])
+    end
+  end
+
+  context "referred user" do
+    it "has a referred user" do
+      expect(@referred.referred_by).to eq(@user)
+    end
+    it "has a referred record" do
+      expect(@referred.referred_record).to eq(@user.referral.referred_records.first)
+    end
+    it "returns boolean if referred" do
+      expect(@referred.referred?).to be_truthy
+      expect(@user.referred?).to be_falsy
+    end
+  end
+
+  context "affiliated user" do
+    it "has an affiliate" do
+      expect(@affiliated.affiliate).to eq(@affiliate)
+    end
+    it "returns boolean if affiliated" do
+      expect(@affiliated.affiliate?).to be_truthy
+    end
+    it "returns an affiliated record" do
+      expect(@affiliated.affiliate_record).to eq(@affiliate.referred_records.first)
+    end
+  end
+end