shopify-gold 3.3.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a5ac7dc8ec8aae821dae0eac89a2decbcca38f65439f9376feef1fc83cd853
-  data.tar.gz: f0d81a473d9349838d77dc764cd05a222d8375db54d2f3ef3693adb22b2edc21
+  metadata.gz: 9fcecad6aca73ac1e0cc4f97b8f819d35907c32aa1bb00e40e6bbb19e35fc328
+  data.tar.gz: 74f433ee134487242e44fa145273eacbc5a3bc933826490c1a024f34d7d10b89
 SHA512:
-  metadata.gz: 0d196f6ca18058e5c5fa9b48630b528607d6397666a67216e6a81103242df58da7156b657ca867d83f003eae5588ab53456b474bc7863e67cff10dba7a0aeecf
-  data.tar.gz: 1a95630918a319db140fe95816253876acaf6f3b1b504d5a1f1b6f2e9077c54d9b3192dd2ce49c9ec2f9e1d92096af187312903c794f757f35a76f61998ef322
+  metadata.gz: 2b0fcb9fa69c799007609982fc77717bc09efd13921373561e122c42b29a472bac7a51fc941c86ae57f5ccbcdd2c715970a8ee9f61b5b901ca8bcbe4c652f894
+  data.tar.gz: d0408016b0e8995a3e3f57957b6fe0a42c7f1cb5fc8c6d527fbf7f1c0f67a02612f7cf31f389936954792c728a768d75ec7cf6839e7f40dbb39f2b9ca0f0e835

data/app/assets/images/gold/aside-bg.svg

@@ -3,11 +3,8 @@
 <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
 	 viewBox="0 0 656 672" style="enable-background:new 0 0 656 672;" xml:space="preserve">
 <style type="text/css">
-	.st0{filter:url(#Adobe_OpacityMaskFilter);}
-	.st1{fill-rule:evenodd;clip-rule:evenodd;fill:#FFFFFF;}
-	.st2{mask:url(#mask-2_1_);fill:none;stroke:url(#Path-8_1_);}
-	.st3{filter:url(#Adobe_OpacityMaskFilter_1_);}
-	.st4{mask:url(#mask-2_2_);fill:none;stroke:url(#Path-9_1_);}
+	.st0{fill:none;stroke:url(#Path-8_1_);stroke-width:2;}
+	.st1{fill:none;stroke:url(#Path-9_1_);stroke-width:2;}
 </style>
 <title>Path 8 + Path 9 Mask</title>
 <desc>Created with Sketch.</desc>
@@ -16,38 +13,18 @@
 		<g transform="translate(720.000000, 143.000000)">
 			<g id="Mask">
 			</g>
-			<defs>
-				<filter id="Adobe_OpacityMaskFilter" filterUnits="userSpaceOnUse" x="-3.5" y="47.3" width="278.5" height="654.4">
-					<feColorMatrix  type="matrix" values="1 0 0 0 0  0 1 0 0 0  0 0 1 0 0  0 0 0 1 0"/>
-				</filter>
-			</defs>
-			<mask maskUnits="userSpaceOnUse" x="-3.5" y="47.3" width="278.5" height="654.4" id="mask-2_1_">
-				<g class="st0">
-					<rect id="path-1_1_" class="st1" width="668" height="735"/>
-				</g>
-			</mask>
 			
-				<linearGradient id="Path-8_1_" gradientUnits="userSpaceOnUse" x1="-354.1977" y1="748.4078" x2="-353.0956" y2="748.4737" gradientTransform="matrix(-188.4878 -657.335 -167.9035 48.1456 59202.0664 -268195.8125)">
+				<linearGradient id="Path-8_1_" gradientUnits="userSpaceOnUse" x1="-276.2975" y1="-132.512" x2="-274.6546" y2="-132.6103" gradientTransform="matrix(-188.4878 -657.335 167.9035 -48.1456 -29446.4434 -187179.9844)">
 				<stop  offset="0" style="stop-color:#5801E3"/>
 				<stop  offset="1" style="stop-color:#42E59A"/>
 			</linearGradient>
-			<path id="Path-8" class="st2" d="M197.9,701.4C346.2,421.8,279.1,203.9-3.3,47.7"/>
-			<defs>
-				<filter id="Adobe_OpacityMaskFilter_1_" filterUnits="userSpaceOnUse" x="-3.4" y="24.1" width="659.1" height="526.6">
-					<feColorMatrix  type="matrix" values="1 0 0 0 0  0 1 0 0 0  0 0 1 0 0  0 0 0 1 0"/>
-				</filter>
-			</defs>
-			<mask maskUnits="userSpaceOnUse" x="-3.4" y="24.1" width="659.1" height="526.6" id="mask-2_2_">
-				<g class="st3">
-					<rect id="path-1_2_" class="st1" width="668" height="735"/>
-				</g>
-			</mask>
+			<path id="Path-8" class="st0" d="M197.9,701.4C346.2,421.8,279.1,203.9-3.3,47.7"/>
 			
-				<linearGradient id="Path-9_1_" gradientUnits="userSpaceOnUse" x1="-353.4046" y1="750.621" x2="-353.7825" y2="749.4943" gradientTransform="matrix(65.1755 -411.5021 -723.7028 -114.6233 566150.875 -59200.8633)">
+				<linearGradient id="Path-9_1_" gradientUnits="userSpaceOnUse" x1="-275.2401" y1="-135.0266" x2="-275.7359" y2="-133.5487" gradientTransform="matrix(65.1755 -411.5021 723.7028 114.6233 115344.25 -97625.6484)">
 				<stop  offset="0" style="stop-color:#5801E3"/>
 				<stop  offset="1" style="stop-color:#FC4646"/>
 			</linearGradient>
-			<path id="Path-9" class="st4" d="M-2.9,24.3c120.7,306.3,340.2,481.6,658.6,525.9"/>
+			<path id="Path-9" class="st1" d="M-2.9,24.3c120.7,306.3,340.2,481.6,658.6,525.9"/>
 		</g>
 	</g>
 </g>

data/app/controllers/gold/admin/admin_controller.rb

@@ -0,0 +1,10 @@
+module Gold
+  module Admin
+    # Main controller for Gold admin to be used in app
+    class AdminController < ApplicationController
+      credentials = Gold.configuration.admin_credentials
+      http_basic_authenticate_with name: credentials[:user],
+                                   password: credentials[:password]
+    end
+  end
+end

data/app/controllers/gold/admin/billing_controller.rb

@@ -1,11 +1,7 @@
 module Gold
   module Admin
     # Main controller for Gold to be used in app
-    class BillingController < ApplicationController
-      credentials = Gold.configuration.admin_credentials
-      http_basic_authenticate_with name: credentials[:user],
-                                   password: credentials[:password]
-
+    class BillingController < AdminController
       around_action :shopify_session
 
       rescue_from Statesman::TransitionFailedError,

data/app/controllers/gold/admin/referrals_controller.rb

@@ -0,0 +1,41 @@
+module Gold
+  module Admin
+    class ReferralsController < AdminController
+      def create
+        referral = Referral.new(referral_params)
+
+        if referral.save
+          flash[:success] = "Created new referrer"
+        else
+          message = referral.errors.full_messages.join(", ")
+          flash[:danger] = "Failed to create, #{message}"
+        end
+
+        redirect_back(fallback_location: "/admin")
+      end
+
+      def update
+        referral = Referral.find(params[:id])
+
+        if referral.update(referral_params)
+          flash[:success] = "Update referrer"
+        else
+          message = referral.errors.full_messages.join(", ")
+          flash[:danger] = "Failed to update, #{message}"
+        end
+
+        redirect_back(fallback_location: "/admin")
+      end
+
+      private
+
+      def referral_params
+        params.require(:referral).permit(:contact_name,
+                                         :contact_email,
+                                         :company,
+                                         :code,
+                                         :discount_percentage)
+      end
+    end
+  end
+end

data/app/controllers/gold/billing_controller.rb

@@ -41,6 +41,19 @@ module Gold
     # Show the possible tiers to select from.
     def tier
       billing # Expose the @billing variable to the view
+
+      # Apply a referral tracking. Don't overwrite an existing code
+      if !billing.referral && session[:gold_referral_code]
+        referral = Gold::Referral.find_by(code: session[:gold_referral_code])
+
+        if referral
+          billing.referral = referral
+          billing.update(
+            discount_percentage: referral.discount_percentage || 0
+          )
+        end
+      end
+
       @tiers = Tier.visible
     end
 

data/app/controllers/gold/referrals_controller.rb

@@ -0,0 +1,12 @@
+module Gold
+  # Handles referral tracking
+  class ReferralsController < ApplicationController
+    def track
+      referral = Referral.find_by(code: params[:code])
+
+      session[:gold_referral_code] = referral.code if referral
+
+      redirect_to Gold.configuration.referral_redirect_url
+    end
+  end
+end

data/app/models/gold/billing.rb

@@ -35,6 +35,10 @@ module Gold
 
     # rubocop:disable Rails/ReflectionClassName
     belongs_to :shop, class_name: Gold.shop_class.to_s
+    belongs_to :referral, class_name: "Gold::Referral",
+                          foreign_key: "gold_referral_id",
+                          inverse_of: :billings,
+                          optional: true
     has_many :transitions, class_name: transition_class.to_s,
                            autosave: false,
                            dependent: :destroy

data/app/models/gold/referral.rb

@@ -0,0 +1,23 @@
+module Gold
+  # A referral can be assigned to a billing record, which can be helpful for
+  # tracking affiliates with discount codes
+  class Referral < ApplicationRecord
+    has_many :billings, dependent: :nullify,
+                        foreign_key: "gold_referral_id",
+                        inverse_of: "referral"
+
+    validates :code, presence: true, uniqueness: true
+    validates :discount_percentage, numericality: {
+      greater_than_or_equal_to: 0,
+      less_than_or_equal_to: 100
+    }
+
+    before_validation :ensure_code_format
+
+    private
+
+    def ensure_code_format
+      self.code = code.parameterize.underscore.upcase
+    end
+  end
+end

data/app/views/gold/admin/referrals/_billings.erb

@@ -0,0 +1,42 @@
+<div class="card mb-3">
+  <div class="card-header">
+    <strong>Merchants</strong>
+  </div>
+  <div class="card-body">
+    <% if billings.any? %>
+      <table class="table celled">
+        <thead>
+          <tr>
+            <th>Domain</th>
+            <th>Sign up</th>
+            <th>Plan</th>
+            <th>Monthly price</th>
+            <th>Installed</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% billings.each do |billing| %>
+            <% shop = billing.shop %>
+            <tr>
+              <td><%= shop.domain %></td>
+              <td><%= time_ago_in_words(shop.created_at) %> ago</td>
+              <td><%= billing&.tier&.id %></td>
+              <td>
+                <%= number_to_currency(shop.monthly_price / 100) %>
+              </td>
+              <td>
+                <% if shop.installed? %>
+                  <span class="green">Yes</span>
+                <% else %>
+                  <span class="red">No</span>
+                <% end %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    <% else %>
+      <p>No shops</p>
+    <% end %>
+  </div>
+</div>

data/app/views/gold/admin/referrals/_form.erb

@@ -0,0 +1,28 @@
+<%= form_for(referral, url: referral.new_record? ? gold_admin_engine.referrals_path : gold_admin_engine.referral_path(referral.id)) do |f| %>
+  <div class="form-group">
+    <label>Full name</label>
+    <%= f.text_field :contact_name, class: "form-control" %>
+  </div>
+
+  <div class="form-group">
+    <label>Email</label>
+    <%= f.email_field :contact_email, class: "form-control" %>
+  </div>
+
+  <div class="form-group">
+    <label>Company</label>
+    <%= f.text_field :company, class: "form-control" %>
+  </div>
+
+  <div class="form-group">
+    <label>Code</label>
+    <%= f.text_field :code, class: "form-control" %>
+  </div>
+
+  <div class="form-group">
+    <label>Discount percentage</label>
+    <%= f.number_field :discount_percentage, class: "form-control", min: 0, max: 100 %>
+  </div>
+
+  <%= f.submit class: "btn btn-primary" %>
+<% end %>

data/config/routes.rb

@@ -16,6 +16,8 @@ Gold::Engine.routes.draw do
   get "/unavailable", to: "billing#unavailable", as: "unavailable"
 
   get "/uninstalled", to: "billing#uninstalled", as: "uninstalled"
+
+  get "/referral", to: "referrals#track", as: "referral"
 end
 
 Gold::AdminEngine.routes.draw do
@@ -30,4 +32,9 @@ Gold::AdminEngine.routes.draw do
     put '/override_shopify_plan', to: 'admin/billing#override_shopify_plan', as: 'override_shopify_plan'
     delete '/charge/:id', to: 'admin/billing#cancel_charge', as: 'cancel_charge'
   end
+
+  scope :referrals do
+    post "/", to: "admin/referrals#create", as: "referrals"
+    patch "/:id", to: "admin/referrals#update", as: "referral"
+  end
 end

data/db/migrate/04_create_gold_referrals.rb

@@ -0,0 +1,15 @@
+class CreateGoldReferrals < ActiveRecord::Migration[5.2]
+  def change
+    create_table :gold_referrals do |t|
+      t.string :contact_name
+      t.string :contact_email
+      t.string :company
+      t.string :code, index: { unique: true }, null: false
+      t.integer :discount_percentage, default: 0
+
+      t.timestamps null: false
+    end
+
+    add_column :gold_billings, :gold_referral_id, :integer
+  end
+end

data/lib/gold/configuration.rb

@@ -12,7 +12,8 @@ module Gold
                   :days_until_delinquent,
                   :days_until_cleanup,
                   :shop_domain_attribute,
-                  :force_embedded_redirect
+                  :force_embedded_redirect,
+                  :referral_redirect_url
 
     # Callbacks
     attr_accessor :on_terms,
@@ -67,6 +68,10 @@ module Gold
 
       # If Gold is allowed to cancel charges (paid -> free) automatically
       @allow_automated_charge_cancellation = true
+
+      # The URL to follow after a referral code is tracked
+      # (e.g. https://apps.shopify.com/customr)
+      @referral_redirect_url = "/"
     end
 
     def shop_class

data/lib/gold/version.rb

@@ -1,3 +1,3 @@
 module Gold
-  VERSION = "3.3.1".freeze
+  VERSION = "4.0.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify-gold
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Andrew Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2020-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -211,11 +211,14 @@ files:
 - app/assets/javascripts/gold/billing.js
 - app/assets/stylesheets/gold/billing.sass
 - app/assets/stylesheets/shopify/polaris.css
+- app/controllers/gold/admin/admin_controller.rb
 - app/controllers/gold/admin/billing_controller.rb
+- app/controllers/gold/admin/referrals_controller.rb
 - app/controllers/gold/application_controller.rb
 - app/controllers/gold/authenticated_controller.rb
 - app/controllers/gold/billing_controller.rb
 - app/controllers/gold/concerns/merchant_facing.rb
+- app/controllers/gold/referrals_controller.rb
 - app/jobs/gold/after_authenticate_job.rb
 - app/jobs/gold/app_uninstalled_job.rb
 - app/jobs/gold/application_job.rb
@@ -224,6 +227,7 @@ files:
 - app/models/gold/billing.rb
 - app/models/gold/concerns/gilded.rb
 - app/models/gold/machine.rb
+- app/models/gold/referral.rb
 - app/models/gold/shopify_plan.rb
 - app/models/gold/tier.rb
 - app/models/gold/transition.rb
@@ -254,6 +258,8 @@ files:
 - app/views/gold/admin/billing/_status.erb
 - app/views/gold/admin/billing/_tier.erb
 - app/views/gold/admin/billing/_trial_days.erb
+- app/views/gold/admin/referrals/_billings.erb
+- app/views/gold/admin/referrals/_form.erb
 - app/views/gold/billing/_inner_head.html.erb
 - app/views/gold/billing/declined_charge.html.erb
 - app/views/gold/billing/expired_charge.html.erb
@@ -276,6 +282,7 @@ files:
 - db/migrate/01_create_gold_billing.rb
 - db/migrate/02_create_gold_transitions.rb
 - db/migrate/03_add_foreign_key_to_billing.rb
+- db/migrate/04_create_gold_referrals.rb
 - lib/gold.rb
 - lib/gold/admin_engine.rb
 - lib/gold/billing_migrator.rb