shopify-cli 0.9.0

data/lib/project_types/rails/commands/populate/draft_order.rb

@@ -0,0 +1,28 @@
+require 'shopify_cli'
+
+module Rails
+  module Commands
+    class Populate
+      class DraftOrder < ShopifyCli::AdminAPI::PopulateResourceCommand
+        @input_type = :DraftOrderInput
+
+        def defaults
+          {
+            lineItems: [{
+              originalUnitPrice: price,
+              quantity: 1,
+              weight: { value: 10, unit: 'GRAMS' },
+              title: ShopifyCli::Helpers::Haikunator.title,
+            }],
+          }
+        end
+
+        def message(data)
+          ret = data['draftOrderCreate']['draftOrder']
+          id = ShopifyCli::API.gid_to_id(ret['id'])
+          @ctx.message('rails.populate.draft_order.added', ShopifyCli::Project.current.env.shop, admin_url, id)
+        end
+      end
+    end
+  end
+end

data/lib/project_types/rails/commands/populate/product.rb

@@ -0,0 +1,30 @@
+require 'shopify_cli'
+
+module Rails
+  module Commands
+    class Populate
+      class Product < ShopifyCli::AdminAPI::PopulateResourceCommand
+        @input_type = :ProductInput
+
+        def defaults
+          {
+            title: ShopifyCli::Helpers::Haikunator.title,
+            variants: [{ price: price }],
+          }
+        end
+
+        def message(data)
+          ret = data['productCreate']['product']
+          id = ShopifyCli::API.gid_to_id(ret['id'])
+          @ctx.message(
+            'rails.populate.product.added',
+            ret['title'],
+            ShopifyCli::Project.current.env.shop,
+            admin_url,
+            id
+          )
+        end
+      end
+    end
+  end
+end

data/lib/project_types/rails/commands/serve.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+module Rails
+  module Commands
+    class Serve < ShopifyCli::Command
+      prerequisite_task :ensure_env, :ensure_dev_store
+
+      options do |parser, flags|
+        parser.on('--host=HOST') do |h|
+          flags[:host] = h.gsub('"', '')
+        end
+      end
+
+      def call(*)
+        project = ShopifyCli::Project.current
+        url = options.flags[:host] || ShopifyCli::Tunnel.start(@ctx)
+        @ctx.abort(@ctx.message('rails.serve.error.host_must_be_https')) if url.match(/^https/i).nil?
+        project.env.update(@ctx, :host, url)
+        ShopifyCli::Tasks::UpdateDashboardURLS.call(
+          @ctx,
+          url: url,
+          callback_url: "/auth/shopify/callback",
+        )
+        if @ctx.mac? && project.env.shop
+          @ctx.puts(@ctx.message('rails.serve.open_info', project.env.shop))
+          @ctx.on_siginfo do
+            @ctx.open_url!("#{project.env.host}/login?shop=#{project.env.shop}")
+          end
+        end
+        Gem.gem_home(@ctx)
+        CLI::UI::Frame.open(@ctx.message('rails.serve.running_server')) do
+          env = ShopifyCli::Project.current.env.to_h
+          env.delete('HOST')
+          env['PORT'] = ShopifyCli::Tunnel::PORT.to_s
+          @ctx.system('bin/rails server', env: env)
+        end
+      end
+
+      def self.help
+        ShopifyCli::Context.message('rails.serve.help', ShopifyCli::TOOL_NAME)
+      end
+
+      def self.extended_help
+        ShopifyCli::Context.message('rails.serve.extended_help', ShopifyCli::TOOL_NAME)
+      end
+    end
+  end
+end

data/lib/project_types/rails/commands/tunnel.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'shopify_cli'
+
+module Rails
+  module Commands
+    class Tunnel < ShopifyCli::Command
+      # subcommands :auth, :start, :stop
+
+      def call(args, _name)
+        subcommand = args.shift
+        case subcommand
+        when 'auth'
+          token = args.shift
+          if token.nil?
+            @ctx.puts(@ctx.message('rails.tunnel.error.token_argument_missing'))
+            @ctx.puts("#{self.class.help}\n#{self.class.extended_help}")
+          else
+            ShopifyCli::Tunnel.auth(@ctx, token)
+          end
+        when 'start'
+          ShopifyCli::Tunnel.start(@ctx)
+        when 'stop'
+          ShopifyCli::Tunnel.stop(@ctx)
+        else
+          @ctx.puts(self.class.help)
+        end
+      end
+
+      def self.help
+        ShopifyCli::Context.message('rails.tunnel.help', ShopifyCli::TOOL_NAME)
+      end
+
+      def self.extended_help
+        ShopifyCli::Context.message('rails.tunnel.extended_help', ShopifyCli::TOOL_NAME)
+      end
+    end
+  end
+end

data/lib/project_types/rails/forms/create.rb

@@ -0,0 +1,116 @@
+require 'uri'
+
+module Rails
+  module Forms
+    class Create < ShopifyCli::Form
+      attr_accessor :name
+      flag_arguments :title, :organization_id, :shop_domain, :type, :db
+      VALID_DB_TYPES = ['sqlite3',
+                        'mysql',
+                        'postgresql',
+                        'sqlite3',
+                        'oracle',
+                        'frontbase',
+                        'ibm_db',
+                        'sqlserver',
+                        'jdbcmysql',
+                        'jdbcsqlite3',
+                        'jdbcpostgresql',
+                        'jdbc']
+
+      def ask
+        self.title ||= CLI::UI::Prompt.ask(ctx.message('rails.forms.create.app_name'))
+        self.type = ask_type
+        self.name = self.title.downcase.split(" ").join("_")
+        self.organization_id ||= organization["id"].to_i
+        self.shop_domain ||= ask_shop_domain
+        self.db = ask_db
+      end
+
+      private
+
+      def ask_type
+        if type.nil?
+          return CLI::UI::Prompt.ask(ctx.message('rails.forms.create.app_type.select')) do |handler|
+            handler.option(ctx.message('rails.forms.create.app_type.select_public')) { 'public' }
+            handler.option(ctx.message('rails.forms.create.app_type.select_custom')) { 'custom' }
+          end
+        end
+
+        unless ShopifyCli::Tasks::CreateApiClient::VALID_APP_TYPES.include?(type)
+          ctx.abort(ctx.message('rails.forms.create.error.invalid_app_type', type))
+        end
+        ctx.puts(ctx.message('rails.forms.create.app_type.selected', type))
+        type
+      end
+
+      def organizations
+        @organizations ||= ShopifyCli::PartnersAPI::Organizations.fetch_all(ctx)
+      end
+
+      def organization
+        @organization ||= if !organization_id.nil?
+          org = ShopifyCli::PartnersAPI::Organizations.fetch(ctx, id: organization_id)
+          if org.nil?
+            ctx.puts(ctx.message('rails.forms.create.authentication_issue', ShopifyCli::TOOL_NAME))
+            ctx.abort(ctx.message('rails.forms.create.error.organization_not_found'))
+          end
+          org
+        elsif organizations.count == 0
+          ctx.puts(ctx.message('rails.forms.create.partners_notice'))
+          ctx.puts(ctx.message('rails.forms.create.authentication_issue', ShopifyCli::TOOL_NAME))
+          ctx.abort(ctx.message('rails.forms.create.error.no_organizations'))
+        elsif organizations.count == 1
+          org = organizations.first
+          ctx.puts(ctx.message('rails.forms.create.organization',
+            ctx.message('core.partners_api.org_name_and_id', org['businessName'], org['id'])))
+          org
+        else
+          org_id = CLI::UI::Prompt.ask(ctx.message('rails.forms.create.organization_select')) do |handler|
+            organizations.each { |o| handler.option(o['businessName']) { o['id'] } }
+          end
+          organizations.find { |o| o['id'] == org_id }
+        end
+      end
+
+      def ask_shop_domain
+        valid_stores = organization['stores'].select do |store|
+          store['transferDisabled'] == true || store['convertableToPartnerTest'] == true
+        end
+
+        if valid_stores.count == 0
+          ctx.puts(ctx.message('rails.forms.create.no_development_stores'))
+          ctx.puts(ctx.message('rails.forms.create.create_store', organization['id']))
+          ctx.puts(ctx.message('rails.forms.create.authentication_issue', ShopifyCli::TOOL_NAME))
+        elsif valid_stores.count == 1
+          domain = valid_stores.first['shopDomain']
+          ctx.puts(ctx.message('rails.forms.create.development_store', domain))
+          domain
+        else
+          CLI::UI::Prompt.ask(
+            ctx.message('rails.forms.create.development_store_select'),
+            options: valid_stores.map { |s| s['shopDomain'] }
+          )
+        end
+      end
+
+      def ask_db
+        if db.nil?
+          return 'sqlite3' unless CLI::UI::Prompt.confirm(ctx.message('rails.forms.create.db.want_select'),
+                                                          default: false)
+          @db = CLI::UI::Prompt.ask(ctx.message('rails.forms.create.db.select')) do |handler|
+            VALID_DB_TYPES.each do |db_type|
+              handler.option(ctx.message("rails.forms.create.db.select_#{db_type}")) { db_type }
+            end
+          end
+        end
+
+        unless VALID_DB_TYPES.include?(db)
+          ctx.abort(ctx.message('rails.forms.create.error.invalid_db_type', db))
+        end
+        ctx.puts(ctx.message('rails.forms.create.db.selected', db))
+        db
+      end
+    end
+  end
+end

data/lib/project_types/rails/gem.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'shopify_cli'
+
+module Rails
+  class Gem
+    include SmartProperties
+
+    property :ctx, accepts: ShopifyCli::Context, required: true
+    property :name, converts: :to_s, required: true
+    property :version, converts: :to_s
+
+    class << self
+      def install(ctx, *args)
+        name = args.shift
+        version = args.shift
+        gem = new(ctx: ctx, name: name, version: version)
+        ctx.debug(ctx.message('rails.gem.installed_debug', name, gem.installed?))
+        gem.install! unless gem.installed?
+      end
+
+      def binary_path_for(ctx, binary)
+        File.join(gem_home(ctx), 'bin', binary)
+      end
+
+      def gem_home(ctx)
+        ctx.getenv('GEM_HOME') || apply_gem_home(ctx)
+      end
+
+      private
+
+      def apply_gem_home(ctx)
+        path = File.join(ctx.getenv('HOME'), '.gem', 'ruby', RUBY_VERSION)
+        ctx.mkdir_p(path) unless Dir.exist?(path)
+        ctx.setenv('GEM_HOME', path)
+      end
+    end
+
+    def installed?
+      !!Dir.glob("#{self.class.gem_home(ctx)}/gems/#{name}-*").detect do |f|
+        f =~ %r{/#{Regexp.quote(name)}-\d}
+      end
+    end
+
+    def install!
+      spin = CLI::UI::SpinGroup.new
+      spin.add(ctx.message('rails.gem.installing', name)) do |spinner|
+        args = %w(gem install)
+        args.push(name)
+        args.push('-v', version) unless version.nil?
+        ctx.system(*args)
+        spinner.update_title(ctx.message('rails.gem.installed', name))
+      end
+      spin.wait
+    end
+  end
+end

data/lib/project_types/rails/messages/messages.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+module Rails
+  module Messages
+    MESSAGES = {
+      rails: {
+        error: {
+          generic: "Error",
+        },
+
+        gem: {
+          installed_debug: "%s installed: %s",
+          installing: "Installing %s gem...",
+          installed: "Installed %s gem",
+        },
+
+        create: {
+          help: <<~HELP,
+          {{command:%s create rails}}: Creates a ruby on rails app.
+            Usage: {{command:%s create rails}}
+            Options:
+              {{command:--name=NAME}} App name. Any string.
+              {{command:--app_url=APPURL}} App URL. Must be a valid URL.
+              {{command:--organization_id=ID}} Partner organization ID. Must be an existing organization.
+              {{command:--shop_domain=MYSHOPIFYDOMAIN }} Development store URL. Must be an existing development store.
+              {{command:--db=DB}} Database type. Must be one of: mysql, postgresql, sqlite3, oracle, frontbase, ibm_db, sqlserver, jdbcmysql, jdbcsqlite3, jdbcpostgresql, jdbc.
+              {{command:--rails_opts=RAILSOPTS}} Additional options. Must be string containing one or more valid Rails options, separated by spaces.
+          HELP
+
+          error: {
+            invalid_ruby_version: <<~MSG,
+            This project requires a ruby version ~> 2.5.
+            See {{underline:https://github.com/Shopify/shopify-app-cli/blob/master/docs/installing-ruby.md}}
+            for our recommended method of installing ruby.
+            MSG
+          },
+
+          info: {
+            created: "{{v}} {{green:%s}} was created in your Partner Dashboard {{underline:%s}}",
+            serve: "{{*}} Change into your new project folder {{green:%s}} and run {{command:%s serve}} to start a " \
+              "local server",
+            install: "{{*}} Then, visit {{underline:%s/test}} to install {{green:%s}} on your Dev Store",
+          },
+          installing_bundler: "Installing bundler…",
+          generating_app: "Generating new rails app project in %s...",
+          adding_shopify_gem: "{{v}} Adding shopify_app gem…",
+          running_bundle_install: "Running bundle install...",
+          running_generator: "Running shopify_app generator...",
+          running_migrations: "Running migrations…",
+        },
+
+        deploy: {
+          help: <<~HELP,
+          Deploy the current Rails project to a hosting service. Heroku ({{underline:https://www.heroku.com}}) is currently the only option, but more will be added in the future.
+            Usage: {{command:%s deploy [ heroku ]}}
+          HELP
+          extended_help: <<~HELP,
+          {{bold:Subcommands:}}
+            {{cyan:heroku}}: Deploys the current Rails project to Heroku.
+              Usage: {{command:%s deploy heroku}}
+          HELP
+
+          heroku: {
+            help: <<~HELP,
+            Deploy the current Rails project to Heroku
+            Usage: {{command:%s deploy heroku}}
+            HELP
+            downloading: "Downloading Heroku CLI…",
+            downloaded: "Downloaded Heroku CLI",
+            installing: "Installing Heroku CLI…",
+            installed: "Installed Heroku CLI",
+            authenticated_with_account: "{{v}} Authenticated with Heroku as `%s`",
+            authenticating: "Authenticating with Heroku…",
+            authenticated: "{{v}} Authenticated with Heroku",
+            deploying: "Deploying to Heroku…",
+            deployed: "{{v}} Deployed to Heroku",
+            db_check: {
+              validating: "Validating application...",
+              checking: "Checking database type...",
+              validated: "Database type \"%s\" validated for platform \"Heroku\"",
+              problem: "A problem was encountered while checking your database type.",
+              sqlite: <<~SQLITE,
+              Heroku does not support deployment using the SQLite database system.
+              Change the database type using {{command:rails db:system:change --to=[new_db_type]}}. For more info:
+              {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
+              SQLITE
+            },
+            git: {
+              checking: "Checking git repo…",
+              initialized: "Git repo initialized",
+              what_branch: "What branch would you like to deploy?",
+              branch_selected: "{{v}} Git branch `%s` selected for deploy",
+            },
+            app: {
+              no_apps_found: "No existing Heroku app found. What would you like to do?",
+              name: "What is your Heroku app’s name?",
+              select: "Specify an existing Heroku app",
+              selecting: "Selecting Heroku app `%s`…",
+              selected: "{{v}} Heroku app `%s` selected",
+              create: "Create a new Heroku app",
+              creating: "Creating new Heroku app…",
+              created: "{{v}} New Heroku app created",
+            },
+          },
+        },
+
+        generate: {
+          help: <<~HELP,
+          Generate code in your Rails project. Currently supports generating new webhooks.
+            Usage: {{command:%s generate [ webhook ]}}
+          HELP
+          extended_help: <<~EXAMPLES,
+          {{bold:Examples:}}
+            {{cyan:%s generate webhook PRODUCTS_CREATE}}
+              Generate and register a new webhook that will be called every time a new product is created on your store.
+          EXAMPLES
+
+          error: {
+            name_exists: "%s already exists!",
+            generic: "Error generating %s",
+          },
+
+          webhook: {
+            help: <<~HELP,
+            Generate and register a new webhook that listens for the specified Shopify store event.
+              Usage: {{command:%s generate webhook <type>}}
+            HELP
+
+            select: "What type of webhook would you like to create?",
+            selected: "Generating webhook: %s",
+          },
+        },
+
+        open: {
+          help: <<~HELP,
+          Open your local development app in the default browser.
+            Usage: {{command:%s open}}
+          HELP
+        },
+
+        populate: {
+          help: <<~HELP,
+          Populate your Shopify development store with example customers, orders, or products.
+            Usage: {{command:%s populate [ customers | draftorders | products ]}}
+          HELP
+          extended_help: <<~HELP,
+          {{bold:Subcommands:}}
+
+            {{cyan:customers [options]}}: Add dummy customers to the specified development store.
+              Usage: {{command:%1$s populate customers}}
+
+            {{cyan:draftorders [options]}}: Add dummy orders to the specified development store.
+              Usage: {{command:%1$s populate draftorders}}
+
+            {{cyan:products [options]}}: Add dummy products to the specified development store.
+              Usage: {{command:%1$s populate products}}
+
+          {{bold:Options:}}
+
+            {{cyan:--count [integer]}}: The number of dummy items to populate. Defaults to 5.
+            {{cyan:--silent}}: Silence the populate output.
+            {{cyan:--help}}: Display more options specific to each subcommand.
+
+          {{bold:Examples:}}
+
+            {{command:%1$s populate products}}
+              Populate your development store with 5 additional products.
+
+            {{command:%1$s populate customers --count 30}}
+              Populate your development store with 30 additional customers.
+
+            {{command:%1$s populate draftorders}}
+              Populate your development store with 5 additional orders.
+
+            {{command:%1$s populate products --help}}
+              Display the list of options available to customize the {{command:%1$s populate products}} command.
+          HELP
+
+          customer: {
+            added: "%s added to {{green:%s}} at {{underline:%scustomers/%d}}",
+          },
+
+          draft_order: {
+            added: "DraftOrder added to {{green:%s}} at {{underline:%sdraft_orders/%d}}",
+          },
+
+          product: {
+            added: "%s added to {{green:%s}} at {{underline:%sproducts/%d}}",
+          },
+        },
+
+        serve: {
+          help: <<~HELP,
+          Start a local development rails server for your project, as well as a public ngrok tunnel to your localhost.
+            Usage: {{command:%s serve}}
+          HELP
+          extended_help: <<~HELP,
+          {{bold:Options:}}
+            {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
+          HELP
+
+          error: {
+            host_must_be_https: "{{red:HOST must be a HTTPS url.}}",
+          },
+
+          open_info: "{{*}} Press {{yellow: Control-T}} to open this project in {{green:%s}} ",
+          running_server: "Running server...",
+        },
+
+        tunnel: {
+          help: <<~HELP,
+          Start or stop an http tunnel to your local development app using ngrok.
+            Usage: {{command:%s tunnel [ auth | start | stop ]}}
+          HELP
+          extended_help: <<~HELP,
+          {{bold:Subcommands:}}
+
+            {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account. Visit https://dashboard.ngrok.com/signup to sign up.
+              Usage: {{command:%1$s tunnel auth <token>}}
+
+            {{cyan:start}}: Starts an ngrok tunnel, will print the URL for an existing tunnel if already running.
+              Usage: {{command:%1$s tunnel start}}
+
+            {{cyan:stop}}: Stops the ngrok tunnel.
+              Usage: {{command:%1$s tunnel stop}}
+
+          HELP
+
+          error: {
+            token_argument_missing: "{{x}} {{red:auth requires a token argument}}\n\n",
+          },
+        },
+
+        forms: {
+          create: {
+            error: {
+              invalid_app_type: "Invalid app type %s",
+              invalid_db_type: "Invalid database type %s",
+              organization_not_found: "Cannot find a partner organization with that ID",
+              no_organizations: "No partner organizations available.",
+            },
+
+            authentication_issue: "For authentication issues, run {{command:%s logout}} to clear invalid credentials",
+            partners_notice: "Please visit https://partners.shopify.com/ to create a partners account",
+            no_development_stores: "{{x}} No development stores available.",
+            create_store: "Visit {{underline:https://partners.shopify.com/%s/stores}} to create one",
+            app_name: "App name",
+            app_type: {
+              select: "What type of app are you building?",
+              select_public: "Public: An app built for a wide merchant audience.",
+              select_custom: "Custom: An app custom built for a single client.",
+              selected: "App type {{green:%s}}",
+            },
+            db: {
+              want_select: <<~WANT_SELECT,
+              Would you like to select what database type to use now? (SQLite is the default)
+              If you want to change this in the future, run {{command:rails db:system:change --to=[new_db_type]}}. For more info:
+              {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
+              WANT_SELECT
+              select: "What database type would you like to use? Please ensure the database is installed.",
+              select_sqlite3: "SQLite (default)",
+              select_mysql: "MySQL",
+              select_postgresql: "PostgreSQL",
+              select_oracle: "Oracle",
+              select_frontbase: "FrontBase",
+              select_ibm_db: "IBM_DB",
+              select_sqlserver: "SQL Server",
+              select_jdbcmysql: "JDBC MySQL",
+              select_jdbcsqlite3: "JDBC SQlite",
+              select_jdbcpostgresql: "JDBC PostgreSQL",
+              select_jdbc: "JDBC",
+              selected: "Database Type {{green:%s}}",
+            },
+            organization_select: "Select partner organization",
+            organization: "Partner organization {{green:%s}}",
+            development_store_select: "Select a development store",
+            development_store: "Using development store {{green:%s}}",
+          },
+        },
+      },
+    }.freeze
+  end
+end