disco_app 0.8.5

data/lib/generators/disco_app/disco_app_generator.rb

@@ -0,0 +1,163 @@
+class DiscoAppGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  # Copy a number of template files to the top-level directory of our application:
+  #
+  #  - .env and .env.local for settings environment variables in development with dotenv-rails;
+  #  - Slightly customised version of the default Rails .gitignore;
+  #  - Default simple Procfile for Heroku.
+  #
+  def copy_root_files
+    %w(.env .env.local .gitignore Procfile).each do |file|
+      copy_file "root/#{file}", file
+    end
+  end
+
+  # Remove a number of root files.
+  def remove_root_files
+    %w(README.rdoc).each do |file|
+      remove_file file
+    end
+  end
+
+  # Configure the application's Gemfile.
+  def configure_gems
+    # Remove sqlite from the general Gemfile.
+    gsub_file 'Gemfile', /^# Use sqlite3 as the database for Active Record\ngem 'sqlite3'/m, ''
+
+    # Add gems common to all environments.
+    gem 'shopify_app', '~> 6.4.1'
+    gem 'sidekiq', '~> 4.0.2'
+    gem 'puma', '~> 2.14.0'
+    gem 'bootstrap-sass', '~> 3.3.5.1'
+    gem 'activerecord-session_store', '~> 0.1.2'
+    gem 'activeresource', github: 'shopify/activeresource', tag: '4.2-threadsafe'
+    gem 'rails-bigint-pk', '~> 1.2.0'
+
+    # Add gems for development and testing only.
+    gem_group :development, :test do
+      gem 'sqlite3', '~> 1.3.11'
+      gem 'dotenv-rails', '~> 2.0.2'
+      gem 'minitest-reporters', '~> 1.0.19'
+      gem 'guard', '~> 2.13.0'
+      gem 'guard-minitest', '~> 2.4.4'
+    end
+
+    # Add gems for production only.
+    gem_group :production do
+      gem 'pg', '~> 0.18.3'
+      gem 'rails_12factor', '~> 0.0.3'
+    end
+  end
+
+  # Run bundle install to add our new gems before running tasks.
+  def bundle_install
+    Bundler.with_clean_env do
+      run 'bundle install'
+    end
+  end
+
+  # Make any required adjustments to the application configuration.
+  def configure_application
+    # The force_ssl flag is commented by default for production.
+    # Uncomment to ensure config.force_ssl = true in production.
+    uncomment_lines 'config/environments/production.rb', /force_ssl/
+
+    # Set defaults for various charge attributes.
+    application "config.x.shopify_charges_default_trial_days = 14\n"
+    application "config.x.shopify_charges_default_price = 10.00"
+    application "config.x.shopify_charges_default_type = :recurring"
+    application "# Set defaults for charges created by the application"
+
+    # Set the "real charges" config variable to false explicitly by default.
+    # Only in production do we read from the environment variable and
+    # potentially have it become true.
+    application "config.x.shopify_charges_real = false\n"
+    application "# Explicitly prevent real charges being created by default"
+    application "config.x.shopify_charges_real = ENV['SHOPIFY_CHARGES_REAL'] == 'true'\n", env: :production
+    application "# Allow real charges in production with an ENV variable", env: :production
+
+    # Configure session storage.
+    application "ActiveRecord::SessionStore::Session.table_name = 'disco_app_sessions'"
+    application "ActionDispatch::Session::ActiveRecordStore.session_class = DiscoApp::Session"
+    application "# Configure custom session storage"
+
+    # Set Sidekiq as the queue adapter in production.
+    application "config.active_job.queue_adapter = :sidekiq\n", env: :production
+    application "# Use Sidekiq as the active job backend", env: :production
+
+    # Ensure the application configuration uses the DEFAULT_HOST environment
+    # variable to set up support for reverse routing absolute URLS (needed when
+    # generating Webhook URLs for example).
+    application "routes.default_url_options[:host] = ENV['DEFAULT_HOST']\n"
+    application "# Set the default host for absolute URL routing purposes"
+
+    # Copy over the default puma configuration.
+    copy_file 'config/puma.rb', 'config/puma.rb'
+  end
+
+  # Set up routes.
+  def setup_routes
+    route "mount DiscoApp::Engine, at: '/'"
+  end
+
+  # Run generators.
+  def run_generators
+    generate 'shopify_app:install'
+    generate 'shopify_app:home_controller'
+    generate 'bigint_pk:install'
+  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'
+    copy_file 'initializers/session_store.rb', 'config/initializers/session_store.rb'
+
+    # 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'
+
+    # 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/layouts/application.html.erb'
+    remove_file 'app/views/layouts/embedded_app.html.erb'
+  end
+
+  # Add the Disco App test helper to test/test_helper.rb
+  def add_test_helper
+    inject_into_file 'test/test_helper.rb', "require 'disco_app/test_help'\n", { after: "require 'rails/test_help'\n" }
+  end
+
+  # Copy engine migrations over.
+  def install_migrations
+    rake 'disco_app:install:migrations'
+  end
+
+  # Run migrations.
+  def migrate
+    rake 'db:migrate'
+  end
+
+  # Lock down the application to a specific Ruby version:
+  #
+  #  - Via .ruby-version file for rbenv in development;
+  #  - Via a Gemfile line in production.
+  #
+  # This should be the last operation, to allow all other operations to run in the initial Ruby version.
+  def set_ruby_version
+    copy_file 'root/.ruby-version', '.ruby-version'
+    prepend_to_file 'Gemfile', "ruby '2.3.0'\n"
+  end
+
+end

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

@@ -0,0 +1,54 @@
+module DiscoApp
+  module Generators
+    class MailifyGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      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.local
+      def add_env_variables
+        configuration = <<-CONFIG.strip_heredoc
+
+          MAILGUN_API_KEY=
+          MAILGUN_API_DOMAIN=
+        CONFIG
+        append_to_file '.env', configuration
+        append_to_file '.env.local', configuration
+      end
+
+    end
+  end
+end

data/lib/generators/disco_app/monitorify/monitorify_generator.rb

@@ -0,0 +1,28 @@
+module DiscoApp
+  module Generators
+    class MonitorifyGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Install the Rollbar, OJ and New Relic gems.
+      def install_gems
+        # Add gem to Gemfile
+        gem 'rollbar', '~> 2.8.0'
+        gem 'oj', '~> 2.14.5'
+        gem 'newrelic_rpm', '~> 3.14.1.314'
+
+        # Install gem.
+        Bundler.with_clean_env do
+          run 'bundle install'
+        end
+      end
+
+      # Copy Rollbar initializer and New Relic config file.
+      def configure
+        copy_file 'initializers/rollbar.rb', 'config/initializers/rollbar.rb'
+        copy_file 'config/newrelic.yml', 'config/newrelic.yml'
+      end
+
+    end
+  end
+end

data/lib/generators/disco_app/monitorify/templates/config/newrelic.yml

@@ -0,0 +1,26 @@
+# This file configures the New Relic Agent.
+#
+# For full documentation of agent configuration options, please refer to
+# https://docs.newrelic.com/docs/agents/ruby-agent/installation-configuration/ruby-agent-configuration
+
+common: &default_settings
+  license_key: <%= ENV['NEW_RELIC_LICENSE_KEY'] %>
+  app_name: <%= ENV['SHOPIFY_APP_NAME'] || 'Unknown App' %>
+
+  # To disable the agent regardless of other settings, uncomment the following:
+  # agent_enabled: false
+
+  # Logging level for log/newrelic_agent.log
+  log_level: info
+
+development:
+  <<: *default_settings
+  app_name: <%= ENV['SHOPIFY_APP_NAME'] || 'Unknown App' %> (Development)
+  developer_mode: true
+
+test:
+  <<: *default_settings
+  monitor_mode: false
+
+production:
+  <<: *default_settings

data/lib/generators/disco_app/monitorify/templates/initializers/rollbar.rb

@@ -0,0 +1,12 @@
+Rollbar.configure do |config|
+  # Fetch the access token from the environment.
+  config.access_token = ENV['ROLLBAR_ACCESS_TOKEN']
+
+  # Only use Rollbar in production when there's a token configured.
+  unless config.access_token and Rails.env.production?
+    config.enabled = false
+  end
+
+  # Enable delayed reporting (using Sidekiq)
+  config.use_sidekiq
+end

data/lib/generators/disco_app/reactify/reactify_generator.rb

@@ -0,0 +1,45 @@
+module DiscoApp
+  module Generators
+    class ReactifyGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Install the react-rails gem and run its setup.
+      def install_gem
+        # Add gem to Gemfile
+        gem 'react-rails', '~> 1.5.0'
+
+        # Install gem.
+        Bundler.with_clean_env do
+          run 'bundle install'
+        end
+
+        # Run the gem's generator.
+        generate 'react:install'
+      end
+
+      # Set application configuration
+      def configure_application
+        application "config.react.variant = :development", env: :development
+        application "# Use development variant of React in development.", env: :development
+        application "config.react.variant = :production", env: :production
+        application "# Use production variant of React in production.", env: :production
+      end
+
+      # Include the DiscoApp component library in the application.js manifest.
+      def add_to_manifest
+        inject_into_file manifest, "//= require disco_app/components\n", { before: "//= require components\n" }
+      end
+
+      private
+
+        # This method of finding the application.js manifest taken from the
+        # install generator in react-rails.
+        # See https://github.com/reactjs/react-rails/blob/3f0af13fa755d6e95969c17728d0354c234f3a37/lib/generators/react/install_generator.rb#L53-L55
+        def manifest
+          Pathname.new(destination_root).join('app/assets/javascripts', 'application.js')
+        end
+
+    end
+  end
+end

data/lib/generators/disco_app/templates/assets/javascripts/application.js

@@ -0,0 +1,17 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require disco_app/disco_app
+//= require_tree .

data/lib/generators/disco_app/templates/assets/stylesheets/application.scss

@@ -0,0 +1,5 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ */
+@import "disco_app/disco_app";

data/lib/generators/disco_app/templates/config/puma.rb

@@ -0,0 +1,15 @@
+workers Integer(ENV['WEB_CONCURRENCY'] || 2)
+threads_count = Integer(ENV['MAX_THREADS'] || 5)
+threads threads_count, threads_count
+
+preload_app!
+
+rackup      DefaultRackup
+port        ENV['PORT']     || 3000
+environment ENV['RACK_ENV'] || 'development'
+
+on_worker_boot do
+  # Worker specific setup for Rails 4.1+
+  # See: https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#on-worker-boot
+  ActiveRecord::Base.establish_connection
+end

data/lib/generators/disco_app/templates/controllers/home_controller.rb

@@ -0,0 +1,7 @@
+class HomeController < ApplicationController
+  include DiscoApp::AuthenticatedController
+
+  def index
+  end
+
+end

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

@@ -0,0 +1,14 @@
+DiscoApp::Engine.routes.default_url_options[:host] = ENV['DEFAULT_HOST']
+
+DiscoApp.configure do |config|
+  # Required configuration.
+  config.app_name = ENV['SHOPIFY_APP_NAME']
+
+  # Set the below if using an application proxy.
+  config.app_proxy_prefix = ENV['SHOPIFY_APP_PROXY_PREFIX']
+
+  # Optional configuration, usually useful for development environments.
+  config.skip_proxy_verification = ENV['SKIP_PROXY_VERIFICATION']
+  config.skip_webhook_verification = ENV['SKIP_WEBHOOK_VERIFICATION']
+  config.skip_carrier_request_verification = ENV['SKIP_CARRIER_REQUEST_VERIFICATION']
+end

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

@@ -0,0 +1,2 @@
+# Use an ActiveRecord-based session store.
+Rails.application.config.session_store :active_record_store, :key => '_disco_app_session'

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

@@ -0,0 +1,7 @@
+ShopifyApp.configure do |config|
+  config.api_key = ENV['SHOPIFY_APP_API_KEY']
+  config.secret = ENV['SHOPIFY_APP_SECRET']
+  config.redirect_uri = ENV['SHOPIFY_APP_REDIRECT_URI']
+  config.scope = ENV['SHOPIFY_APP_SCOPE']
+  config.embedded_app = true
+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/lib/generators/disco_app/templates/root/Procfile

@@ -0,0 +1,2 @@
+web: bundle exec puma -C ./config/puma.rb
+worker: bundle exec sidekiq -c 5 -v -q default -q mailers -q rollbar

data/lib/generators/disco_app/templates/views/home/index.html.erb

@@ -0,0 +1,2 @@
+<% provide(:title, 'Welcome') %>
+<h1>Welcome</h1>

data/lib/tasks/carrier_service.rake

@@ -0,0 +1,10 @@
+namespace :carrier_service do
+
+  desc 'Synchronise carrier service across all installed shops.'
+  task sync: :environment do
+    DiscoApp::Shop.installed.has_active_shopify_plan.each do |shop|
+      DiscoApp::SynchroniseCarrierServiceJob.perform_later(shop.shopify_domain)
+    end
+  end
+
+end

data/lib/tasks/sessions.rake

@@ -0,0 +1,9 @@
+namespace :sessions do
+
+  desc 'Clean out any stale sessions.'
+  task clean: [:environment, 'db:load_config'] do
+    threshold = (ENV['SESSIONS_CLEAN_THRESHOLD_DAYS'] || 30).to_i.days.ago
+    ActiveRecord::Base.connection.execute("DELETE FROM #{ActiveRecord::SessionStore::Session.table_name} WHERE updated_at < '#{threshold}'")
+  end
+
+end

data/lib/tasks/start.rake

@@ -0,0 +1,3 @@
+task start: :environment do
+  system 'bundle exec rails server -b 127.0.0.1 -p 3000'
+end

data/lib/tasks/webhooks.rake

@@ -0,0 +1,10 @@
+namespace :webhooks do
+
+  desc 'Synchronise webhooks across all installed shops.'
+  task sync: :environment do
+    DiscoApp::Shop.installed.has_active_shopify_plan.each do |shop|
+      DiscoApp::SynchroniseWebhooksJob.perform_later(shop.shopify_domain)
+    end
+  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

data/test/controllers/disco_app/webhooks_controller_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+class DiscoApp::WebhooksControllerTest < ActionController::TestCase
+  include ActiveJob::TestHelper
+
+  def setup
+    @shop = disco_app_shops(:widget_store)
+    @routes = DiscoApp::Engine.routes
+  end
+
+  def teardown
+    @shop = nil
+  end
+
+  test 'webhook request without authentication information returns unauthorized' do
+    body = webhook_fixture('app_uninstalled')
+    post(:process_webhook, body)
+    assert_response :unauthorized
+  end
+
+  test 'webhook request with no HMAC returns unauthorized' do
+    body = webhook_fixture('app_uninstalled')
+    @request.headers['HTTP_X_SHOPIFY_TOPIC'] = :'app/uninstalled'
+    @request.headers['HTTP_X_SHOPIFY_SHOP_DOMAIN'] = @shop.shopify_domain
+    post(:process_webhook, body)
+    assert_response :unauthorized
+  end
+
+  test 'webhook request with invalid HMAC returns unauthorized' do
+    body = webhook_fixture('app_uninstalled')
+    @request.headers['HTTP_X_SHOPIFY_TOPIC'] = :'app/uninstalled'
+    @request.headers['HTTP_X_SHOPIFY_SHOP_DOMAIN'] = @shop.shopify_domain
+    @request.headers['HTTP_X_SHOPIFY_HMAC_SHA256'] = '0000'
+    post(:process_webhook, body)
+    assert_response :unauthorized
+  end
+
+  test 'webhook request with valid HMAC returns OK' do
+    body = webhook_fixture('app_uninstalled')
+    @request.headers['HTTP_X_SHOPIFY_TOPIC'] = :'app/uninstalled'
+    @request.headers['HTTP_X_SHOPIFY_SHOP_DOMAIN'] = @shop.shopify_domain
+    @request.headers['HTTP_X_SHOPIFY_HMAC_SHA256'] = DiscoApp::WebhookService.calculated_hmac(body, ShopifyApp.configuration.secret)
+    post(:process_webhook, body)
+    assert_response :ok
+  end
+
+  test 'app uninstalled job queued when app/uninstalled webhook arrives' do
+    body = webhook_fixture('app_uninstalled')
+    @request.headers['HTTP_X_SHOPIFY_TOPIC'] = :'app/uninstalled'
+    @request.headers['HTTP_X_SHOPIFY_SHOP_DOMAIN'] = @shop.shopify_domain
+    @request.headers['HTTP_X_SHOPIFY_HMAC_SHA256'] = DiscoApp::WebhookService.calculated_hmac(body, ShopifyApp.configuration.secret)
+
+    assert_enqueued_with(job: DiscoApp::AppUninstalledJob) do
+      post(:process_webhook, body)
+    end
+  end
+
+end

data/test/controllers/home_controller_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class HomeControllerTest < ActionController::TestCase
+
+  def setup
+    @shop = disco_app_shops(:widget_store)
+    log_in_as(@shop)
+  end
+
+  def teardown
+    @shop = nil
+  end
+
+  test 'non-logged in user is redirected to the login page' do
+    log_out
+    get(:index)
+    assert_redirected_to ShopifyApp::Engine.routes.url_helpers.login_path
+  end
+
+  test 'logged-in, never installed user is redirected to the install page' do
+    get(:index)
+    assert_redirected_to DiscoApp::Engine.routes.url_helpers.install_path
+  end
+
+  test 'logged-in, awaiting install user is redirected to the installing page' do
+    @shop.awaiting_install!
+    get(:index)
+    assert_redirected_to DiscoApp::Engine.routes.url_helpers.installing_path
+  end
+
+  test 'logged-in, installing user is redirected to the installing page' do
+    @shop.installing!
+    get(:index)
+    assert_redirected_to DiscoApp::Engine.routes.url_helpers.installing_path
+  end
+
+  test 'logged-in, installed user is able to access the page' do
+    @shop.installed!
+    get(:index)
+    assert_response :success
+  end
+
+  test 'logged-in, awaiting uninstall user is redirected to the uninstalling page' do
+    @shop.awaiting_uninstall!
+    get(:index)
+    assert_redirected_to DiscoApp::Engine.routes.url_helpers.uninstalling_path
+  end
+
+  test 'logged-in, uninstalling user is redirected to the uninstalling page' do
+    @shop.uninstalling!
+    get(:index)
+    assert_redirected_to DiscoApp::Engine.routes.url_helpers.uninstalling_path
+  end
+
+  test 'logged-in, uninstalled user is redirected to the install page' do
+    @shop.uninstalled!
+    get(:index)
+    assert_redirected_to DiscoApp::Engine.routes.url_helpers.install_path
+  end
+
+end