shopify-gold 4.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2f3bd33de348c0f6ec3cf6e3f01afc445047d48e1df6f4544e843fe003a6ff1
-  data.tar.gz: 87c3b24f37dc3c1b6fba30171029af7251f2d248802803ea51d2930e79b7e13e
+  metadata.gz: 27bbc1ba14621fd2a39291faa1df4d52e004cb512858d82f04e29fdefd4f43fc
+  data.tar.gz: 237848311344321a2b5a218ddbfaed88e133efb7ec9ca3b094718c4db1ac382b
 SHA512:
-  metadata.gz: fbffeb717f7a5ec08d084de5a2d1530a1fde2bc7500412084847ce620a9dc8e60f7e24cc33f24498001781a5b0e5ef626a72c84ded3c41c611c28cfede703533
-  data.tar.gz: 0660e85fab96435db7bbb431b0d955e753399535449890a1c5a9dc87ceffa4b949b9cb40caaef587763ee5f0ab36174246860940cb35dd15a9a50354f6c9ef47
+  metadata.gz: f3293e0897c04ad38929c80a2dbb528f5ebfd3f24563e3dcfdcaa68b0a37562ff97406112f4821711ef74d3d539f336a7ccd22de171d6496839be838fc5bde7c
+  data.tar.gz: 06c96b494db7fd61e25a3d4189d004b7cedfe4a93d1636795bcf0923f3036f9fb6cc67be48944991d881195564287ab066fc8866b83c8639aefe3ce50b1b2c9c

data/README.md

@@ -183,6 +183,11 @@ To add tiers to your app, add a `config/tiers.yml` file. Here's an example file:
     max_customers: 1000
 ```
 
+Any tier that is visible will appear in the list of choices. If it is hidden, you
+can link to it either directly (/tier?id=basic) or indirectly (/start?tier=basic).
+The later will route to the app listing page before selecting this option on the
+tier page.
+
 ##  Controller and views
 Ok, so it's time to get paid. Let's add our module to show merchants tier choices.
 
@@ -262,11 +267,4 @@ which you can do on Mac via Homebrew with `brew install graphviz`
 
 ## Release
 To release gem, run `gem release`, which depends on having `gem-release` installed
-on your system.
-
-## Changelog
-Version 4.0.0
-- Added referral affiliates
-
-Version 3.2.0
-- Removed `force_embedded_redirect` config option
+on your system.

data/app/controllers/gold/authenticated_controller.rb

@@ -1,4 +1,4 @@
-require_dependency "gold/application_controller"
+require "gold/application_controller"
 
 module Gold
   # Inherit from Shopify's authenticated module

data/app/controllers/gold/billing_controller.rb

@@ -7,7 +7,7 @@ module Gold
     layout "gold/billing"
 
     rescue_from Statesman::TransitionFailedError do |e|
-      billing = Billing.find_by!(shop_id: session[:shopify])
+      billing = Billing.find_by!(shop_id: session[:shop_id])
       Gold.logger.error("Shop '#{billing.shop.shopify_domain}' failed to " \
                         "transtion '#{e}'")
       render "gold/billing/transition_error", layout: "gold/billing",
@@ -44,17 +44,20 @@ module Gold
 
       apply_referral_cookie unless billing.tier
 
+      params[:id] = cookies[:gold_tier_id] if cookies[:gold_tier_id].present?
+
       @tiers = Tier.visible
     end
 
     # Process a tier selection.
     def select_tier
       @tiers = Tier.visible
-      @tier = Tier.find(params[:tier])
+      @tier =  Tier.find(params[:tier])
       outcome = SelectTierOp.new(billing, @tier).call
       case outcome
       when SameTier, TierApplied
-        redirect_to main_app.root_url
+        cookies.delete(:gold_tier_id)
+        redirect_to Gold.configuration.after_tier_redirect_path
       when CannotSelectTier
         flash.now[:error] = "Your shop is not eligible for this plan"
         render :tier
@@ -95,7 +98,7 @@ module Gold
           Gold.logger.info("[#{billing.id}] Charge is ready")
         end
 
-        redirect_to main_app.root_url
+        redirect_to Gold.configuration.after_tier_redirect_path
       else
         raise "Not sure how to handle #{outcome} on outstanding charge"
       end
@@ -109,7 +112,7 @@ module Gold
       case outcome
       when ActiveCharge
         ApplyTierOp.new(billing).call
-        outer_redirect_to_main
+        outer_redirect(Gold.configuration.after_tier_redirect_path)
       when DeclinedCharge
         redirect_to declined_charge_url
       when ExpiredCharge
@@ -162,14 +165,14 @@ module Gold
 
     # If embedded app, redirect directly through the Shopify admin. This can provide
     # a better experience than the page rendering and JS kicking off a redirect
-    def outer_redirect_to_main
+    def outer_redirect(redirect_path)
       if ShopifyApp.configuration.embedded_app
         shopify_domain = billing.shop.shopify_domain
         api_key = ShopifyApp.configuration.api_key
-        fullpath = "/admin/apps/#{api_key}#{main_app.root_path}"
+        fullpath = "/admin/apps/#{api_key}#{redirect_path}"
         redirect_to URI::HTTPS.build(host: shopify_domain, path: fullpath).to_s
       else
-        redirect_to main_app.root_url
+        redirect_to redirect_path
       end
     end
 

data/app/controllers/gold/concerns/merchant_facing.rb

@@ -9,7 +9,7 @@ module Gold
 
       # Returns the Gold::Billing instance for the currently logged-in merchant.
       def billing
-        @billing ||= Billing.find_by!(shop_id: session[:shopify])
+        @billing ||= Billing.find_by!(shop_id: session[:shop_id])
       rescue ActiveRecord::RecordNotFound
         raise Gold::Exceptions::BillingNotFound
       end

data/app/controllers/gold/referrals_controller.rb

@@ -6,7 +6,7 @@ module Gold
 
       cookies[:gold_referral_id] = { value: referral.id, expires: 30.days } if referral
 
-      redirect_to Gold.configuration.referral_redirect_url
+      redirect_to Gold.configuration.app_listing_url
     end
   end
 end

data/app/controllers/gold/setup_controller.rb

@@ -0,0 +1,9 @@
+module Gold
+  class SetupController < ApplicationController
+    def new
+      tier = Tier.find(params[:tier])
+      cookies[:gold_tier_id] = { value: tier.id, expires: 7.days } if tier
+      redirect_to Gold.configuration.app_listing_url
+    end
+  end
+end

data/app/models/gold/concerns/gilded.rb

@@ -1,4 +1,4 @@
-require_dependency "statesman"
+require "statesman"
 
 module Gold
   module Concerns

data/app/models/gold/machine.rb

@@ -1,4 +1,4 @@
-require_dependency "statesman"
+require "statesman"
 
 module Gold
   # This is the finite state machine specification that governs how shops may
@@ -230,7 +230,8 @@ module Gold
                                           apply_free_tier
                                           change_tier
                                           staff
-                                          optional_charge]
+                                          optional_charge
+                                          marked_as_uninstalled]
 
     before_transition to: :optional_charge, &require_metadata(:charge_id)
     guard_transition to: :optional_charge, &ensure_plan_is(:paying?)
@@ -238,7 +239,8 @@ module Gold
                                               optional_charge_accepted
                                               optional_charge_declined
                                               marked_as_uninstalled]
-    transition from: :optional_charge_declined, to: :billing
+    transition from: :optional_charge_declined, to: %i[billing
+                                                       marked_as_uninstalled]
 
     transition from: :optional_charge_accepted, to: %i[charge_activated
                                                        marked_as_uninstalled]
@@ -256,13 +258,17 @@ module Gold
                                                       marked_as_uninstalled]
 
     transition from: :delayed_charge_expired, to: %i[delayed_charge
-                                                     marked_as_delinquent]
+                                                     marked_as_delinquent
+                                                     marked_as_uninstalled]
     transition from: :delayed_charge_declined, to: %i[marked_as_delinquent
-                                                      delayed_charge]
+                                                      delayed_charge
+                                                      marked_as_uninstalled]
 
     guard_transition to: :marked_as_delinquent,
                      &ensure_min_days_in_state(Gold.configuration.days_until_delinquent)
-    transition from: :marked_as_delinquent, to: :delinquent
+    transition from: :marked_as_delinquent, to: %i[delinquent
+                                                   marked_as_uninstalled]
+
     transition from: :delinquent, to: %i[marked_as_uninstalled delayed_charge cleanup]
 
     guard_transition to: :affiliate, &ensure_plan_is(:affiliate?)

data/app/models/gold/shopify_plan.rb

@@ -20,14 +20,16 @@ module Gold
 
     # Returns true if this is a development (non-live) shop.
     def affiliate?
-      plan == "affiliate"
+      plans = %w[affiliate partner_test]
+      plans.include?(plan)
     end
 
     # Returns true if this is a shop owned by Shopify staff. This specifically
     # excludes Shopify Business shops, as we believe those are paid stores that
     # Shopify employees use for their own businesses.
     def staff?
-      plan == "staff"
+      plans = %w[plus_partner_sandbox staff]
+      plans.include?(plan)
     end
 
     # Returns true if this shop has been frozen by Shopify for non-payment.

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

@@ -1,14 +1,19 @@
 <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.
+  We have suspended access to your <%= Gold.configuration.app_name %> usage for
+  <%= @shop.myshopify_domain %> 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>
+  If you think this has been made in error, please respond to this email and we'll
+  help you get things sorted!
+</p>
 <p>
   <a href="<%= shopify_app.login_url %>" class="button">Log in</a>
 </p>

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

@@ -1,10 +1,10 @@
 <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.
+  We've suspended access to your <%= Gold.configuration.app_name %> usage for
+  <%= @shop.myshopify_domain %> 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

data/config/routes.rb

@@ -1,4 +1,6 @@
 Gold::Engine.routes.draw do
+  get "/start", to: "setup#new"
+
   get "/terms", to: "billing#terms", as: "terms"
   put "/terms", to: "billing#process_terms"
 

data/lib/gold/configuration.rb

@@ -13,7 +13,8 @@ module Gold
                   :days_until_cleanup,
                   :shop_domain_attribute,
                   :force_embedded_redirect,
-                  :referral_redirect_url
+                  :app_listing_url,
+                  :after_tier_redirect_path
 
     # Callbacks
     attr_accessor :on_terms,
@@ -71,7 +72,11 @@ module Gold
 
       # The URL to follow after a referral code is tracked
       # (e.g. https://apps.shopify.com/customr)
-      @referral_redirect_url = "/"
+      @app_listing_url = "https://apps.shopify.com/"
+
+      # The redirect path after a tier is applied. Use this path to welcome a
+      # merchant if they just installed
+      @after_tier_redirect_path = "/"
     end
 
     def shop_class

data/lib/gold/version.rb

@@ -1,3 +1,3 @@
 module Gold
-  VERSION = "4.1.0".freeze
+  VERSION = "5.1.1".freeze
 end

data/lib/tasks/gold_tasks.rake

@@ -90,8 +90,17 @@ namespace :gold do
       end
 
       billing.shop.with_shopify_session do
-        Gold::MarkAsDelinquentOp.new(billing).call
-        puts "Shop '#{billing.shop.shopify_domain}' is delinquent"
+        domain = billing.shop.shopify_domain
+
+        begin
+          Gold::MarkAsDelinquentOp.new(billing).call
+          puts "Shop '#{domain}' is delinquent"
+        rescue ActiveResource::UnauthorizedAccess
+          puts "It looks like '#{domain}' uninstalled, running op..."
+          Gold::UninstallOp.new(billing).call
+        rescue ActiveResource::ClientError => e
+          puts "Error for '#{domain}', #{e}"
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify-gold
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - Andrew Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,42 +17,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shopify_app
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: statesman
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -113,16 +113,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '0.74'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '0.74'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -157,14 +157,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.3.0
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.3.0
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -185,14 +185,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: '3'
 description: |
   Gold is Helium's approach to billing for Shopify apps. It provides a
   framework to build Rails apps upon.
@@ -219,6 +219,7 @@ files:
 - app/controllers/gold/billing_controller.rb
 - app/controllers/gold/concerns/merchant_facing.rb
 - app/controllers/gold/referrals_controller.rb
+- app/controllers/gold/setup_controller.rb
 - app/jobs/gold/after_authenticate_job.rb
 - app/jobs/gold/app_uninstalled_job.rb
 - app/jobs/gold/application_job.rb
@@ -316,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Helium's approach to billing for Shopify apps