disco_app 0.5.6 → 0.6.0

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

@@ -0,0 +1,19 @@
+module DiscoApp::Concerns::AppUninstalledJob
+  extend ActiveSupport::Concern
+
+  included do
+
+    before_enqueue { @shop.awaiting_uninstall! }
+    before_perform { @shop.uninstalling! }
+    after_perform { @shop.uninstalled! }
+
+  end
+
+  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

data/app/jobs/disco_app/shop_job.rb

@@ -16,7 +16,7 @@ module DiscoApp
     private
 
       def find_shop(job)
-        @shop ||= ::Shop.find_by!(shopify_domain: job.arguments.first)
+        @shop ||= Shop.find_by!(shopify_domain: job.arguments.first)
       end
 
       def shop_context(job, block)

data/app/jobs/disco_app/shop_update_job.rb

@@ -9,7 +9,7 @@ module DiscoApp
       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))
+      @shop.update_attributes(shop_data.except(:id, :created_at).slice(*DiscoApp::Shop.column_names))
     end
 
   end

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

@@ -0,0 +1,14 @@
+module DiscoApp::Concerns::Plan
+  extend ActiveSupport::Concern
+
+  included do
+
+    has_many :subscriptions
+    has_many :shops, through: :subscriptions
+
+    enum status: [:available, :unavailable, :hidden]
+
+    scope :available, -> { where status: statuses[:available] }
+
+  end
+end

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

@@ -0,0 +1,62 @@
+module DiscoApp::Concerns::Shop
+  extend ActiveSupport::Concern
+
+  included do
+    include ShopifyApp::Shop
+
+    # Define relationships to plans and subscriptions.
+    has_many :subscriptions
+    has_many :plans, through: :subscriptions
+
+    # 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] }
+    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
+
+    # 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
+
+    # Convenience method to get the currently active subscription for this Shop.
+    def current_subscription
+      subscriptions.active.first
+    end
+
+    # Return the absolute URL to the shop's storefront.
+    # @TODO: Account for HTTPS.
+    def url
+      "http://#{domain}"
+    end
+
+    # Return the absolute URL to the shop's admin.
+    def admin_url
+      "https://#{shopify_domain}/admin"
+    end
+
+  end
+
+end

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

@@ -0,0 +1,14 @@
+module DiscoApp::Concerns::Subscription
+  extend ActiveSupport::Concern
+
+  included do
+
+    belongs_to :shop
+    belongs_to :plan
+
+    enum status: [:active, :replaced, :cancelled]
+
+    scope :active, -> { where status: statuses[:active] }
+
+  end
+end

data/app/models/disco_app/plan.rb

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

data/app/models/disco_app/session_storage.rb

@@ -0,0 +1,18 @@
+module DiscoApp
+  class SessionStorage
+    def self.store(session)
+      shop = Shop.find_or_initialize_by(shopify_domain: session.url)
+      shop.shopify_token = session.token
+      shop.save!
+      shop.id
+    end
+
+    def self.retrieve(id)
+      return unless id
+      shop = Shop.find(id)
+      ShopifyAPI::Session.new(shop.shopify_domain, shop.shopify_token)
+    rescue ActiveRecord::RecordNotFound
+      nil
+    end
+  end
+end

data/app/models/disco_app/shop.rb

@@ -1,44 +1,3 @@
-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: ::Shop.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
+class DiscoApp::Shop < ActiveRecord::Base
+  include DiscoApp::Concerns::Shop
 end

data/app/models/disco_app/subscription.rb

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

data/app/services/disco_app/subscription_service.rb

@@ -0,0 +1,25 @@
+class DiscoApp::SubscriptionService
+
+  # Subscribe the given shop to the given plan.
+  def self.subscribe(shop, plan)
+    # Mark all existing active subscriptions as replaced.
+    shop.subscriptions.active.update_all(status: DiscoApp::Subscription.statuses[:replaced])
+
+    # Add the new subscription.
+    DiscoApp::Subscription.create!(
+      shop: shop,
+      plan: plan,
+      status: DiscoApp::Subscription.statuses[:active],
+      name: plan.name,
+      charge_type: plan.charge_type,
+      price: plan.default_price,
+      trial_days: plan.default_trial_days
+    )
+  end
+
+  # Cancel any active subscription for the given shop.
+  def self.cancel(shop)
+    shop.subscriptions.active.update_all(status: DiscoApp::Subscription.statuses[:cancelled])
+  end
+
+end

data/app/services/disco_app/webhook_service.rb

@@ -0,0 +1,30 @@
+class DiscoApp::WebhookService
+
+  # Return true iff the provided hmac_to_verify matches that calculated from the
+  # give data and secret.
+  def self.is_valid_hmac?(body, secret, hmac_to_verify)
+    self.calculated_hmac(body, secret) == hmac_to_verify
+  end
+
+  # Calculate the HMAC for the given data and secret.
+  def self.calculated_hmac(body, secret)
+    digest  = OpenSSL::Digest.new('sha256')
+    Base64.encode64(OpenSSL::HMAC.digest(digest, secret, body)).strip
+  end
+
+  # Try to find a job class for the given webhook topic.
+  def self.find_job_class(topic)
+    begin
+      # First try to find a top-level matching job class.
+      "#{topic}_job".gsub('/', '_').classify.constantize
+    rescue NameError
+      # If that fails, try to find a DiscoApp:: prefixed job class.
+      begin
+        %Q{DiscoApp::#{"#{topic}_job".gsub('/', '_').classify}}.constantize
+      rescue NameError
+        nil
+      end
+    end
+  end
+
+end

data/app/views/disco_app/shared/_card.html.erb

@@ -0,0 +1,16 @@
+<% disabled ||= false %>
+<div class="next-card <% if disabled %>next-card--disabled<% end %>">
+  <% if content_for?(:card_header) %>
+    <header class="next-card__header">
+      <%= content_for :card_header %>
+    </header>
+  <% end %>
+  <section class="next-card__section">
+    <%= content_for :card_content %>
+  </section>
+  <% if content_for?(:card_footer) %>
+    <footer class="next-card__footer">
+      <%= content_for :card_footer %>
+    </footer>
+  <% end %>
+</div>

data/app/views/disco_app/shared/_section.html.erb

@@ -0,0 +1,17 @@
+<section class="section">
+  <div class="layout-content">
+
+    <aside class="layout-content__sidebar layout-content__first">
+      <% if content_for?(:section_summary) %>
+      <div class="section-summary">
+        <%= content_for :section_summary %>
+      </div>
+      <% end %>
+    </aside>
+
+    <section class="layout-content__main">
+      <%= content_for :section_content %>
+    </section>
+
+  </div>
+</section>

data/{lib/generators/disco_app/templates → app}/views/layouts/embedded_app.html.erb

@@ -5,17 +5,12 @@
 
   <script src="//cdn.shopify.com/s/assets/external/app.js?<%= Time.now.strftime('%Y%m%d%H') %>"></script>
   <script type="text/javascript">
+    // Initialise the Shopify App.
     ShopifyApp.init({
       "apiKey": "<%= ShopifyApp.configuration.api_key %>",
       "shopOrigin": "<%= "https://#{ @shop_session.url }" if @shop_session %>",
       "debug": <%= Rails.env.development? ? 'true' : 'false' %>
     });
-
-    ShopifyApp.ready(function() {
-      ShopifyApp.Bar.initialize({
-        title: "<%= yield(:title) %>"
-      });
-    });
   </script>
 
   <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
@@ -25,9 +20,22 @@
   <%= yield :extra_head %>
 </head>
 <body>
+  <script type="text/javascript">
+    ShopifyApp.Bar.initialize({
+      title: "<%= yield(:title) %>",
+      icon: "<%= image_url("disco_app/icon.svg") %>",
+      buttons: <%= content_for?(:buttons) ? content_for(:buttons) : '{}' %>
+    });
+  </script>
 
   <%= yield %>
 
+  <% flash.each do |key, message| %>
+  <script type="text/javascript">
+    ShopifyApp.flash<%= (key == 'error') ? 'Error' : 'Notice' %>('<%= message %>');
+  </script>
+  <% end %>
+
   <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
 </body>
 </html>

data/db/migrate/20150525000000_create_shops_if_not_existent.rb

@@ -0,0 +1,15 @@
+class CreateShopsIfNotExistent < ActiveRecord::Migration
+
+  def change
+    unless table_exists? :shops or table_exists? :disco_app_shops
+      create_table :shops  do |t|
+        t.string :shopify_domain, null: false
+        t.string :shopify_token, null: false
+        t.timestamps
+      end
+
+      add_index :shops, :shopify_domain, unique: true
+    end
+  end
+
+end

data/db/migrate/20151017231302_create_disco_app_plans.rb

@@ -0,0 +1,13 @@
+class CreateDiscoAppPlans < ActiveRecord::Migration
+  def change
+    create_table :disco_app_plans do |t|
+      t.integer :status
+      t.string :name
+      t.integer :charge_type
+      t.decimal :default_price
+      t.integer :default_trial_days
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20151017232027_create_disco_app_subscriptions.rb

@@ -0,0 +1,15 @@
+class CreateDiscoAppSubscriptions < ActiveRecord::Migration
+  def change
+    create_table :disco_app_subscriptions do |t|
+      t.belongs_to :shop, index: true
+      t.belongs_to :plan, index: true
+      t.integer :status
+      t.string :name
+      t.integer :charge_type
+      t.decimal :price
+      t.integer :trial_days
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20151017234409_move_shop_to_disco_app_engine.rb

@@ -0,0 +1,5 @@
+class MoveShopToDiscoAppEngine < ActiveRecord::Migration
+  def change
+    rename_table :shops, :disco_app_shops
+  end
+end

data/lib/disco_app/engine.rb

@@ -1,3 +1,8 @@
+require 'shopify_app'
+require 'bootstrap-sass'
+require 'jquery-rails'
+require 'turbolinks'
+
 module DiscoApp
   class Engine < ::Rails::Engine
     isolate_namespace DiscoApp

data/lib/disco_app/version.rb

@@ -1,3 +1,3 @@
 module DiscoApp
-  VERSION = "0.5.6"
+  VERSION = "0.6.0"
 end

data/lib/generators/disco_app/disco_app_generator.rb

@@ -27,14 +27,14 @@ class DiscoAppGenerator < Rails::Generators::Base
     gsub_file 'Gemfile', /^# Use sqlite3 as the database for Active Record\ngem 'sqlite3'/m, ''
 
     # Add gems common to all environments.
-    gem 'shopify_app', '~> 6.1.0'
-    gem 'sidekiq', '~> 3.5.0'
-    gem 'puma', '~> 2.11.3'
+    gem 'shopify_app', '~> 6.2.0'
+    gem 'sidekiq', '~> 3.5.1'
+    gem 'puma', '~> 2.14.0'
     gem 'bootstrap-sass', '~> 3.3.5.1'
 
     # Add gems for development and testing only.
     gem_group :development, :test do
-      gem 'sqlite3', '~> 1.3.10'
+      gem 'sqlite3', '~> 1.3.11'
       gem 'dotenv-rails', '~> 2.0.2'
       gem 'minitest-reporters', '~> 1.0.19'
       gem 'guard', '~> 2.13.0'
@@ -43,7 +43,7 @@ class DiscoAppGenerator < Rails::Generators::Base
 
     # Add gems for production only.
     gem_group :production do
-      gem 'pg', '~> 0.18.2'
+      gem 'pg', '~> 0.18.3'
       gem 'rails_12factor', '~> 0.0.3'
     end
   end
@@ -86,45 +86,18 @@ class DiscoAppGenerator < Rails::Generators::Base
   # Create Rakefiles
   def create_rakefiles
     rakefile 'start.rake' do
-      %Q{
+      <<-RAKEFILE.strip_heredoc
         task start: :environment do
           system 'bundle exec rails server -b 127.0.0.1 -p 3000'
         end
-      }
+      RAKEFILE
     end
     rakefile 'console.rake' do
-      %Q{
+      <<-RAKEFILE.strip_heredoc
         task console: :environment do
           system 'bundle exec rails console'
         end
-      }
-    end
-  end
-
-  # Run shopify_app:install and shopify_app:shop_model
-  def shopify_app_install
-    generate 'shopify_app:install'
-    generate 'shopify_app:shop_model'
-  end
-
-  # Set up initializers, overriding some of the defaults generated by shopify_app:install and shopify_app:shop_model
-  def setup_initializers
-    ['shopify_app', 'disco_app'].each do |initializer_name|
-      copy_file "initializers/#{initializer_name}.rb", "config/initializers/#{initializer_name}.rb"
-    end
-  end
-
-  # Set up models, overriding some of the defaults generated by shopify_app:install and shopify_app:shop_model
-  def setup_models
-    ['shop'].each do |model_name|
-      copy_file "models/#{model_name}.rb", "app/models/#{model_name}.rb"
-    end
-  end
-
-  # Set up default jobs.
-  def setup_jobs
-    ['app_installed', 'app_uninstalled', 'shop_update'].each do |job_name|
-      copy_file "jobs/#{job_name}_job.rb", "app/jobs/#{job_name}_job.rb"
+      RAKEFILE
     end
   end
 
@@ -133,29 +106,33 @@ class DiscoAppGenerator < Rails::Generators::Base
     route "mount DiscoApp::Engine, at: '/'"
   end
 
-  # Set up controllers.
-  def setup_controllers
-    ['home'].each do |controller_name|
-      copy_file "controllers/#{controller_name}_controller.rb", "app/controllers/#{controller_name}_controller.rb"
-    end
+  # Run shopify_app:install
+  def shopify_app_install
+    generate 'shopify_app:install'
   end
 
-  # Set up views.
-  def setup_views
-    ['layouts/application', 'layouts/embedded_app', 'home/index', 'sessions/new'].each do |view_name|
-      copy_file "views/#{view_name}.html.erb", "app/views/#{view_name}.html.erb"
-    end
-  end
+  # Copy template files to the appropriate location. In some cases, we'll be
+  # overwriting or removing existing files or those created by ShopifyApp.
+  def copy_and_remove_files
+    # Copy initializers
+    copy_file 'initializers/shopify_app.rb', 'config/initializers/shopify_app.rb'
+    copy_file 'initializers/disco_app.rb', 'config/initializers/disco_app.rb'
+    copy_file 'initializers/shopify_session_repository.rb', 'config/initializers/shopify_session_repository.rb'
 
-  # Set up assets.
-  def setup_assets
-    # Copy over our default assets.
-    ['javascripts/application.js', 'stylesheets/application.scss'].each do |asset_name|
-      copy_file "assets/#{asset_name}", "app/assets/#{asset_name}"
-    end
+    # Copy default home controller and view
+    copy_file 'controllers/home_controller.rb', 'app/controllers/home_controller.rb'
+    copy_file 'views/home/index.html.erb', 'app/views/home/index.html.erb'
 
-    # Make sure application.css is removed.
+    # Copy assets
+    copy_file 'assets/javascripts/application.js', 'app/assets/javascripts/application.js'
+    copy_file 'assets/stylesheets/application.scss', 'app/assets/stylesheets/application.scss'
+
+    # Remove application.css
     remove_file 'app/assets/stylesheets/application.css'
+
+    # Remove the layout files created by ShopifyApp
+    remove_file 'app/views/layout/application.html.erb'
+    remove_file 'app/views/layout/embedded_app.html.erb'
   end
 
   # Copy engine migrations over.

data/lib/generators/disco_app/mailify/mailify_generator.rb

@@ -0,0 +1,55 @@
+module DiscoApp
+  module Generators
+    class MailifyGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Install the react-rails gem and run its setup.
+      def install_gem
+        # Add premailer gem to Gemfile.
+        gem 'premailer-rails', '~> 1.8.2'
+
+        # Add explicit dependency on Nokogiri
+        gem 'nokogiri', '~> 1.6.6.1'
+
+        # Add the Mailgun rails gem (production only)
+        gem_group :production do
+          gem 'mailgun_rails', '~> 0.7.0'
+        end
+
+        # Install gem.
+        Bundler.with_clean_env do
+          run 'bundle install'
+        end
+      end
+
+      # Set application configuration
+      def configure_application
+        configuration = <<-CONFIG.strip_heredoc
+
+          # Configure ActionMailer to use MailGun
+          if ENV['MAILGUN_API_KEY']
+            config.action_mailer.delivery_method = :mailgun
+            config.action_mailer.mailgun_settings = {
+              api_key: ENV['MAILGUN_API_KEY'],
+              domain: ENV['MAILGUN_API_DOMAIN']
+            }
+          end
+        CONFIG
+        application configuration, env: :production
+      end
+
+      # Add entries to .env and .env.sample
+      def add_env_variables
+        configuration = <<-CONFIG.strip_heredoc
+
+          MAILGUN_API_KEY=
+          MAILGUN_API_DOMAIN=
+        CONFIG
+        append_to_file '.env', configuration
+        append_to_file '.env.sample', configuration
+      end
+
+    end
+  end
+end

data/lib/generators/disco_app/templates/initializers/shopify_session_repository.rb

@@ -0,0 +1,7 @@
+if Rails.configuration.cache_classes
+  ShopifyApp::SessionRepository.storage = DiscoApp::SessionStorage
+else
+  ActionDispatch::Reloader.to_prepare do
+    ShopifyApp::SessionRepository.storage = DiscoApp::SessionStorage
+  end
+end

data/test/controllers/disco_app/install_controller_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+class DiscoApp::InstallControllerTest < ActionController::TestCase
+  include ActiveJob::TestHelper
+
+  def setup
+    @shop = disco_app_shops(:widget_store)
+    @routes = DiscoApp::Engine.routes
+    log_in_as(@shop)
+  end
+
+  def teardown
+    @shop = nil
+  end
+
+  test 'logged-in but uninstalled user triggers installation from install page' do
+    get(:install)
+    assert_redirected_to :installing
+    assert_enqueued_jobs 1
+    @shop.reload
+    assert @shop.awaiting_install?
+  end
+
+  test 'logged-in and installed user is redirected to installing url for install/uninstalling actions' do
+    @shop.installed!
+    [:install, :uninstalling].each do |action|
+      get(:install)
+      assert_redirected_to :installing
+    end
+  end
+
+  test 'logged-in and installed user is redirected to root url for installing' do
+    @shop.installed!
+    get(:installing)
+    assert_redirected_to Rails.application.routes.url_helpers.root_path
+  end
+
+  test 'logged-in and uninstalling user sees uninstalling page' do
+    @shop.uninstalling!
+    get(:uninstalling)
+    assert_response :success
+  end
+
+  test 'logged-in and uninstalled user starts install process again' do
+    @shop.uninstalled!
+    get(:uninstalling)
+    assert_redirected_to :install
+  end
+
+end