shopify-gold 2.0.0.pre

data/lib/gold.rb

@@ -0,0 +1,102 @@
+require "gold/engine"
+require "gold/outcomes"
+require "statesman"
+
+# Configure Statesman to store transitions in the database.
+Statesman.configure do
+  storage_adapter Statesman::Adapters::ActiveRecord
+end
+
+# This is the main module where configuration can be set.
+module Gold
+  class << self
+    attr_accessor :configuration
+
+    delegate :shop_class,
+             :shop_domain_attribute,
+             :logger,
+             to: :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # Config for Gold
+  class Configuration
+    attr_accessor :test_charge,
+                  :app_name,
+                  :contact_email,
+                  :plan_comparison_url,
+                  :logger,
+                  :admin_credentials,
+                  :shopify_api_version,
+                  :allow_automated_charge_cancellation,
+                  :days_until_delinquent,
+                  :days_until_cleanup,
+                  :shop_domain_attribute
+
+    # Callbacks
+    attr_accessor :on_terms,
+                  :on_install,
+                  :on_uninstall,
+                  :on_cleanup,
+                  :on_apply_tier
+
+    attr_writer :shop_class
+
+    def initialize
+      # The class name (string) of the the app's Active Record Shop model
+      @shop_class = nil
+
+      # The attribute of the *.myshopify.com domain on the Shop model
+      @shop_domain_attribute = nil
+
+      # Should Gold create test charges? Helpful in a development environment
+      @test_charge = false
+
+      # The logger Gold will use
+      @logger = Logger.new(STDOUT)
+
+      # How many days we'll wait before cleaning up an uninstalled shop
+      @days_until_cleanup = 30
+
+      # How many days we'll wait before we uninstall a shop without payment
+      @days_until_delinquent = 7
+
+      # The name of the app using gold (used in the charge name)
+      @app_name = "My App"
+
+      # The email Gold uses to send emails from
+      @contact_email = nil
+
+      # The URL to a plan comparison page for the app
+      @plan_comparison_url = nil
+
+      # Login credential's to Gold's backend
+      @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
+
+    def shop_class
+      @shop_constant ||= @shop_class.to_s.constantize
+    rescue NameError
+      raise "'#{@shop_class}' is not a valid class name for shop class. " \
+            "You must specify one in your Gold config file with " \
+            "'config.shop'"
+    end
+
+    def test_charge?
+      @test_charge
+    end
+  end
+end

data/lib/tasks/gold_tasks.rake

@@ -0,0 +1,94 @@
+namespace :gold do
+  desc "Generate a diagram of the Gold::Machine state machine"
+  task diagram: :environment do
+    # So that graphs export colors consistently
+    random = Random.new(1)
+
+    acceptance_states = lambda do |node|
+      if Gold::Machine::ACCEPTANCE_STATES.include?(node.id.to_sym)
+        node[:shape] = :doublecircle
+      end
+    end
+
+    # Describes a transition between two states. Used as a Hash key.
+    Transition = Struct.new(:from, :to)
+
+    # Extract labels for guards.
+    labels = {}
+    Gold::Machine.callbacks[:guards].each do |guard|
+      guard.to.each do |to|
+        labels[Transition.new(guard.from, to)] = guard.callback.to_s
+      end
+    end
+
+    labels_and_colors = lambda do |edge|
+      color = %w[red darkgreen blue orange violet].sample(random: random)
+
+      edge[:color] = color
+      edge[:fontcolor] = color
+
+      label = [
+        labels[Transition.new(nil, edge.head_node)],
+        labels[Transition.new(edge.tail_node, edge.head_node)]
+      ].compact.join(" and ")
+      if label
+        edge[:label] = label
+        edge[:fontsize] = 9
+      end
+    end
+
+    diagram = Gold::Diagram.new(Gold::Machine,
+                                node_callback: acceptance_states,
+                                edge_callback: labels_and_colors)
+
+    path = Rails.root.join("tmp", "gold_machine.svg")
+    diagram.render(path)
+    puts "Diagram generated and saved to #{path}"
+  end
+
+  desc "Checks charges for all billing instances"
+  task check_charges: :environment do
+    Gold::Billing.all.each do |billing|
+      next unless billing.state_machine.can_transition_to?(:check_charge)
+
+      billing.shop.with_shopify_session do
+        outcome = Gold::CheckChargeOp.new(billing).call
+
+        unless outcome.ok?
+          puts "Check charge for shop '#{billing.shop.shopify_domain}': #{outcome}"
+          Gold::ChargeOp.new(billing,
+                             Gold::Engine.routes.url_helpers.process_charge_url).call
+        end
+      rescue ActiveResource::UnauthorizedAccess
+        puts "It looks like '#{billing.shop.shopify_domain}' uninstalled, running op..."
+        Gold::UninstallOp.new(billing).call
+      end
+    end
+  end
+
+  desc "Move eligible billings into cleanup"
+  task cleanup: :environment do
+    Gold::Billing.all.each do |billing|
+      next unless billing.state_machine.can_transition_to?(:cleanup)
+
+      billing.shop.with_shopify_session do
+        outcome = Gold::CleanupOp.new(billing).call
+        puts "Cleanup for shop '#{billing.shop.shopify_domain}': #{outcome}"
+      end
+    end
+  end
+
+  desc "Move eligible billings into delinquence"
+  task delinquents: :environment do
+    Gold::Billing.all.each do |billing|
+      unless billing.current_state == :marked_as_delinquent
+        next unless billing.state_machine.can_transition_to?(:marked_as_delinquent)
+      end
+
+      billing.shop.with_shopify_session do
+        Gold::MarkAsDelinquentOp.new(billing).call
+        puts "Shop '#{billing.shop.shopify_domain}' is delinquent"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,298 @@
+--- !ruby/object:Gem::Specification
+name: shopify-gold
+version: !ruby/object:Gem::Version
+  version: 2.0.0.pre
+platform: ruby
+authors:
+- Andrew Smith
+- Nick Mealey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: shopify_app
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: statesman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: minitest-skip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+description: |
+  Gold is Helium's approach to billing for Shopify apps. It provides a
+  framework to build Rails apps upon.
+email:
+- andrew@heliumdev.com
+- nick@heliumdev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/gold_manifest.js
+- app/assets/images/gold/app-logo.svg
+- app/assets/images/gold/aside-bg.svg
+- app/assets/javascripts/gold/billing.js
+- app/assets/stylesheets/gold/billing.sass
+- app/assets/stylesheets/shopify/polaris.css
+- app/controllers/gold/admin/billing_controller.rb
+- app/controllers/gold/application_controller.rb
+- app/controllers/gold/authenticated_controller.rb
+- app/controllers/gold/billing_controller.rb
+- app/controllers/gold/concerns/merchant_facing.rb
+- app/jobs/app_uninstalled_job.rb
+- app/jobs/gold/after_authenticate_job.rb
+- app/jobs/gold/app_uninstalled_job.rb
+- app/jobs/gold/application_job.rb
+- app/mailers/gold/application_mailer.rb
+- app/mailers/gold/billing_mailer.rb
+- app/models/gold/billing.rb
+- app/models/gold/concerns/gilded.rb
+- app/models/gold/machine.rb
+- app/models/gold/shopify_plan.rb
+- app/models/gold/tier.rb
+- app/models/gold/transition.rb
+- app/operations/gold/accept_or_decline_charge_op.rb
+- app/operations/gold/accept_or_decline_terms_op.rb
+- app/operations/gold/apply_discount_op.rb
+- app/operations/gold/apply_tier_op.rb
+- app/operations/gold/charge_op.rb
+- app/operations/gold/check_charge_op.rb
+- app/operations/gold/cleanup_op.rb
+- app/operations/gold/convert_affiliate_to_paid_op.rb
+- app/operations/gold/freeze_op.rb
+- app/operations/gold/install_op.rb
+- app/operations/gold/issue_credit_op.rb
+- app/operations/gold/mark_as_delinquent_op.rb
+- app/operations/gold/resolve_outstanding_charge_op.rb
+- app/operations/gold/select_tier_op.rb
+- app/operations/gold/suspend_op.rb
+- app/operations/gold/uninstall_op.rb
+- app/operations/gold/unsuspend_op.rb
+- app/views/gold/admin/billing/_active_charge.erb
+- app/views/gold/admin/billing/_credit.erb
+- app/views/gold/admin/billing/_discount.erb
+- app/views/gold/admin/billing/_history.erb
+- app/views/gold/admin/billing/_overview.erb
+- app/views/gold/admin/billing/_shopify_plan.erb
+- app/views/gold/admin/billing/_state.erb
+- app/views/gold/admin/billing/_status.erb
+- app/views/gold/admin/billing/_tier.erb
+- app/views/gold/admin/billing/_trial_days.erb
+- 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/missing_charge.html.erb
+- app/views/gold/billing/outstanding_charge.html.erb
+- app/views/gold/billing/suspended.html.erb
+- app/views/gold/billing/terms.html.erb
+- app/views/gold/billing/tier.html.erb
+- app/views/gold/billing/transition_error.html.erb
+- app/views/gold/billing/unavailable.erb
+- app/views/gold/billing/uninstalled.html.erb
+- app/views/gold/billing_mailer/affiliate_to_paid.erb
+- app/views/gold/billing_mailer/delinquent.html.erb
+- app/views/gold/billing_mailer/suspension.html.erb
+- app/views/layouts/gold/billing.html.erb
+- app/views/layouts/gold/mailer.html.erb
+- app/views/layouts/gold/mailer.text.erb
+- config/routes.rb
+- db/migrate/01_create_gold_billing.rb
+- db/migrate/02_create_gold_transitions.rb
+- db/migrate/03_add_foreign_key_to_billing.rb
+- lib/gold.rb
+- lib/gold/admin_engine.rb
+- lib/gold/billing_migrator.rb
+- lib/gold/coverage.rb
+- lib/gold/diagram.rb
+- lib/gold/engine.rb
+- lib/gold/exceptions/metadata_missing.rb
+- lib/gold/outcomes.rb
+- lib/gold/retries.rb
+- lib/gold/version.rb
+- lib/tasks/gold_tasks.rake
+homepage: https://gitlab.com/helium-development/infrastructure/gold
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Helium's approach to billing for Shopify apps
+test_files: []