shopify-gold 2.0.0.pre

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

@@ -0,0 +1,22 @@
+<h1>Terms of Service</h1>
+
+<% if @error %>
+  <p class="error">
+    You must accept the terms of service before continuing.
+  </p>
+<% end %>
+
+<p>
+  This is where a set of terms and conditions should go.
+</p>
+
+<% if @already_accepted %>
+  <p>
+    You have already accepted these terms.
+  </p>
+<% else %>
+  <%= form_tag(terms_path, method: :put) do %>
+    <%= submit_tag "Decline", name: "decline" %>
+    <%= submit_tag "Accept", name: "accept" %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,29 @@
+<h1>Select a Tier</h1>
+
+<p>
+  Here are the tiers that are available to you. You can always come back here
+  later and choose a different tier.
+</p>
+
+<%= form_tag(select_tier_path, method: :put) do %>
+  <% @tiers.each do |tier| %>
+    <div>
+      <% @current_tier = billing.tier == tier %>
+      <% @unavailable = !billing.qualifies_for_tier?(tier) %>
+      <label>
+        <%= radio_button_tag :tier, tier.id, @current_tier, disabled: @unavailable %>
+        <%= tier.name %>
+        <% if @current_tier && @unavailable %>
+          (This your current tier and you have outgrown it with your usage)
+        <% elsif @current_tier %>
+          (This is your current tier)
+        <% elsif @unavailable %>
+          (This tier is not available based on your current usage)
+        <% end %>
+      </label>
+    </div>
+  <% end %>
+
+  <%= link_to "Cancel", main_app.root_path %>
+  <%= submit_tag "Select" %>
+<% end %>

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

@@ -0,0 +1,9 @@
+<p class="Polaris-DisplayText Polaris-DisplayText--sizeLarge">
+  Request failed
+</p>
+
+<p>
+  We're sorry, but we couldn't respond to your request. Please try again
+  in a few minutes. If the problem persists, please reach out to our
+  support and we'll get right on it.
+</p>

data/app/views/gold/billing/unavailable.erb

@@ -0,0 +1,8 @@
+<p class="Polaris-DisplayText Polaris-DisplayText--sizeLarge">
+  Install unavailable
+</p>
+
+<p>Drat! We're sorry, but we couldn't install the app at this time. Please try again in a few minutes or contact our support.</p>
+<div style="height: 25px;"></div>
+<a class="Polaris-Button" href="<%= shopify_app.login_path %>">Try again</a>
+  

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

@@ -0,0 +1,13 @@
+<p class="Polaris-DisplayText Polaris-DisplayText--sizeLarge">
+  <%= Gold.configuration.app_name %> is uninstalled
+</p>
+
+
+<p>
+  It looks like you have uninstalled this app recently or your store was previously frozen.
+</p>
+<div style="height: 25px;"></div>
+<p>
+  <a class="Polaris-Button Polaris-Button--primary-button" 
+  href="<%= shopify_app.login_path %>">Reinstall</a>
+</p>

data/app/views/gold/billing_mailer/affiliate_to_paid.erb

@@ -0,0 +1,23 @@
+<h1>Please approve app charges</h1>
+<p>Hey <%= @shop.shop_owner %>,</p>
+
+<p>
+  We noticed that you've updated your store from a development shop 
+  to a paid plan. Feels good doesn't it?
+</p>
+
+<p>
+  Since we don't charge for partner stores, we haven't been charging 
+  you to use <%= Gold.configuration.app_name %>. Now that your store is live, you'll
+  have to approve a charge to continue using the app. 
+  <strong>
+    You must approve this charge within <%= Gold.configuration.days_until_delinquent %> days to avoid interruption of service.
+  </strong>
+</p>
+
+<p>
+  <a class="button" href="<%= @confirmation_url %>">Approve charge</a>
+</p>
+<div>
+  or <a href="<%= Gold.configuration.plan_comparison_url %>">compare plans</a>
+</div>

data/app/views/gold/billing_mailer/delinquent.html.erb

@@ -0,0 +1,21 @@
+<h1>Your account has been frozen</h1>
+<p>Hey <%= @shop.shop_owner %>,</p>
+<p>
+  We have suspended access to your <%= Gold.configuration.app_name %> usage because we
+  have not received an authorization of payment towards your new billing tier.
+</p>
+<p>
+  Please respond to this email promptly by logging into the app and approving
+  the displayed charge. If we do not hear from you for more than 30 days, we may
+  choose to delete your account.
+</p>
+<p>
+  <a href="<%= shopify_app.login_url %>" class="button">Log in</a>
+</p>
+
+<p>
+  Regards,
+</p>
+<p>
+  Helium Support
+</p>

data/app/views/gold/billing_mailer/suspension.html.erb

@@ -0,0 +1,19 @@
+<h1>Your account has been suspended</h1>
+<p>Hey <%= @shop.shop_owner %>,</p>
+<p>
+  We've suspended access to your <%= Gold.configuration.app_name %> usage because we
+  believe you are in violation of our terms of service. Until we have reconciled
+  this problem, you will not be able to access the app, nor will your customers
+  be able to interact with it.
+</p>
+<p>
+  Please respond to this email promptly by asking how to resolve this suspension
+  and we can advise you on how to proceed. If we do not hear from you for more
+  than 30 days, we may choose to delete your account.
+</p>
+<p>
+  Regards,
+</p>
+<p>
+  Helium Support
+</p>

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

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title><%= Gold.configuration.app_name %></title>
+
+    <%= stylesheet_link_tag "shopify/polaris" %>
+    <%= stylesheet_link_tag "gold/billing" %>
+
+    <%= render "gold/billing/inner_head" %>
+  </head>
+
+  <body>
+    <main>
+      <div class="main-content">
+        <%= yield %>
+      </div>
+    </main>
+    <aside></aside>
+    <%= javascript_include_tag "gold/billing" %>
+  </body>
+</html>

data/app/views/layouts/gold/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/gold/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/config/routes.rb

@@ -0,0 +1,33 @@
+Gold::Engine.routes.draw do
+  get "/terms", to: "billing#terms", as: "terms"
+  put "/terms", to: "billing#process_terms"
+
+  get "/tier", to: "billing#tier", as: "select_tier"
+  put "/tier", to: "billing#select_tier"
+
+  get "/charge", to: "billing#outstanding_charge", as: "outstanding_charge"
+  get "/charge/process", to: "billing#process_charge", as: "process_charge"
+  get "/charge/expired", to: "billing#expired_charge", as: "expired_charge"
+  get "/charge/declined", to: "billing#declined_charge", as: "declined_charge"
+  get "/charge/missing", to: "billing#missing_charge", as: "missing_charge"
+  post "/charge/retry", to: "billing#retry_charge", as: "retry_charge"
+
+  get "/suspended", to: "billing#suspended", as: "suspended"
+  get "/unavailable", to: "billing#unavailable", as: "unavailable"
+
+  get "/uninstalled", to: "billing#uninstalled", as: "uninstalled"
+end
+
+Gold::AdminEngine.routes.draw do
+  scope :billing do
+    post '/credit', to: 'admin/billing#issue_credit', as: 'issue_credit'
+    put '/suspend', to: 'admin/billing#suspend', as: 'suspend'
+    put '/unsuspend', to: 'admin/billing#unsuspend', as: 'unsuspend'
+    put '/reset_trial_days', to: 'admin/billing#reset_trial_days', as: 'reset_trial_days'
+    put '/discount', to: 'admin/billing#apply_discount', as: 'apply_discount'
+    put '/transition', to: 'admin/billing#transition', as: 'transition'
+    put '/change_tier', to: 'admin/billing#change_tier', as: 'change_tier'
+    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
+end

data/db/migrate/01_create_gold_billing.rb

@@ -0,0 +1,11 @@
+class CreateGoldBilling < ActiveRecord::Migration[5.2]
+  def change
+    create_table :gold_billings do |t|
+      t.integer :shop_id, null: false, index: { unique: true }
+      t.timestamp :trial_starts_at
+      t.string :tier_id
+      t.string :shopify_plan_override
+      t.integer :discount_percentage, null: false, default: 0
+    end
+  end
+end

data/db/migrate/02_create_gold_transitions.rb

@@ -0,0 +1,29 @@
+class CreateGoldTransitions < ActiveRecord::Migration[5.2]
+  def change
+    create_table :gold_transitions do |t|
+      t.string :to_state, null: false
+      t.json :metadata, default: {}
+      t.integer :sort_key, null: false
+      t.integer :billing_id, null: false
+      t.boolean :most_recent, null: false
+
+      # If you decide not to include an updated timestamp column in your transition
+      # table, you'll need to configure the `updated_timestamp_column` setting in your
+      # migration class.
+      t.timestamps null: false
+    end
+
+    # Foreign keys are optional, but highly recommended
+    add_foreign_key :gold_transitions, :gold_billings, column: :billing_id
+
+    add_index(:gold_transitions,
+              [:billing_id, :sort_key],
+              unique: true,
+              name: "index_gold_transitions_parent_sort")
+    add_index(:gold_transitions,
+              [:billing_id, :most_recent],
+              unique: true,
+              where: 'most_recent',
+              name: "index_gold_transitions_parent_most_recent")
+  end
+end

data/db/migrate/03_add_foreign_key_to_billing.rb

@@ -0,0 +1,8 @@
+class AddForeignKeyToBilling < ActiveRecord::Migration[5.2]
+  def change
+    # TODO (nick/andrew) make this from a generator, which takes the
+    # Gold.shop_class and uses the correct table as the primary key
+    add_foreign_key :gold_billings, :shops, column: :shop_id, primary_key: :id
+    #                               |^^^^^| change this
+  end
+end

data/lib/gold/admin_engine.rb

@@ -0,0 +1,8 @@
+module Gold
+  # Brings the Gold to your app. Mount this in your config/routes.rb.
+  class AdminEngine < ::Rails::Engine
+    isolate_namespace Gold
+    config.autoload_paths << File.expand_path("../../lib", __dir__)
+    engine_name "gold_admin_engine"
+  end
+end

data/lib/gold/billing_migrator.rb

@@ -0,0 +1,107 @@
+require "bigdecimal"
+
+module Gold
+  # Migrates previous systems to Gold for a specific shop
+  class BillingMigrator
+    attr_reader :shop,
+                :tier_id,
+                :tier,
+                :billing
+
+    def initialize(shop, tier_id, trial_starts_at = nil)
+      @shop = shop
+      @tier_id = tier_id.to_sym
+      @trial_starts_at = trial_starts_at
+    end
+
+    # Finds an appropriate tier based on tier_id and current charge
+    def lookup_tier!
+      charge = ShopifyAPI::RecurringApplicationCharge.current
+
+      # First attempt to find a matching tier with name and price
+      tier = Tier.all.find do |t|
+        (t.id == @tier_id || t.parent&.id == @tier_id) &&
+          tier_matches_charge_price(t, charge)
+      end
+
+      # Fallback on just tier id
+      tier ||= Tier.find(@tier_id)
+
+      # Raise an exception if no tier is found
+      raise Outcomes::TierNotFound unless tier
+
+      @tier = tier
+    end
+
+    def migrate!
+      if Billing.find_by(shop_id: shop.id)
+        Gold.logger.warn("Attempted to migrate shop '#{@shop.shopify_domain}'" \
+                         ", but Billing record already exists")
+        return false
+      end
+
+      @billing = Billing.create!(
+        shop: @shop,
+        trial_starts_at: @trial_starts_at
+      )
+
+      lookup_tier!
+      accept_terms
+      select_tier
+
+      Gold.logger.info("Migrated shop '#{@shop.shopify_domain}', state is " \
+                       "'#{@billing.current_state}', tier is '#{@tier.id}'")
+
+      true
+    rescue ActiveResource::UnauthorizedAccess,
+           ActiveResource::ForbiddenAccess,
+           ActiveResource::ResourceNotFound
+      Gold.logger.info("Shop '#{@shop.shopify_domain}' is uninstalled, skipping...")
+    end
+
+    private
+
+    def accept_terms
+      AcceptOrDeclineTermsOp.new(@billing, true).call
+    end
+
+    def select_tier
+      outcome = SelectTierOp.new(@billing, @tier, false).call
+
+      charge_op if outcome.is_a?(Outcomes::ChargeNeeded)
+    end
+
+    def charge_op
+      return_url = Engine.routes.url_helpers.process_charge_url
+      ChargeOp.new(@billing, return_url).call
+
+      charge_transition = @billing.state_machine.last_transition_to(:sudden_charge)
+
+      unless charge_transition
+        raise "Expected billing '#{@billing.id}' to have sudden_charge transition"
+      end
+
+      accept_charge(charge_transition.metadata["charge_id"])
+    end
+
+    def accept_charge(charge_id)
+      outcome = AcceptOrDeclineChargeOp.new(@billing, charge_id).call
+
+      if outcome.ok?
+        apply_tier
+      else
+        Rails.logger.info("Charge for '#{@shop.shopify_domain}' was '#{outcome}'")
+      end
+    end
+
+    def apply_tier
+      ApplyTierOp.new(@billing).call.ok?
+    end
+
+    def tier_matches_charge_price(tier, charge)
+      return false unless charge
+
+      tier.monthly_price == charge.price.to_d
+    end
+  end
+end

data/lib/gold/coverage.rb

@@ -0,0 +1,89 @@
+module Gold
+  # Captures coverage on Statesman state machines. Include this module into the
+  # `Statesman::Machine` subclass that you want to record usage for. Results may
+  # be accessed with `#coverage` on that class (not the instances).
+  module Coverage
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    # Class methods to add to the state machine when Gold::Coverage is included.
+    module ClassMethods
+      def coverage
+        @coverage ||= Results.new(self)
+      end
+    end
+
+    # Whether or not we are collecting coverage information currently.
+    def self.covered?
+      @covered = @covered.nil? || @covered
+    end
+
+    # Set whether we are collecting coverage information currently.
+    def self.covered=(covered)
+      @covered = covered
+    end
+
+    # Execute a block and don't include it in the coverage results.
+    def self.exclude_from_coverage
+      original = covered?
+      self.covered = false
+      result = yield
+      self.covered = original
+      result
+    end
+
+    # Describes a transition between two states.
+    Transition = Struct.new(:from, :to)
+
+    # Holds the collected coverage data.
+    class Results
+      def initialize(machine)
+        @machine = machine
+        @covered = Set.new
+      end
+
+      # Records when a transition is made from one state to another.
+      def cover(from, to)
+        @covered.add(Transition.new(from, to))
+      end
+
+      # Iterates over transitions that have been made thus far. This is in the
+      # same form as `Statesman::Machine#successors`, so the two can be compared
+      # to see where coverage is lacking.
+      def to_h
+        @covered.each_with_object(Hash.new { [] }) do |transition, hash|
+          hash[transition.from] = hash[transition.from] << transition.to
+          hash
+        end
+      end
+
+      # Generates an SVG diagram of the coverage that has been captured so far.
+      # Covered transitions are colored green and uncovered transitions are
+      # colored red.
+      def to_svg(path)
+        coverage = to_h
+        callback = lambda do |edge|
+          from = edge.tail_node
+          to = edge.head_node
+          edge[:color] =
+            coverage.key?(from) && coverage[from].include?(to) ? "green" : "red"
+        end
+        Gold::Diagram.new(@machine, edge_callback: callback).render(path)
+      end
+    end
+
+    # Override `#transition_to!` to observe the current state and the new state.
+    # Statesman's callbacks do not currently allow for this, hence the need to
+    # intercept here. `#transition_to` calls `#transition_to!`, so it is
+    # sufficient to tap into `Statesman::Machine` at this one point.
+    def transition_to!(new_state, metadata = {})
+      initial_state = current_state
+      super(new_state, metadata)
+      if Gold::Coverage.covered?
+        self.class.coverage.cover(initial_state.to_s, new_state.to_s)
+      end
+      true
+    end
+  end
+end

data/lib/gold/diagram.rb

@@ -0,0 +1,40 @@
+require "graphviz"
+
+module Gold
+  # Renders graphs of `Statesman::Machine`s.
+  class Diagram
+    # Prepares to render a diagram from a `Statesman::Machine` class.
+    def initialize(machine, node_callback: nil, edge_callback: nil)
+      @machine = machine
+      @node_callback = node_callback
+      @edge_callback = edge_callback
+    end
+
+    # Renders a diagram and saves it to a SVG stored at `output`.
+    def render(output)
+      g = GraphViz.new(@machine.to_s, type: :digraph)
+
+      # Mark the start of the state machine with a "start" label and arrow to the
+      # initial state.
+      g.add_node("start", shape: :plaintext)
+      g.add_edge("start", @machine.initial_state)
+
+      # Add all of the states as nodes.
+      @machine.states.each do |state|
+        node = g.add_node(state)
+        @node_callback&.call(node)
+      end
+
+      # Add edges between connected states.
+      @machine.successors.each do |state, successors|
+        successors.each do |successor|
+          edge = g.add_edge(state, successor)
+          @edge_callback&.call(edge)
+        end
+      end
+
+      # Save the output to a file.
+      g.output(svg: output)
+    end
+  end
+end

data/lib/gold/engine.rb

@@ -0,0 +1,16 @@
+module Gold
+  # Brings the Gold to your app. Mount this in your config/routes.rb.
+  class Engine < ::Rails::Engine
+    isolate_namespace Gold
+    config.autoload_paths << File.expand_path("../../lib", __dir__)
+    engine_name "gold_engine"
+
+    initializer "gold.assets.precompile" do |app|
+      app.config.assets.precompile += %w[
+        gold/billing.css
+        gold/billing.js
+        shopify/polaris.css
+      ]
+    end
+  end
+end

data/lib/gold/exceptions/metadata_missing.rb

@@ -0,0 +1,5 @@
+module Gold
+  module Exceptions
+    class MetadataMissing < StandardError; end
+  end
+end

data/lib/gold/outcomes.rb

@@ -0,0 +1,77 @@
+module Gold
+  module Outcomes
+    # This is the base class for any outcome. Sub-classes are intended to
+    # inherit from this and define whether that outcome is considered ok or not.
+    #
+    # If any subclass defines an `initialize` method, it should call `super` to
+    # ensure the `@ok` variable is set.
+    class Outcome < StandardError
+      def initialize(is_ok, message = nil)
+        @ok = is_ok
+        super(message)
+      end
+
+      def ok?
+        @ok
+      end
+    end
+
+    # General failure class
+    class Failure < Outcome
+      attr_reader :reason
+
+      def initialize(reason = nil, message = nil)
+        @reason = reason
+        super(false, message || reason)
+      end
+    end
+
+    # A general success class
+    class Success < Outcome
+      def initialize(message = nil)
+        super(true, message)
+      end
+    end
+
+    # Common outcomes
+    Uninstalled = Class.new(Failure)
+
+    # Outcomes that relate to tiers
+    TierApplied = Class.new(Success)
+    TierNotFound = Class.new(Failure)
+
+    # Outcomes that relate to charges
+    ChargeNeeded = Class.new(Success)
+    ChargeNotNeeded = Class.new(Success)
+    FrozenCharge = Class.new(Success)
+    ExpiredCharge = Class.new(Failure)
+    MissingCharge = Class.new(Failure)
+
+    ActiveCharge = Class.new(Success) do
+      attr_reader :charge_id
+
+      def initialize(charge_id)
+        @charge_id = charge_id
+        super()
+      end
+    end
+
+    AcceptedCharge = Class.new(Success) do
+      attr_reader :return_url
+
+      def initialize(return_url)
+        @return_url = return_url
+        super()
+      end
+    end
+
+    PendingCharge = Class.new(Success) do
+      attr_reader :confirmation_url
+
+      def initialize(confirmation_url)
+        @confirmation_url = confirmation_url
+        super()
+      end
+    end
+  end
+end

data/lib/gold/retries.rb

@@ -0,0 +1,31 @@
+module Gold
+  # For handling network request retries
+  module Retries
+    def request_with_retries(max_attempts = 3)
+      attempts = 0
+
+      begin
+        attempts += 1
+        yield
+      rescue ActiveResource::ConnectionError => e
+        # Maybe this is a transient error? Try it again up to the max amount
+        Gold.logger.error("Failed to make request: #{e}")
+
+        case e
+        when ActiveResource::ServerError
+          Gold.logger.info e.response.code.inspect
+          raise e unless %w[500 502 503 504].include?(e.response.code)
+        when ActiveResource::SSLError
+          Gold.logger.warn "SSL Error"
+        when ActiveResource::TimeoutError
+          Gold.logger.warn "Timeout Error"
+        else
+          raise e
+        end
+
+        retry unless attempts > max_attempts
+        raise e
+      end
+    end
+  end
+end

data/lib/gold/version.rb

@@ -0,0 +1,3 @@
+module Gold
+  VERSION = "2.0.0.pre".freeze
+end