shopify-gold 2.0.1.pre → 2.0.2.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a15b83f137cb729f8570f15df2a8f1359d8d2015200f10593fe8ac8bb87813cd
-  data.tar.gz: 1f6a1e258075ce400beb19aab823640e6064b6029989b919ddbe2d81add805c4
+  metadata.gz: a207a2139e8e1ab1be012353b58500a6ab9f0c6799f6158cd131bfe63a0fc7e0
+  data.tar.gz: 16a1d206a15a09286a79ded2239807dcc9c16767fb57ba1f75481515ccac9226
 SHA512:
-  metadata.gz: 16f2b30e916670995ad0410cef60fe6178c31657eed28ce911bec83e1ed02b65c4e5109f3782615bc5f85c077a5ba3d603cb8882b154d509ad3b3631ba773bac
-  data.tar.gz: 88c047df0f6a2f0d55aa81a03fdbcf71254a9d3874c2cf89f093e1254457f3c41f2150c28ec11dd493ef14cf077c80731744306d3c8f3568cb7992c2687f8888
+  metadata.gz: 8027b833952d50b72ed0a38d24a8c32307b00e911a67fc2edd24657a64532a50eafa343fa92d8ab7b6d2d9ade2abf5d2f6a4786a810e770afa0caad07a45adb5
+  data.tar.gz: b2dc4970350aa2c6466f9256bcd98b66916c7d0d1664998ca83d6aeb57e3dee10565cff178413b88d170e6f398d720f8728243dc151f97e3a81d6b750315b814

data/README.md

@@ -25,7 +25,7 @@ Gold is comprised of a few pieces:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'gold'
+gem "shopify-gold", require: "gold"
 ```
 
 And then execute:
@@ -42,16 +42,54 @@ $ bin/rails gold:install:migrations
 $ bin/rails db:migrate
 ```
 
-Finally, you will need to mount the engine in your `config/routes.rb` file:
+Mount the engine in your `config/routes.rb` file:
 
 ```ruby
-mount Gold::Engine, at: "/"
+mount Gold::Engine, at: "/billing"
 ```
 
 Note that by default, the engine's name is `gold_engine`. If you must change this,
 you'll need to define a new helper method `gold_engine` and reference your custom
 `as` param.
 
+Add module to your `Shop` class:
+`include Gold::Concerns::Gilded`
+
+Add the following methods to your `Shop` class:
+`#shopify_domain`, which responds with the *.myshopify.com domain of the shop
+`#shopify_plan_name`, which responds to the plan name of the Shopify store (e.g. "unlimited", "affilaite")
+`#qualifies_for_tier?(_tier)`, return a boolean if the shop should qualify to a tier
+`#with_shopify_session`, provided by the Shopify App gem
+
+After shop properties have been updated (say, after a shop/update webhook), call:
+`shop.billing.after_shop_update!`. This tells Gold something has changed about the
+shop, which will run any operations (example affiliate -> paid) that might be relevant.
+
+Call the AfterAuthenticateJob inline when a user logs in. This can be setup
+either directly in `shopify_app.rb` initializer, or in your own job.
+`Gold::AfterAuthenticateJob.perform_now(shop_domain: shop_domain)`
+
+## Background tasks
+Gold runs background jobs to queue events under the `gold` queue. For example, if
+you're using Sidekiq, run:
+`bundle exec sidekiq -q gold`
+
+## Adding tiers
+To add tiers to your app, add a `config/tiers.yml` file. Here's an example file:
+```
+- id: basic
+  name: "Basic"
+  description: "Shops just gettings started with a few number of custom fields."
+  features:
+    feature_1: Yes
+    featured_2: No
+  pricing:
+    trial_days: 14
+    monthly: "10.00"
+  qualifications:
+    max_customers: 1000
+```
+
 ## Configuration
 Add `gold.rb` within the `initializers` folder of your project. Below are Gold's
 configuration options:
@@ -85,12 +123,6 @@ Gold.configure do |config|
   # The URL to a plan comparison page for the app
   config.plan_comparison_url = "https://heliumdev.com/pricing"
 
-  # Login credential's to Gold's backend
-  config.admin_credentials = {
-    user: "admin",
-    password: "password123"
-  }
-
   # The API version used by Shopify (https://help.shopify.com/en/api/versioning)
   @shopify_api_version = "2019-04"
 
@@ -125,6 +157,34 @@ Gold.configure do |config|
 end
 ```
 
+## Admin interface
+Gold can manage billing for each shop through an admin interface. First, you'll
+want to setup some basic HTTP auth credentials in your Gold config initializer.
+```
+Gold.configure do |config|
+  config.admin_credentials = {
+    user: "admin",
+    password: "password123"
+  }
+end
+```
+
+Mount the engine in routes:
+`mount Gold::AdminEngine, at: '/admin', as: 'gold_admin_engine'`
+
+You can inject a partial anywhere in your own admin interface to include Gold's
+admin management by providing an instance of `Billing`:
+`render "gold/admin/billing/overview", billing: @shop.billing`
+
+## Migration
+If you have existing charges that you want to migrate to Gold on a specific plan,
+use the `BillingMigrator.new([Shop], [tier_id], [start_at])` class. Example:
+`Gold::BillingMigrator.new(@shop, "basic", 5.days.ago)`
+
+The shop will automatically be pushed through the state machine (new, accepted_terms, etc).
+Note that the `tier_id` must match a tier setup in Gold. If that shop does not 
+have a charge that matches the tier's price, a new charge will be requested.
+
 ## Contributing
 
 Run tests with:
@@ -142,3 +202,7 @@ $ bundle exec rubocop
 If you want to see a visual representation of `Gold::Machine`, you can run
 `bin/rails app:gold:diagram`. You will need to have the Graphviz tool installed,
 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.

data/app/controllers/gold/billing_controller.rb

@@ -14,6 +14,10 @@ module Gold
                                               status: :internal_server_error
     end
 
+    rescue_from Gold::Exceptions::BillingNotFound do
+      redirect_to shopify_app.login_path
+    end
+
     # Show the terms of service.
     def terms
       @already_accepted = !billing.can_transition_to?(:accepted_terms)

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

@@ -10,6 +10,8 @@ module Gold
       # Returns the Gold::Billing instance for the currently logged-in merchant.
       def billing
         @billing ||= Billing.find_by!(shop_id: session[:shopify])
+      rescue ActiveRecord::RecordNotFound
+        raise Gold::Exceptions::BillingNotFound
       end
 
       # `before_action` filter that forces a merchant to deal with

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

@@ -3,7 +3,8 @@
 </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
+  We're sorry, but we couldn't respond to your request. Please
+  <a href="<%= shopify_app.logout_path %>" class="Polaris-Link">logout</a>
+  and 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/lib/gold/exceptions/billing_not_found.rb

@@ -0,0 +1,5 @@
+module Gold
+  module Exceptions
+    class BillingNotFound < ActiveRecord::RecordNotFound; end
+  end
+end

data/lib/gold/version.rb

@@ -1,3 +1,3 @@
 module Gold
-  VERSION = "2.0.1.pre".freeze
+  VERSION = "2.0.2.pre".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify-gold
 version: !ruby/object:Gem::Version
-  version: 2.0.1.pre
+  version: 2.0.2.pre
 platform: ruby
 authors:
 - Andrew Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -152,19 +152,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: gem-release
+  name: shopify_app
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +258,7 @@ files:
 - app/views/gold/billing/_inner_head.html.erb
 - app/views/gold/billing/declined_charge.html.erb
 - app/views/gold/billing/expired_charge.html.erb
+- app/views/gold/billing/login_error.html.erb
 - app/views/gold/billing/missing_charge.html.erb
 - app/views/gold/billing/outstanding_charge.html.erb
 - app/views/gold/billing/suspended.html.erb
@@ -282,6 +283,7 @@ files:
 - lib/gold/coverage.rb
 - lib/gold/diagram.rb
 - lib/gold/engine.rb
+- lib/gold/exceptions/billing_not_found.rb
 - lib/gold/exceptions/metadata_missing.rb
 - lib/gold/outcomes.rb
 - lib/gold/retries.rb