shopify-cli 1.3.1 → 1.7.0

data/lib/shopify-cli/transform_data_structure.rb

@@ -0,0 +1,86 @@
+
+module ShopifyCli
+  ##
+  # `TransformDataStructure` helps to standardize data structure access. It
+  # traverses nested data structures and can convert
+  #
+  # * all strings used as keys to symbols,
+  # * all strings used as keys from `CamelCase` to `snake_case` and
+  # * associative array containers, e.g. from Hash to OpenStruct.
+  #
+  # Standardizing how a data structure is accessed greatly reduces the risk
+  # of subtle bugs especially when dealing with API responses.
+  #
+  #    TransformDataStructure.new(
+  #      symbolize_keys: true,
+  #      underscore_keys: true,
+  #      associative_array_container: OpenStruct
+  #    ).call([{"SomeKey" => "value"}]).tap do |result|
+  #      result.value # => [#<OpenStruct: some_key: "value">]
+  #    end
+  #
+  # Since `TransformDataStructure` is a method object, it can easily be chained:
+  #
+  #    require 'open-uri'
+  #    ShopifyCli::Result
+  #      .call { open("https://jsonplaceholder.typicode.com/todos/1") }
+  #      .map(&TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
+  #      .value # => { id: 1, user_id: 1, ... }
+  #
+  class TransformDataStructure
+    include ShopifyCli::MethodObject
+
+    class << self
+      private
+
+      def valid_associative_array_container(klass)
+        klass.respond_to?(:new) && klass.method_defined?(:[]=)
+      end
+    end
+
+    property! :underscore_keys, accepts: [true, false], default: false, reader: :underscore_keys?
+    property! :symbolize_keys, accepts: [true, false], default: false, reader: :symbolize_keys?
+    property! :associative_array_container,
+      accepts: ->(c) { c.respond_to?(:new) && c.method_defined?(:[]=) },
+      default: Hash
+
+    def call(object)
+      case object
+      when Array
+        object.map(&self).map(&:value)
+      when Hash
+        object.each.with_object(associative_array_container.new) do |(key, value), result|
+          result[transform_key(key)] = call(value).value
+        end
+      else
+        ShopifyCli::Result.success(object)
+      end
+    end
+
+    private
+
+    def transform_key(key)
+      key
+        .yield_self(&method(:underscore_key))
+        .yield_self(&method(:symbolize_key))
+    end
+
+    def underscore_key(key)
+      return key unless underscore_keys? && key.respond_to?(:to_str)
+
+      key.to_str.dup.yield_self do |k|
+        k.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        k.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        k.tr!("-", "_")
+        k.gsub!(/\s/, "_")
+        k.gsub!(/__+/, "_")
+        k.downcase!
+      end
+    end
+
+    def symbolize_key(key)
+      return key unless symbolize_keys? && key.respond_to?(:to_sym)
+      key.to_sym
+    end
+  end
+end

data/lib/shopify-cli/tunnel.rb

@@ -1,7 +1,7 @@
-require 'json'
-require 'fileutils'
-require 'shopify_cli'
-require 'forwardable'
+require "json"
+require "fileutils"
+require "shopify_cli"
+require "forwardable"
 
 module ShopifyCli
   ##
@@ -19,14 +19,14 @@ module ShopifyCli
     PORT = 8081 # port that ngrok will bind to
     # mapping for supported operating systems for where to download ngrok from.
     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',
+      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')
-    TUNNELS_FIELD = 'tunnels'
-    PUBLIC_URL_FIELD = 'public_url'
+    NGROK_TUNNELS_URI = URI.parse("http://localhost:4040/api/tunnels")
+    TUNNELS_FIELD = "tunnels"
+    PUBLIC_URL_FIELD = "public_url"
 
     ##
     # will find and stop a running tunnel process. It will also output if the
@@ -39,12 +39,12 @@ module ShopifyCli
     def stop(ctx)
       if ShopifyCli::ProcessSupervision.running?(:ngrok)
         if ShopifyCli::ProcessSupervision.stop(:ngrok)
-          ctx.puts(ctx.message('core.tunnel.stopped'))
+          ctx.puts(ctx.message("core.tunnel.stopped"))
         else
-          ctx.abort(ctx.message('core.tunnel.error.stop'))
+          ctx.abort(ctx.message("core.tunnel.error.stop"))
         end
       else
-        ctx.puts(ctx.message('core.tunnel.not_running'))
+        ctx.puts(ctx.message("core.tunnel.not_running"))
       end
     end
 
@@ -65,15 +65,15 @@ module ShopifyCli
       install(ctx)
       url, account, seconds_remaining = start_ngrok(ctx, port)
       if account
-        ctx.puts(ctx.message('core.tunnel.start_with_account', url, account))
+        ctx.puts(ctx.message("core.tunnel.start_with_account", url, account))
       else
         if seconds_remaining <= 0
-          ctx.puts(ctx.message('core.tunnel.timed_out'))
+          ctx.puts(ctx.message("core.tunnel.timed_out"))
           url, _account, seconds_remaining = restart_ngrok(ctx, port)
         end
-        ctx.puts(ctx.message('core.tunnel.start', url))
-        ctx.puts(ctx.message('core.tunnel.will_timeout', seconds_to_hm(seconds_remaining)))
-        ctx.puts(ctx.message('core.tunnel.signup_suggestion', ShopifyCli::TOOL_NAME))
+        ctx.puts(ctx.message("core.tunnel.start", url))
+        ctx.puts(ctx.message("core.tunnel.will_timeout", seconds_to_hm(seconds_remaining)))
+        ctx.puts(ctx.message("core.tunnel.signup_suggestion", ShopifyCli::TOOL_NAME))
       end
       url
     end
@@ -89,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
 
     ##
@@ -123,14 +123,15 @@ module ShopifyCli
     private
 
     def install(ctx)
-      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')
+      ngrok = "ngrok#{ctx.executable_file_extension}"
+      return if File.exist?(File.join(ShopifyCli.cache_dir, 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')
+      spinner.add("Installing ngrok...") do
+        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
         args = if ctx.linux?
           %W(unzip -u #{zip_dest})
@@ -141,6 +142,11 @@ module ShopifyCli
         ctx.rm(zip_dest)
       end
       spinner.wait
+
+      # final check to see if ngrok is accessible
+      unless File.exist?(File.join(ShopifyCli.cache_dir, ngrok))
+        ctx.abort(ctx.message("core.tunnel.error.ngrok", ngrok, ShopifyCli.cache_dir))
+      end
     end
 
     def fetch_url(ctx, log_path)
@@ -151,7 +157,7 @@ module ShopifyCli
     end
 
     def ngrok_command(port)
-      "\"#{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)
@@ -167,15 +173,15 @@ module ShopifyCli
 
     def restart_ngrok(ctx, port)
       unless ShopifyCli::ProcessSupervision.stop(:ngrok)
-        ctx.abort(ctx.message('core.tunnel.error.stop'))
+        ctx.abort(ctx.message("core.tunnel.error.stop"))
       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))
+      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:
@@ -193,7 +199,7 @@ module ShopifyCli
           sleep(1)
         end
 
-        raise FetchUrlError, Context.message('core.tunnel.error.url_fetch_failure') unless url
+        raise FetchUrlError, Context.message("core.tunnel.error.url_fetch_failure") unless url
       end
 
       def parse

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = '1.3.1'
+  VERSION = "1.7.0"
 end

data/lib/shopify_cli.rb

@@ -8,23 +8,23 @@ Thread.report_on_exception = false
 # require_relative 'support/ruby_backports'
 
 # See bin/load_shopify.rb
-ENV['PATH'] = ENV['PATH'].split(':').select { |p| p.start_with?('/', '~') }.join(':') unless defined?($original_env)
+ENV["PATH"] = ENV["PATH"].split(":").select { |p| p.start_with?("/", "~") }.join(":") unless defined?($original_env)
 
 # Load vendor and CLI UI/Kit.
 # Nothing else should be loaded at this point and nothing else should be added to the load path on boot
 vendor_path = File.expand_path("../../vendor/lib", __FILE__)
 $LOAD_PATH.unshift(vendor_path) unless $LOAD_PATH.include?(vendor_path)
 
-deps = %w(cli-ui cli-kit smart_properties)
+deps = %w(cli-ui cli-kit smart_properties webrick)
 deps.each do |dep|
   vendor_path = File.expand_path("../../vendor/deps/#{dep}/lib", __FILE__)
   $LOAD_PATH.unshift(vendor_path) unless $LOAD_PATH.include?(vendor_path)
 end
 
-require 'cli/ui'
-require 'cli/kit'
-require 'smart_properties'
-require_relative 'shopify-cli/version'
+require "cli/ui"
+require "cli/kit"
+require "smart_properties"
+require_relative "shopify-cli/version"
 
 # Enable stdout routing. At this point all calls to STDOUT (and STDERR) will go through this class.
 # See https://github.com/Shopify/cli-ui/blob/master/lib/cli/ui/stdout_router.rb for more info
@@ -39,16 +39,16 @@ CLI::UI::StdoutRouter.enable
 module ShopifyCli
   extend CLI::Kit::Autocall
 
-  TOOL_NAME         = 'shopify'
-  TOOL_FULL_NAME    = 'Shopify CLI'
-  ROOT              = File.expand_path('../..', __FILE__)
-  PROJECT_TYPES_DIR = File.join(ROOT, 'lib', 'project_types')
-  TEMP_DIR          = File.join(ROOT, '.tmp')
+  TOOL_NAME         = "shopify"
+  TOOL_FULL_NAME    = "Shopify CLI"
+  ROOT              = File.expand_path("../..", __FILE__)
+  PROJECT_TYPES_DIR = File.join(ROOT, "lib", "project_types")
+  TEMP_DIR          = File.join(ROOT, ".tmp")
 
   # programmer emoji if default install location, else wrench emoji
-  EMOJI    = ROOT == '/opt/shopify' ? "\u{1f469}\u{200d}\u{1f4bb}" : "\u{1f527}"
+  EMOJI    = ROOT == "/opt/shopify" ? "\u{1f469}\u{200d}\u{1f4bb}" : "\u{1f527}"
   # shrug or boom emoji
-  FAILMOJI = ROOT == '/opt/shopify' ? "\u{1f937}" : "\u{1f4a5}"
+  FAILMOJI = ROOT == "/opt/shopify" ? "\u{1f937}" : "\u{1f4a5}"
 
   # Exit management in `shopify-app-cli` follows the management set out by CLI Kit.
   # https://github.com/Shopify/cli-kit/blob/master/lib/cli/kit.rb
@@ -94,43 +94,49 @@ module ShopifyCli
     )
   end
 
-  autoload :AdminAPI, 'shopify-cli/admin_api'
-  autoload :API, 'shopify-cli/api'
-  autoload :Command, 'shopify-cli/command'
-  autoload :Commands, 'shopify-cli/commands'
-  autoload :Context, 'shopify-cli/context'
-  autoload :Core, 'shopify-cli/core'
-  autoload :DB, 'shopify-cli/db'
-  autoload :Feature, 'shopify-cli/feature'
-  autoload :Form, 'shopify-cli/form'
-  autoload :Git, 'shopify-cli/git'
-  autoload :Helpers, 'shopify-cli/helpers'
-  autoload :Heroku, 'shopify-cli/heroku'
-  autoload :JsDeps, 'shopify-cli/js_deps'
-  autoload :JsSystem, 'shopify-cli/js_system'
-  autoload :Log, 'shopify-cli/log'
-  autoload :OAuth, 'shopify-cli/oauth'
-  autoload :Options, 'shopify-cli/options'
-  autoload :PartnersAPI, 'shopify-cli/partners_api'
-  autoload :ProcessSupervision, 'shopify-cli/process_supervision'
-  autoload :Project, 'shopify-cli/project'
-  autoload :ProjectType, 'shopify-cli/project_type'
-  autoload :Resources, 'shopify-cli/resources'
-  autoload :SubCommand, 'shopify-cli/sub_command'
-  autoload :Task, 'shopify-cli/task'
-  autoload :Tasks, 'shopify-cli/tasks'
-  autoload :Tunnel, 'shopify-cli/tunnel'
-
-  require 'shopify-cli/messages/messages'
+  autoload :AdminAPI, "shopify-cli/admin_api"
+  autoload :API, "shopify-cli/api"
+  autoload :Command, "shopify-cli/command"
+  autoload :Commands, "shopify-cli/commands"
+  autoload :Context, "shopify-cli/context"
+  autoload :Core, "shopify-cli/core"
+  autoload :DB, "shopify-cli/db"
+  autoload :Feature, "shopify-cli/feature"
+  autoload :Form, "shopify-cli/form"
+  autoload :Git, "shopify-cli/git"
+  autoload :Helpers, "shopify-cli/helpers"
+  autoload :Heroku, "shopify-cli/heroku"
+  autoload :JsDeps, "shopify-cli/js_deps"
+  autoload :JsSystem, "shopify-cli/js_system"
+  autoload :MethodObject, "shopify-cli/method_object"
+  autoload :LazyDelegator, "shopify-cli/lazy_delegator"
+  autoload :Log, "shopify-cli/log"
+  autoload :OAuth, "shopify-cli/oauth"
+  autoload :Options, "shopify-cli/options"
+  autoload :PartnersAPI, "shopify-cli/partners_api"
+  autoload :ProcessSupervision, "shopify-cli/process_supervision"
+  autoload :Project, "shopify-cli/project"
+  autoload :ProjectType, "shopify-cli/project_type"
+  autoload :ResolveConstant, "shopify-cli/resolve_constant"
+  autoload :Resources, "shopify-cli/resources"
+  autoload :Result, "shopify-cli/result"
+  autoload :Shopifolk, "shopify-cli/shopifolk"
+  autoload :SubCommand, "shopify-cli/sub_command"
+  autoload :Task, "shopify-cli/task"
+  autoload :Tasks, "shopify-cli/tasks"
+  autoload :TransformDataStructure, "shopify-cli/transform_data_structure"
+  autoload :Tunnel, "shopify-cli/tunnel"
+
+  require "shopify-cli/messages/messages"
   Context.load_messages(ShopifyCli::Messages::MESSAGES)
 
   def self.cache_dir
-    cache_dir = if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
+    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)
+    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)
+      File.join(File.expand_path(ENV["LOCALAPPDATA"]), TOOL_NAME)
     end
 
     # Make sure the cache dir always exists
@@ -140,20 +146,20 @@ module ShopifyCli
   end
 
   def self.tool_config_path
-    if ENV.key?('RUNNING_SHOPIFY_CLI_TESTS')
+    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)
+    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)
+      File.join(File.expand_path(ENV["APPDATA"]), TOOL_NAME)
     end
   end
 
   def self.log_file
-    File.join(tool_config_path, 'logs', 'log.log')
+    File.join(tool_config_path, "logs", "log.log")
   end
 
   def self.debug_log_file
-    File.join(tool_config_path, 'logs', 'debug.log')
+    File.join(tool_config_path, "logs", "debug.log")
   end
 end

data/shopify-cli.gemspec

@@ -1,11 +1,11 @@
-require_relative 'lib/shopify-cli/version'
+require_relative "lib/shopify-cli/version"
 
 Gem::Specification.new do |spec|
   spec.name = "shopify-cli"
   spec.version = ShopifyCli::VERSION
   spec.authors = ["Shopify"]
   spec.email = ["dev-tools-education@shopify.com"]
-  spec.license = 'MIT'
+  spec.license = "MIT"
 
   spec.summary = "Shopify CLI helps you build Shopify apps faster."
   spec.description = <<~HERE
@@ -25,7 +25,7 @@ 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
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     %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)$})
@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib", "vendor"]
   spec.extensions = ["ext/shopify-cli/extconf.rb"]
 
-  spec.add_development_dependency('bundler', '~> 1.17')
-  spec.add_development_dependency('rake', '~> 12.3', '>= 12.3.3')
-  spec.add_development_dependency('minitest', '~> 5.0')
+  spec.add_development_dependency("bundler", "~> 1.17")
+  spec.add_development_dependency("rake", "~> 12.3", ">= 12.3.3")
+  spec.add_development_dependency("minitest", "~> 5.0")
 end

data/shopify.fish

@@ -7,6 +7,6 @@ if [ $status != "0" ]
   echo "This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
 
 Please visit this page for complete instructions:
-  https://shopify.github.io/shopify-app-cli/migrate/
+  https://shopify.dev/tools/cli/troubleshooting#migrate-from-a-legacy-version
 "
 end

data/shopify.sh

@@ -6,6 +6,6 @@ if [ "$?" != "0" ]; then
   echo "This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
 
 Please visit this page for complete instructions:
-  https://shopify.github.io/shopify-app-cli/migrate/
+  https://shopify.dev/tools/cli/troubleshooting#migrate-from-a-legacy-version
 "
 fi