disco_app 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d435f0f5ba6860fac53344b430a0177ba110b35d118d11a43c597ed460ec5fb
-  data.tar.gz: 1df37961682c32e2c594cb2852090f2031b8b1bce6bf1380bd85c371d51537ba
+  metadata.gz: 6d121a39b30f43fccab67728b99a8bc4e4aed5ef0fea0aaaba6c72f35b2c30b3
+  data.tar.gz: 8a6dd1711f023374e251243c661c4eec548aa1613ab39175c4e5b07975400579
 SHA512:
-  metadata.gz: a7651d300a93a6eed409cb120aa8934c9a8970457d4b2c8ee933db2b6897f8b842b29ba0c45545fa30cc9ef33404473964058ddb3fe2a5352f3d6094d3961505
-  data.tar.gz: 44cf0e056f7c302a8e3202f5c75a4049e4461cc9802232d4bccc37cf982eda987c85ccef3b5a7e2c36d4fb5bca10b43040072c2799c182e7b27c254c5fcea807
+  metadata.gz: 8d9ad557bccac5b7d620b2e6ffab730588394c8ab8570836c376dbb72080da66e79ddec488efcb9f638c44a5a57d793b13022fd96fe50c29d0fe5700d4fa9e04
+  data.tar.gz: bfe171a5488905b6704eb84e39f5f1a4c1a6603d337b18df96d8e8923c4706b889595cf6532ea83c1f28fe77f6f91c0bd476b9e00018f7fb95b5aba43ab4007b

data/app/controllers/disco_app/admin/concerns/plans_controller.rb

@@ -0,0 +1,51 @@
+module DiscoApp::Admin::Concerns::PlansController
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :find_plan, only: [:edit, :update]
+  end
+
+  def index
+    @plans = DiscoApp::Plan.all
+  end
+
+  def new
+    @plan = DiscoApp::Plan.new
+    @plan.plan_codes.build
+  end
+
+  def create
+    @plan = DiscoApp::Plan.new(plan_params)
+    if @plan.save
+      redirect_to admin_plans_path
+    else
+      render 'new'
+    end
+  end
+
+  def edit
+    @plan.plan_codes.build
+  end
+
+  def update
+    if @plan.update_attributes(plan_params)
+      redirect_to admin_plans_path
+    else
+      render 'edit'
+    end
+  end
+
+  private
+
+    def find_plan
+      @plan = DiscoApp::Plan.find(params[:id])
+    end
+
+    def plan_params
+      params.require(:plan).permit(
+        :name, :status, :plan_type, :trial_period_days, :amount,
+        :plan_codes_attributes => [:code, :trial_period_days, :amount]
+      )
+    end
+
+end

data/app/controllers/disco_app/admin/plans_controller.rb

@@ -0,0 +1,3 @@
+class DiscoApp::Admin::PlansController < DiscoApp::Admin::ApplicationController
+  include DiscoApp::Admin::Concerns::PlansController
+end

data/app/controllers/disco_app/charges_controller.rb

@@ -1,30 +1,47 @@
-module DiscoApp
-  class ChargesController < ApplicationController
-    include DiscoApp::Concerns::AuthenticatedController
+class DiscoApp::ChargesController < ApplicationController
+  include DiscoApp::Concerns::AuthenticatedController
 
-    skip_before_action :verify_status, only: [:create, :activate]
+  skip_before_action :check_active_charge
+  before_action :find_subscription
 
-    # Display a "pre-charge" page, giving the opportunity to explain why a charge needs to be made.
-    def new
+  # Display a "pre-charge" page, giving the opportunity to explain why a charge
+  # needs to be made.
+  def new
+  end
+
+  # Attempt to create a new charge for the logged in shop and selected
+  # subscription. If successful, redirect to the (external) charge confirmation
+  # URL. If it fails, redirect back to the new charge page.
+  def create
+    if(charge = DiscoApp::ChargesService.create(@shop, @subscription)).nil?
+      redirect_to action: :new
+    else
+      redirect_to charge.confirmation_url
     end
+  end
 
-    # Create a new charge for the currently logged in shop, then redirect to the charge's confirmation URL.
-    def create
-      if (shopify_charge = DiscoApp::ChargesService.create(@shop)).nil?
-        redirect_to action: :new and return
-      end
-      redirect_to shopify_charge.confirmation_url
+  # Attempt to activate a charge after a user has accepted or declined it.
+  # Redirect to the main application's root URL immediately afterwards - if the
+  # charge wasn't accepted, the flow will start again.
+  def activate
+    # First attempt to find a matching charge.
+    if(charge = @subscription.charges.find_by(id: params[:id], shopify_id: params[:charge_id])).nil?
+      redirect_to action: :new and return
+    end
+    if DiscoApp::ChargesService.activate(@shop, charge)
+      redirect_to main_app.root_url
+    else
+      redirect_to action: :new
     end
+  end
+
+  private
 
-    # Attempt to activate a charge after a user has accepted or declined it. Redirect to the main application's root URL
-    # immediately afterwards - if the charge wasn't accepted, the flow will start again.
-    def activate
-      if (shopify_charge = DiscoApp::ChargesService.get_accepted_charge(@shop, params[:charge_id])).nil?
-        redirect_to action: :new and return
+    def find_subscription
+      @subscription = @shop.subscriptions.find_by_id!(params[:subscription_id])
+      unless @subscription.requires_active_charge? and not @subscription.active_charge?
+        redirect_to main_app.root_url
       end
-      DiscoApp::ChargesService.activate(@shop, shopify_charge)
-      redirect_to main_app.root_url
     end
 
-  end
 end

data/app/controllers/disco_app/concerns/app_proxy_controller.rb

@@ -20,7 +20,7 @@ module DiscoApp::Concerns::AppProxyController
     end
 
     def proxy_signature_is_valid?
-      return true if DiscoApp.configuration.skip_proxy_verification?
+      return true if Rails.env.development? and DiscoApp.configuration.skip_proxy_verification?
       DiscoApp::ProxyService.proxy_signature_is_valid?(request.query_string, ShopifyApp.configuration.secret)
     end
 

data/app/controllers/disco_app/concerns/authenticated_controller.rb

@@ -4,7 +4,9 @@ module DiscoApp::Concerns::AuthenticatedController
   included do
     before_action :login_again_if_different_shop
     before_action :shopify_shop
-    before_action :verify_status
+    before_action :check_installed
+    before_action :check_current_subscription
+    before_action :check_active_charge
     around_filter :shopify_session
     layout 'embedded_app'
   end
@@ -19,17 +21,29 @@ module DiscoApp::Concerns::AuthenticatedController
       end
     end
 
-    def verify_status
-      if not (@shop.charge_active? or @shop.charge_waived?)
-        redirect_if_not_current_path(disco_app.new_charge_path)
-      elsif @shop.charge_accepted?
-        redirect_if_not_current_path(disco_app.activate_charge_path)
-      elsif @shop.never_installed? or @shop.uninstalled?
-        redirect_if_not_current_path(disco_app.install_path)
-      elsif @shop.awaiting_install? or @shop.installing?
-        redirect_if_not_current_path(disco_app.installing_path)
-      elsif @shop.awaiting_uninstall? or @shop.uninstalling?
-        redirect_if_not_current_path(disco_app.uninstalling_path)
+    def check_installed
+      if @shop.awaiting_install? or @shop.installing?
+        redirect_if_not_current_path disco_app.installing_path
+        return
+      end
+      if @shop.awaiting_uninstall? or @shop.uninstalling?
+        redirect_if_not_current_path disco_app.uninstalling_path
+        return
+      end
+      unless @shop.installed?
+        redirect_if_not_current_path disco_app.install_path
+      end
+    end
+
+    def check_current_subscription
+      unless @shop.current_subscription?
+        redirect_if_not_current_path disco_app.new_subscription_path
+      end
+    end
+
+    def check_active_charge
+      if @shop.current_subscription? and @shop.current_subscription.requires_active_charge? and not @shop.current_subscription.active_charge?
+        redirect_if_not_current_path disco_app.new_subscription_charge_path(@shop.current_subscription)
       end
     end
 

data/app/controllers/disco_app/concerns/carrier_request_controller.rb

@@ -14,7 +14,7 @@ module DiscoApp::Concerns::CarrierRequestController
     end
 
     def carrier_request_signature_is_valid?
-      return true if DiscoApp.configuration.skip_carrier_request_verification?
+      return true if Rails.env.development? and DiscoApp.configuration.skip_carrier_request_verification?
       DiscoApp::CarrierRequestService.is_valid_hmac?(request.body.read.to_s, ShopifyApp.configuration.secret, request.headers['HTTP_X_SHOPIFY_HMAC_SHA256'])
     end
 

data/app/controllers/disco_app/install_controller.rb

@@ -1,26 +1,27 @@
-module DiscoApp
-  class InstallController < ApplicationController
-    include DiscoApp::Concerns::AuthenticatedController
+class DiscoApp::InstallController < ApplicationController
+  include DiscoApp::Concerns::AuthenticatedController
 
-    # Start the installation process for the current shop, then redirect to the installing screen.
-    def install
-      AppInstalledJob.perform_later(@shop.shopify_domain)
-      redirect_to action: :installing
-    end
+  skip_before_action :check_current_subscription
+  skip_before_action :check_active_charge
 
-    # Display an "installing" page.
-    def installing
-      if @shop.installed?
-        redirect_to main_app.root_path
-      end
-    end
+  # Start the installation process for the current shop, then redirect to the installing screen.
+  def install
+    DiscoApp::AppInstalledJob.perform_later(@shop.shopify_domain)
+    redirect_to action: :installing
+  end
 
-    # Display an "uninstalling" page. Should be almost never used.
-    def uninstalling
-      if @shop.uninstalled?
-        redirect_to main_app.root_path
-      end
+  # Display an "installing" page.
+  def installing
+    if @shop.installed?
+      redirect_to main_app.root_path
     end
+  end
 
+  # Display an "uninstalling" page. Should be almost never used.
+  def uninstalling
+    if @shop.uninstalled?
+      redirect_to main_app.root_path
+    end
   end
+
 end

data/app/controllers/disco_app/subscriptions_controller.rb

@@ -0,0 +1,40 @@
+class DiscoApp::SubscriptionsController < ApplicationController
+  include DiscoApp::Concerns::AuthenticatedController
+
+  skip_before_action :check_current_subscription
+
+  def new
+    @subscription = DiscoApp::Subscription.new
+  end
+
+  def create
+    # Get the selected plan. If it's not available or couldn't be found,
+    # redirect back to the plan selection page.
+    if(plan = DiscoApp::Plan.available.find_by_id(subscription_params[:plan])).nil?
+      redirect_to action: :new and return
+    end
+
+    # If a plan code was provided, check that it's (a) valid and available and
+    # (b) valid for the selected plan.
+    plan_code = nil
+    if subscription_params[:plan_code].present?
+      if(plan_code = DiscoApp::PlanCode.available.find_by(plan: plan, code: subscription_params[:plan_code])).nil?
+        redirect_to action: :new and return
+      end
+    end
+
+    # Subscribe the current shop to the selected plan.
+    if(subscription = DiscoApp::SubscriptionService.subscribe(@shop, plan, plan_code)).nil?
+      redirect_to action: :new
+    else
+      redirect_to main_app.root_path
+    end
+  end
+
+  private
+
+    def subscription_params
+      params.require(:subscription).permit(:plan, :plan_code)
+    end
+
+end

data/app/controllers/disco_app/webhooks_controller.rb

@@ -38,7 +38,7 @@ module DiscoApp
       end
 
       def webhook_is_valid?
-        return true if DiscoApp.configuration.skip_webhook_verification?
+        return true if Rails.env.development? and DiscoApp.configuration.skip_webhook_verification?
         DiscoApp::WebhookService.is_valid_hmac?(request.body.read.to_s, ShopifyApp.configuration.secret, request.headers['HTTP_X_SHOPIFY_HMAC_SHA256'])
       end
 

data/app/controllers/sessions_controller.rb

@@ -0,0 +1,22 @@
+class SessionsController < ApplicationController
+  include ShopifyApp::SessionsController
+
+  protected
+
+    # Override the authenticate method to allow skipping OAuth in development
+    # mode. Skipping OAuth still requires a shop with Shopify domain specified
+    # by the `shop` parameter to be present in the local database.
+    def authenticate
+      if Rails.env.development? and DiscoApp.configuration.skip_oauth?
+        shop = DiscoApp::Shop.find_by_shopify_domain!(sanitized_shop_name)
+
+        sess = ShopifyAPI::Session.new(shop.shopify_domain, shop.shopify_token)
+        session[:shopify] = ShopifyApp::SessionRepository.store(sess)
+        session[:shopify_domain] = sanitized_shop_name
+
+        redirect_to disco_app.frame_path and return
+      end
+      super
+    end
+
+end

data/app/jobs/disco_app/concerns/app_installed_job.rb

@@ -12,11 +12,28 @@ module DiscoApp::Concerns::AppInstalledJob
   # - Synchronise webhooks.
   # - Synchronise carrier service, if required.
   # - Perform initial update of shop information.
+  # - Subscribe to default plan, if any exists.
   #
-  def perform(domain)
-    DiscoApp::SynchroniseWebhooksJob.perform_now(domain)
-    DiscoApp::SynchroniseCarrierServiceJob.perform_now(domain)
-    DiscoApp::ShopUpdateJob.perform_now(domain)
+  def perform(shopify_domain)
+    DiscoApp::SynchroniseWebhooksJob.perform_now(shopify_domain)
+    DiscoApp::SynchroniseCarrierServiceJob.perform_now(shopify_domain)
+    DiscoApp::ShopUpdateJob.perform_now(shopify_domain)
+
+    @shop.reload
+
+    if default_plan.present?
+      DiscoApp::SubscriptionService.subscribe(@shop, default_plan)
+    end
+  end
+
+  # Provide an overridable hook for applications to examine the @shop object
+  # and return the default plan, if any, the shop should be subscribed to. If
+  # nil is returned, no automatic subscription will take place and the store
+  # owner will be forced to choose a plan after installation.
+  #
+  # If implementing this method, it should be memoized.
+  def default_plan
+    nil
   end
 
 end

data/app/jobs/disco_app/concerns/app_uninstalled_job.rb

@@ -9,14 +9,11 @@ module DiscoApp::Concerns::AppUninstalledJob
 
   # Perform application uninstallation.
   #
-  # - Mark charge status as "cancelled" unless charges have been waived.
+  # - Mark any recurring application charges as cancelled.
   # - Remove any stored sessions for the shop.
   #
   def perform(domain, shop_data)
-    unless @shop.charge_waived?
-      @shop.charge_cancelled!
-    end
-
+    DiscoApp::ChargesService.cancel_recurring_charges(@shop)
     @shop.sessions.delete_all
   end
 

data/app/jobs/disco_app/concerns/subscription_changed_job.rb

@@ -0,0 +1,7 @@
+module DiscoApp::Concerns::SubscriptionChangedJob
+  extend ActiveSupport::Concern
+
+  def perform(shopify_domain, subscription)
+  end
+
+end

data/app/jobs/disco_app/subscription_changed_job.rb

@@ -0,0 +1,3 @@
+class DiscoApp::SubscriptionChangedJob < DiscoApp::ShopJob
+  include DiscoApp::Concerns::SubscriptionChangedJob
+end

data/app/models/disco_app/application_charge.rb

@@ -0,0 +1,18 @@
+class DiscoApp::ApplicationCharge < ActiveRecord::Base
+
+  belongs_to :shop
+  belongs_to :subscription
+
+  enum status: [:pending, :accepted, :declined, :expired, :active]
+
+  scope :active, -> { where status: statuses[:active] }
+
+  def recurring?
+    false
+  end
+
+  def activate_url
+    DiscoApp::Engine.routes.url_helpers.activate_subscription_charge_url(subscription, self)
+  end
+
+end

data/app/models/disco_app/concerns/plan.rb

@@ -5,10 +5,22 @@ module DiscoApp::Concerns::Plan
 
     has_many :subscriptions
     has_many :shops, through: :subscriptions
+    has_many :plan_codes
 
-    enum status: [:available, :unavailable, :hidden]
+    accepts_nested_attributes_for :plan_codes
+
+    enum status: [:available, :unavailable]
+    enum plan_type: [:recurring, :one_time]
+    enum interval: [:month, :year]
 
     scope :available, -> { where status: statuses[:available] }
 
+    validates_presence_of :name
+
   end
+
+  def has_trial?
+    trial_period_days.present? and trial_period_days > 0
+  end
+
 end

data/app/models/disco_app/concerns/plan_code.rb

@@ -0,0 +1,15 @@
+module DiscoApp::Concerns::PlanCode
+  extend ActiveSupport::Concern
+
+  included do
+
+    belongs_to :plan
+
+    enum status: [:available, :unavailable]
+
+    validates_presence_of :code
+    validates_presence_of :amount
+
+  end
+
+end

data/app/models/disco_app/concerns/shop.rb

@@ -15,9 +15,6 @@ module DiscoApp::Concerns::Shop
     # Define possible installation statuses as an enum.
     enum status: [:never_installed, :awaiting_install, :installing, :installed, :awaiting_uninstall, :uninstalling, :uninstalled]
 
-    # Define possible charge statuses as an enum.
-    enum charge_status: [:charge_none, :charge_pending, :charge_accepted, :charge_declined, :charge_active, :charge_cancelled, :charge_waived]
-
     # Define some useful scopes.
     scope :status, -> (status) { where status: status }
     scope :installed, -> { where status: statuses[:installed] }
@@ -39,15 +36,19 @@ module DiscoApp::Concerns::Shop
       }
     end
 
-    # Update this Shop's charge_status attribute based on the given Shopify charge object.
-    def update_charge_status(shopify_charge)
-      status_update_method_name = "charge_#{shopify_charge.status}!"
-      self.public_send(status_update_method_name) if self.respond_to? status_update_method_name
+    # Convenience method to check if this shop has a current subscription.
+    def current_subscription?
+      current_subscription.present?
     end
 
-    # Convenience method to get the currently active subscription for this Shop.
+    # Convenience method to get the current subscription for this shop, if any.
     def current_subscription
-      subscriptions.active.first
+      subscriptions.current.first
+    end
+
+    # Convenience method to get the current plan for this shop, if any.
+    def current_plan
+      current_subscription&.plan
     end
 
     # Return the absolute URL to the shop's storefront.

data/app/models/disco_app/concerns/subscription.rb

@@ -5,10 +5,44 @@ module DiscoApp::Concerns::Subscription
 
     belongs_to :shop
     belongs_to :plan
+    belongs_to :plan_code
 
-    enum status: [:active, :replaced, :cancelled]
+    has_many :one_time_charges, class_name: 'DiscoApp::ApplicationCharge', dependent: :destroy
+    has_many :recurring_charges, class_name: 'DiscoApp::RecurringApplicationCharge', dependent: :destroy
 
-    scope :active, -> { where status: statuses[:active] }
+    enum status: [:trial, :active, :cancelled]
+    enum subscription_type: [:recurring, :one_time]
 
+    scope :current, -> { where status: [statuses[:trial], statuses[:active]] }
+
+  end
+
+  # Only require an active charge if the amount to be charged is > 0.
+  def requires_active_charge?
+    amount > 0
+  end
+
+  # Convenience method to check if this subscription has an active charge.
+  def active_charge?
+    active_charge.present?
+  end
+
+  # Convenience method to get the active charge for this subscription.
+  def active_charge
+    charges.active.first
   end
+
+  # Return the appropriate set of charges for this subscription's type.
+  def charges
+    recurring? ? recurring_charges : one_time_charges
+  end
+
+  def charge_class
+    recurring? ? DiscoApp::RecurringApplicationCharge : DiscoApp::ApplicationCharge
+  end
+
+  def shopify_charge_class
+    recurring? ? ShopifyAPI::RecurringApplicationCharge : ShopifyAPI::ApplicationCharge
+  end
+
 end

data/app/models/disco_app/plan_code.rb

@@ -0,0 +1,3 @@
+class DiscoApp::PlanCode < ActiveRecord::Base
+  include DiscoApp::Concerns::PlanCode
+end

data/app/models/disco_app/recurring_application_charge.rb

@@ -0,0 +1,18 @@
+class DiscoApp::RecurringApplicationCharge < ActiveRecord::Base
+
+  belongs_to :shop
+  belongs_to :subscription
+
+  enum status: [:pending, :accepted, :declined, :active, :cancelled, :expired]
+
+  scope :active, -> { where status: statuses[:active] }
+
+  def recurring?
+    true
+  end
+
+  def activate_url
+    DiscoApp::Engine.routes.url_helpers.activate_subscription_charge_url(subscription, self)
+  end
+
+end