disco_app 0.15.2 → 0.18.1

data/lib/generators/disco_app/install/install_generator.rb

@@ -0,0 +1,297 @@
+module DiscoApp
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('templates', __dir__)
+
+      # 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;
+      #  - .editorconfig to help enforce 2-space tabs, newlines and truncated whitespace for editors that support it.
+      #  - README/PULL REQUEST template
+      #
+      def copy_root_files
+        %w[.editorconfig .env .env.local .gitignore .rubocop.yml Procfile CHECKS README.md].each do |file|
+          copy_file "root/#{file}", file
+        end
+        directory 'root/.github'
+      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_gemfile
+        # Remove sqlite.
+        gsub_file 'Gemfile', /^# Use sqlite3 as the database for Active Record\ngem 'sqlite3', '~> 1.4'/m, ''
+
+        # Add gem requirements.
+        gem 'active_link_to'
+        gem 'activeresource'
+        gem 'acts_as_singleton'
+        gem 'appsignal'
+        gem 'classnames-rails'
+        gem 'nokogiri'
+        gem 'oj'
+        gem 'pg'
+        gem 'premailer-rails'
+        gem 'react-rails'
+        gem 'render_anywhere'
+        gem 'shopify_app'
+        gem 'sidekiq'
+        gem 'timber', '~> 3.0'
+
+        # Indicate which gems should only be used in production.
+        gem_group :staging, :production do
+          gem 'mailgun_rails'
+          gem 'rails_12factor'
+        end
+
+        # Indicate which gems should only be used in development.
+        gem_group :development do
+          gem 'rb-readline'
+          gem 'rubocop'
+          gem 'rubocop-performance'
+          gem 'rubocop-rails'
+        end
+
+        # Indicate which gems should only be used in development and test.
+        gem_group :development, :test do
+          gem 'coveralls'
+          gem 'dotenv-rails'
+          gem 'factory_bot_rails'
+          gem 'faker'
+          gem 'mechanize'
+          gem 'rspec-rails'
+          gem 'vcr'
+          gem 'webmock'
+        end
+
+        gem_group :test do
+          gem 'database_cleaner'
+          gem 'shoulda-matchers'
+        end
+      end
+
+      # copy template for pg configuration
+      def update_database_config
+        template 'config/database.yml.tt'
+      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
+
+      def support_staging_environment
+        copy_file 'config/environments/staging.rb', 'config/environments/staging.rb'
+      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 time zone to UTC
+        application "config.time_zone = 'UTC'"
+        application '# Ensure UTC is the default timezone'
+
+        # Set server side rendereing for components.js
+        application <<~CONFIG
+          # Enable server side react rendering
+          config.react.server_renderer_options = {
+            # files to load for prerendering
+            files: ['components.js']
+          }
+        CONFIG
+
+        # 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
+
+        # Configure to delete X-Frame-Options so that embedded app works in iframe.
+        application "config.action_dispatch.default_headers.delete('X-Frame-Options')"
+        application '# Allow iframe requests'
+
+        # Set Sidekiq as the queue adapter in staging.
+        application "config.active_job.queue_adapter = :sidekiq\n", env: :staging
+        application '# Use Sidekiq as the active job backend', env: :staging
+
+        # 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'
+
+        # Configure React in development, staging and production.
+        application 'config.react.variant = :development', env: :development
+        application '# Use development variant of React in development.', env: :development
+        application 'config.react.variant = :production', env: :staging
+        application '# Use production variant of React in staging.', env: :staging
+        application 'config.react.variant = :production', env: :production
+        application '# Use production variant of React in production.', env: :production
+
+        # Configure ActionDispatch::HostAuthorization to be disabled
+        application 'config.hosts.clear', env: :development
+        application '# Disable Host Authorization middleware', env: :development
+
+        # Configure Factory Bot as the Rails testing fixture replacement
+        application <<~CONFIG
+          config.generators do |g|
+            g.test_framework :rspec, fixtures: true, view_specs: false, helper_specs: false, routing_specs: false
+            g.fixture_replacement :factory_bot, dir: 'spec/factories'
+          end
+        CONFIG
+
+        # Copy over the default puma configuration.
+        copy_file 'config/puma.rb', 'config/puma.rb'
+
+        # Mail configuration
+        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
+        application configuration, env: :staging
+
+        # Monitoring configuration
+        copy_file 'config/appsignal.yml', 'config/appsignal.yml'
+      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
+
+      # 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'
+        rails_command 'webpacker:install'
+        generate 'react:install'
+      end
+
+      def configure_rspec
+        directory 'spec'
+        copy_file 'root/.rspec', '.rspec'
+      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_file 'initializers/timber.rb', 'config/initializers/timber.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/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'
+
+        # Remove the test directory generated by rails new
+        remove_dir 'test'
+      end
+
+      # Copy engine migrations over.
+      def install_migrations
+        rake 'disco_app:install:migrations'
+      end
+
+      # Create PG database
+      def create_database
+        rake 'db:create'
+      end
+
+      # Run migrations.
+      def migrate
+        rake 'db:migrate'
+      end
+
+      # Copy package.json.
+      def configure_package
+        template 'root/package.json.tt', 'package.json'
+      end
+
+      def yarn_install
+        run 'yarn install'
+      end
+
+      # Lock down the application to a specific Ruby version:
+      #
+      #  - Via .tool-versions file for asdf in development;
+      #
+      # 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/.tool-versions', '.tool-versions'
+      end
+
+      private
+
+        # This method of finding the component.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 components
+          Pathname.new(destination_root).join('app/assets/javascripts', 'components.js')
+        end
+
+    end
+  end
+end

data/lib/generators/disco_app/install/templates/config/appsignal.yml

@@ -0,0 +1,12 @@
+default: &defaults
+  name: <%= ENV['SHOPIFY_APP_NAME'] || 'Unknown App' %>
+  push_api_key: <%= ENV['APPSIGNAL_PUSH_API_KEY'] %>
+  development:
+    <<: *defaults
+    active: false
+  staging:
+    <<: *defaults
+    active: true
+  production:
+    <<: *defaults
+    active: true

data/lib/generators/disco_app/install/templates/config/cable.yml.tt

@@ -0,0 +1,11 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+staging:
+  adapter: async
+
+production:
+  adapter: async

data/lib/generators/disco_app/{templates → install/templates}/config/database.yml.tt

@@ -4,18 +4,21 @@ default: &default
   pool: 5
   timeout: 5000
   prepared_statements: false
- 
+
 development:
   <<: *default
   host: localhost
   port: 5432
   database: <%= Rails.application.class.parent_name.downcase %>
- 
+
 test:
   <<: *default
   host: localhost
   port: 5432
   database: <%= Rails.application.class.parent_name.downcase %>_test
- 
+
+staging:
+  <<: *default
+
 production:
   <<: *default

data/lib/generators/disco_app/install/templates/config/environments/staging.rb

@@ -0,0 +1,108 @@
+Rails.application.configure do
+  # 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
+
+  # Use production variant of React in staging.
+  config.react.variant = :production
+  # Use Sidekiq as the active job backend
+  config.active_job.queue_adapter = :sidekiq
+
+  # Allow real charges in production with an ENV variable
+  config.x.shopify_charges_real = false
+
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local = false
+  config.action_controller.perform_caching = true
+
+  # Attempt to read encrypted secrets from `config/secrets.yml.enc`.
+  # Requires an encryption key in `ENV["RAILS_MASTER_KEY"]` or
+  # `config/secrets.yml.key`.
+  config.read_encrypted_secrets = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Mount Action Cable outside main process or domain
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [:request_id]
+
+  # Use a different cache store in staging.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "example_app_#{Rails.env}"
+  config.action_mailer.perform_caching = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+  if ENV['RAILS_LOG_TO_STDOUT'].present?
+    logger = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/lib/generators/disco_app/{templates → install/templates}/controllers/home_controller.rb

@@ -1,4 +1,5 @@
 class HomeController < ApplicationController
+
   include DiscoApp::Concerns::AuthenticatedController
 
   def index

data/lib/generators/disco_app/{templates → install/templates}/initializers/disco_app.rb

@@ -8,6 +8,11 @@ DiscoApp.configure do |config|
   # See https://help.shopify.com/api/reference/webhook.
   config.webhook_topics = []
 
+  # By default, webhooks request all fields to be provided in the payload.
+  # You can override this behaviour by providing an entry in this hash with the
+  # key set to a webhook topic and the value set to an array of fields.
+  # config.webhook_fields = {}
+
   # Set the below if using an application proxy.
   config.app_proxy_prefix = ENV['SHOPIFY_APP_PROXY_PREFIX']
 

data/lib/generators/disco_app/install/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/install/templates/initializers/shopify_app.rb

@@ -0,0 +1,11 @@
+ShopifyApp.configure do |config|
+  config.application_name = ENV['SHOPIFY_APP_NAME']
+  config.api_key = ENV['SHOPIFY_APP_API_KEY']
+  config.secret = ENV['SHOPIFY_APP_SECRET']
+  config.old_secret = ''
+  config.scope = ENV['SHOPIFY_APP_SCOPE']
+  config.embedded_app = true
+  config.after_authenticate_job = false
+  config.api_version = ENV.fetch('SHOPIFY_APP_API_VERSION', '2019-10')
+  config.session_repository = ShopifyApp::InMemorySessionStore
+end

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

@@ -0,0 +1,4 @@
+if ENV['TIMBER_API_KEY'] && ENV['TIMBER_SOURCE_ID']
+  http_device = Timber::LogDevices::HTTP.new(ENV['TIMBER_API_KEY'], ENV['TIMBER_SOURCE_ID'])
+  Rails.logger = Timber::Logger.new(http_device)
+end

data/lib/generators/disco_app/{templates → install/templates}/root/.env

@@ -5,6 +5,7 @@ SHOPIFY_APP_API_KEY=00000000000000000000000000000000
 SHOPIFY_APP_SECRET=00000000000000000000000000000000
 SHOPIFY_APP_SCOPE=
 SHOPIFY_APP_PROXY_PREFIX=
+SHOPIFY_APP_API_VERSION=
 
 ADMIN_APP_USERNAME=
 ADMIN_APP_PASSWORD=
@@ -18,3 +19,9 @@ REDIS_PROVIDER=
 DISCO_API_URL=
 
 WHITELISTED_DOMAINS=
+
+# You can find this listed in 1Password
+APPSIGNAL_PUSH_API_KEY=
+
+TIMBER_API_KEY=
+TIMBER_SOURCE_ID=

data/lib/generators/disco_app/{templates → install/templates}/root/.env.local

@@ -5,6 +5,7 @@ SHOPIFY_APP_API_KEY=
 SHOPIFY_APP_SECRET=
 SHOPIFY_APP_SCOPE=
 SHOPIFY_APP_PROXY_PREFIX=
+SHOPIFY_APP_API_VERSION=
 
 ADMIN_APP_USERNAME=
 ADMIN_APP_PASSWORD=
@@ -23,3 +24,6 @@ REDIS_PROVIDER=
 DISCO_API_URL=
 
 WHITELISTED_DOMAINS=
+
+# You can find this listed in 1Password
+APPSIGNAL_PUSH_API_KEY=

data/lib/generators/disco_app/{templates → install/templates}/root/.gitignore

@@ -15,6 +15,11 @@ pickle-email-*.html
 .byebug_history
 .DS_Store
 .disco_app
+/public/packs
+/public/packs-test
+/node_modules
+yarn-debug.log*
+.yarn-integrity
 
 ## Environment normalisation:
 /.bundle
@@ -22,6 +27,7 @@ pickle-email-*.html
 /vendor/ruby
 /.env.local
 .envrc
+.pryrc
 
 # these should all be checked in to normalise the environment:
 # Gemfile.lock, .ruby-version, .ruby-gemset

data/lib/generators/disco_app/install/templates/root/.rspec

@@ -0,0 +1 @@
+--require spec_helper