shopify-cli 2.4.0 → 2.6.2

data/lib/project_types/node/messages/messages.rb

@@ -119,10 +119,12 @@ module Node
           extended_help: <<~HELP,
             {{bold:Options:}}
               {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
+              {{cyan:--port=PORT}}: Use custom port.
           HELP
 
           error: {
             host_must_be_https: "HOST must be a HTTPS url.",
+            invalid_port: "%s is not a valid port.",
           },
 
           open_info: <<~MESSAGE,
@@ -154,6 +156,7 @@ module Node
           error: {
             token_argument_missing: "{{x}} {{red:auth requires a token argument}}\n\n",
           },
+
         },
 
         forms: {

data/lib/project_types/php/cli.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module PHP
+  class Project < ShopifyCLI::ProjectType
+    require Project.project_filepath("messages/messages")
+    register_messages(PHP::Messages::MESSAGES)
+  end
+
+  # define/autoload project specific Commands
+  class Command < ShopifyCLI::ProjectCommands
+    subcommand :Connect, "connect", Project.project_filepath("commands/connect")
+    subcommand :Create, "create", Project.project_filepath("commands/create")
+    subcommand :Deploy, "deploy", Project.project_filepath("commands/deploy")
+    subcommand :Open, "open", Project.project_filepath("commands/open")
+    subcommand :Serve, "serve", Project.project_filepath("commands/serve")
+    subcommand :Tunnel, "tunnel", Project.project_filepath("commands/tunnel")
+  end
+  ShopifyCLI::Commands.register("PHP::Command", "php")
+
+  # define/autoload project specific Tasks
+  module Tasks
+  end
+
+  # define/autoload project specific Forms
+  module Forms
+    autoload :Create, Project.project_filepath("forms/create")
+  end
+end

data/lib/project_types/php/commands/connect.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module PHP
+  class Command
+    class Connect < ShopifyCLI::SubCommand
+      def call(*)
+        if ShopifyCLI::Project.has_current? && ShopifyCLI::Project.current.env
+          @ctx.puts(@ctx.message("php.connect.production_warning"))
+        end
+
+        app = ShopifyCLI::Connect.new(@ctx).default_connect("php")
+        @ctx.done(@ctx.message("php.connect.connected", app))
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("php.connect.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

data/lib/project_types/php/commands/create.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+require "semantic/semantic"
+
+module PHP
+  class Command
+    class Create < ShopifyCLI::SubCommand
+      options do |parser, flags|
+        parser.on("--name=NAME") { |name| flags[:title] = name }
+        parser.on("--organization-id=ID") { |organization_id| flags[:organization_id] = organization_id }
+        parser.on("--store=MYSHOPIFYDOMAIN") { |url| flags[:shop_domain] = url }
+        parser.on("--type=APPTYPE") { |type| flags[:type] = type }
+        parser.on("--verbose") { flags[:verbose] = true }
+      end
+
+      def call(args, _name)
+        form = Forms::Create.ask(@ctx, args, options.flags)
+        return @ctx.puts(self.class.help) if form.nil?
+
+        check_php
+        check_composer
+        check_npm
+        app_id = build(form)
+
+        ShopifyCLI::Project.write(
+          @ctx,
+          project_type: "php",
+          organization_id: form.organization_id,
+        )
+
+        partners_url = ShopifyCLI::PartnersAPI.partners_url_for(form.organization_id, app_id)
+
+        @ctx.puts(@ctx.message("apps.create.info.created", form.title, partners_url))
+        @ctx.puts(@ctx.message("apps.create.info.serve", form.name, ShopifyCLI::TOOL_NAME, "php"))
+        unless ShopifyCLI::Shopifolk.acting_as_shopify_organization?
+          @ctx.puts(@ctx.message("apps.create.info.install", partners_url, form.title))
+        end
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("php.create.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+
+      private
+
+      def check_php
+        cmd_path = @ctx.which("php")
+        @ctx.abort(@ctx.message("php.create.error.php_required")) if cmd_path.nil?
+
+        version, stat = @ctx.capture2e("php", "-r", "echo phpversion();")
+        @ctx.abort(@ctx.message("php.create.error.php_version_failure")) unless stat.success?
+
+        if ::Semantic::Version.new(version) < ::Semantic::Version.new("7.3.0")
+          @ctx.abort(@ctx.message("php.create.error.php_version_too_low", "7.3"))
+        end
+
+        @ctx.done(@ctx.message("php.create.php_version", version))
+      end
+
+      def check_composer
+        cmd_path = @ctx.which("composer")
+        @ctx.abort(@ctx.message("php.create.error.composer_required")) if cmd_path.nil?
+      end
+
+      def check_npm
+        cmd_path = @ctx.which("npm")
+        @ctx.abort(@ctx.message("php.create.error.npm_required")) if cmd_path.nil?
+
+        version, stat = @ctx.capture2e("npm", "-v")
+        @ctx.abort(@ctx.message("php.create.error.npm_version_failure")) unless stat.success?
+
+        @ctx.done(@ctx.message("php.create.npm_version", version))
+      end
+
+      def build(form)
+        ShopifyCLI::Git.clone("https://github.com/Shopify/shopify-app-php.git", form.name)
+
+        @ctx.root = File.join(@ctx.root, form.name)
+        @ctx.chdir(@ctx.root)
+
+        api_client = ShopifyCLI::Tasks::CreateApiClient.call(
+          @ctx,
+          org_id: form.organization_id,
+          title: form.title,
+          type: form.type,
+        )
+
+        # Override the example settings with our own
+        @ctx.cp(".env.example", ".env")
+
+        env_file = ShopifyCLI::Resources::EnvFile.read
+        env_file.api_key = api_client["apiKey"]
+        env_file.secret = api_client["apiSecretKeys"].first["secret"]
+        env_file.shop = form.shop_domain
+        env_file.host = "localhost"
+        env_file.scopes = "write_products,write_draft_orders,write_customers"
+        env_file.extra["DB_DATABASE"] = File.join(@ctx.root, env_file.extra["DB_DATABASE"])
+        env_file.write(@ctx)
+
+        ShopifyCLI::PHPDeps.install(@ctx, !options.flags[:verbose].nil?)
+
+        set_npm_config
+        ShopifyCLI::JsDeps.install(@ctx, !options.flags[:verbose].nil?)
+
+        title = @ctx.message("php.create.app_setting_up")
+        success = @ctx.message("php.create.app_set_up")
+        failure = @ctx.message("php.create.error.app_setup")
+        CLI::UI::Frame.open(title, success_text: success, failure_text: failure) do
+          FileUtils.touch(env_file.extra["DB_DATABASE"])
+          @ctx.system("php", "artisan", "key:generate")
+          @ctx.system("php", "artisan", "migrate")
+        end
+
+        begin
+          @ctx.rm_r(".git")
+          @ctx.rm_r(".github")
+        rescue Errno::ENOENT => e
+          @ctx.debug(e)
+        end
+
+        api_client["id"]
+      end
+
+      def set_npm_config
+        # check available npmrc (either user or system) for production registry
+        registry, _ = @ctx.capture2("npm config get @shopify:registry")
+        return if registry.include?("https://registry.yarnpkg.com")
+
+        # available npmrc doesn't have production registry =>
+        # set a project-based .npmrc
+        @ctx.system(
+          "npm",
+          "--userconfig",
+          "./.npmrc",
+          "config",
+          "set",
+          "@shopify:registry",
+          "https://registry.yarnpkg.com",
+          chdir: @ctx.root
+        )
+      end
+    end
+  end
+end

data/lib/project_types/php/commands/deploy/heroku.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module PHP
+  class Command
+    class Deploy
+      class Heroku
+        def self.help
+          ShopifyCLI::Context.message("php.deploy.heroku.help", ShopifyCLI::TOOL_NAME)
+        end
+
+        def self.start(ctx)
+          spin_group = CLI::UI::SpinGroup.new
+          heroku_service = ShopifyCLI::Heroku.new(ctx)
+
+          spin_group.add(ctx.message("php.deploy.heroku.downloading")) do |spinner|
+            heroku_service.download
+            spinner.update_title(ctx.message("php.deploy.heroku.downloaded"))
+          end
+          spin_group.wait
+
+          install_message = ctx.message(
+            ctx.windows? ? "php.deploy.heroku.installing_windows" : "php.deploy.heroku.installing"
+          )
+          spin_group.add(install_message) do |spinner|
+            heroku_service.install
+            spinner.update_title(ctx.message("php.deploy.heroku.installed"))
+          end
+          spin_group.wait
+
+          spin_group.add(ctx.message("php.deploy.heroku.git.checking")) do |spinner|
+            ShopifyCLI::Git.init(ctx)
+            spinner.update_title(ctx.message("php.deploy.heroku.git.initialized"))
+          end
+          spin_group.wait
+
+          if (account = heroku_service.whoami)
+            ctx.puts(ctx.message("php.deploy.heroku.authenticated_with_account", account))
+          else
+            CLI::UI::Frame.open(
+              ctx.message("php.deploy.heroku.authenticating"),
+              success_text: ctx.message("php.deploy.heroku.authenticated")
+            ) do
+              heroku_service.authenticate
+            end
+          end
+
+          if (app_name = heroku_service.app)
+            ctx.puts(ctx.message("php.deploy.heroku.app.selected", app_name))
+          else
+            app_type = CLI::UI::Prompt.ask(ctx.message("php.deploy.heroku.app.no_apps_found")) do |handler|
+              handler.option(ctx.message("php.deploy.heroku.app.create")) { :new }
+              handler.option(ctx.message("php.deploy.heroku.app.select")) { :existing }
+            end
+
+            if app_type == :existing
+              app_name = CLI::UI::Prompt.ask(ctx.message("php.deploy.heroku.app.name"))
+              CLI::UI::Frame.open(
+                ctx.message("php.deploy.heroku.app.selecting", app_name),
+                success_text: ctx.message("php.deploy.heroku.app.selected", app_name)
+              ) do
+                heroku_service.select_existing_app(app_name)
+              end
+            elsif app_type == :new
+              CLI::UI::Frame.open(
+                ctx.message("php.deploy.heroku.app.creating"),
+                success_text: ctx.message("php.deploy.heroku.app.created")
+              ) do
+                heroku_service.create_new_app
+                app_name = heroku_service.app
+              end
+            end
+          end
+
+          branches = ShopifyCLI::Git.branches(ctx)
+          if branches.length == 1
+            branch_to_deploy = branches[0]
+            ctx.puts(ctx.message("php.deploy.heroku.git.branch_selected", branch_to_deploy))
+          else
+            branch_to_deploy = CLI::UI::Prompt.ask(ctx.message("php.deploy.heroku.git.what_branch")) do |handler|
+              branches.each do |branch|
+                handler.option(branch) { branch }
+              end
+            end
+          end
+
+          app_url = "https://#{app_name}.herokuapp.com"
+
+          CLI::UI::Frame.open(
+            ctx.message("php.deploy.heroku.app.setting_configs"),
+            success_text: ctx.message("php.deploy.heroku.app.configs_set")
+          ) do
+            allowed_configs = [/SHOPIFY_API_KEY/, /SHOPIFY_API_SECRET/, /SCOPES/, /HOST/]
+
+            ShopifyCLI::Project.current.env.to_h.each do |config, value|
+              next unless allowed_configs.any? { |pattern| pattern.match?(config) }
+
+              value = app_url if config == "HOST"
+
+              current = heroku_service.get_config(config)
+              heroku_service.set_config(config, value) if current.nil? || current != value
+            end
+
+            current_key = heroku_service.get_config("APP_KEY")
+            if current_key.nil? || current_key.empty?
+              output, status = ctx.capture2e("php", "artisan", "key:generate", "--show")
+
+              ctx.abort(ctx.message("php.deploy.heroku.error.generate_app_key")) unless status.success?
+
+              heroku_service.set_config("APP_KEY", output.strip) if status.success?
+            end
+
+            heroku_service.add_buildpacks(["heroku/php", "heroku/nodejs"])
+          end
+
+          CLI::UI::Frame.open(
+            ctx.message("php.deploy.heroku.deploying"),
+            success_text: ctx.message("php.deploy.heroku.deployed")
+          ) do
+            heroku_service.deploy(branch_to_deploy)
+          end
+
+          heroku_command = heroku_service.heroku_command
+          ctx.puts(ctx.message("php.deploy.heroku.post_deploy", app_url, heroku_command))
+        end
+      end
+    end
+  end
+end

data/lib/project_types/php/commands/deploy.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module PHP
+  class Command
+    class Deploy < ShopifyCLI::SubCommand
+      prerequisite_task ensure_project_type: :php
+
+      autoload :Heroku, Project.project_filepath("commands/deploy/heroku")
+
+      HEROKU = "heroku"
+
+      def call(args, _name)
+        subcommand = args.shift
+        case subcommand
+        when HEROKU
+          PHP::Command::Deploy::Heroku.start(@ctx)
+        else
+          @ctx.puts(self.class.help)
+        end
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("php.deploy.help", ShopifyCLI::TOOL_NAME)
+      end
+
+      def self.extended_help
+        ShopifyCLI::Context.message("php.deploy.extended_help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

data/lib/project_types/php/commands/open.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PHP
+  class Command
+    class Open < ShopifyCLI::SubCommand
+      def call(*)
+        project = ShopifyCLI::Project.current
+        @ctx.open_url!("#{project.env.host}/login?shop=#{project.env.shop}")
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("php.open.help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+module PHP
+  class Command
+    class Serve < ShopifyCLI::SubCommand
+      PORT = 3000
+
+      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, port: PORT)
+        @ctx.abort(@ctx.message("php.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/callback",
+        )
+
+        if project.env.shop
+          project_url = "#{project.env.host}/login?shop=#{project.env.shop}"
+          @ctx.puts("\n" + @ctx.message("php.serve.open_info", project_url) + "\n")
+        end
+
+        CLI::UI::Frame.open(@ctx.message("php.serve.running_server")) do
+          if ShopifyCLI::ProcessSupervision.running?(:npm_watch)
+            ShopifyCLI::ProcessSupervision.stop(:npm_watch)
+          end
+          ShopifyCLI::ProcessSupervision.start(:npm_watch, "npm run watch", force_spawn: true)
+
+          env = project.env.to_h
+          @ctx.system("php", "artisan", "serve", "--port", PORT.to_s, env: env)
+        end
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("php.serve.help", ShopifyCLI::TOOL_NAME)
+      end
+
+      def self.extended_help
+        ShopifyCLI::Context.message("php.serve.extended_help")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "shopify_cli"
+
+module PHP
+  class Command
+    class Tunnel < ShopifyCLI::SubCommand
+      def call(args, _name)
+        subcommand = args.shift
+        case subcommand
+        when "auth"
+          token = args.shift
+          if token.nil?
+            @ctx.puts(@ctx.message("php.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("php.tunnel.help", ShopifyCLI::TOOL_NAME)
+      end
+
+      def self.extended_help
+        ShopifyCLI::Context.message("php.tunnel.extended_help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require "uri"
+
+module PHP
+  module Forms
+    class Create < ShopifyCLI::Form
+      attr_accessor :name
+      flag_arguments :title, :organization_id, :shop_domain, :type
+
+      def ask
+        self.title ||= CLI::UI::Prompt.ask(ctx.message("php.forms.create.app_name"))
+        self.name = format_name
+        self.type = ask_type
+        res = ShopifyCLI::Tasks::SelectOrgAndShop.call(ctx, organization_id: organization_id, shop_domain: shop_domain)
+        self.organization_id = res[:organization_id]
+        self.shop_domain = res[:shop_domain]
+      end
+
+      private
+
+      def format_name
+        name = title.downcase.split(" ").join("_")
+
+        if name.include?("shopify")
+          ctx.abort(ctx.message("php.forms.create.error.invalid_app_name"))
+        end
+        name
+      end
+
+      def ask_type
+        if type.nil?
+          return CLI::UI::Prompt.ask(ctx.message("php.forms.create.app_type.select")) do |handler|
+            handler.option(ctx.message("php.forms.create.app_type.select_public")) { "public" }
+            handler.option(ctx.message("php.forms.create.app_type.select_custom")) { "custom" }
+          end
+        end
+
+        unless ShopifyCLI::Tasks::CreateApiClient::VALID_APP_TYPES.include?(type)
+          ctx.abort(ctx.message("php.forms.create.error.invalid_app_type", type))
+        end
+        ctx.puts(ctx.message("php.forms.create.app_type.selected", type))
+        type
+      end
+    end
+  end
+end