spree_reffiliate 2.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77a9b01c5eb8422a610145b80f1d11435a6771f1
+  data.tar.gz: 1d594af8533cb3147f70467b4f05b0ccba940886
+SHA512:
+  metadata.gz: 7da5e58657f86c5304f78017afcd1607762a5b2ebc4f966c7b6d924488b511f389f9e422f7934d71f34af94b036eb55219fd5262237111f2ab35bd044a975164
+  data.tar.gz: 8e4953bcb70cf171baf418d5e4479875e343b167c814a2dcf7e6b498bd372504db964ced8598558e1dec7c106e962ac17307741886a73226a14d9c9a87bb9aee

data/ .travis.yml

@@ -0,0 +1,3 @@
+addons:
+  code_climate:
+    repo_token: dcc9b789b5067ef1437fffe22754df1ffefa75f86566c5d1ba88fbfdd393c720

data/.gitignore

@@ -0,0 +1,14 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: '2-3-stable'
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '2-3-stable'
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,121 @@
+Spree Reffiliate
+================
+[![Codeship Status for kinduff/spree_reffiliate](https://codeship.com/projects/ab504f70-4b22-0132-8f9f-22e1dbe6882e/status)](https://codeship.com/projects/46636)
+[![Build Status](https://travis-ci.org/kinduff/spree_reffiliate.svg?branch=master)](https://travis-ci.org/kinduff/spree_reffiliate)
+[![Code Climate](https://codeclimate.com/github/kinduff/spree_reffiliate/badges/gpa.svg)](https://codeclimate.com/github/kinduff/spree_reffiliate)
+[![Test Coverage](https://codeclimate.com/github/kinduff/spree_reffiliate/badges/coverage.svg)](https://codeclimate.com/github/kinduff/spree_reffiliate)
+
+Spree Reffiliate is a [Spree] Extension that adds the referral and affiliate features to your Spree Store. Users are going to be able to share a unique hyperlink with their friends to gain benefits and you'll be able to create affiliate campaigns through the Spree Administrator and configure it to your needs.
+
+### Referrals
++ User can share a unique URL
++ User can signup as a referred user
++ Referred user can have promotions
++ Admin is able to see referred users and orders from user
+
+### Affiliates
++ Admin is able to create an affiliate with a custom path
++ Customize the affiliate view with a partial
++ Users are going to be able to signup as an affiliated user
++ Affiliated user can have individual promotions
++ Admin is able to see affiliated users and orders from affiliate
+
+![Spree Reffiliate](https://cloud.githubusercontent.com/assets/1270156/4210980/11c6ba84-387f-11e4-8f3d-4eb7f45f9004.png)
+
+## Installation
+
+Add spree_reffiliate to your Gemfile:
+
+```ruby
+gem 'spree_reffiliate', github: 'kinduff/spree_reffiliate'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_reffiliate:install
+```
+
+### Existing Users
+If you already have users within your database, you'll need to run the following command to generate the referral registry for your users:
+
+```shell
+bundle exec rake reffiliate:generate
+```
+
+## Usage
+
+Referral path is `/r/:code` and Affiliate path (assigned in the admin) is `/a/:path`
+
+Once installed, you'll be able to access the following methods.
+
+#### Spree::User
++ referred_by => user record
++ referral_count => user count
++ referred? => boolean
++ affiliate? => boolean
++ affiliate => affiliate record
++ referral => referral record
+
+#### Spree::Referral
++ code => referral code
++ referred_users => array of users
++ referred_orders => array of orders
++ referred_count => user count
++ referral_activated_users => users with completed orders
+
+#### Spree::Affiliates
++ referred_users => array of users
++ referred_orders => array of orders
++ referred_count => user count
+
+### Spree Admin
+
+#### Users
+![User Listing](https://cloud.githubusercontent.com/assets/1270156/4210981/11cd353a-387f-11e4-826d-07b272bb249a.png)
+
+#### Affiliates
+![Referral Listing](https://cloud.githubusercontent.com/assets/1270156/4210982/11e9966c-387f-11e4-9a27-fca70c7a706d.png)
+
+#### Promotion Rules
+
+**Important**: in both referrals and affiliates, do **not** fill in the promotion code for the promotion itself to be applied automatically to the user's order. If you add a promotion code, the user will need to apply the for promotion manually.
+
+##### For referrals
+
+![Referral Rules](https://cloud.githubusercontent.com/assets/1270156/4244240/ec3dac8c-3a1d-11e4-8c6d-42c9f9b31e5f.png)
+
+##### For affiliates
+
+![Affiliate Rules](https://cloud.githubusercontent.com/assets/1270156/4244241/ec3e156e-3a1d-11e4-972a-5d61ebf0f053.png)
+
+### User account
+![User account](https://cloud.githubusercontent.com/assets/1270156/4210983/11e9b9a8-387f-11e4-8733-182bdebc449c.png)
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_reffiliate/factories'
+```
+
+## ToDo
++ Add missing documentation
++ Add 2-2-stable and 2-1-stable support (or at least test them)
++ Improve affiliates admin
++ Improve User and Orders listing at user admin
++ Add option or helper to show referral code to the user
+
+Copyright (c) 2014 Alejandro AR, released under the New BSD License
+
+[Spree]: http://spreecommerce.com/

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_reffiliate'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/controllers/spree/admin/affiliates_controller.rb

@@ -0,0 +1,23 @@
+module Spree
+  module Admin
+    class AffiliatesController < Spree::Admin::ResourceController
+      helper_method :affiliate_partial_exists?
+      before_filter :layout_options, only: [:new, :edit]
+
+      def index
+        @affiliates = Affiliate.all.page(params[:page]).per(Spree::Config[:admin_products_per_page])
+      end
+
+      protected
+
+        def affiliate_partial_exists? partial
+          return false if partial.blank? 
+          Affiliate.lookup_for_partial lookup_context, partial
+        end
+
+        def layout_options
+          @layout_options = Spree::Affiliate.layout_options
+        end
+    end
+  end
+end

data/app/controllers/spree/reffiliate_controller.rb

@@ -0,0 +1,22 @@
+module Spree
+  class ReffiliateController < Spree::StoreController
+    def referral
+      session[:referral] = params[:code]
+      redirect_to root_path
+    end
+    def affiliate
+      session[:affiliate] = params[:path]
+      affiliate = Spree::Affiliate.find_by(:path => params[:path])
+      if affiliate.nil? or affiliate.partial.blank? or !partial_exists affiliate.partial
+        redirect_to(root_path)
+      elsif partial_exists affiliate.partial
+        render "spree/affiliates/#{affiliate.partial}", :layout => affiliate.get_layout
+      end
+    end
+
+    private
+      def partial_exists partial
+        Affiliate.lookup_for_partial lookup_context, partial
+      end
+  end
+end

data/app/controllers/spree/user_controller_decorator.rb

@@ -0,0 +1,6 @@
+Spree::UserRegistrationsController.class_eval do
+  before_filter :check_referral_and_affiliate, :only => :create
+  def check_referral_and_affiliate
+    params[:spree_user].merge!(:referral_code => session[:referral], :affiliate_code => session[:affiliate])
+  end
+end

data/app/models/spree/affiliate.rb

@@ -0,0 +1,39 @@
+module Spree
+  class Affiliate < Spree::Base
+    has_many :referred_records
+    
+    validates_presence_of :name, :path
+
+    def referred_users
+      referred_records.includes(:user).collect(&:user).compact
+    end
+
+    def referred_orders
+      referred_records.includes({:user => :orders}).collect{|u| u.user.orders }.flatten.compact
+    end
+
+    def referred_count
+      referred_records.count
+    end
+
+    def get_layout
+      return false if layout == 'false'
+      layout
+    end
+
+    private
+
+      def self.layout_options
+        [
+          ["No Layout", "false"],
+          ["Spree Application Layout", 'spree/layouts/spree_application'],
+          ["Custom Layout Path", nil]
+        ]
+      end
+
+      def self.lookup_for_partial lookup_context, partial
+        lookup_context.template_exists?(partial, ["spree/affiliates"], false)
+      end
+
+  end
+end

data/app/models/spree/promotion/rules/affiliated_promotion_rule.rb

@@ -0,0 +1,37 @@
+module Spree
+  class Promotion
+    module Rules
+      class AffiliatedPromotionRule < Spree::PromotionRule
+        belongs_to :affiliate, :class_name => '::Spree::Affiliate'
+        has_and_belongs_to_many :affiliates, :class_name => '::Spree::Affiliate',
+          :join_table => 'spree_affiliates_promotion_rules', :foreign_key => 'promotion_rule_id',
+          :association_foreign_key => 'affiliate_id'
+
+        def eligible?(order, options = {})
+          return true if order.user and order.user.affiliate? and affiliates.collect(&:id).include?(order.user.affiliate.id)
+          false
+        end
+
+        def applicable?(promotable)
+          promotable.is_a?(Spree::Order)
+        end
+
+        def affiliate_ids_string
+          affiliate_ids.join(',')
+        end
+
+        def affiliate_ids_string=(s)
+          self.affiliate_ids = s.to_s.split(',').map(&:strip)
+        end
+
+        def affiliate_list
+          affiliate_ids
+        end
+
+        def affiliate_list=(a)
+          self.affiliate_ids = a
+        end
+      end
+    end
+  end
+end

data/app/models/spree/promotion/rules/referred_promotion_rule.rb

@@ -0,0 +1,15 @@
+module Spree
+  class Promotion
+    module Rules
+      class ReferredPromotionRule < Spree::PromotionRule
+        def eligible?(order, options = {})
+          return true if order.user and order.user.referred?
+          false
+        end
+        def applicable?(promotable)
+          promotable.is_a?(Spree::Order)
+        end
+      end
+    end
+  end
+end

data/app/models/spree/referral.rb

@@ -0,0 +1,40 @@
+module Spree
+  class Referral < Spree::Base
+    belongs_to :user, class_name: Spree.user_class.to_s
+    has_many :referred_records
+
+    validates_presence_of :user_id, :code
+
+    before_validation :attach_code, on: :create
+
+    def referred_users
+      referred_records.includes(:user).collect(&:user).compact
+    end
+
+    def referred_orders
+      referred_records_with_user_orders.collect{|u| u.user.orders }.flatten.compact
+    end
+
+    def referral_activated_users
+      referred_records_with_user_orders.select{|u| post_referral_order?(u) }.collect(&:user)
+    end
+
+    protected
+      def attach_code
+        self.code = loop do
+          code =  (0...8).map { (65 + rand(26)).chr }.join
+          break code unless Referral.exists?(code: code)
+        end
+      end
+
+   private
+
+    def referred_records_with_user_orders
+      referred_records.includes({:user => :orders})
+    end
+
+    def post_referral_order?(referred_record)
+      referred_record.user.orders.where('completed_at > ?', self.user.created_at).any?
+    end
+  end
+end

data/app/models/spree/referred_record.rb

@@ -0,0 +1,9 @@
+module Spree
+  class ReferredRecord < Spree::Base
+    belongs_to :referral
+    belongs_to :user, class_name: Spree.user_class.to_s
+    belongs_to :affiliate
+
+    validates_presence_of :user
+  end
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,41 @@
+module Spree
+  Spree.user_class.class_eval do
+    has_one :referral
+    has_one :referred_record
+    has_one :affiliate, through: :referred_record, foreign_key: :affiliate_id
+    has_one :affiliate_record, class_name: ReferredRecord
+
+    attr_accessor :referral_code, :affiliate_code
+
+    after_create :create_referral
+    after_create :referral_affiliate_check
+
+    def referred_by
+      referred_record.try(:referral).try(:user)
+    end
+    
+    def referred_count
+      referral.referred_records.count
+    end
+
+    def referred?
+      !referred_record.try(:referral).try(:user).nil?
+    end
+
+    def affiliate?
+      !affiliate.nil?
+    end
+
+    private
+      def referral_affiliate_check
+        if !self.referral_code.nil?
+          referred = Referral.find_by(code: referral_code)
+        elsif !self.affiliate_code.nil?
+          referred = Affiliate.find_by(path: affiliate_code)
+        end
+        if referred
+          referred.referred_records.create(user: self)
+        end
+      end
+  end
+end

data/app/overrides/spree/admin/shared/_configuration_menu.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  :virtual_path => "spree/admin/shared/_configuration_menu",
+  :name => "admin_content_admin_configuration_menu_parser",
+  :insert_bottom => "[data-hook='admin_configurations_sidebar_menu']",
+  :text => "<%= configurations_sidebar_menu_item Spree.t(:affiliates), admin_affiliates_path %>"
+)

data/app/overrides/spree/admin/users/edit.rb

@@ -0,0 +1,50 @@
+Deface::Override.new(
+  :virtual_path => "spree/admin/users/edit",
+  :name => "referral_fieldset",
+  :insert_after => "[data-hook='admin_user_api_key']"
+) do
+<<-CODE.chomp
+<fieldset>
+  <legend>Referral Information</legend>
+  <table>
+    <tr>
+      <th>Referred by</th>
+      <td>
+        <% if @user.referred? %>
+          <%= link_to(@user.referred_by.email, edit_admin_user_url(@user.referred_by)) %>
+        <% elsif @user.affiliate? %>
+          <%= link_to(@user.affiliate.name, edit_admin_affiliate_url(@user.affiliate)) %>
+        <% else %>
+          Organic
+        <% end %>
+      </td>
+    </tr>
+      <th>Referral code</th>
+      <td><%= @user.referral.code %></td>
+    <tr>
+    </tr>
+      <th>Referred orders</th>
+      <td>
+        <%= "No referred orders yet." if @user.referral.referred_orders.count == 0 %>
+        <ol style="margin-left: 20px;">
+          <% @user.referral.referred_orders.each do |order| %>
+            <li><%= link_to order.number, edit_admin_order_path(order) %></li>
+          <% end %>
+        <ol>
+      </td>
+    <tr>
+    <tr>
+      <th>Users referred</th>
+      <td>
+        <%= "No referred users yet." if @user.referred_count == 0 %>
+        <ol style="margin-left: 20px;">
+          <% @user.referral.referred_users.each do |user| %>
+            <li><%= link_to user.email, edit_admin_user_url(user) %></li>
+          <% end %>
+        </ol>
+      </td>
+    <tr>
+  </tr>
+</fieldset>
+CODE
+end

data/app/overrides/spree/admin/users/index.rb

@@ -0,0 +1,18 @@
+Deface::Override.new(
+  :virtual_path => "spree/admin/users/index",
+  :name => "referral_code_header",
+  :insert_before => "[data-hook='admin_users_index_headers'] th:nth-child(2)",
+  :text => "<th class='align-center'>Referrals</th>"
+)
+Deface::Override.new(
+  :virtual_path => "spree/admin/users/index",
+  :name => "referral_code",
+  :insert_before => "[data-hook='admin_users_index_rows'] td:nth-child(2)",
+  :text => "<td class='align-center'><%= user.referred_count %></td>"
+)
+Deface::Override.new(
+  :virtual_path => "spree/admin/users/index",
+  :name => "column_withds",
+  :replace => "#listing_users > colgroup",
+  :text => "<col style='width: 75%'><col style='width: 10%'><col style='width: 15%'>"
+)

data/app/overrides/spree/users/show.rb

@@ -0,0 +1,12 @@
+Deface::Override.new(
+  :virtual_path => "spree/users/show",
+  :name => "user_info",
+  :insert_after => "[data-hook='account_summary'] #user-info dd:first"
+) do
+<<-CODE.chomp
+<dt>Referral URL</dt>
+<dd><input type='text' value='<%= referral_url(@user.referral.code) %>' onClick='this.select();' /></dd>
+<dt>Referred Users</dt>
+<dd><%= @user.referred_count%></dd>
+CODE
+end

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

@@ -0,0 +1,45 @@
+<div data-hook="admin_user_form_fields" class="row">
+  <div class="alpha six columns">
+    <%= f.field_container :name do %>
+      <%= f.label :name, Spree.t(:name) %>
+      <%= f.text_field :name, class: 'fullwidth' %>
+      <%= error_message_on :user, :name %>
+    <% end %>
+    <%= f.field_container :partial do %>
+      <%= f.label :partial, Spree.t(:partial) + " (leave blank if no partial) " %>
+      <p>app/views/spree/affiliates/<%= f.text_field :partial %></p>
+      <%= f.error_message_on :partial %>
+    <% end %>
+  </div>
+
+  <div class="omega six columns">
+    <%= f.field_container :path do %>
+      <%= f.label :path, Spree.t(:path) %>
+      <%= f.text_field :path, class: 'fullwidth' %>
+      <%= f.error_message_on :path %>
+    <% end %>
+    <%= f.field_container :path do %>
+      <%= f.label :layout, Spree.t(:layout) %>
+      <%= select_tag 'fake_layout', options_for_select(@layout_options, selected: @affiliate.layout), class: "fullwidth #{'other' unless @layout_options.flatten.include?(@affiliate.layout)}" %>
+      <%= f.text_field :layout, value: @affiliate.layout.nil? ? @layout_options.first : @affiliate.layout, class: 'fullwidth' %>
+      <script>
+        var fake_layout = $("#fake_layout"),
+            affiliate_layout = $("#affiliate_layout");
+        fake_layout.on("change", function(){
+          affiliate_layout.hide();
+          if ($(this).val() != '') {
+            affiliate_layout.val($(this).val());
+          } else {
+            affiliate_layout.val('layouts/application').show().focus();
+          }
+        });
+        if (!fake_layout.hasClass('other')) {
+          affiliate_layout.hide();
+        } else {
+          fake_layout.val('');
+        }
+      </script>
+      <%= f.error_message_on :layout %>
+    <% end %>
+  </div>
+</div>

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

@@ -0,0 +1,76 @@
+<% content_for :page_title do %>
+  <%= link_to "#{Spree.t(:editing_affiliate)} #{@affiliate.name}", edit_admin_affiliate_url(@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 %>
+
+<fieldset data-hook="admin_affiliate_edit_general_settings" class="alpha twelve columns">
+  <legend><%= Spree.t(:general_settings) %></legend>
+
+  <div data-hook="admin_affiliate_edit_form_header">
+    <%= render :partial => 'spree/shared/error_messages', :locals => { :target => @affiliate } %>
+  </div>
+
+  <div data-hook="admin_affiliate_edit_form">
+    <%= form_for [:admin, @affiliate], as: :affiliate, url: admin_affiliate_url(@affiliate), method: :put do |f| %>
+      <%= render :partial => 'form', :locals => { :f => f } %>
+
+      <div data-hook="admin_affiliate_edit_form_button">
+        <%= render :partial => 'spree/admin/shared/edit_resource_links', :locals => { :collection_url => admin_affiliates_url } %>
+      </div>
+    <% end %>
+  </div>
+</fieldset>
+<fieldset data-hook="admin_affiliate_edit_stats" class="alpha twelve columns">
+  <legend><%= Spree.t(:statistics) %></legend>
+  <table>
+    <tbody>
+      <tr>
+        <th>Affiliate hyperlink</th>
+        <td><%= text_field_tag nil, affiliate_url(@affiliate.path), onclick: 'this.select();' %></td>
+      </tr>
+      <tr>
+        <th>Partial Status</th>
+        <% if @affiliate.partial.blank? or !affiliate_partial_exists?(@affiliate.partial) %>
+          <td style="color: red">Not found</td>
+        <% elsif affiliate_partial_exists?(@affiliate.partial) %>
+          <td style="color: green">Found</td>
+        <% end %>
+      </tr>
+      <tr>
+        <th>Referred users count</th>
+        <td><%= @affiliate.referred_count %></td>
+      </tr>
+      <tr>
+        <th>Referred orders count</th>
+        <td><%= @affiliate.referred_orders.count %></td>
+      </tr>
+      <tr>
+        <th>Orders referred</th>
+        <td>
+          <%= "No referred orders" if @affiliate.referred_orders.count == 0 %>
+          <ol style="margin-left: 20px;">
+            <% @affiliate.referred_orders.each do |user| %>
+              <li><%= link_to user.email, edit_admin_user_url(user) %></li>
+            <% end %>
+          </ol>
+        </td>
+      <tr>
+      <tr>
+        <th>Users referred</th>
+        <td>
+          <%= "No referred users" if @affiliate.referred_count == 0 %>
+          <ol style="margin-left: 20px;">
+            <% @affiliate.referred_users.each do |user| %>
+              <li><%= link_to user.email, edit_admin_user_url(user) %></li>
+            <% end %>
+          </ol>
+        </td>
+      <tr>
+    </tbody>
+  </table>
+</fieldset>