shopify-gold 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 527eadfe26ca80bdf73302aabce389c5e0c848fb02693a58dd9531c8d388b1cc
-  data.tar.gz: a1ebdbbc9cd44759eed117dbef5fc1f7dff2d0dac8a787b9194cfca89d587a8f
+  metadata.gz: c030cdd2491bfaaa608daf0872d00a666c02de89075ebdfc02e2db16c9b4fc1a
+  data.tar.gz: f09f58ef6ed29763f352985b06a4b69d4c178aa98a344be6c3b7d4d18692de88
 SHA512:
-  metadata.gz: a13ade86f9c8ddb7563535d08f98fba3aaa1632521c82a71e80dc0ede5208e86433a5efbe20d03e215c96da2a6610473b06334eafd055aa0ee346c8139424aac
-  data.tar.gz: eb4ef029165350c7925c6d2c0b165d1917c6477af687b1b0df151ffde2cf1d3977ecfd885538ea4df54bf220041293a5d911025c8a106a13bd1477d1a3de4d85
+  metadata.gz: 0b4ec8a6c8c13d9dc81de919fe16d9da5ec952ed1573f8f437a853499013a1511aa3862e0474f4137f7cd1313cd9a15369a5def927f59e50b3c2fcf8d1b6c70d
+  data.tar.gz: 2790090bddf8bf32067ddc50fbfeecea31b90b8c0aa017111a696153e1825400d50f0e1d00ac2cadc45f2988b34b29b019a74d5d4fe9ff1d20a57b34af9e9365

data/README.md

@@ -38,8 +38,8 @@ You will need to apply migrations to your app's `Shop` class and bring in the
 other Gold models to your database:
 
 ```bash
-$ bin/rails gold:install:migrations
-$ bin/rails db:migrate
+$ rake gold_engine:install:migrations
+$ rake db:migrate
 ```
 
 Mount the engine in your `config/routes.rb` file:
@@ -53,7 +53,9 @@ you'll need to define a new helper method `gold_engine` and reference your custo
 `as` param.
 
 Add module to your `Shop` class:
-`include Gold::Concerns::Gilded`
+```ruby
+include Gold::Concerns::Gilded
+```
 
 Add the following methods to your `Shop` class:
 `#shopify_domain`, which responds with the *.myshopify.com domain of the shop
@@ -65,29 +67,22 @@ 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)`
+Call the AfterAuthenticateJob inline when a user logs in. 
+In `shopify_app.rb` initializer:
+```ruby
+config.after_authenticate_job = { job: Gold::AfterAuthenticateJob, inline: true }
+```
+Or in your own job:
+```ruby
+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
+```bash
+$ bundle exec sidekiq -q gold
 ```
 
 ## Configuration
@@ -124,10 +119,16 @@ Gold.configure do |config|
   config.plan_comparison_url = "https://heliumdev.com/pricing"
 
   # The API version used by Shopify (https://help.shopify.com/en/api/versioning)
-  @shopify_api_version = "2019-04"
+  config.shopify_api_version = "2019-04"
 
   # If Gold is allowed to cancel charges (paid -> free) automatically
-  @allow_automated_charge_cancellation = true
+  config.allow_automated_charge_cancellation = true
+
+  config.admin_credentials = {
+    user: "admin",
+    password: "password123"
+  }
+
 end
 ```
 
@@ -165,6 +166,38 @@ Gold.configure do |config|
 end
 ```
 
+## 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
+```
+
+##  Controller and views
+Ok, so it's time to get paid. Let's add our module to show merchants tier choices.
+
+Include the following in your `ApplicationController`:
+```ruby
+include Gold::Concerns::MerchantFacing
+```
+
+When you want to put an action or controller behind a paywall, add:
+```ruby
+before_action :confront_mandatory_billing_action
+```
+
+You can override any view file by matching Gold's path pattern under `views`. The
+most notable are likely 
+
 ## 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.
@@ -184,6 +217,13 @@ 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`
 
+This partial expects the following instance variables to be defined from your
+controller:
+```
+@active_charge = ShopifyAPI::RecurringApplicationCharge.current
+@credits = ShopifyAPI::ApplicationCredit.all || []
+```
+
 ## 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:

data/app/models/gold/machine.rb

@@ -180,7 +180,7 @@ module Gold
     before_transition to: :apply_tier, &require_metadata(:tier_id)
     transition from: :apply_tier, to: :billing
     before_transition to: :apply_free_tier, &require_metadata(:tier_id)
-    transition from: :apply_free_tier, to: :billing
+    transition from: :apply_free_tier, to: %i[billing staff affiliate]
 
     transition from: :billing, to: %i[apply_discount
                                       calculate_usage

data/lib/gold/version.rb

@@ -1,3 +1,3 @@
 module Gold
-  VERSION = "3.0.0".freeze
+  VERSION = "3.0.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify-gold
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Andrew Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails