shopify-gold 2.0.0.pre

data/app/operations/gold/select_tier_op.rb

@@ -0,0 +1,58 @@
+module Gold
+  module Outcomes
+    CannotSelectTier = Class.new(Failure)
+    SameTier = Class.new(Success)
+  end
+
+  # Allows a merchant to select their initial tier or change their tier.
+  class SelectTierOp
+    include Outcomes
+
+    def initialize(billing, tier, enforce_locking = true)
+      @billing = billing
+      @tier = tier
+      @enforce_locking = enforce_locking
+    end
+
+    def call
+      @billing.transaction do
+        return CannotSelectTier.new(:nil) unless @tier
+        return CannotSelectTier.new(:locked) if @enforce_locking && @tier.locked?
+
+        unless @billing.qualifies_for_tier?(@tier)
+          return CannotSelectTier.new(:disqualified)
+        end
+
+        # Mark the tier as selected
+        if @billing.transition_to(:select_tier, tier_id: @tier.id)
+        elsif @billing.transition_to(:change_tier, tier_id: @tier.id)
+        else
+          message = "Cannot transition from '#{@billing.current_state}' " \
+                    "to 'select_tier' or 'change_tier'"
+          raise Statesman::TransitionFailedError, message
+        end
+
+        # Mark the beginning of the trial if it hasn't been set already
+        @billing.update(trial_starts_at: Time.current) unless @billing.trial_starts_at
+
+        # Process the tier selection, creating charges if necessary
+        if @billing.shopify_plan.affiliate?
+          @billing.tier = @tier
+          @billing.save!
+          @billing.transition_to!(:affiliate)
+          return TierApplied.new
+        elsif @billing.shopify_plan.staff?
+          @billing.tier = @tier
+          @billing.save!
+          @billing.transition_to!(:staff)
+          return TierApplied.new
+        elsif @tier.free?
+          return ApplyTierOp.new(@billing).call
+        else
+          # A valid charge is necessary before applying the new tier
+          return ChargeNeeded.new
+        end
+      end
+    end
+  end
+end

data/app/operations/gold/suspend_op.rb

@@ -0,0 +1,21 @@
+module Gold
+  # Invoked when Helium suspends a merchant for violating ToS.
+  class SuspendOp
+    include Outcomes
+
+    def initialize(billing)
+      @billing = billing
+    end
+
+    def call
+      @billing.transition_to_or_stay_in!(:marked_as_suspended)
+
+      # Communicate suspension to the merchant.
+      BillingMailer.suspension(@billing).deliver_now
+
+      @billing.transition_to!(:suspended)
+
+      Success.new
+    end
+  end
+end

data/app/operations/gold/uninstall_op.rb

@@ -0,0 +1,20 @@
+module Gold
+  # Invoked when a shop has uninstalled this app.
+  class UninstallOp
+    include Outcomes
+
+    def initialize(billing)
+      @billing = billing
+    end
+
+    def call
+      return Success.new if @billing.current_state == :uninstalled
+
+      @billing.transition_to_or_stay_in!(:marked_as_uninstalled)
+      @billing.transition_to!(:uninstalled)
+      Gold.configuration.on_uninstall&.call(@billing)
+
+      Success.new
+    end
+  end
+end

data/app/operations/gold/unsuspend_op.rb

@@ -0,0 +1,20 @@
+module Gold
+  # Invoked when Helium unsuspends a shop.
+  class UnsuspendOp
+    include Outcomes
+
+    def initialize(billing)
+      @billing = billing
+    end
+
+    def call
+      if @billing.can_transition_to?(:affiliate)
+        @billing.transition_to!(:affiliate)
+      else
+        @billing.transition_to!(:check_charge)
+      end
+
+      Success.new
+    end
+  end
+end

data/app/views/gold/admin/billing/_active_charge.erb

@@ -0,0 +1,29 @@
+<div class="card mb-3">
+  <div class="card-header">
+    <strong>Active charge</strong>
+  </div>
+  <div class="card-body">
+    <% billing.shop.with_shopify_session do %>
+      <% charge = @active_charge %>
+      <% if charge %>
+        <% if charge.test %>
+          <span class="badge badge-warning">test charge</span>
+          <hr>
+        <% end %>
+        <p>Name<br> <strong><%= charge.name %></strong></p>
+        <p>ID<br> <strong><%= charge.id %></strong></p>
+        <p>Monthly<br> <strong>$<%= charge.price %></strong></p>
+        <p>Trial days<br> <strong><%= charge.trial_days %></strong></p>
+        <p>Created at<br> <strong><%= DateTime.parse(charge.created_at).strftime("%Y-%m-%e %H:%M") %></strong></p>
+        <p>Trial ends on<br> <strong><%= charge.trial_ends_on %></strong></p>
+        <p>Next billing<br> <strong><%= charge.billing_on %></strong></p>
+
+        <%= form_tag(gold_admin_engine.cancel_charge_path(id: billing.id, charge_id: charge.id), method: :delete) do %>
+          <%= submit_tag 'Cancel charge', class: "btn btn-danger", data: {confirm: "Are you really sure you want to cancel this charge?"} %>
+        <% end %>
+      <% else %>
+        No charge from Shopify
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/views/gold/admin/billing/_credit.erb

@@ -0,0 +1,46 @@
+<% billing.shop.with_shopify_session do %>
+  <% credits = @credits %>
+  <div class="card mb-3">
+    <div class="card-header">
+      <strong>Credit</strong>
+    </div>
+    <div class="card-body">
+      <h6>Credits</h6>
+      <% if credits.any? %>
+        <table class="table celled">
+          <thead>
+            <tr>
+              <th>Reason</th>
+              <th>Amount</th>
+            </tr>
+          </thead>
+          <tbody>
+            <% billing.shop.with_shopify_session do %>
+              <% ShopifyAPI::ApplicationCredit.all.each do |credit| %>
+                <tr>
+                  <%= credit.description %>
+                  <% if credit.test %>
+                    <strong>(test)</strong>
+                  <% end %>
+                </tr>
+                <tr><%= credit.amount %></tr>
+              <% end %>
+            <% end %>
+          </tbody>
+        </table>
+      <% else %>
+        <p>No active credits</p>
+      <% end %>
+      <hr>
+      <%= form_tag(gold_admin_engine.issue_credit_path(id: billing.id), method: :post) do %>
+        <p>Give the merchant a credit for next month (in dollars)</p>
+        <%= number_field_tag 'amount', 0, size: 3 %>
+        <%= text_field_tag 'reason', '', placeholder: 'Reason to merchant' %>
+        <div>
+          <hr>
+          <%= submit_tag 'Issue Credit', class: "btn btn-primary" %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+<% end %>

data/app/views/gold/admin/billing/_discount.erb

@@ -0,0 +1,23 @@
+<div class="card mb-3">
+  <div class="card-header">
+    <strong>Discount</strong>
+  </div>
+  <div class="card-body">
+    <%= form_tag(gold_admin_engine.apply_discount_path(id: billing.id), method: :put) do %>
+      <input 
+        type="number" 
+        name="percentage" 
+        min="0"
+        max="100"
+        value="<%= billing.discount_percentage %>">%
+      <div>
+        <hr>
+        <% if billing.can_transition_to?(:apply_discount) %>      
+          <%= submit_tag 'Apply discount', class: "btn btn-primary", data: {confirm: "Are you really sure you want to apply this discount?"} %>
+        <% else %>
+          <p>Discount cannot be applied in the current state</p>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/gold/admin/billing/_history.erb

@@ -0,0 +1,65 @@
+
+<div class="card">
+  <div class="card-header">
+    <strong>History</strong>
+  </div>
+  <div class="card-body">
+    <p>These are all the billing-related events that have happened. 
+    Only forcefully transition to a state as a last resort.</p>
+
+    <div class="mb-4">
+      <%= form_tag(gold_admin_engine.transition_path, method: :put) do %>
+        <input type="hidden" name="id" value="<%= billing.id %>">
+        <div>
+          Transition from <mark><%= billing.current_state %></mark>
+          &rarr;
+          <select name="to" class="mr-2">
+            <option value="">Select a state...</option>
+            <% Gold::Machine.successors.with_indifferent_access[billing.current_state].each do |transition| %>
+              <option><%= transition %></option>
+            <% end %>
+          </select>
+        </div>
+        <div class="mb-2 mt-2">
+          Metadata: 
+          <input type="text" name="metadata[key]" placeholder="key">
+          <input type="text" name="metadata[value]" placeholder="value">
+        </div>
+        <%= submit_tag 'Transition', class: "btn btn-primary" %>
+      <% end %>
+    </div>
+    <div style="max-height: 500px; overflow: auto;">
+      <table class="table table-sm table-dark">
+        <thead>
+          <tr>
+            <th>Date</th>
+            <th>State</th>
+            <th>Metadata</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% last_transition = nil %>
+          <% billing.state_machine.history.where.not(to_state: "check_charge").reverse.each do |transition| %>
+            <%# This hides all the check_charges and back to billing %>
+            <% if transition.to_state == "billing" %>
+              <% unless last_transition&.to_state == "billing" %>
+                <tr>
+                  <td><%= transition.created_at.localtime.strftime("%Y-%m-%e %H:%M") %></td>
+                  <td><%= transition.to_state %></td>
+                  <td><%= transition.metadata %></td>
+                </tr>
+              <% end %>
+            <% else %>
+              <tr>
+                <td><%= transition.created_at.localtime.strftime("%Y-%m-%e %H:%M") %></td>
+                <td><%= transition.to_state %></td>
+                <td><%= transition.metadata %></td>
+              </tr>
+            <% end %>
+            <% last_transition = transition %>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>

data/app/views/gold/admin/billing/_overview.erb

@@ -0,0 +1,14 @@
+<%= render "gold/admin/billing/state", billing: billing %>
+<% tier = billing.tier %>
+<% if tier %>
+  <%= render "gold/admin/billing/tier", billing: billing, tier: tier %>
+<% end %>
+<%= render "gold/admin/billing/active_charge", billing: billing %>
+<%= render "gold/admin/billing/status", billing: billing %>
+<%= render "gold/admin/billing/discount", billing: billing %>
+<% if tier %>
+  <%= render "gold/admin/billing/trial_days", billing: billing %>
+<% end %>
+<%= render "gold/admin/billing/credit", billing: billing %>
+<%= render "gold/admin/billing/shopify_plan", billing: billing %>
+<%= render "gold/admin/billing/history", billing: billing %>

data/app/views/gold/admin/billing/_shopify_plan.erb

@@ -0,0 +1,21 @@
+<div class="card mb-3">
+  <div class="card-header">
+    <strong>Shopify Plan Override</strong>
+  </div>
+  <div class="card-body">
+    <%= form_tag(gold_admin_engine.override_shopify_plan_path(id: billing.id), method: :put) do %>
+      <p>
+        Actual Shopify plan: 
+        <span class="badge badge-info"><%= billing.shop.shopify_plan_name %></span>
+      </p>
+      <input 
+        type="text" 
+        name="plan" 
+        value="<%= billing.shopify_plan_override %>">
+      <div>
+        <hr>
+        <%= submit_tag 'Override', class: "btn btn-primary", data: {confirm: "Are you really sure you want to override plan?"} %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/gold/admin/billing/_state.erb

@@ -0,0 +1,26 @@
+<div class="card mb-3">
+  <div class="card-header"><strong>Status</strong></div>
+  <div class="card-body">
+    <h3 class="badge
+      <% if billing.state_machine.accepted? %>
+        badge-success
+      <% else %>
+        badge-warning
+      <% end %>">
+      <%= billing.current_state %>
+      <% metadata = billing.transitions.last&.metadata %>
+      <% if metadata&.keys&.any? %>
+        &rarr;
+        <%= metadata.to_a.join(": ") %>
+      <% end %>
+    </h3>
+
+    <% if billing.can_transition_to?(:optional_charge_declined) %>
+      <%= form_tag(gold_admin_engine.transition_path(id: billing.id), method: :put) do %>
+        <input type="hidden" name="to[]" value="optional_charge_declined">
+        <input type="hidden" name="to[]" value="billing">
+        <%= submit_tag 'Decline', class: "btn btn-danger btn-sm", data: { confirm: "Are you sure you want to decline this charge?" } %>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/views/gold/admin/billing/_status.erb

@@ -0,0 +1,25 @@
+<div class="card mb-3">
+  <div class="card-header">
+    <strong>Account status</strong>
+  </div>
+  <div class="card-body">
+    <% if billing.current_state.to_s.include?("suspended") %>
+      <p>This account is currently <strong>suspended</strong></p>
+      <%= form_tag(gold_admin_engine.unsuspend_path(id: billing.id), method: :put) do %>
+        <%= submit_tag 'Unsuspend', data: {confirm: "Are you really sure you want to UNSUSPEND this account?"} %>
+      <% end %>
+    <% else %>
+      <p>This account is currently <strong>allowed</strong></p>
+      <% if billing.can_transition_to? :marked_as_suspended %>
+        <%= form_tag(gold_admin_engine.suspend_path(id: billing.id), method: :put) do %>
+          <div>
+            <label>
+              <input type="checkbox" name="confirm_suspend"> Yes I want to suspend this account
+            </label>
+          </div>
+          <%= submit_tag 'Confirm suspend', class:"btn btn-secondary btn-danger", data: {confirm: "Are you really sure you want to SUSPEND this account?"} %>
+        <% end %>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/views/gold/admin/billing/_tier.erb

@@ -0,0 +1,155 @@
+<div class="card mb-3">
+  <div class="card-header"><strong>Tier</strong></div>
+  <div class="card-body">
+    <table class="table">
+      <tr>
+        <td><h6>Plan</h6></td>
+        <td><h6>Plan ID</h6></td>
+        <td><h6>Monthly price</h6></td>
+        <td><h6>Plan trial days</h6></td>
+        <td><h6>Trial days left</h6></td>
+        <td><h6>Features</h6></td>
+      </tr>
+      <% next_tier = billing.last_selected_tier %>
+      <% if tier.id != next_tier.id %>
+        <tr>
+          <td><%= next_tier.name %> <span class="badge badge-warning">pending</span></td>
+          <td>
+            <span class="badge badge-info"><%= next_tier.id %></span>
+          </td>
+          <td>
+            <% next_tier_price = next_tier.monthly_price %>
+            <% next_tier_calc_price = billing.calculate_price(next_tier) %>
+
+            <% if next_tier_price != next_tier_calc_price %>
+              <s><%= number_to_currency(next_tier_price) %></s>
+            <% end %>
+
+            <%= number_to_currency(next_tier_calc_price) %>
+          </td>
+          <td><%= next_tier.trial_days %></td>
+          <td><%= billing.calculate_trial_days(next_tier) %></td>
+          <td>
+            <% next_tier.features.each do |feature| %>
+              <div>
+                <span class="badge badge-success"><%= feature.join(": ") %></span>
+              </div>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+
+      <% if tier %>
+        <tr>
+          <td><%= tier.name %> <span class="badge badge-success">active</span></td>
+          <td>
+            <span class="badge badge-info"><%= tier.id %></span>
+          </td>
+          <td>
+            <% tier_price = tier.monthly_price %>
+            <% tier_calc_price = billing.calculate_price(tier) %>
+            
+            <% if tier_price != tier_calc_price %>
+            <s><%= number_to_currency(tier_price) %></s>
+            <% end %>
+            
+            <%= number_to_currency(tier_calc_price) %>
+          </td>
+          <td><%= tier.trial_days %></td>
+          <td><%= billing.calculate_trial_days(tier) %></td>
+          <td>
+            <% tier.features.each do |feature| %>
+              <div>
+                <span class="badge badge-success"><%= feature.join(": ") %></span>
+              </div>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+    </table>
+    <hr>
+    <% if billing.can_transition_to?(:change_tier) %>
+      <%= form_tag(gold_admin_engine.change_tier_path(id: billing.id), method: :put) do %>
+        Change tier &rarr;
+        <select name="tier" class="mr-2">
+          <option value="">Select a tier...</option>
+          <%= Gold::Tier.all.each do |_tier| %>
+            <% price_difference = _tier.monthly_price - tier.monthly_price %>
+            <option value="<%= _tier.id %>" <% if _tier.locked? %>disabled<% end %>>
+              <%= _tier.name %>
+              <% if _tier.free? %>
+                (free)
+              <% elsif price_difference > 0 %>
+                (+<%= number_to_currency(price_difference) %>)
+              <% elsif price_difference < 0 %>
+              (-<%= number_to_currency(price_difference.abs) %>)
+              <% end %>
+
+              <% if _tier.locked? %>(locked)<% end %>
+            </option>
+          <% end %>
+        </select>
+        <%= submit_tag 'Apply', class: "btn btn-primary btn-sm" %>
+      <% end %>
+    <% else %>
+      <p>Can't change tiers, because the current state doesn't allow it</p>
+    <% end %>
+    <br />
+    <a data-toggle="collapse" href="#collapsePlans" role="button" aria-expanded="false" aria-controls="collapsePlans">
+      See all plans
+    </a>
+    
+    <table id="collapsePlans" class="table celled collapse">
+      <thead>
+        <tr>
+          <th>ID</th>
+          <th>Name</th>
+          <th>Monthly price</th>
+          <th>Trial days</th>
+          <th>Features</th>
+          <th>Qualifications</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% Gold::Tier.all.each do |tier| %>
+          <tr>
+            <td><%= tier.id %></td>
+            <td>
+              <%= tier.name %>
+
+              <div>
+                <% if tier.locked? %>
+                  <span class="badge badge-warning">locked</span>
+                <% end %>
+  
+                <% if tier.free? %>
+                  <span class="badge badge-info">free</span>
+                <% end %>
+  
+                <% unless tier.visible? %>
+                  <span class="badge badge-secondary">hidden</span>
+                <% end %>
+              </div>
+            </td>
+            <td><%= number_to_currency(tier.monthly_price) %></td>
+            <td><%= tier.trial_days %></td>
+            <td>
+              <% tier.features.each do |feature| %>
+                <div>
+                  <span class="badge badge-success"><%= feature.join(": ") %></span>
+                </div>
+              <% end %>
+            </td>
+            <td>
+              <% tier.qualifications.each do |qual| %>
+                <div>
+                  <span class="badge badge-danger"><%= qual.join(": ") %></span>
+                </div>
+              <% end %>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>

data/app/views/gold/admin/billing/_trial_days.erb

@@ -0,0 +1,42 @@
+<div class="card mb-3">
+  <div class="card-header">
+    <strong>Trial Days</strong>
+  </div>
+  <div class="card-body">
+    <% if billing.trial_starts_at %>
+      <p>
+        Trial started at:
+        <strong><%= billing.trial_starts_at.localtime.strftime("%Y-%m-%e %H:%M") %></strong>
+      </p>
+
+      <p>
+        Trial days left:
+        <strong><%= billing.trial_days_left %></strong>
+      </p>
+
+      <hr>
+
+      <%= form_tag(gold_admin_engine.reset_trial_days_path(id: billing.id), method: :put) do %>
+        <input type="hidden" name="trial_action" value="reset">
+        <p>
+          Start the trial over starting today. The merchant won't be forced to update charge.
+        </p>
+        <%= submit_tag 'Reset trial', class: "btn btn-primary", data: {confirm: "You sure?"} %>
+      <% end %>
+
+      <hr>
+
+      <%= form_tag(gold_admin_engine.reset_trial_days_path(id: billing.id), method: :put) do %>
+        <input type="hidden" name="trial_action" value="clear">
+        <p>
+          Clear the trial and only start again once they choose a plan. The merchant will be 
+          prompted to accept a new charge if they already have one.
+        </p>
+        <%= submit_tag 'Clear trial', class: "btn btn-secondary", data: {confirm: "You sure?"} %>
+      <% end %>
+
+    <% else %>
+      <p>Trial not started yet</p>
+    <% end %>
+  </div>
+</div>

data/app/views/gold/billing/_inner_head.html.erb

@@ -0,0 +1 @@
+<%# Override this in your app %>

data/app/views/gold/billing/declined_charge.html.erb

@@ -0,0 +1,20 @@
+<p class="Polaris-DisplayText Polaris-DisplayText--sizeLarge">
+  Charge declined
+</p>
+<p>
+  We couldn't process your payment because you declined the charge from Shopify.
+</p>
+<div style="height: 25px;"></div>
+
+<%= form_tag(retry_charge_path, method: :post) do %>
+  <a class="Polaris-Button" href="<%= tier_path %>">Choose a plan</a>
+  <span style="padding: 0 10px;">or</span>
+  <button 
+    type="submit" 
+    class="Polaris-Button Polaris-Button--primary">
+    <span class="Polaris-Button__Content">
+      <span class="Polaris-Button__Text">Try again</span>
+    </span>
+  </button>
+  </p>
+<% end %>

data/app/views/gold/billing/expired_charge.html.erb

@@ -0,0 +1,14 @@
+<p class="Polaris-DisplayText Polaris-DisplayText--sizeLarge">
+  Your app charge has expired
+</p>
+<p>Please accept a new charge before continuing.</p>
+<div style="height: 25px;"></div>
+<%= form_tag(retry_charge_path, method: :post) do %>
+  <button 
+    type="submit" 
+    class="Polaris-Button Polaris-Button--primary">
+    <span class="Polaris-Button__Content">
+      <span class="Polaris-Button__Text">Try again</span>
+    </span>
+  </button>
+<% end %>

data/app/views/gold/billing/missing_charge.html.erb

@@ -0,0 +1,22 @@
+<p class="Polaris-DisplayText Polaris-DisplayText--sizeLarge">
+  Missing app charge
+</p>
+
+<p>
+  We have checked our records and Shopify's and we cannot find your recurring
+  charge for <%= Gold.configuration.app_name %>. The following might prompt you to approve a new charge with
+  Shopify. Don't worry, this will replace any existing charge so you won't be
+  double-charged.
+</p>
+
+<div style="height: 25px;"></div>
+
+<%= form_tag(retry_charge_path, method: :post) do %>
+  <button 
+    type="submit" 
+    class="Polaris-Button Polaris-Button--primary">
+    <span class="Polaris-Button__Content">
+      <span class="Polaris-Button__Text">Continue</span>
+    </span>
+  </button>
+<% end %>

data/app/views/gold/billing/outstanding_charge.html.erb

@@ -0,0 +1,12 @@
+<p class="Polaris-DisplayText Polaris-DisplayText--sizeLarge">
+  Outstanding app charge
+</p>
+
+<p>
+  Please approve this charge before continuing. You will be redirected to Shopify's billing
+  to accept this charge.
+</p>
+
+<div style="height: 25px;"></div>
+
+<a class="Polaris-Button Polaris-Button--primary" href="<%= @confirmation_url %>">View charges</a>

data/app/views/gold/billing/suspended.html.erb

@@ -0,0 +1,8 @@
+<p class="Polaris-DisplayText Polaris-DisplayText--sizeLarge">
+  Your store is currently suspended
+</p>
+
+<p>
+  We have sent you an email about this. Please reach out to support so
+  that we can resolve this.
+</p>