shopify-cli 0.9.0 → 1.0.1

data/lib/project_types/script/templates/ts/as-pect.d.ts

@@ -0,0 +1 @@
+/// <reference types="@as-pect/assembly/types/as-pect" />

data/lib/project_types/script/ui/error_handler.rb

@@ -44,6 +44,11 @@ module Script
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_context_cause'),
             help_suggestion: ShopifyCli::Context.message('script.error.invalid_context_help'),
           }
+        when Errors::InvalidScriptNameError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_script_name_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.invalid_script_name_help'),
+          }
         when Errors::NoExistingAppsError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.no_existing_apps_cause'),

data/lib/shopify-cli/admin_api.rb

@@ -37,8 +37,7 @@ module ShopifyCli
       #
       #   ShopifyCli::AdminAPI.query(@ctx, 'all_organizations')
       #
-      def query(ctx, query_name, api_version: nil, shop: nil, **variables)
-        shop ||= Project.current.env.shop
+      def query(ctx, query_name, shop:, api_version: nil, **variables)
         authenticated_req(ctx, shop) do
           api_client(ctx, api_version, shop).query(query_name, variables: variables)
         end

data/lib/shopify-cli/admin_api/populate_resource_command.rb

@@ -41,6 +41,8 @@ module ShopifyCli
           return @ctx.puts(output)
         end
 
+        @shop ||= Project.current.env.shop || get_shop(@ctx)
+
         if @silent
           spin_group = CLI::UI::SpinGroup.new
           spin_group.add(@ctx.message('core.populate.populating', @count, camel_case_resource_type)) do |spinner|
@@ -114,7 +116,7 @@ module ShopifyCli
 
       def run_mutation(data)
         kwargs = { input: data }
-        kwargs[:shop] = @shop if @shop
+        kwargs[:shop] = @shop
         resp = AdminAPI.query(
           @ctx, "create_#{snake_case_resource_type}", kwargs
         )
@@ -145,6 +147,13 @@ module ShopifyCli
 
       private
 
+      def get_shop(ctx)
+        res = ShopifyCli::Tasks::SelectOrgAndShop.call(ctx)
+        domain = res[:shop_domain]
+        Project.current.env.update(ctx, :shop, domain)
+        domain
+      end
+
       def camel_case_resource_type
         @camel_case_resource_type ||= self.class.to_s.split('::').last
       end

data/lib/shopify-cli/api.rb

@@ -32,6 +32,8 @@ module ShopifyCli
       )
       ctx.debug(resp)
       resp
+    rescue API::APIRequestServerError, API::APIRequestUnexpectedError
+      ctx.puts(ctx.message('core.api.error.internal_server_error'))
     end
 
     protected

data/lib/shopify-cli/context.rb

@@ -131,6 +131,47 @@ module ShopifyCli
       File.write(ctx_path(fname), content)
     end
 
+    # will change directories and update the root, the filepath is relative to the command root unless absolute
+    #
+    # #### Parameters
+    # * `path` - the file path to a directory, relative to the context root to remove from the FS
+    #
+    def chdir(path)
+      Dir.chdir(ctx_path(path))
+      self.root = ctx_path(path)
+    end
+
+    # checks if a directory exists, the filepath is relative to the command root unless absolute
+    #
+    # #### Parameters
+    # * `path` - the file path to a directory, relative to the context root to remove from the FS
+    #
+    def exist?(path)
+      Dir.exist?(ctx_path(path))
+    end
+
+    # will recursively copy a directory from the FS, the filepath is relative to the command
+    # root unless absolute
+    #
+    # #### Parameters
+    # * `from` - the path of the original file
+    # * `to` - the destination path
+    #
+    def cp_r(from, to)
+      FileUtils.cp_r(ctx_path(from), ctx_path(to))
+    end
+
+    # will copy a directory from the FS, the filepath is relative to the command
+    # root unless absolute
+    #
+    # #### Parameters
+    # * `from` - the path of the original file
+    # * `to` - the destination path
+    #
+    def cp(from, to)
+      FileUtils.cp(ctx_path(from), ctx_path(to))
+    end
+
     # will rename a file from one place to another, relative to the command root
     # unless the path is absolute.
     #
@@ -162,6 +203,16 @@ module ShopifyCli
       FileUtils.rm_r(ctx_path(fname))
     end
 
+    # will force remove a directory from the FS, the filepath is relative to the command
+    # root unless absolute
+    #
+    # #### Parameters
+    # * `fname` - the file path to a directory, relative to the context root to remove from the FS
+    #
+    def rm_rf(fname)
+      FileUtils.rm_rf(ctx_path(fname))
+    end
+
     # will create a directory, recursively if it does not exist. So if you create
     # a directory `foo/bar/dun`, this will also create the directories `foo` and
     # `foo/bar` if they do not exist. The path will be made relative to the command

data/lib/shopify-cli/core/entry_point.rb

@@ -11,6 +11,12 @@ module ShopifyCli
             IO.open(9) { is_shell_shim = true }
           rescue Errno::EBADF
             # This is expected if the descriptor doesn't exist
+          rescue ArgumentError => e
+            # This can happen on RVM, because it can use fd 9 itself and block access to it. That only happens if the fd
+            # did not exist beforehand, so that means there was no fd 9 before Ruby started.
+            unless e.message == 'The given fd is not accessible because RubyVM reserves it'
+              raise e
+            end
           end
 
           if !ctx.testing? && is_shell_shim

data/lib/shopify-cli/core/finalize.rb

@@ -0,0 +1,13 @@
+module ShopifyCli
+  module Core
+    # This class is just a dummy to make sure that we don't trigger warnings on the first time the updated code runs.
+    # The old code would try to call the Finalizer after it is done updating, which would then trigger an autoload of
+    # this class and fail.
+    module Finalize
+      class << self
+        def deliver!
+        end
+      end
+    end
+  end
+end

data/lib/shopify-cli/git.rb

@@ -46,10 +46,10 @@ module ShopifyCli
         if Dir.exist?(dest)
           ctx.abort(ctx.message('core.git.error.directory_exists'))
         else
-          CLI::UI::Frame.open(ctx.message('core.git.cloning', dest)) do
+          success_message = ctx.message('core.git.cloned', dest)
+          CLI::UI::Frame.open(ctx.message('core.git.cloning', repository, dest), success_text: success_message) do
             clone_progress('clone', '--single-branch', repository, dest, ctx: ctx)
           end
-          ctx.done(ctx.message('core.git.cloned', dest))
         end
       end
 
@@ -121,19 +121,23 @@ module ShopifyCli
       def clone_progress(*git_command, ctx:)
         CLI::UI::Progress.progress do |bar|
           msg = []
-          success = ctx.system('git', *git_command, '--progress') do |_out, err|
-            if err.strip.start_with?('Receiving objects:')
-              percent = (err.match(/Receiving objects:\s+(\d+)/)[1].to_f / 100).round(2)
+          require 'open3'
+
+          success = Open3.popen3('git', *git_command, '--progress') do |_stdin, _stdout, stderr, thread|
+            while (line = stderr.gets)
+              next unless line.strip.start_with?('Receiving objects:')
+              percent = (line.match(/Receiving objects:\s+(\d+)/)[1].to_f / 100).round(2)
               bar.tick(set_percent: percent)
               next
             end
-            msg << err
+
+            msg << stderr
+            thread.value
           end.success?
-          unless success
-            ctx.abort(msg.join("\n"))
-          end
+
+          ctx.abort(msg.join("\n")) unless success
           bar.tick(set_percent: 1.0)
-          true
+          success
         end
       end
     end

data/lib/shopify-cli/messages/messages.rb

@@ -60,8 +60,8 @@ module ShopifyCli
             no_commits_made: "No git commits have been made. Please make at least one commit.",
           },
 
-          cloning: "Cloning into %s...",
-          cloned: "Cloned into %s",
+          cloning: "Cloning %s into %s...",
+          cloned: "{{v}} Cloned into %s",
         },
 
         help: {
@@ -154,6 +154,12 @@ module ShopifyCli
           },
         },
 
+        api: {
+          error: {
+            internal_server_error: '{{red:{{x}} An unexpected error occurred on Shopify.}}',
+          },
+        },
+
         populate: {
           options: {
             header: "{{bold:{{cyan:%s}} options:}}",
@@ -245,6 +251,20 @@ module ShopifyCli
               "{{x}} error: For authentication issues, run {{command:%s logout}} to clear invalid credentials",
             update_prompt: "Do you want to update your application url?",
           },
+          select_org_and_shop: {
+            authentication_issue: "For authentication issues, run {{command:%s logout}} to clear invalid credentials",
+            create_store: "Visit {{underline:https://partners.shopify.com/%s/stores}} to create one",
+            development_store: "Using development store {{green:%s}}",
+            development_store_select: "Select a development store",
+            error: {
+              no_development_stores: "{{x}} No Development Stores available.",
+              no_organizations: "No partner organizations available.",
+              organization_not_found: "Cannot find a partner organization with that ID",
+              partners_notice: "Please visit https://partners.shopify.com/ to create a partners account",
+            },
+            organization: "Partner organization {{green:%s (%s)}}",
+            organization_select: "Select partner organization",
+          },
         },
 
         tunnel: {

data/lib/shopify-cli/packager.rb

@@ -7,22 +7,8 @@ module ShopifyCli
       FileUtils.mkdir_p(BUILDS_DIR)
     end
 
-    def build_gem
-      build_path = gem_path
-      puts "\nBuilding gem"
-
-      puts "Outputting gem to:\n  #{build_path}\n\n"
-      raise "Failed to build gem" unless system(
-        'gem',
-        'build',
-        '-o',
-        build_path,
-        File.join(ShopifyCli::ROOT, 'shopify-cli.gemspec')
-      )
-    end
-
     def build_debian
-      ensure_program_installed('dpkg-deb')
+      ensure_program_installed('dpkg-deb', 'brew install dpkg')
 
       root_dir = File.join(PACKAGING_DIR, 'debian')
       debian_dir = File.join(root_dir, 'shopify-cli', 'DEBIAN')
@@ -54,7 +40,7 @@ module ShopifyCli
     end
 
     def build_rpm
-      ensure_program_installed('rpmbuild')
+      ensure_program_installed('rpmbuild', 'brew install rpm')
 
       root_dir = File.join(PACKAGING_DIR, 'rpm')
       rpm_build_dir = File.join(root_dir, 'build')
@@ -92,10 +78,14 @@ module ShopifyCli
       spec_contents = File.read(File.join(root_dir, 'shopify-cli.base.rb'))
       spec_contents = spec_contents.gsub('SHOPIFY_CLI_VERSION', ShopifyCli::VERSION)
 
-      checksum = %x`shasum -a 256 #{gem_path}`
-      gem_checksum = checksum.split(' ')[0]
+      puts "Grabbing sha256 checksum from Rubygems.org"
+      require 'digest/sha2'
+      require 'open-uri'
+      gem_checksum = open("https://rubygems.org/downloads/shopify-cli-#{ShopifyCli::VERSION}.gem") do |io|
+        Digest::SHA256.new.hexdigest(io.read)
+      end
 
-      puts "Got sha256 sum for gem: #{gem_checksum}"
+      puts "Got sha256 checksum for gem: #{gem_checksum}"
       spec_contents = spec_contents.gsub('SHOPIFY_CLI_GEM_CHECKSUM', gem_checksum)
 
       puts "Writing generated formula\n  To: #{build_path}\n\n"
@@ -104,13 +94,15 @@ module ShopifyCli
 
     private
 
-    def ensure_program_installed(program)
-      raise "Could not find program #{program} which is required to build the package" unless
-        system(program, '--version', out: File::NULL, err: File::NULL)
-    end
+    def ensure_program_installed(program, installation_cmd)
+      unless system(program, '--version', out: File::NULL, err: File::NULL)
+        raise <<~MESSAGE
+
+          Could not find program #{program} which is required to build the package.
+          You can install it by running `#{installation_cmd}`.
 
-    def gem_path
-      File.join(BUILDS_DIR, "shopify-cli.gem")
+        MESSAGE
+      end
     end
   end
 end

data/lib/shopify-cli/tasks.rb

@@ -27,6 +27,7 @@ module ShopifyCli
     register :EnsureEnv, :ensure_env, 'shopify-cli/tasks/ensure_env'
     register :EnsureLoopbackURL, :ensure_loopback_url, 'shopify-cli/tasks/ensure_loopback_url'
     register :EnsureDevStore, :ensure_dev_store, 'shopify-cli/tasks/ensure_dev_store'
+    register :SelectOrgAndShop, :select_org_and_shop, 'shopify-cli/tasks/select_org_and_shop'
     register :UpdateDashboardURLS, :update_dashboard_urls, 'shopify-cli/tasks/update_dashboard_urls'
   end
 end

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

@@ -0,0 +1,77 @@
+require 'shopify_cli'
+
+module ShopifyCli
+  module Tasks
+    class SelectOrgAndShop < ShopifyCli::Task
+      attr_reader :ctx
+
+      def call(ctx, organization_id: nil, shop_domain: nil)
+        @ctx = ctx
+        return response(organization_id.to_i, shop_domain) unless organization_id.nil? || shop_domain.nil?
+        org = get_organization(organization_id)
+        shop_domain ||= get_shop_domain(org)
+        response(org["id"].to_i, shop_domain)
+      end
+
+      private
+
+      def response(organization_id, shop_domain)
+        {
+          organization_id: organization_id,
+          shop_domain: shop_domain,
+        }
+      end
+
+      def organizations
+        @organizations ||= ShopifyCli::PartnersAPI::Organizations.fetch_all(ctx)
+      end
+
+      def get_organization(organization_id)
+        @organization ||= if !organization_id.nil?
+          org = ShopifyCli::PartnersAPI::Organizations.fetch(ctx, id: organization_id)
+          if org.nil?
+            ctx.puts(ctx.message('core.tasks.select_org_and_shop.error.authentication_issue', ShopifyCli::TOOL_NAME))
+            ctx.abort(ctx.message('core.tasks.select_org_and_shop.error.organization_not_found'))
+          end
+          org
+        elsif organizations.count == 0
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.error.partners_notice'))
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.authentication_issue', ShopifyCli::TOOL_NAME))
+          ctx.abort(ctx.message('core.tasks.select_org_and_shop.error.no_organizations'))
+        elsif organizations.count == 1
+          org = organizations.first
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.organization', org['businessName'], org['id']))
+          org
+        else
+          org_id = CLI::UI::Prompt.ask(ctx.message('core.tasks.select_org_and_shop.organization_select')) do |handler|
+            organizations.each do |o|
+              handler.option(ctx.message('core.partners_api.org_name_and_id', o['businessName'], o['id'])) { o['id'] }
+            end
+          end
+          organizations.find { |o| o['id'] == org_id }
+        end
+      end
+
+      def get_shop_domain(organization)
+        valid_stores = organization['stores'].select do |store|
+          store['transferDisabled'] == true || store['convertableToPartnerTest'] == true
+        end
+
+        if valid_stores.count == 0
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.error.no_development_stores'))
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.create_store', organization['id']))
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.authentication_issue', ShopifyCli::TOOL_NAME))
+        elsif valid_stores.count == 1
+          domain = valid_stores.first['shopDomain']
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.development_store', domain))
+          domain
+        else
+          CLI::UI::Prompt.ask(
+            ctx.message('core.tasks.select_org_and_shop.development_store_select'),
+            options: valid_stores.map { |s| s['shopDomain'] }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/shopify-cli/tunnel.rb

@@ -11,7 +11,7 @@ module ShopifyCli
   class Tunnel
     extend SingleForwardable
 
-    def_delegators :new, :start, :stop, :auth
+    def_delegators :new, :start, :stop, :auth, :stats, :urls
 
     class FetchUrlError < RuntimeError; end
     class NgrokError < RuntimeError; end
@@ -23,6 +23,10 @@ module ShopifyCli
       linux: 'https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip',
     }
 
+    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
     # operation was successful or not
@@ -82,6 +86,34 @@ module ShopifyCli
       ctx.system(File.join(ShopifyCli::CACHE_DIR, 'ngrok'), 'authtoken', token)
     end
 
+    ##
+    # will return the statistics of the current running tunnels
+    #
+    # #### Returns
+    #
+    # * `stats` - the hash of running statistics returning from the ngrok api
+    #
+    def stats
+      response = Net::HTTP.get_response(NGROK_TUNNELS_URI)
+      JSON.parse(response.body)
+    rescue
+      {}
+    end
+
+    ##
+    # will return the urls of the current running tunnels
+    #
+    # #### Returns
+    #
+    # * `stats` - the array of urls
+    #
+    def urls
+      tunnels = stats.dig(TUNNELS_FIELD)
+      tunnels.map { |tunnel| tunnel.dig(PUBLIC_URL_FIELD) }
+    rescue
+      []
+    end
+
     private
 
     def install(ctx)