shopify-cli 1.0.4 → 1.2.0

data/lib/shopify-cli/project_type.rb

@@ -14,6 +14,7 @@ module ShopifyCli
       alias_method :all_loaded, :repository
 
       def inherited(klass)
+        super
         repository << klass
         klass.project_type = @current_type
         klass.project_load_shallow = @shallow_load
@@ -32,7 +33,7 @@ module ShopifyCli
 
       def load_all
         Dir.glob(File.join(ShopifyCli::ROOT, 'lib', 'project_types', '*', 'cli.rb')).map do |filepath|
-          load_type(filepath.split(File::Separator)[-2], true)
+          load_type(filepath.split(File::Separator)[-2].to_sym, true)
         end
       end
 
@@ -64,7 +65,7 @@ module ShopifyCli
 
       def register_task(task, name)
         return if project_load_shallow
-        Task::Registry.add(const_get(task), name)
+        ShopifyCli::Task.register(task, name)
       end
 
       def register_messages(messages)

data/lib/shopify-cli/sub_command.rb

@@ -8,6 +8,7 @@ module ShopifyCli
         cmd = new(@ctx)
         args = cmd.options.parse(@_options, args[1..-1] || [])
         return call_help(parent_command, command_name) if cmd.options.help
+        run_prerequisites
         cmd.call(args, command_name)
       end
     end

data/lib/shopify-cli/task.rb

@@ -2,9 +2,9 @@ require 'shopify_cli'
 
 module ShopifyCli
   class Task
-    def self.call(*args)
+    def self.call(*args, **kwargs)
       task = new
-      task.call(*args)
+      task.call(*args, **kwargs)
     end
   end
 end

data/lib/shopify-cli/tasks.rb

@@ -12,15 +12,22 @@ module ShopifyCli
       end
 
       def [](name)
-        @tasks[name]
+        class_or_proc = @tasks[name]
+        if class_or_proc.is_a?(Class)
+          class_or_proc
+        elsif class_or_proc.respond_to?(:call)
+          class_or_proc.call
+        else
+          class_or_proc
+        end
       end
     end
 
     Registry = TaskRegistry.new
 
-    def self.register(task, name, path)
-      autoload(task, path)
-      Registry.add(const_get(task), name)
+    def self.register(task, name, path = nil)
+      autoload(task, path) if path
+      Registry.add(-> () { const_get(task) }, name)
     end
 
     register :CreateApiClient, :create_api_client, 'shopify-cli/tasks/create_api_client'

data/lib/shopify-cli/tasks/ensure_env.rb

@@ -3,27 +3,84 @@ require 'shopify_cli'
 module ShopifyCli
   module Tasks
     class EnsureEnv < ShopifyCli::Task
-      def call(ctx)
+      def call(ctx, regenerate: false, required: [:api_key, :secret])
         @ctx = ctx
-        Resources::EnvFile.read(ctx.root)
-      rescue Errno::ENOENT
-        ask
+        env_data =
+          begin
+            Resources::EnvFile.parse_external_env
+          rescue Errno::ENOENT
+            {}
+          end
+
+        return {} if !regenerate && required.all? { |property| env_data[property] }
+
+        org = fetch_org
+        write_env(env_data, org)
+        org
+      end
+
+      private
+
+      def fetch_org
+        orgs = PartnersAPI::Organizations.fetch_with_app(@ctx)
+        org_id = if orgs.count == 1
+          orgs.first["id"]
+        else
+          CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.organization_select')) do |handler|
+            orgs.each do |org|
+              handler.option(
+                @ctx.message('core.partners_api.org_name_and_id', org['businessName'], org['id'])
+              ) { org["id"] }
+            end
+          end
+        end
+        orgs.find { |o| o["id"] == org_id }
       end
 
-      def ask
-        api_key = CLI::UI.ask(@ctx.message('core.tasks.ensure_env.api_key_question'))
-        api_secret = CLI::UI.ask(@ctx.message('core.tasks.ensure_env.api_secret_key_question'))
-        shop = CLI::UI.ask(@ctx.message('core.tasks.ensure_env.development_store_question'))
-        shop.gsub!(/https?\:\/\//, '')
-
-        env = Resources::EnvFile.new(
-          api_key: api_key,
-          secret: api_secret,
-          shop: shop,
-          host: ShopifyCli::Tunnel.start(@ctx),
-          scopes: 'write_products,write_customers,write_draft_orders',
+      def get_app(org_id, apps)
+        if apps.count == 1
+          apps.first
+        elsif apps.count == 0
+          @ctx.puts(@ctx.message('core.tasks.ensure_env.no_apps'))
+          title = CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.app_name'))
+          type = CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.app_type.select')) do |handler|
+            handler.option(@ctx.message('core.tasks.ensure_env.app_type.select_public')) { 'public' }
+            handler.option(@ctx.message('core.tasks.ensure_env.app_type.select_custom')) { 'custom' }
+          end
+          ShopifyCli::Tasks::CreateApiClient.call(@ctx, org_id: org_id, title: title, type: type)
+        else
+          CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.app_select')) do |handler|
+            apps.each { |app| handler.option(app["title"]) { app } }
+          end
+        end
+      end
+
+      def get_shop(shops, id)
+        if shops.count == 1
+          shop = shops.first["shopDomain"]
+        elsif shops.count == 0
+          @ctx.puts(@ctx.message('core.tasks.ensure_env.no_development_stores', id))
+        else
+          shop = CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.development_store_select')) do |handler|
+            shops.each { |s| handler.option(s["shopName"]) { s["shopDomain"] } }
+          end
+        end
+        shop
+      end
+
+      def write_env(env_data, org)
+        id = org['id']
+        app = get_app(id, org['apps'])
+
+        env_data[:shop] = get_shop(org['stores'], id)
+        env_data[:api_key] = app["apiKey"]
+        env_data[:secret] = app["apiSecretKeys"].first["secret"]
+        env_data[:scopes] = 'write_products,write_customers,write_draft_orders' if env_data[:scopes].nil?
+        env_data[:extra] = {} if env_data[:extra].nil?
+
+        Resources::EnvFile.new(
+          env_data
         ).write(@ctx)
-        env
       end
     end
   end

data/lib/shopify-cli/tunnel.rb

@@ -21,6 +21,7 @@ module ShopifyCli
     DOWNLOAD_URLS = {
       mac: 'https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-darwin-amd64.zip',
       linux: 'https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip',
+      windows: 'https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-windows-amd64.zip',
     }
 
     NGROK_TUNNELS_URI = URI.parse('http://localhost:4040/api/tunnels')
@@ -88,7 +89,7 @@ module ShopifyCli
     #
     def auth(ctx, token)
       install(ctx)
-      ctx.system(File.join(ShopifyCli::CACHE_DIR, 'ngrok'), 'authtoken', token)
+      ctx.system(File.join(ShopifyCli.cache_dir, 'ngrok'), 'authtoken', token)
     end
 
     ##
@@ -122,14 +123,21 @@ module ShopifyCli
     private
 
     def install(ctx)
-      return if File.exist?(File.join(ShopifyCli::CACHE_DIR, 'ngrok'))
+      return if File.exist?(File.join(ShopifyCli.cache_dir, ctx.windows? ? 'ngrok.exe' : 'ngrok'))
+      check_prereq_command(ctx, 'curl')
+      check_prereq_command(ctx, ctx.linux? ? 'unzip' : 'tar')
       spinner = CLI::UI::SpinGroup.new
       spinner.add('Installing ngrok...') do
-        zip_dest = File.join(ShopifyCli::CACHE_DIR, 'ngrok.zip')
+        zip_dest = File.join(ShopifyCli.cache_dir, 'ngrok.zip')
         unless File.exist?(zip_dest)
-          ctx.system('curl', '-o', zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCli::CACHE_DIR)
+          ctx.system('curl', '-o', zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCli.cache_dir)
         end
-        ctx.system('unzip', '-u', zip_dest, chdir: ShopifyCli::CACHE_DIR)
+        args = if ctx.linux?
+          %W(unzip -u #{zip_dest})
+        else
+          %W(tar -xf #{zip_dest})
+        end
+        ctx.system(*args, chdir: ShopifyCli.cache_dir)
         ctx.rm(zip_dest)
       end
       spinner.wait
@@ -143,7 +151,7 @@ module ShopifyCli
     end
 
     def ngrok_command(port)
-      "exec #{File.join(ShopifyCli::CACHE_DIR, 'ngrok')} http -inspect=false -log=stdout -log-level=debug #{port}"
+      "\"#{File.join(ShopifyCli.cache_dir, 'ngrok')}\" http -inspect=false -log=stdout -log-level=debug #{port}"
     end
 
     def seconds_to_hm(seconds)
@@ -163,6 +171,13 @@ module ShopifyCli
       end
       start_ngrok(ctx, port)
     end
+
+    def check_prereq_command(ctx, command)
+      cmd_path = ctx.which(command)
+      ctx.abort(ctx.message('core.tunnel.error.prereq_command_required', command)) if cmd_path.nil?
+      ctx.done(ctx.message('core.tunnel.prereq_command_location', command, cmd_path))
+    end
+
     class LogParser # :nodoc:
       TIMEOUT = 10
 
@@ -195,7 +210,7 @@ module ShopifyCli
       end
 
       def parse_account
-        account, timeout, _ = @log.match(/AccountName:([\w\s]*) SessionDuration:([\d]+) PlanName/)&.captures
+        account, timeout, _ = @log.match(/AccountName:([\w\s\d@._\-]*) SessionDuration:([\d]+) PlanName/)&.captures
         @account = account&.empty? ? nil : account
         @timeout = timeout&.empty? ? 0 : timeout.to_i
       end

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = '1.0.4'
+  VERSION = '1.2.0'
 end

data/lib/shopify_cli.rb

@@ -44,10 +44,6 @@ module ShopifyCli
   ROOT              = File.expand_path('../..', __FILE__)
   PROJECT_TYPES_DIR = File.join(ROOT, 'lib', 'project_types')
   TEMP_DIR          = File.join(ROOT, '.tmp')
-  CACHE_DIR         = File.join(File.expand_path(ENV.fetch('XDG_CACHE_HOME', '~/.cache')), TOOL_NAME)
-  TOOL_CONFIG_PATH  = File.join(File.expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config')), TOOL_NAME)
-  LOG_FILE          = File.join(TOOL_CONFIG_PATH, 'logs', 'log.log')
-  DEBUG_LOG_FILE    = File.join(TOOL_CONFIG_PATH, 'logs', 'debug.log')
 
   # programmer emoji if default install location, else wrench emoji
   EMOJI    = ROOT == '/opt/shopify' ? "\u{1f469}\u{200d}\u{1f4bb}" : "\u{1f527}"
@@ -82,7 +78,7 @@ module ShopifyCli
   # ShopifyCli::Config
   autocall(:Config)   { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
   # ShopifyCli::Logger
-  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: DEBUG_LOG_FILE) }
+  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: ShopifyCli.debug_log_file) }
   # ShopifyCli::Resolver
   autocall(:Resolver) do
     ShopifyCli::Core::HelpResolver.new(
@@ -93,7 +89,7 @@ module ShopifyCli
   # ShopifyCli::ErrorHandler
   autocall(:ErrorHandler) do
     CLI::Kit::ErrorHandler.new(
-      log_file: ShopifyCli::LOG_FILE,
+      log_file: ShopifyCli.log_file,
       exception_reporter: nil,
     )
   end
@@ -127,7 +123,37 @@ module ShopifyCli
 
   require 'shopify-cli/messages/messages'
   Context.load_messages(ShopifyCli::Messages::MESSAGES)
-end
 
-# Make sure the cache dir always exists
-FileUtils.mkdir_p(ShopifyCli::CACHE_DIR)
+  def self.cache_dir
+    cache_dir = if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
+      TEMP_DIR
+    elsif ENV['LOCALAPPDATA'].nil?
+      File.join(File.expand_path(ENV.fetch('XDG_CACHE_HOME', '~/.cache')), TOOL_NAME)
+    else
+      File.join(File.expand_path(ENV['LOCALAPPDATA']), TOOL_NAME)
+    end
+
+    # Make sure the cache dir always exists
+    @cache_dir_exists ||= FileUtils.mkdir_p(cache_dir)
+
+    cache_dir
+  end
+
+  def self.tool_config_path
+    if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
+      TEMP_DIR
+    elsif ENV['APPDATA'].nil?
+      File.join(File.expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config')), TOOL_NAME)
+    else
+      File.join(File.expand_path(ENV['APPDATA']), TOOL_NAME)
+    end
+  end
+
+  def self.log_file
+    File.join(tool_config_path, 'logs', 'log.log')
+  end
+
+  def self.debug_log_file
+    File.join(tool_config_path, 'logs', 'debug.log')
+  end
+end

data/shopify-cli.gemspec

@@ -26,7 +26,10 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features|packaging)/}) }
+    %x(git ls-files -z).split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|packaging)/}) ||
+      f.match(%r{^bin/(update-deps|shopify.bat)$})
+    end
   end
   spec.bindir = "bin"
   spec.require_paths = ["lib", "vendor"]

data/vendor/deps/cli-kit/REVISION

@@ -1 +1 @@
-fc25a17dff9d3130bb705659c002282ef7827932
+1013aa5c5664e7034ca3f02fd2e0513361b07e95 (dirty)

data/vendor/deps/cli-kit/lib/cli/kit.rb

@@ -51,7 +51,7 @@ module CLI
     #       1. rescue Abort or Bug
     #       2. Print a contextualized error message
     #       3. Re-raise AbortSilent or BugSilent respectively.
-    GenericAbort = Class.new(Exception)
+    GenericAbort = Class.new(Exception) # rubocop:disable Lint/InheritException
     Abort        = Class.new(GenericAbort)
     Bug          = Class.new(GenericAbort)
     BugSilent    = Class.new(GenericAbort)

data/vendor/deps/cli-kit/lib/cli/kit/autocall.rb

@@ -11,8 +11,8 @@ module CLI
       def const_missing(const)
         block = begin
           @autocalls.fetch(const)
-        rescue KeyError
-          return super
+                rescue KeyError
+                  return super
         end
         const_set(const, block.call)
       end

data/vendor/deps/cli-kit/lib/cli/kit/error_handler.rb

@@ -22,11 +22,11 @@ module CLI
       end
 
       def handle_exception(error)
-        if notify_with = exception_for_submission(error)
+        if (notify_with = exception_for_submission(error))
           logs = begin
             File.read(@log_file)
-          rescue => e
-            "(#{e.class}: #{e.message})"
+                 rescue => e
+                   "(#{e.class}: #{e.message})"
           end
           exception_reporter.report(notify_with, logs)
         end
@@ -56,7 +56,7 @@ module CLI
             # if it was `exit 30`, translate the exit code to 1, and submit nothing.
             # 30 is used to signal normal failures that are not indicative of bugs.
             # However, users should see it presented as 1.
-            exit 1
+            exit(1)
           else
             # A weird termination status happened. `error.exception "message"` will maintain backtrace
             # but allow us to set a message
@@ -83,7 +83,7 @@ module CLI
 
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       rescue Interrupt
-        $stderr.puts(format_error_message("Interrupt"))
+        stderr_puts_message('Interrupt')
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       rescue Errno::ENOSPC
         message = if @tool_name
@@ -91,10 +91,16 @@ module CLI
         else
           "Your disk is full - free space is required to operate"
         end
-        $stderr.puts(format_error_message(message))
+        stderr_puts_message(message)
         CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
       end
 
+      def stderr_puts_message(message)
+        $stderr.puts(format_error_message(message))
+      rescue Errno::EPIPE
+        nil
+      end
+
       def exception_reporter
         if @exception_reporter_or_proc.respond_to?(:report)
           @exception_reporter_or_proc

data/vendor/deps/cli-kit/lib/cli/kit/executor.rb

@@ -13,19 +13,17 @@ module CLI
       def call(command, command_name, args)
         with_traps do
           with_logging do |id|
+            command.call(args, command_name)
+          rescue => e
             begin
-              command.call(args, command_name)
-            rescue => e
-              begin
-                $stderr.puts "This command ran with ID: #{id}"
-                $stderr.puts "Please include this information in any issues/report along with relevant logs"
-              rescue SystemCallError
-                # Outputting to stderr is best-effort.  Avoid raising another error when outputting debug info so that
-                # we can detect and log the original error, which may even be the source of this error.
-                nil
-              end
-              raise e
+              $stderr.puts "This command ran with ID: #{id}"
+              $stderr.puts "Please include this information in any issues/report along with relevant logs"
+            rescue SystemCallError
+              # Outputting to stderr is best-effort.  Avoid raising another error when outputting debug info so that
+              # we can detect and log the original error, which may even be the source of this error.
+              nil
             end
+            raise e
           end
         end
       end

data/vendor/deps/cli-kit/lib/cli/kit/logger.rb

@@ -10,9 +10,10 @@ module CLI
       # Constructor for CLI::Kit::Logger
       #
       # @param debug_log_file [String] path to the file where debug logs should be stored
-      def initialize(debug_log_file:)
+      def initialize(debug_log_file:, env_debug_name: 'DEBUG')
         FileUtils.mkpath(File.dirname(debug_log_file))
         @debug_logger = ::Logger.new(debug_log_file, MAX_NUM_LOGS, MAX_LOG_SIZE)
+        @env_debug_name = env_debug_name
       end
 
       # Functionally equivalent to Logger#info
@@ -60,7 +61,7 @@ module CLI
       #
       # @param msg [String] the message to log
       def debug(msg)
-        $stdout.puts CLI::UI.fmt(msg) if ENV['DEBUG']
+        $stdout.puts CLI::UI.fmt(msg) if is_debug?
         @debug_logger.debug(format_debug(msg))
       end
 
@@ -71,6 +72,11 @@ module CLI
         return msg unless CLI::UI::StdoutRouter.current_id
         "[#{CLI::UI::StdoutRouter.current_id[:id]}] #{msg}"
       end
+
+      def is_debug?
+        val = ENV[@env_debug_name]
+        val && val != '0' && val != ''
+      end
     end
   end
 end