refer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 736ad28aa8233ae7dd3de16fe4f735931fa626b24f2875d2f60ac0d2791e1c05
-  data.tar.gz: c114325825aebd3e62fc5f2a0f29cf8ec7b562b646b2597c326a6631efd5920e
+  metadata.gz: d3e23e2268de377fc2bf73d90fc5ede044f1a31cd37f748e925ca68f11fcb059
+  data.tar.gz: 27ae4e3b9d7cca116132bcc3fb5310c6a7b82352d2330f70b52b5004c76838cf
 SHA512:
-  metadata.gz: 2929027d9b24206e3ed98c6e6b8858bc5efa9e0df3c094edd272dd80c318f764fe83761a6540d045faf6f9628adf537e94109e4fc88b9108ffb2b71d91fa3969
-  data.tar.gz: ab6a96074eba0db0bd0319c4233aae91418a506182dc93ccf6937debd1a8f909a20485fbd238defa6d3ebf261d866554783360d1c16a634c1b25e3330cfce670
+  metadata.gz: ee9e1dae466166dd4299e39ede4e06ea492c21c03f21ea0f4f13fc8343a1eca039c8e6d2914fbf35e8ea4354b8dda9a04057699361db91ad45e56d896e98ac6a
+  data.tar.gz: 0e5b8663f94465cc9ce236310f1b728f011d442f8076f6184cd7a0bb5a2480bbd81205c0ecc5a5bc81dbe611e30c672a6f7015bb0153233c3c70c98def454238

data/README.md

@@ -1,6 +1,6 @@
 # Refer
 
-Referral codes for Ruby on Rails applications.
+Referral codes and affiliate links for Ruby on Rails applications.
 
 ## 📦 Installation
 Add this line to your application's Gemfile:
@@ -14,9 +14,15 @@ And then execute:
 $ bundle
 ```
 
+Add Refer to your controllers to store referral cookies:
+```bash
+bin/rails generate refer:install
+```
+
 And add Refer to your model:
 ```bash
 bin/rails generate refer:model User
+bin/rails db:migrate
 ```
 
 ## 🧑‍💻 Usage
@@ -42,7 +48,7 @@ user.referral_codes.create(code: "chris")
 To customize the referral code generator:
 
 ```ruby
-Refer.code_generator = ->(referrer) { [id, SecureRandom.alphanumeric(8).join("-") }
+Refer.code_generator = ->(referrer) { [id, SecureRandom.alphanumeric(8)].join("-") }
 #=> generates codes like "1-7frb5fUw"
 ```
 
@@ -54,7 +60,15 @@ To track users, we need to stash the referral code in a cookie when present. By
 
 ```ruby
 class ApplicationController < ActionController::Base
-  before_action :set_refer_cookie
+  set_referral_cookie
+end
+```
+
+Move `set_referral_cookie` to specific controllers if you'd only like cookies set in certain areas like marketing pages for example.
+
+```ruby
+class MarketingController < ActionController::Base
+  set_referral_cookie except: [:about_us]
 end
 ```
 

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

@@ -2,14 +2,22 @@ module Refer
   module Controller
     extend ActiveSupport::Concern
 
-    def set_refer_cookie
-      if (code = params[Refer.param_name])
-        cookies[Refer.cookie_name] = Refer.cookie(code)
+    class_methods do
+      def set_referral_cookie(param_name: Refer.param_name, cookie_name: Refer.cookie_name, **options)
+        before_action -> { set_refer_cookie(param_name: param_name, cookie_name: cookie_name) }, **options
       end
     end
 
-    def refer(referee)
-      Refer.refer(code: cookies[Refer.cookie_name], referee: referee)
+    def refer(referee, cookie_name: Refer.cookie_name)
+      Refer.refer(code: cookies[cookie_name], referee: referee)
+    end
+
+    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
     end
   end
 end

data/app/models/concerns/refer/model.rb

@@ -3,8 +3,9 @@ module Refer
     extend ActiveSupport::Concern
 
     included do
-      has_many :referrals, inverse_of: :referrer, class_name: "Refer::Referral"
-      has_one :referral, inverse_of: :referee, class_name: "Refer::Referral"
+      has_many :referral_codes, inverse_of: :referrer, class_name: "Refer::ReferralCode", dependent: :destroy
+      has_many :referrals, inverse_of: :referrer, class_name: "Refer::Referral", dependent: :destroy
+      has_one :referral, inverse_of: :referee, class_name: "Refer::Referral", dependent: :destroy
       delegate :referrer, to: :referral
     end
   end

data/app/models/refer/referral_code.rb

@@ -1,7 +1,7 @@
 module Refer
   class ReferralCode < ApplicationRecord
     belongs_to :referrer, polymorphic: true
-    has_many :referrals
+    has_many :referrals, dependent: :nullify
 
     validates :code, presence: true, uniqueness: true
 

data/lib/generators/refer/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds Refer to ApplicationController to set referral cookies
+
+Example:
+    bin/rails generate refer:install
+
+    This will add `sets_refer_cookie` to the ApplicationController class.
+

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

@@ -0,0 +1,7 @@
+class Refer::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def add_refer
+    inject_into_class File.join("app", "controllers", "application_controller.rb"), "ApplicationController", "  set_referral_cookie\n"
+  end
+end

data/lib/generators/refer/model/USAGE

@@ -1,8 +1,7 @@
 Description:
-    Explain the generator
+    Adds Refer associations to a model
 
 Example:
-    bin/rails generate model Thing
+    bin/rails generate refer:model User
 
-    This will create:
-        what/will/it/create
+    This will add `has_referrals` to the User class.

data/lib/refer/version.rb

@@ -1,3 +1,3 @@
 module Refer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.0
-description: Referral codes for Ruby on Rails apps
+description: Referral codes & affiliate links for Ruby on Rails apps
 email:
 - excid3@gmail.com
 executables: []
@@ -43,6 +43,8 @@ files:
 - config/routes.rb
 - db/migrate/20240611180738_create_refer_referrals.rb
 - db/migrate/20240611183349_create_refer_referral_codes.rb
+- lib/generators/refer/install/USAGE
+- lib/generators/refer/install/install_generator.rb
 - lib/generators/refer/model/USAGE
 - lib/generators/refer/model/model_generator.rb
 - lib/refer.rb
@@ -74,5 +76,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: Referral codes for Ruby on Rails apps
+summary: Referral codes & affiliate links for Ruby on Rails apps
 test_files: []