shopify-gold 2.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 917c31cd7ce6e41b8147461e53ce5a5568a771fdde314e13d566235fdb67a052
+  data.tar.gz: ebab84d89085345240df8395b224eec8c51e6d9d7b89134354e57ad6865c13ad
+SHA512:
+  metadata.gz: 93f021916913a6a29e9e3cd7a94fbecf6349fee1b84f4ef9cd1ff798a52c13041a01eb8fc98dc59f166f9e76b05686bd2895855c5cf795e8a4c39c523e1c03fe
+  data.tar.gz: 64c4a74b23f203225264243a5bc6a74268fb05f420527d09be71b794a71f2af85cbe47335e8528e3d539fe342ef96061c585b742c1d5cea5d23620f512cb051f

data/README.md

@@ -0,0 +1,144 @@
+# Gold
+Gold is Helium’s approach to predictably and accurately billing merchants for
+Shopify apps.
+
+For more information about the goals and design of this project, please review
+[Gold's design document](https://docs.google.com/document/d/1U5REQyTDhXkI6q8VJYQgPDaAbiJMq3UAp3G0c6U8F2A/view).
+
+## Tour
+Gold is comprised of a few pieces:
+
+* `Gold::BillingController` allows merchants to select tiers, set up charges,
+  and review their billing information.
+* `Gold::Billing` ties together all pieces of a shop's billing information.
+* `Gold::Machine` defines the state that a shop is in and what transitions
+  can be made from that state to others.
+* `Gold::Transition` records these state transitions in the database.
+* `Gold::Tier` holds definitions of tiers that are available for merchants to
+  select from. Apps using Gold define these in their `config/tiers.yml` file.
+* `Gold::Concerns::Gilded` is a mixin to an app's shop class to give it Gold's
+  functionality. This app-specific shop class is configured with the `Gold`
+  module's `#shop_class=` setter.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gold'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+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
+```
+
+Finally, you will need to mount the engine in your `config/routes.rb` file:
+
+```ruby
+mount Gold::Engine, at: "/"
+```
+
+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.
+
+## Configuration
+Add `gold.rb` within the `initializers` folder of your project. Below are Gold's
+configuration options:
+
+```
+Gold.configure do |config|
+  # The class name (string) of the the app's Active Record Shop model
+  config.shop_class = "Shop"
+
+  # The attribute of the *.myshopify.com domain on the Shop model
+  config.shop_domain_attribute = "shopify_domain"
+
+  # Should Gold create test charges? Helpful in a development environment
+  config.test_charge = false
+
+  # The logger Gold will use
+  config.logger = Logger.new(STDOUT)
+
+  # How many days we'll wait before cleaning up an uninstalled shop
+  config.days_until_cleanup = 30
+
+  # How many days we'll wait before we uninstall a shop without payment
+  config.days_until_delinquent = 7
+
+  # The name of the app using gold (used in the charge name)
+  config.app_name = "My App"
+
+  # The email Gold uses to send emails from
+  config.contact_email = "example@heliumdev.com"
+
+  # 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"
+
+  # If Gold is allowed to cancel charges (paid -> free) automatically
+  @allow_automated_charge_cancellation = true
+end
+```
+
+## Hooks
+You can hook into Gold's lifecycle by providing a Proc. Available hooks:
+```
+Gold.configure do |config|
+  config.on_install = proc {
+    puts "Installing Gold..."
+  }
+
+  config.on_terms = proc {
+    puts "Accepted terms from Gold..."
+  }
+
+  config.on_apply_tier = proc { |billing, tier_id|
+    puts "Applied tier..."
+  }
+
+  config.on_uninstall = proc {
+    puts "Uninstalling Gold..."
+  }
+
+  config.on_cleanup = proc { |billing|
+    puts "Cleaning up shop"
+  }
+end
+```
+
+## Contributing
+
+Run tests with:
+
+```bash
+$ bin/rails test
+```
+
+Run lint/style checks with:
+
+```bash
+$ 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`

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Gold"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/images/gold/app-logo.svg

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="164px" height="158px" viewBox="0 0 164 158" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 55.2 (78181) - https://sketchapp.com -->
+    <title>Logo</title>
+    <desc>Created with Sketch.</desc>
+    <defs>
+        <linearGradient x1="28.9979993%" y1="-8.96517743%" x2="84.8882717%" y2="105.103572%" id="linearGradient-1">
+            <stop stop-color="#5801E3" offset="0%"></stop>
+            <stop stop-color="#FC4646" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g id="Billing" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Intro-form" fill="url(#linearGradient-1)">
+            <path d="M-21,-12.5035429 L-21,-13.2617143 C-20.8582857,-22.9532 -15.2800571,-28 -5.47874286,-28 C17.0963429,-27.9964571 62.0693714,-1.21777143 114.562114,57.2801143 C168.3604,-5.90851429 178.496514,-52.1676 88.2882857,15.6285143 C88.1235429,15.4850286 80.8181714,9.04765714 80.6463429,8.89885714 C82.2530286,7.80765714 124.276629,-27.9256 149.267943,-27.9256 C177.9084,-27.9256 166.782057,11.8128571 121.291771,64.9716571 C197.069943,153.530686 162.750286,187.504914 75.224,116.444057 L72.4216,114.171314 C59.5840571,124.334 20.6622286,158 -4.79142857,158 C-25.6978286,158 -23.1257143,136.420457 -13.1649714,116.555657 C-5.75862857,101.787257 6.44297143,84.4414286 23.1192,64.9716571 C-7.56194286,29.1232571 -20.7821143,2.80337143 -21,-12.5035429 Z M64.6857714,22.6929714 C-17.4925714,-47.5725143 -37.7949143,-21.9984 29.8417714,57.312 C42.1532,43.8172571 56.6523429,30.3862857 64.6857714,22.6929714 Z M65.9665143,94.9389143 C65.9665143,94.9389143 58.5761143,101.626057 58.3918857,101.789029 C57.1306286,100.549029 44.6438286,89.1622857 29.8311429,72.6561143 C14.6074857,90.5050286 -27.0405714,148.000286 -4.82154286,148.000286 C21.2556571,148.000286 78.1185143,98.2692 107.846629,64.9876 C97.1737714,53.0180571 84.8162857,40.6056571 72.3542857,29.4137714 C62.2376571,38.9830286 47.2248,53.2377143 36.5608,64.9645714 C44.3710286,73.5046286 57.4902286,86.5848571 65.9665143,94.9389143 Z M80.0493714,107.161771 C80.2247429,107.291086 122.165086,144.712514 145.4824,144.712514 C170.225714,144.712514 130.703371,91.5554857 114.565657,72.6738286 C104.902514,83.4352571 94.4971429,94.0709143 80.0493714,107.161771 Z" id="Logo"></path>
+        </g>
+    </g>
+</svg>

data/app/assets/images/gold/aside-bg.svg

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 23.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 656 672" style="enable-background:new 0 0 656 672;" xml:space="preserve">
+<style type="text/css">
+	.st0{filter:url(#Adobe_OpacityMaskFilter);}
+	.st1{fill-rule:evenodd;clip-rule:evenodd;fill:#FFFFFF;}
+	.st2{mask:url(#mask-2_1_);fill:none;stroke:url(#Path-8_1_);}
+	.st3{filter:url(#Adobe_OpacityMaskFilter_1_);}
+	.st4{mask:url(#mask-2_2_);fill:none;stroke:url(#Path-9_1_);}
+</style>
+<title>Path 8 + Path 9 Mask</title>
+<desc>Created with Sketch.</desc>
+<g id="Billing">
+	<g id="Intro-form" transform="translate(-720.000000, -173.000000)">
+		<g transform="translate(720.000000, 143.000000)">
+			<g id="Mask">
+			</g>
+			<defs>
+				<filter id="Adobe_OpacityMaskFilter" filterUnits="userSpaceOnUse" x="-3.5" y="47.3" width="278.5" height="654.4">
+					<feColorMatrix  type="matrix" values="1 0 0 0 0  0 1 0 0 0  0 0 1 0 0  0 0 0 1 0"/>
+				</filter>
+			</defs>
+			<mask maskUnits="userSpaceOnUse" x="-3.5" y="47.3" width="278.5" height="654.4" id="mask-2_1_">
+				<g class="st0">
+					<rect id="path-1_1_" class="st1" width="668" height="735"/>
+				</g>
+			</mask>
+			
+				<linearGradient id="Path-8_1_" gradientUnits="userSpaceOnUse" x1="-354.1977" y1="748.4078" x2="-353.0956" y2="748.4737" gradientTransform="matrix(-188.4878 -657.335 -167.9035 48.1456 59202.0664 -268195.8125)">
+				<stop  offset="0" style="stop-color:#5801E3"/>
+				<stop  offset="1" style="stop-color:#42E59A"/>
+			</linearGradient>
+			<path id="Path-8" class="st2" d="M197.9,701.4C346.2,421.8,279.1,203.9-3.3,47.7"/>
+			<defs>
+				<filter id="Adobe_OpacityMaskFilter_1_" filterUnits="userSpaceOnUse" x="-3.4" y="24.1" width="659.1" height="526.6">
+					<feColorMatrix  type="matrix" values="1 0 0 0 0  0 1 0 0 0  0 0 1 0 0  0 0 0 1 0"/>
+				</filter>
+			</defs>
+			<mask maskUnits="userSpaceOnUse" x="-3.4" y="24.1" width="659.1" height="526.6" id="mask-2_2_">
+				<g class="st3">
+					<rect id="path-1_2_" class="st1" width="668" height="735"/>
+				</g>
+			</mask>
+			
+				<linearGradient id="Path-9_1_" gradientUnits="userSpaceOnUse" x1="-353.4046" y1="750.621" x2="-353.7825" y2="749.4943" gradientTransform="matrix(65.1755 -411.5021 -723.7028 -114.6233 566150.875 -59200.8633)">
+				<stop  offset="0" style="stop-color:#5801E3"/>
+				<stop  offset="1" style="stop-color:#FC4646"/>
+			</linearGradient>
+			<path id="Path-9" class="st4" d="M-2.9,24.3c120.7,306.3,340.2,481.6,658.6,525.9"/>
+		</g>
+	</g>
+</g>
+</svg>

data/app/assets/javascripts/gold/billing.js

@@ -0,0 +1,30 @@
+var $tierForm = document.querySelector('.tiers form');
+
+function tierStep($form) {
+  var $tiers = $form.querySelectorAll('input[name="tier"]');
+
+  function setSelectPlanButtonState() {
+    var $selectedTier = $form.querySelector('input[name="tier"]:checked'),
+        $submit = $form.querySelector('button[type="submit"]');
+  
+    if ($selectedTier) {
+      $submit.removeAttribute('disabled');
+      $submit.classList.remove('Polaris-Button--disabled');
+    } else {
+      $submit.setAttribute('disabled', 'disabled');
+      $submit.classList.add('Polaris-Button--disabled');
+    }
+  }
+
+  for (var i = 0; i < $tiers.length; i++) {
+    $tiers[i].addEventListener('change', function(e) {
+      setSelectPlanButtonState();
+    });
+  }
+  
+  setSelectPlanButtonState();
+}
+
+if ($tierForm) {
+  tierStep($tierForm);
+}

data/app/assets/stylesheets/gold/billing.sass

@@ -0,0 +1,64 @@
+body
+  display: flex
+  align-items: stretch
+  margin: 0
+  padding: 0
+
+  main
+    min-height: 100%
+    width: 50%
+    padding: 180px 25px 25px 25px
+    background-color: white
+    position: relative
+    overflow: auto
+
+    &:before
+      content: asset-url('gold/app-logo.svg')
+      position: absolute
+      top: 0
+      left: 0
+      opacity: 0.2
+      width: 175px
+
+    .main-content
+      margin: auto
+      max-width: 600px
+
+  aside
+    width: 50%
+    background: #160A2C
+    background-image: asset-url('gold/aside-bg.svg')
+    background-repeat: no-repeat
+    background-position: 0 40%
+    background-size: 700px
+
+.tiers
+  .tier
+    border-top: 1px solid #DFE3E8
+    padding: 15px 0 5px 0
+    cursor: pointer
+    background: white
+    position: relative
+
+    &[data-disabled]
+      .tier-heading
+        opacity: 0.5
+
+    &:first-of-type
+      border-top: none
+
+    .Polaris-Choice
+      width: 100%
+      align-items: center
+      
+    .Polaris-Choice__Control
+      margin-right: 15px
+
+    .Polaris-Choice__Label
+      display: flex
+      align-items: center
+      justify-content: space-between
+      width: 100%
+
+    .tier-description
+      max-width: 320px