disco_app 0.15.2 → 0.18.1

data/lib/generators/disco_app/install/templates/root/.tool-versions

@@ -0,0 +1,2 @@
+ruby 2.6.5
+nodejs 13.7.0

data/lib/generators/disco_app/install/templates/root/package.json.tt

@@ -0,0 +1,17 @@
+{
+  "name": "<%= Rails.application.class.parent_name.underscore.dasherize %>",
+  "private": true,
+  "dependencies": {
+    "@rails/actioncable": "^6.0.0-alpha",
+    "@rails/activestorage": "^6.0.0-alpha",
+    "@rails/ujs": "^6.0.0-alpha",
+    "@rails/webpacker": "^4.0.7",
+    "react": "^16.11.0",
+    "react-dom": "^16.11.0",
+    "react_ujs": "^2.6.0",
+    "turbolinks": "^5.2.0"
+  },
+  "devDependencies": {
+    "webpack-dev-server": "^3.9.0"
+  }
+}

data/lib/generators/disco_app/install/templates/spec/rails_helper.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../config/environment', __dir__)
+
+abort('The Rails environment is running in production mode!') if Rails.env.production?
+
+require 'rspec/rails'
+
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
+
+# Checks for pending migrations and applies them before tests are run.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+
+RSpec.configure do |config|
+  config.filter_rails_from_backtrace!
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+  config.include Helpers::JsonHelper
+end

data/lib/generators/disco_app/install/templates/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'support/coveralls'
+require 'support/webmock'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.disable_monkey_patching!
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+  config.filter_run_when_matching :focus
+  config.order = :random
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  Kernel.srand config.seed
+end

data/lib/generators/disco_app/install/templates/spec/support/active_job.rb

@@ -0,0 +1,13 @@
+require 'sidekiq/testing'
+
+RSpec.configure do |config|
+  config.include ActiveJob::TestHelper
+
+  config.before(:all) do
+    Sidekiq::Testing.fake!
+  end
+
+  config.before(:each) do
+    Sidekiq::Worker.clear_all
+  end
+end

data/lib/generators/disco_app/install/templates/spec/support/coveralls.rb

@@ -0,0 +1,3 @@
+require 'coveralls'
+
+Coveralls.wear!('rails')

data/lib/generators/disco_app/install/templates/spec/support/database_cleaner.rb

@@ -0,0 +1,17 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/lib/generators/disco_app/install/templates/spec/support/factory_bot.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

data/lib/generators/disco_app/install/templates/spec/support/helpers/json_helper.rb

@@ -0,0 +1,13 @@
+module Helpers
+  module JsonHelper
+
+    # Return a JSON fixture as an indifferent hash.
+    def json_fixture(path, dir: 'json', parse: true)
+      filename = Rails.root.join('spec', 'fixtures', 'files', dir, "#{path}.json")
+      return File.read(filename) unless parse
+
+      HashWithIndifferentAccess.new(ActiveSupport::JSON.decode(File.read(filename)))
+    end
+
+  end
+end

data/lib/generators/disco_app/install/templates/spec/support/shared_examples/a_synchronise_job.rb

@@ -0,0 +1,12 @@
+RSpec.shared_examples :a_synchronise_job do |model|
+  subject(:job) { described_class.perform_later(shop, data) }
+
+  let(:shop) { create(:shop) }
+  let(:data) { 'data' }
+
+  it "synchronises #{model}" do
+    expect(model).to receive(:synchronise).with(shop, data, any_args)
+
+    perform_enqueued_jobs { job }
+  end
+end

data/lib/generators/disco_app/install/templates/spec/support/shoulda.rb

@@ -0,0 +1,6 @@
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

data/lib/generators/disco_app/install/templates/spec/support/vcr.rb

@@ -0,0 +1,14 @@
+VCR.configure do |config|
+  config.before_record do |interaction|
+    interaction.request.headers['X-Shopify-Access-Token'] = ['<REDACTED>']
+    interaction.request.headers['Authorization'] = ['<REDACTED>']
+  end
+  config.cassette_library_dir = 'spec/vcr'
+  config.configure_rspec_metadata!
+  config.default_cassette_options = {
+    decode_compressed_response: true,
+    match_requests_on: %i[method uri body],
+    record: :once
+  }
+  config.hook_into :webmock
+end

data/lib/generators/disco_app/install/templates/spec/support/webmock.rb

@@ -0,0 +1,8 @@
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    WebMock.reset!
+    WebMock.disable_net_connect!
+  end
+end

data/lib/generators/disco_app/react/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Generate boilerplate for a React-flavoured embedded app.
+
+Example:
+  rails generate disco_app:react

data/lib/generators/disco_app/react/react_generator.rb

@@ -0,0 +1,108 @@
+module DiscoApp
+  module Generators
+    class ReactGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('templates', __dir__)
+
+      def prepare_application
+        copy_file 'root/VERSION', 'VERSION'
+      end
+
+      def configure_gemfile
+        gem 'fast_jsonapi'
+        gem 'multi_json'
+        gem 'oj'
+        gem 'olive_branch'
+        gem 'webpacker'
+      end
+
+      def bundle_install
+        Bundler.with_clean_env do
+          run 'bundle install'
+        end
+      end
+
+      def configure_application
+        application 'config.middleware.use OliveBranch::Middleware'
+        application '# Camel-case to underscore transformation for JSON requests.'
+
+        copy_file 'config/initializers/mime_types.rb'
+        copy_file 'config/initializers/omniauth.rb'
+        template 'config/initializers/version.rb.tt', 'config/initializers/version.rb'
+
+        %w[.env .env.local].each do |file|
+          append_to_file file, 'BUGSNAG_API_KEY=00000000'
+        end
+      end
+
+      def update_routes
+        routes = <<-ROUTES.gsub(/^ {8}/, '')
+          # Embedded React routes.
+          root to: 'embedded/home#index'
+
+          # Embedded API.
+          namespace :embedded do
+            namespace :api, constraints: { format: :json }, defaults: { format: :json } do
+              resource :shop, only: [:show]
+
+              resources :users, only: [] do
+                get :current, on: :collection
+              end
+            end
+          end
+        ROUTES
+
+        route routes
+
+        comment_lines 'config/routes.rb', "root to: 'home#index'"
+      end
+
+      def install_webpacker
+        rake 'webpacker:install'
+      end
+
+      def configure_webpack
+        %w[.eslintignore .eslintrc .prettierrc babel.config.js postcss.config.js].each do |file|
+          copy_file "root/#{file}", file
+        end
+
+        template 'root/package.json.tt', 'package.json'
+
+        copy_file 'config/webpacker.yml'
+        copy_file 'config/webpack/staging.js'
+        copy_file 'config/webpack/test.js'
+
+        run "if [ -d 'app/javascript' ]; then mv -f app/javascript app/webpack; fi"
+      end
+
+      def yarn_install
+        run 'yarn install'
+      end
+
+      def configure_api
+        directory 'app/controllers/embedded'
+      end
+
+      def configure_views
+        directory 'app/views/embedded'
+        copy_file 'app/views/layouts/embedded.html.erb'
+      end
+
+      def configure_serializers
+        directory 'app/serializers'
+      end
+
+      def configure_api_response
+        copy_file 'app/models/api_response.rb'
+      end
+
+      def configure_react
+        directory 'app/webpack/javascripts'
+        directory 'app/webpack/stylesheets'
+        copy_file 'app/webpack/packs/embedded.js'
+        remove_file 'app/webpack/packs/application.js'
+      end
+
+    end
+  end
+end

data/lib/generators/disco_app/react/templates/app/controllers/embedded/api/base_controller.rb

@@ -0,0 +1,18 @@
+module Embedded
+  module Api
+    class BaseController < ApplicationController
+
+      include DiscoApp::Concerns::AuthenticatedController
+      include DiscoApp::Concerns::UserAuthenticatedController
+
+      rescue_from ActiveRecord::RecordInvalid, with: :unprocessable_entity
+
+      private
+
+        def unprocessable_entity(exception)
+          render json: ApiResponse.serialize(exception.record.errors), status: :unprocessable_entity
+        end
+
+    end
+  end
+end

data/lib/generators/disco_app/react/templates/app/controllers/embedded/api/home_controller.rb

@@ -0,0 +1,10 @@
+module Embedded
+  module Api
+    class HomeController < BaseController
+
+      def show
+      end
+
+    end
+  end
+end

data/lib/generators/disco_app/react/templates/app/controllers/embedded/api/shops_controller.rb

@@ -0,0 +1,11 @@
+module Embedded
+  module Api
+    class ShopsController < BaseController
+
+      def show
+        render json: ApiResponse.serialize(@shop)
+      end
+
+    end
+  end
+end

data/lib/generators/disco_app/react/templates/app/controllers/embedded/api/users_controller.rb

@@ -0,0 +1,11 @@
+module Embedded
+  module Api
+    class UsersController < BaseController
+
+      def current
+        render json: ApiResponse.serialize(@user)
+      end
+
+    end
+  end
+end

data/lib/generators/disco_app/react/templates/app/controllers/embedded/home_controller.rb

@@ -0,0 +1,13 @@
+module Embedded
+  class HomeController < ApplicationController
+
+    include DiscoApp::Concerns::AuthenticatedController
+    include DiscoApp::Concerns::UserAuthenticatedController
+
+    layout 'embedded'
+
+    def index
+    end
+
+  end
+end

data/lib/generators/disco_app/react/templates/app/models/api_response.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+class ApiResponse
+
+  EMPTY_SERIALIZER = 'Empty'
+  ERROR_SERIALIZER = 'Error'
+  SERIALIZER_SUFFIX = 'Serializer'
+  SENSITIVE_REQUEST_PARAMS = ['timestamp', 'signature'].freeze
+
+  def initialize(result, custom_serializer = nil)
+    @result = result
+    @custom_serializer = custom_serializer
+  end
+
+  def serialize(options = {})
+    request = options.delete(:request)
+
+    serializer.new(
+      result, options.merge(collection_options(request))
+    ).serializable_hash
+  end
+
+  def self.serialize(result, options = {})
+    serializer = options.delete(:serializer)
+
+    new(result, serializer).serialize(options)
+  end
+
+  private
+
+    attr_accessor :result, :custom_serializer
+
+    def array?
+      result.is_a?(Array)
+    end
+
+    def collection?
+      result.is_a?(ActiveRecord::Relation)
+    end
+
+    def error?
+      [
+        result.is_a?(ActiveModel::Errors),
+        result.is_a?(ActiveResource::Errors),
+        result.is_a?(StandardError),
+        result.is_a?(String)
+      ].any?
+    end
+
+    def empty?
+      (array? || collection?) && result.empty?
+    end
+
+    def resource?
+      !array && !collection? && !error?
+    end
+
+    def resource_type
+      return custom_serializer.to_s.classify if custom_serializer
+      return ERROR_SERIALIZER if error?
+      return EMPTY_SERIALIZER if empty?
+      return result.first.class.name if array?
+      return result.class.to_s.deconstantize if collection?
+
+      result.class.name
+    end
+
+    def serializer
+      "#{resource_type}#{SERIALIZER_SUFFIX}".constantize
+    end
+
+    def collection_options(request = nil)
+      options = {}
+
+      return options if error?
+
+      options[:is_collection] = array? || collection?
+
+      if collection? && result.respond_to?(:total_count)
+        options[:meta] = {
+          page_size: result.limit_value,
+          total_count: result.total_count,
+          total_pages: result.total_pages
+        }
+
+        options[:links] = {
+          prev: link(result.prev_page, request),
+          next: link(result.next_page, request)
+        }
+      end
+
+      options
+    end
+
+    def link(page, request)
+      return page if page.blank? || request.blank?
+
+      uri = URI.parse(request)
+      params = Rack::Utils.parse_query(uri.query)
+      params.delete_if{ |key| SENSITIVE_REQUEST_PARAMS.include?(key) }
+      params['page[number]'] = page
+      parsed_params = params.map{ |key, value| "#{key}=#{value}" }.join('&')
+
+      "#{uri.scheme}:://#{uri.host}#{uri.path}?#{parsed_params}"
+    end
+
+end

data/lib/generators/disco_app/react/templates/app/serializers/disco_app/shop_serializer.rb

@@ -0,0 +1,13 @@
+module DiscoApp
+  class ShopSerializer
+
+    include FastJsonapi::ObjectSerializer
+
+    attributes :id, :name, :shopify_url
+
+    attribute :time_zone do |shop|
+      shop.time_zone.tzinfo.name
+    end
+
+  end
+end

data/lib/generators/disco_app/react/templates/app/serializers/disco_app/user_serializer.rb

@@ -0,0 +1,13 @@
+module DiscoApp
+  class UserSerializer
+
+    include FastJsonapi::ObjectSerializer
+
+    attributes :email, :first_name, :id, :last_name
+
+    attribute :initials do |user|
+      [user.first_name, user.last_name].compact.map(&:first).join
+    end
+
+  end
+end

data/lib/generators/disco_app/react/templates/app/serializers/empty_serializer.rb

@@ -0,0 +1,5 @@
+class EmptySerializer
+
+  include FastJsonapi::ObjectSerializer
+
+end

data/lib/generators/disco_app/react/templates/app/serializers/error_serializer.rb

@@ -0,0 +1,76 @@
+class ErrorSerializer
+
+  attr_reader :errors, :source, :title
+
+  def initialize(errors, source: nil, title: nil)
+    @errors = errors
+    @source = source
+    @title = title
+  end
+
+  def serialized_json
+    serializable_hash.to_json
+  end
+
+  def serializable_hash
+    {
+      errors: formatted_errors
+    }
+  end
+
+  private
+
+    def formatted_errors
+      return errors_from_exception if exception_error?
+      return errors_from_string if string_error?
+
+      errors_from_active_model
+    end
+
+    def errors_from_active_model
+      error_array = []
+
+      errors.keys.each do |field|
+        errors.full_messages_for(field).each do |error|
+          error_array << {
+            source: { pointer: "/data/attributes/#{field}" },
+            title: title || 'Unprocessable entity',
+            detail: error
+          }
+        end
+      end
+
+      error_array
+    end
+
+    def errors_from_exception
+      error = {
+        title: title || errors.class.name.demodulize || 'Unknown error',
+        detail: errors.message
+      }
+
+      error[:source] = { pointer: source } if source
+
+      [error]
+    end
+
+    def errors_from_string
+      error = {
+        title: title || 'Unknown error',
+        detail: errors
+      }
+
+      error[:source] = { pointer: source } if source
+
+      [error]
+    end
+
+    def exception_error?
+      errors.is_a?(StandardError)
+    end
+
+    def string_error?
+      errors.is_a?(String)
+    end
+
+end

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

@@ -0,0 +1,12 @@
+<div
+  id="app"
+  data-api-key="<%= ShopifyApp.configuration.api_key %>"
+  data-bugsnag-api-key="<%= ENV['BUGSNAG_API_KEY'] %>"
+  data-debug="<%= Rails.env.development? ? 'true' : 'false' %>"
+  data-environment="<%= Rails.env %>"
+  data-force-redirect="<%= Rails.env.development? ? 'false' : 'true' %>"
+  data-shop-origin="<%= @shop_session&.url %>"
+  data-version="<%= Rails.application.class::VERSION %>"
+></div>
+<%= javascript_pack_tag 'embedded' %>
+<%= stylesheet_pack_tag 'embedded' %>

data/lib/generators/disco_app/react/templates/app/views/layouts/embedded.html.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= ENV['SHOPIFY_APP_NAME'] %></title>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>