disco_app 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e94f1a57f95b758fd65f751679875a60ca89e1ccd211c3ae4223e12b3962d33b
+  data.tar.gz: e60095bae476ae30411b7dbc346075ab9bfc6edd4a89e971b40549550094add0
+SHA512:
+  metadata.gz: 63d9d433da4bead908a2677d6edc22f71611132c775695bd3b15228d5291ff57a3f61594792df40dd05151a38c2e9b2f88faeac4c75d11b4fbe906c63967709f
+  data.tar.gz: 322af952fb19124ffdd22af1ed022ac8afd8c99133247ce863406320ca6b7e822d00e24c83de735ed789296b5dbc7c4a6434268feaebf2ca4efd3e1d8b9d6e8b

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'DiscoApp'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/disco_app/disco_app.js

@@ -0,0 +1,7 @@
+/**
+ * disco_app/disco_app.js
+ * Base Javascript for Disco applications.
+ * Assumes that jQuery will be loaded in the parent application.js.
+ */
+//= require bootstrap-sprockets
+//= require_tree .

data/app/assets/stylesheets/disco_app/bootstrap-custom.scss

@@ -0,0 +1,55 @@
+/*!
+ * bootstrap-custom.scss
+ * Customise the bootstrap components we pull in styles for.
+ */
+
+// Core variables and mixins
+@import "bootstrap/variables";
+@import "bootstrap/mixins";
+
+// Reset and dependencies
+@import "bootstrap/normalize";
+//@import "bootstrap/print";
+//@import "bootstrap/glyphicons";
+
+// Core CSS
+@import "bootstrap/scaffolding";
+@import "bootstrap/type";
+//@import "bootstrap/code";
+@import "bootstrap/grid";
+@import "bootstrap/tables";
+@import "bootstrap/forms";
+@import "bootstrap/buttons";
+
+// Components
+@import "bootstrap/component-animations";
+@import "bootstrap/dropdowns";
+@import "bootstrap/button-groups";
+@import "bootstrap/input-groups";
+@import "bootstrap/navs";
+@import "bootstrap/navbar";
+//@import "bootstrap/breadcrumbs";
+//@import "bootstrap/pagination";
+//@import "bootstrap/pager";
+@import "bootstrap/labels";
+@import "bootstrap/badges";
+//@import "bootstrap/jumbotron";
+@import "bootstrap/thumbnails";
+@import "bootstrap/alerts";
+@import "bootstrap/progress-bars";
+@import "bootstrap/media";
+@import "bootstrap/list-group";
+@import "bootstrap/panels";
+//@import "bootstrap/responsive-embed";
+//@import "bootstrap/wells";
+@import "bootstrap/close";
+
+// Components w/ JavaScript
+//@import "bootstrap/modals";
+//@import "bootstrap/tooltip";
+//@import "bootstrap/popovers";
+//@import "bootstrap/carousel";
+
+// Utility classes
+@import "bootstrap/utilities";
+@import "bootstrap/responsive-utilities";

data/app/assets/stylesheets/disco_app/bootstrap-variables.scss

@@ -0,0 +1,12 @@
+/*!
+ * bootstrap-variables.scss
+ * Set custom values for Bootstrap variables.
+ */
+
+// Grid - change to a 24-column grid for enhanced flexibility.
+$grid-columns: 24;
+$grid-gutter-width: 12px;
+
+// Colors
+$brand-primary: #479ccf;
+$brand-danger: #ff5d5d;

data/app/assets/stylesheets/disco_app/disco_app.scss

@@ -0,0 +1,7 @@
+/*!
+ * disco_app/disco_app.scss
+ * Base styles for Disco applications.
+ */
+@import 'bootstrap-sprockets';
+@import 'bootstrap-variables';
+@import 'bootstrap-custom';

data/app/controllers/disco_app/app_proxy_controller.rb

@@ -0,0 +1,41 @@
+module DiscoApp
+  module AppProxyController
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :verify_proxy_signature
+      after_action :add_liquid_header
+
+      rescue_from ActiveRecord::RecordNotFound do |exception|
+        render_error 404
+      end
+    end
+
+    private
+
+      def verify_proxy_signature
+        unless proxy_signature_is_valid?
+          head :unauthorized
+        end
+      end
+
+      def proxy_signature_is_valid?
+        return true unless Rails.env.production?
+        query_hash = Rack::Utils.parse_query(request.query_string)
+        signature = query_hash.delete("signature")
+        sorted_params = query_hash.collect{ |k, v| "#{k}=#{Array(v).join(',')}" }.sort.join
+        calculated_signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), ShopifyApp.configuration.secret, sorted_params)
+        signature == calculated_signature
+      end
+
+      def add_liquid_header
+        response.headers['Content-Type'] = 'application/liquid'
+      end
+
+      def render_error(status)
+        add_liquid_header
+        render "disco_app/proxy_errors/#{status}", status: status
+      end
+
+  end
+end

data/app/controllers/disco_app/authenticated_controller.rb

@@ -0,0 +1,44 @@
+module DiscoApp
+  module AuthenticatedController
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :login_again_if_different_shop
+      before_action :shopify_shop
+      before_action :verify_status
+      around_filter :shopify_session
+      layout 'embedded_app'
+    end
+
+    private
+
+      def shopify_shop
+        if shop_session
+          @shop = ::Shop.find_by!(shopify_domain: @shop_session.url)
+        else
+          redirect_to_login
+        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)
+        end
+      end
+
+      def redirect_if_not_current_path(target)
+        if request.path != target
+          redirect_to target
+        end
+      end
+
+  end
+end

data/app/controllers/disco_app/carrier_request_controller.rb

@@ -0,0 +1,28 @@
+module DiscoApp
+  module CarrierRequestController
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :verify_carrier_request_signature
+    end
+
+    private
+
+      def verify_carrier_request_signature
+        unless carrier_request_signature_is_valid?
+          head :unauthorized
+        end
+      end
+
+      def carrier_request_signature_is_valid?
+        return true unless Rails.env.production?
+        data = request.body.read.to_s
+        hmac_header = request.headers['HTTP_X_SHOPIFY_HMAC_SHA256']
+        digest  = OpenSSL::Digest::Digest.new('sha256')
+        calculated_hmac = Base64.encode64(OpenSSL::HMAC.digest(digest, ShopifyApp.configuration.secret, data)).strip
+        request.body.rewind
+        calculated_hmac == hmac_header
+      end
+
+  end
+end

data/app/controllers/disco_app/charges_controller.rb

@@ -0,0 +1,30 @@
+module DiscoApp
+  class ChargesController < ApplicationController
+    include DiscoApp::AuthenticatedController
+
+    skip_before_action :verify_status, only: [:create, :activate]
+
+    # Display a "pre-charge" page, giving the opportunity to explain why a charge needs to be made.
+    def new
+    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
+    end
+
+    # 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
+      end
+      DiscoApp::ChargesService.activate(@shop, shopify_charge)
+      redirect_to main_app.root_url
+    end
+
+  end
+end

data/app/controllers/disco_app/install_controller.rb

@@ -0,0 +1,26 @@
+module DiscoApp
+  class InstallController < ApplicationController
+    include DiscoApp::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
+
+    # 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
+end

data/app/controllers/disco_app/webhooks_controller.rb

@@ -0,0 +1,40 @@
+module DiscoApp
+  class WebhooksController < ActionController::Base
+
+    before_action :verify_webhook
+
+    def process_webhook
+      # Get the topic and domain for this webhook.
+      topic = request.headers['HTTP_X_SHOPIFY_TOPIC']
+      domain = request.headers['HTTP_X_SHOPIFY_SHOP_DOMAIN']
+
+      # Try to find a matching background job task for the given topic using class name.
+      begin
+        job_class = "#{topic}_job".gsub('/', '_').classify.constantize
+      rescue NameError
+        head :bad_request
+      end
+
+      # Decode the body data and enqueue the appropriate job.
+      data = ActiveSupport::JSON::decode(request.body.read)
+      job_class.perform_later(domain, data)
+
+      render nothing: true
+    end
+
+    private
+
+      # Verify a webhook request.
+      def verify_webhook
+        data = request.body.read.to_s
+        hmac_header = request.headers['HTTP_X_SHOPIFY_HMAC_SHA256']
+        digest  = OpenSSL::Digest::Digest.new('sha256')
+        calculated_hmac = Base64.encode64(OpenSSL::HMAC.digest(digest, ShopifyApp.configuration.secret, data)).strip
+        unless calculated_hmac == hmac_header
+          head :unauthorized
+        end
+        request.body.rewind
+      end
+
+  end
+end

data/app/helpers/disco_app/application_helper.rb

@@ -0,0 +1,4 @@
+module DiscoApp
+  module ApplicationHelper
+  end
+end

data/app/jobs/disco_app/app_installed_job.rb

@@ -0,0 +1,41 @@
+module DiscoApp
+  class AppInstalledJob < DiscoApp::ShopJob
+
+    before_enqueue { @shop.awaiting_install! }
+    before_perform { @shop.installing! }
+    after_perform { @shop.installed! }
+
+    def perform(domain)
+
+      # Install webhooks.
+      (base_webhook_topics + webhook_topics).each do |topic|
+        ShopifyAPI::Webhook.create(topic: topic, address: webhooks_url, format: 'json')
+      end
+
+      # Perform initial update of shop information.
+      ::ShopUpdateJob.perform_now(domain)
+
+    end
+
+    protected
+
+      # Return a list of additional webhook topics to listen for.
+      # This method should be overridden in the application.
+      def webhook_topics
+        []
+      end
+
+    private
+
+      # Return a list of webhook topics that will always be set up for the application.
+      def base_webhook_topics
+        [:'app/uninstalled', :'shop/update']
+      end
+
+      # Return the absolute URL to the webhooks endpoint.
+      def webhooks_url
+        DiscoApp::Engine.routes.url_helpers.webhooks_url
+      end
+
+  end
+end

data/app/jobs/disco_app/app_uninstalled_job.rb

@@ -0,0 +1,18 @@
+module DiscoApp
+  class AppUninstalledJob < DiscoApp::ShopJob
+
+    before_enqueue { @shop.awaiting_uninstall! }
+    before_perform { @shop.uninstalling! }
+    after_perform { @shop.uninstalled! }
+
+    def perform(domain, shop_data)
+
+      # Mark the shop's charge status as "cancelled" unless charges have been waived.
+      unless @shop.charge_waived?
+        @shop.charge_cancelled!
+      end
+
+    end
+
+  end
+end

data/app/jobs/disco_app/shop_job.rb

@@ -0,0 +1,29 @@
+# The base class for all jobs that should be performed in the context of a particular Shop's API session. The first
+# argument to any job inheriting from this class must be the domain of the relevant store, so that the appropriate
+# Shop model can be fetched and the temporary API session created.
+
+module DiscoApp
+  class ShopJob < ActiveJob::Base
+
+    queue_as :default
+
+    before_perform { |job| find_shop(job) }
+    before_enqueue { |job| find_shop(job) }
+
+    around_enqueue { |job, block| shop_context(job, block) }
+    around_perform { |job, block| shop_context(job, block) }
+
+    private
+
+      def find_shop(job)
+        @shop ||= ::Shop.find_by!(shopify_domain: job.arguments.first)
+      end
+
+      def shop_context(job, block)
+        @shop.temp {
+          block.call(job.arguments)
+        }
+      end
+
+  end
+end

data/app/jobs/disco_app/shop_update_job.rb

@@ -0,0 +1,16 @@
+module DiscoApp
+  class ShopUpdateJob < DiscoApp::ShopJob
+
+    def perform(domain, shop_data = nil)
+      # If we weren't provided with shop data (eg from a webhook), fetch it.
+      shop_data ||= ActiveSupport::JSON::decode(ShopifyAPI::Shop.current.to_json)
+
+      # Ensure we can access shop data through symbols.
+      shop_data = HashWithIndifferentAccess.new(shop_data)
+
+      # Update model attributes present in both our model and the data hash.
+      @shop.update_attributes(shop_data.except(:id, :created_at).slice(*::Shop.column_names))
+    end
+
+  end
+end

data/app/models/disco_app/shop.rb

@@ -0,0 +1,44 @@
+module DiscoApp
+  module Shop
+    extend ActiveSupport::Concern
+
+    # Include the base ShopifyApp functionality.
+    include ShopifyApp::Shop
+
+    included do
+      # 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: ShopifySession.statuses[:installed] }
+      scope :has_active_shopify_plan, -> { where.not(plan_name: [:cancelled, :frozen]) }
+
+      # Alias 'with_shopify_session' as 'temp', as per our existing conventions.
+      alias_method :temp, :with_shopify_session
+    end
+
+    # Return a hash of attributes that should be used to create a new charge for this shop.
+    # This method can be overridden by the inheriting Shop class in order to provide charges
+    # customised to a particular shop. Otherwise, the default settings configured in application.rb
+    # will be used.
+    def new_charge_attributes
+      {
+          type: Rails.configuration.x.shopify_charges_default_type,
+          name: Rails.configuration.x.shopify_app_name,
+          price: Rails.configuration.x.shopify_charges_default_price,
+          trial_days: Rails.configuration.x.shopify_charges_default_trial_days,
+      }
+    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
+    end
+
+  end
+end

data/app/services/disco_app/charges_service.rb

@@ -0,0 +1,73 @@
+module DiscoApp
+  class ChargesService
+
+    # Create a new charge for the given Shop using the Shopify API.
+    #
+    # The attributes of the charge are fetched using the shop's `new_charge_attributes` method, which can be overriden
+    # to provide custom charge types for individual shops.
+    #
+    # Returns the new Shopify charge model on success, nil otherwise.
+    def self.create(shop)
+      shopify_charge = shop.temp {
+        self.charge_api_class(shop).create(self.new_charge_attributes(shop))
+      }
+
+      # If the charge was successfully created, update the charge status on the shop.
+      shop.update_charge_status(shopify_charge) if shopify_charge
+
+      # Return the charge.
+      shopify_charge
+    end
+
+    # Fetch the specified charge for the given Shop using the Shopify API and check that it has been actioned (either
+    # accepted or declined). Updates the shop object's charge status, then returns the charge if it was accepted or
+    # nil otherwise.
+    def self.get_accepted_charge(shop, charge_id)
+      begin
+        shopify_charge = shop.temp {
+          self.charge_api_class(shop).find(charge_id)
+        }
+
+        # If the charge was successfully fetched, update the status for the shop accordingly.
+        shop.update_charge_status(shopify_charge) if shopify_charge
+
+        shopify_charge
+      rescue
+        nil
+      end
+    end
+
+    # Attempt to activate the given Shopify charge for the given Shop using the Shopify API.
+    # Returns true on successful activation, false otherwise.
+    def self.activate(shop, shopify_charge)
+      begin
+        shop.temp {
+          shopify_charge.activate
+        }
+        shop.charge_active!
+        true
+      rescue
+        false
+      end
+    end
+
+    # Merge the new_charge_attributes returned by the given shop model and merge them with some application-level
+    # charge attributes.
+    def self.new_charge_attributes(shop)
+      shop.new_charge_attributes.merge(
+        return_url: DiscoApp::Engine.routes.url_helpers.activate_charge_url,
+        test: !Rails.configuration.x.shopify_charges_real,
+      )
+    end
+
+    # Get the appropriate Shopify API class for the given shop (either ApplicationCharge or RecurringApplicationCharge).
+    def self.charge_api_class(shop)
+      if shop.new_charge_attributes[:type] == :one_time
+        ShopifyAPI::ApplicationCharge
+      else
+        ShopifyAPI::RecurringApplicationCharge
+      end
+    end
+
+  end
+end

data/app/views/disco_app/charges/activate.html.erb

@@ -0,0 +1 @@
+activate_charge

data/app/views/disco_app/charges/create.html.erb

@@ -0,0 +1 @@
+create_charge

data/app/views/disco_app/charges/new.html.erb

@@ -0,0 +1,45 @@
+<% provide(:title, 'Thankyou') %>
+
+<div class="row">
+  <% if @shop.charge_declined? %>
+    <div class="alert alert-warning">
+      <p>
+        Oops! Looks like you declined the charge.
+        Unfortunately, you'll have to accept the charge on the next screen in order to continue installing the application.
+      </p>
+    </div>
+  <% elsif @shop.charge_cancelled? %>
+    <div class="alert alert-warning">
+      <p>
+        Your authorized charge for this application has expired.
+        This could have occurred if:
+      </p>
+      <ul>
+        <li>You uninstalled and reinstalled the application; or</li>
+        <li>Your plan level has changed.</li>
+      </ul>
+      <p>
+        In either case, it's no problem!
+        Simply click okay and you'll be asked to authorize a new charge.
+        Don't worry - you *wont'* be billed twice.
+      </p>
+    </div>
+  <% else %>
+    <div class="alert alert-success">
+      <p>
+        Thanks for installing <%= Rails.configuration.x.shopify_app_name %>!
+      </p>
+      <p>
+        Before we start setting things up, we need you to authorize a charge for the application.
+      </p>
+    </div>
+  <% end %>
+</div>
+
+<div class="row">
+  <%= form_tag disco_app.create_charge_path, method: 'POST', target: '_parent' do %>
+    <div class="form-group">
+      <%= submit_tag 'Okay', class: 'form-input' %>
+    </div>
+  <% end %>
+</div>

data/app/views/disco_app/install/installing.html.erb

@@ -0,0 +1,7 @@
+<% content_for :extra_head do %>
+  <meta http-equiv="refresh" content="5">
+<% end %>
+
+<p>
+  Installing, please wait...
+</p>

data/app/views/disco_app/install/uninstalling.html.erb

@@ -0,0 +1 @@
+uninstalling

data/app/views/disco_app/proxy_errors/404.html.erb

@@ -0,0 +1 @@
+404 Not Found

data/config/routes.rb

@@ -0,0 +1,19 @@
+DiscoApp::Engine.routes.draw do
+
+  controller :webhooks do
+    post 'webhooks' => :process_webhook, as: :webhooks
+  end
+
+  controller :charges do
+    get 'charges/new' => :new, as: :new_charge
+    post 'charges/create' => :create, as: :create_charge
+    get 'charges/activate' => :activate, as: :activate_charge
+  end
+
+  controller :install do
+    get 'install' => :install, as: :install
+    get 'installing' => :installing, as: :installing
+    get 'uninstalling' => :uninstalling, as: :uninstalling
+  end
+
+end

data/db/migrate/20150525162112_add_status_to_shops.rb

@@ -0,0 +1,5 @@
+class AddStatusToShops < ActiveRecord::Migration
+  def change
+    add_column :shops, :status, :integer, default: 0
+  end
+end