Gem refer (#264)

yshmarov · web-flow · commit c1f60403ee0c · 2025-06-01T22:02:07.000+02:00
* gem "refer" * Update en.yml * Create pay_charge_extensions.rb * omfg fix pay * Create index.html.erb * test * clipboard component https://www.stimulus-components.com/docs/stimulus-clipboard
diff --git a/Gemfile b/Gemfile
@@ -97,3 +97,6 @@ gem "ransack", "~> 4.2"
 gem "pay", "~> 8.0"
 gem "stripe", "~> 13.0"
 gem "profitable"
+
+# business logic
+gem "refer"
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -401,6 +401,8 @@ GEM
     rdoc (6.14.0)
       erb
       psych (>= 4.0.0)
+    refer (1.0.2)
+      rails (>= 7.1.0)
     regexp_parser (2.10.0)
     reline (0.6.1)
       io-console (~> 0.5)
@@ -572,6 +574,7 @@ DEPENDENCIES
   pundit (~> 2.3)
   rails (~> 8.0.1)
   ransack (~> 4.2)
+  refer
   rubocop-rails-omakase
   selenium-webdriver
   simplecov (~> 0.22.0)
diff --git a/app/components/metrics_grid_component.html.erb b/app/components/metrics_grid_component.html.erb
@@ -0,0 +1,17 @@
+<div class="grid grid-cols-1 md:grid-cols-2 gap-6">
+  <% @metrics.each do |metric| %>
+    <div class="du-card du-bg-base-100 du-shadow-xl border">
+      <div class="du-card-body space-y-2">
+        <h2 class="du-card-title text-base-content/70 text-sm uppercase tracking-wider"><%= metric[:title] %></h2>
+        <p class="text-4xl font-bold text-primary">
+          <% if metric[:type] == :money %>
+            <%= number_to_currency(metric[:value].to_f/100) %>
+          <% elsif metric[:type] == :number %>
+            <%= number_with_delimiter(metric[:value]) %>
+          <% end %>
+        </p>
+        <p class="text-sm text-base-content/60"><%= metric[:subtitle] %></p>
+      </div>
+    </div>
+  <% end %>
+</div> 
diff --git a/app/components/metrics_grid_component.rb b/app/components/metrics_grid_component.rb
@@ -0,0 +1,5 @@
+class MetricsGridComponent < ViewComponent::Base
+  def initialize(metrics:)
+    @metrics = metrics
+  end
+end
diff --git a/app/components/page_component.html.erb b/app/components/page_component.html.erb
@@ -8,6 +8,12 @@
     </div>
   </div>
 
+  <% if subtitle %>
+    <p class="text-sm text-base-content/60">
+      <%= subtitle %>
+    </p>
+  <% end %>
+
   <div class="space-y-4">
     <%= content %>
   </div>
diff --git a/app/components/page_component.rb b/app/components/page_component.rb
@@ -1,12 +1,13 @@
 class PageComponent < ViewComponent::Base
   renders_one :action_list
 
-  def initialize(title:, full_width: false)
+  def initialize(title:, full_width: false, subtitle: nil)
     @title = title
     @full_width = full_width
+    @subtitle = subtitle
   end
 
-  attr_reader :title
+  attr_reader :title, :subtitle
 
   def width_class
     if @full_width == true
diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
@@ -5,6 +5,8 @@ class ApplicationController < ActionController::Base
   before_action :authenticate_user!
   before_action :set_current_organizations, if: :user_signed_in?
 
+  set_referral_cookie
+
   def after_sign_in_path_for(resource)
     stored_location_for(resource) || organizations_path
   end
diff --git a/app/controllers/users/referrals_controller.rb b/app/controllers/users/referrals_controller.rb
@@ -0,0 +1,10 @@
+class Users::ReferralsController < ApplicationController
+  def index
+    @referral_code = current_user.referral_codes.first_or_create
+    @metrics = [
+      { title: t("users.referrals.index.clicks"), subtitle: t("users.referrals.index.clicks_description"), value: @referral_code.visits_count, type: :number },
+      { title: t("users.referrals.index.referrals"), subtitle: t("users.referrals.index.referrals_description"), value: @referral_code.referrals.count, type: :number },
+      { title: t("users.referrals.index.completed"), subtitle: t("users.referrals.index.completed_description"), value: @referral_code.referrals.completed.count, type: :number }
+    ]
+  end
+end
diff --git a/app/controllers/users/registrations_controller.rb b/app/controllers/users/registrations_controller.rb
@@ -1,3 +1,9 @@
 class Users::RegistrationsController < Devise::RegistrationsController
   rate_limit to: 50, within: 3.minutes, only: :create, with: -> { redirect_to new_user_registration_url, alert: t("shared.errors.rate_limit") }
+
+  def create
+    super do
+      refer resource if resource.persisted?
+    end
+  end
 end
diff --git a/app/javascript/controllers/index.js b/app/javascript/controllers/index.js
@@ -6,6 +6,8 @@ import { application } from "controllers/application"
 import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
 eagerLoadControllersFrom("controllers", application)
 
+import Clipboard from "@stimulus-components/clipboard"
+application.register("clipboard", Clipboard)
 // Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
 // import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
 // lazyLoadControllersFrom("controllers", application)
diff --git a/app/models/user.rb b/app/models/user.rb
@@ -1,6 +1,7 @@
 class User < ApplicationRecord
   include User::Authentication
   include User::Multitenancy
+  has_referrals
 
   def self.ransackable_attributes(auth_object = nil)
     %w[id email]
diff --git a/app/views/shared/_navbar.html.erb b/app/views/shared/_navbar.html.erb
@@ -57,7 +57,8 @@
           <%= inline_svg_tag "svg/chevron-down.svg", class: "w-4 h-4 stroke-2 transition-transform duration-200 group-open:rotate-180" %>
         </summary>
         <div class="absolute right-0 mt-5 bg-base-200 border border-base-content/20 z-1 rounded-lg p-1 space-y-1 du-menu">
-          <%= nav_link "Connected Accounts", user_connected_accounts_path, icon: "🔗" if Devise.omniauth_configs.keys.any? %>
+          <%= nav_link t("users.referrals.index.title"), user_referrals_path, icon: "👥" %>
+          <%= nav_link t("users.connected_accounts.index.title"), user_connected_accounts_path, icon: "🔗" if Devise.omniauth_configs.keys.any? %>
           <%= nav_link t("shared.navigation.edit_profile"), edit_user_registration_path, icon: "🔐" %>
           <%= nav_link t("shared.navigation.logout"), destroy_user_session_path, data: { turbo_method: :delete, turbo_confirm: t("shared.actions.confirm") } %>
         </div>
diff --git a/app/views/users/referrals/index.html.erb b/app/views/users/referrals/index.html.erb
@@ -0,0 +1,7 @@
+<%= render PageComponent.new(title: t(".title"), subtitle: t(".subtitle")) do |component| %>
+  <div data-controller="clipboard" data-clipboard-success-content-value="Copied!" class="flex items-center gap-2">
+    <%= text_field_tag nil, root_url(Refer.param_name => @referral_code.code), readonly: true, data: { clipboard_target: "source" }, class: "form-input" %>
+    <button type="button" data-action="clipboard#copy" data-clipboard-target="button" class="du-btn du-btn-neutral">Copy</button>
+  </div>
+  <%= render MetricsGridComponent.new(metrics: @metrics) %>
+<% end %>
diff --git a/config/importmap.rb b/config/importmap.rb
@@ -2,7 +2,8 @@
 
 pin "application"
 pin "@hotwired/turbo", to: "turbo.min.js", preload: true
-pin "@hotwired/stimulus", to: "stimulus.min.js"
+pin "@hotwired/stimulus", to: "@hotwired--stimulus.js" # @3.2.2
 pin "@hotwired/stimulus-loading", to: "stimulus-loading.js"
 pin_all_from "app/javascript/controllers", under: "controllers"
 pin "turbo_power" # @0.7.1
+pin "@stimulus-components/clipboard", to: "@stimulus-components--clipboard.js" # @5.0.0
diff --git a/config/initializers/pay.rb b/config/initializers/pay.rb
@@ -6,3 +6,20 @@
   config.enabled_processors = [ :stripe ]
   config.send_emails = false
 end
+
+# Pay::Charge.new.respond_to?(:complete_referral, true)
+module ChargeExtensions
+  extend ActiveSupport::Concern
+
+  included do
+    after_create_commit :complete_referral
+  end
+
+  def complete_referral
+    customer.owner.owner.referral&.complete!
+  end
+end
+
+Rails.configuration.to_prepare do
+  Pay::Charge.include ChargeExtensions
+end
diff --git a/config/locales/en.yml b/config/locales/en.yml
@@ -180,3 +180,14 @@ en:
         success: Membership request revoked
       index:
         title: Outgoing membership requests
+    referrals:
+      index:
+        clicks: Link clicks
+        clicks_description: How many times your unique link has been clicked.
+        completed: Completed referrals
+        completed_description: Friends who've signed up and made their first purchase.
+        referrals: Successful signups
+        referrals_description: Friends who've joined using your link.
+        subtitle: Share your unique referral link and earn rewards when your friends
+          sign up and make their first purchase.
+        title: Invite friends, get rewards
diff --git a/config/routes/users.rb b/config/routes/users.rb
@@ -7,6 +7,7 @@
 resource :user do
   scope module: :users do
     resources :connected_accounts
+    resources :referrals, only: %i[index]
     resources :invitations, only: %i[index] do
       member do
         post :approve
diff --git a/db/migrate/20250601151851_create_refer_referrals.refer.rb b/db/migrate/20250601151851_create_refer_referrals.refer.rb
@@ -0,0 +1,12 @@
+# This migration comes from refer (originally 20240611180738)
+class CreateReferReferrals < ActiveRecord::Migration[6.1]
+  def change
+    create_table :refer_referrals do |t|
+      t.belongs_to :referrer, polymorphic: true, null: false
+      t.belongs_to :referee, polymorphic: true, null: false
+      t.belongs_to :referral_code
+
+      t.timestamps
+    end
+  end
+end
diff --git a/db/migrate/20250601151852_create_refer_referral_codes.refer.rb b/db/migrate/20250601151852_create_refer_referral_codes.refer.rb
@@ -0,0 +1,11 @@
+# This migration comes from refer (originally 20240611183349)
+class CreateReferReferralCodes < ActiveRecord::Migration[6.1]
+  def change
+    create_table :refer_referral_codes do |t|
+      t.belongs_to :referrer, polymorphic: true, null: false
+      t.string :code, null: false, index: { unique: true }
+
+      t.timestamps
+    end
+  end
+end
diff --git a/db/migrate/20250601151853_create_refer_visits.refer.rb b/db/migrate/20250601151853_create_refer_visits.refer.rb
@@ -0,0 +1,18 @@
+# This migration comes from refer (originally 20240701172643)
+class CreateReferVisits < ActiveRecord::Migration[6.1]
+  def change
+    create_table :refer_visits do |t|
+      t.belongs_to :referral_code, null: false, foreign_key: { to_table: :refer_referral_codes }
+      t.string :ip
+      t.text :user_agent
+      t.text :referrer
+      t.string :referring_domain
+
+      t.timestamps
+    end
+
+    add_column :refer_referral_codes, :referrals_count, :integer, default: 0
+    add_column :refer_referral_codes, :visits_count, :integer, default: 0
+    add_column :refer_referrals, :completed_at, :datetime
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
diff --git a/test/components/metrics_grid_component_test.rb b/test/components/metrics_grid_component_test.rb
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class MetricsGridComponentTest < ViewComponent::TestCase
+  def test_component_renders_something_useful
+    # assert_equal(
+    #   %(<span>Hello, components!</span>),
+    #   render_inline(MetricsGridComponent.new(message: "Hello, components!")).css("span").to_html
+    # )
+  end
+end
diff --git a/test/controllers/users/connected_accounts_controller_test.rb b/test/controllers/users/connected_accounts_controller_test.rb
@@ -0,0 +1,15 @@
+require "test_helper"
+
+class Users::ConnectedAccountsControllerTest < ActionDispatch::IntegrationTest
+  setup do
+    @user = users(:one)
+    sign_in @user
+
+    skip if Devise.omniauth_configs.keys.empty?
+  end
+
+  test "get #index" do
+    get user_connected_accounts_url
+    assert_response :success
+  end
+end
diff --git a/test/controllers/users/referrals_controller_test.rb b/test/controllers/users/referrals_controller_test.rb
@@ -0,0 +1,20 @@
+require "test_helper"
+
+class Users::ReferralsControllerTest < ActionDispatch::IntegrationTest
+  setup do
+    @user = users(:one)
+    sign_in @user
+  end
+
+  test "get #index" do
+    assert_difference "Refer::ReferralCode.count" do
+      get user_referrals_url
+      assert_response :success
+    end
+
+    assert_no_difference "Refer::ReferralCode.count" do
+      get user_referrals_url
+      assert_response :success
+    end
+  end
+end
diff --git a/test/fixtures/connected_accounts.yml b/test/fixtures/connected_accounts.yml
diff --git a/vendor/javascript/@hotwired--stimulus.js b/vendor/javascript/@hotwired--stimulus.js
diff --git a/vendor/javascript/@stimulus-components--clipboard.js b/vendor/javascript/@stimulus-components--clipboard.js
