refer 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b67d5a90aba044db91c58de5ba63120d31b89e4826545e3589388eae68922a
-  data.tar.gz: bccf49ec61313f94f7cf842920249d0af40bda63dd632fef70694701912b1e63
+  metadata.gz: 8c8a0abb5e281f32bf502b1de5c76ce89d8f39414a5e03b5f499339a6d253fee
+  data.tar.gz: 1c2a9895ad6841fcef7511c6dc3d591ead6ad944ffdd32b15327541204ab3a7b
 SHA512:
-  metadata.gz: d96dbd8d446574bf29433a558f9b342e385a0af450d2885d37db182960ef3cb1a1fe38d7be0f9eeac7ace6eeb77b7d7117c30f606eb220726764ed6b95ea7b45
-  data.tar.gz: 597c07e84d93b9b6ad2d487a61ad456c20f0b4e687a8fe5b2b6e5184327e11ae79b68b7426acb7d266d047b2b6259d4c9d8f3e583e6f4e97e17ea6ca630028b7
+  metadata.gz: 5dafc7f167fbdaa7de09c830a1fc37384e3c775bc12daa0e95a3bcd01b753869c558c95148b5dfe76e56ef94ded5df5a9ad554ee8e8250d90be9c2cc6e3875c2
+  data.tar.gz: 5b6cdb88cad2df78e0cfc63a31389b6dd4fda8e06d82acd7ad9ddd0dd844038f5d0c1918b536972528b858260e7fa61645f0935e54ba84044b48a12f37b1e70b

data/README.md

@@ -139,6 +139,27 @@ To access a user's referrer, you can use `referrer`:
 ```ruby
 user.referrer #=> User that referred this User
 ```
+## Refer with Devise
+
+To use Refer with Devise, you'll need to customize the Devise controller to track the referral after a successful registration.
+
+We can do this by telling Devise to use a custom controller in the routes and hooking into the `create` action to track the referral.
+
+```ruby
+# config/routes.rb
+devise_for :users, controllers: { registrations: "users/registrations" }
+```
+
+```ruby
+# app/controllers/users/registrations_controller.rb
+class Users::RegistrationsController < Devise::RegistrationsController
+  def create
+    super do
+      refer resource if resource.persisted?
+    end
+  end
+end
+```
 
 ## Providing Referral Rewards
 

data/app/controllers/concerns/refer/controller.rb

@@ -15,9 +15,11 @@ module Refer
     private
 
     def set_refer_cookie(param_name: Refer.param_name, cookie_name: Refer.cookie_name)
-      if (code = params[param_name])
-        cookies[cookie_name] = Refer.cookie(code)
-      end
+      code = params[param_name]
+      return if code.blank?
+
+      cookies[cookie_name] = Refer.cookie(code) if Refer.overwrite_cookie || cookies[cookie_name].blank?
+      ReferralCode.find_by(code: code)&.track_visit(request) if Refer.track_visits
     end
   end
 end

data/app/models/refer/referral.rb

@@ -2,10 +2,14 @@ module Refer
   class Referral < ApplicationRecord
     belongs_to :referrer, polymorphic: true
     belongs_to :referee, polymorphic: true
-    belongs_to :referral_code, optional: true
+    belongs_to :referral_code, optional: true, counter_cache: true
 
     before_validation do
       self.referrer = referral_code&.referrer
     end
+
+    def complete!(**attributes)
+      update attributes.with_defaults(completed_at: Time.current)
+    end
   end
 end

data/app/models/refer/referral_code.rb

@@ -2,15 +2,20 @@ module Refer
   class ReferralCode < ApplicationRecord
     belongs_to :referrer, polymorphic: true
     has_many :referrals, dependent: :nullify
+    has_many :visits, dependent: :delete_all
 
     validates :code, presence: true, uniqueness: true
 
-    before_create if: -> { Refer.code_generator } do
-      Refer.code_generator.call(referrer)
+    before_validation if: -> { Refer.code_generator } do
+      self.code = Refer.code_generator.call(referrer)
     end
 
     def to_param
       code
     end
+
+    def track_visit(request)
+      visits.from_request(request).save
+    end
   end
 end

data/app/models/refer/visit.rb

@@ -0,0 +1,16 @@
+module Refer
+  class Visit < ApplicationRecord
+    belongs_to :referral_code, counter_cache: true
+
+    normalizes :ip, with: -> { Refer.mask_ip(_1) }
+
+    def self.from_request(request)
+      new(
+        ip: request.ip,
+        user_agent: request.user_agent,
+        referrer: request.referrer,
+        referring_domain: (URI.parse(request.referrer).try(:host) rescue nil)
+      )
+    end
+  end
+end

data/db/migrate/20240701172643_create_refer_visits.rb

@@ -0,0 +1,17 @@
+class CreateReferVisits < ActiveRecord::Migration[7.2]
+  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

data/lib/refer/version.rb

@@ -1,3 +1,3 @@
 module Refer
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/refer.rb

@@ -9,6 +9,9 @@ module Refer
   config_accessor :cookie_length, default: 30.days
   config_accessor :cookie_name, default: :refer_code
   config_accessor :param_name, default: :ref
+  config_accessor :overwrite_cookie, default: true
+  config_accessor :track_visits, default: true
+  config_accessor :mask_ips, default: true
 
   class Error < StandardError; end
   class AlreadyReferred < Error; end
@@ -33,6 +36,20 @@ module Refer
       expires: Refer.cookie_length.from_now
     }
   end
+
+  # From Ahoy gem: https://github.com/ankane/ahoy/blob/v5.1.0/lib/ahoy.rb#L133-L142
+  def self.mask_ip(ip)
+    return ip unless mask_ips
+
+    addr = IPAddr.new(ip)
+    if addr.ipv4?
+      # set last octet to 0
+      addr.mask(24).to_s
+    else
+      # set last 80 bits to zeros
+      addr.mask(48).to_s
+    end
+  end
 end
 
 ActiveSupport.on_load(:active_record) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: refer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -40,9 +40,11 @@ files:
 - app/models/refer/application_record.rb
 - app/models/refer/referral.rb
 - app/models/refer/referral_code.rb
+- app/models/refer/visit.rb
 - config/routes.rb
 - db/migrate/20240611180738_create_refer_referrals.rb
 - db/migrate/20240611183349_create_refer_referral_codes.rb
+- db/migrate/20240701172643_create_refer_visits.rb
 - lib/generators/refer/install/USAGE
 - lib/generators/refer/install/install_generator.rb
 - lib/generators/refer/model/USAGE