disco_app 0.3.0

data/lib/generators/disco_app/disco_app_generator.rb

@@ -0,0 +1,179 @@
+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.sample 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.sample .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.1.0'
+    gem 'sidekiq', '~> 3.3.4'
+    gem 'puma', '~> 2.11.3'
+    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 'dotenv-rails', '~> 2.0.2'
+    end
+
+    # Add gems for production only.
+    gem_group :production do
+      gem 'pg', '~> 0.18.2'
+      gem 'rails_12factor', '~> 0.0.3'
+    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
+
+    # 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"
+
+    application "config.x.shopify_app_name = ENV['SHOPIFY_APP_NAME']\n"
+    application "# Set the name of the application"
+
+    # Copy over the default puma configuration.
+    copy_file 'config/puma.rb', 'config/puma.rb'
+  end
+
+  # Create Rakefiles
+  def create_rakefiles
+    rakefile 'start.rake' do
+      %Q{
+        task start: :environment do
+          system 'bundle exec rails server -b 127.0.0.1 -p 3000'
+        end
+      }
+    end
+    rakefile 'console.rake' do
+      %Q{
+        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"
+    end
+  end
+
+  # Set up routes.
+  def setup_routes
+    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
+  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
+
+  # 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
+
+    # Make sure application.css is removed.
+    remove_file 'app/assets/stylesheets/application.css'
+  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.2.2'\n"
+  end
+
+end

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

@@ -0,0 +1,31 @@
+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.0.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
+
+    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 @@
+DiscoApp::Engine.routes.default_url_options[:host] = ENV['DEFAULT_HOST']

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

@@ -0,0 +1,6 @@
+ShopifyApp.configure do |config|
+  config.api_key = ENV['SHOPIFY_APP_API_KEY']
+  config.secret = ENV['SHOPIFY_APP_SECRET']
+  config.scope = ENV['SHOPIFY_APP_SCOPE']
+  config.embedded_app = true
+end

data/lib/generators/disco_app/templates/jobs/app_installed_job.rb

@@ -0,0 +1,2 @@
+class AppInstalledJob < DiscoApp::AppInstalledJob
+end

data/lib/generators/disco_app/templates/jobs/app_uninstalled_job.rb

@@ -0,0 +1,16 @@
+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

data/lib/generators/disco_app/templates/jobs/shop_update_job.rb

@@ -0,0 +1,14 @@
+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

data/lib/generators/disco_app/templates/models/shop.rb

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

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

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

data/lib/generators/disco_app/templates/views/layouts/application.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= yield(:title) %></title>
+
+  <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
+
+  <%= csrf_meta_tags %>
+
+  <%= yield :extra_head %>
+</head>
+<body>
+
+  <%= yield %>
+
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+</body>
+</html>

data/lib/generators/disco_app/templates/views/layouts/embedded_app.html.erb

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= yield(:title) %></title>
+
+  <script src="//cdn.shopify.com/s/assets/external/app.js?<%= Time.now.strftime('%Y%m%d%H') %>"></script>
+  <script type="text/javascript">
+    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 %>
+
+  <%= csrf_meta_tags %>
+
+  <%= yield :extra_head %>
+</head>
+<body>
+
+  <%= yield %>
+
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+</body>
+</html>

data/lib/generators/disco_app/templates/views/sessions/new.html.erb

@@ -0,0 +1,26 @@
+<% provide(:title, 'Install') %>
+
+<%= form_tag shopify_app.login_path do %>
+    <div class="modal-dialog">
+      <div class="modal-content">
+        <div class="modal-body">
+
+          <% flash.each do |message_type, message| %>
+              <div class="alert alert-<%= message_type %>"><%= message %></div>
+          <% end %>
+
+          <div class="form-group">
+            <div class="input-group">
+              <div class="input-group-addon">http://</div>
+              <input type="text" class="form-control" id="shop" name="shop" placeholder="your-store" autocomplete="off" autofocus="on" />
+              <div class="input-group-addon">.myshopify.com</div>
+            </div>
+          </div>
+
+        </div>
+        <div class="modal-footer">
+          <button type="submit" class="btn btn-primary">Install</button>
+        </div>
+      </div>
+    </div>
+<% end %>

data/test/disco_app_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class DiscoAppTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, DiscoApp
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// 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_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "disco_app"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end