shopify-cli 1.3.1 → 1.7.0

data/lib/shopify-cli/oauth.rb

@@ -1,18 +1,18 @@
-require 'base64'
-require 'digest'
-require 'json'
-require 'net/http'
-require 'securerandom'
-require 'openssl'
-require 'shopify_cli'
-require 'uri'
-require 'webrick'
+require "base64"
+require "digest"
+require "json"
+require "net/http"
+require "securerandom"
+require "openssl"
+require "shopify_cli"
+require "uri"
+require "webrick"
 
 module ShopifyCli
   class OAuth
     include SmartProperties
 
-    autoload :Servlet, 'shopify-cli/oauth/servlet'
+    autoload :Servlet, "shopify-cli/oauth/servlet"
 
     class Error < StandardError; end
     LocalRequest = Struct.new(:method, :path, :query, :protocol)
@@ -54,10 +54,10 @@ module ShopifyCli
       @server ||= begin
         server = WEBrick::HTTPServer.new(
           Port: DEFAULT_PORT,
-          Logger: WEBrick::Log.new(File.open(File::NULL, 'w')),
+          Logger: WEBrick::Log.new(File.open(File::NULL, "w")),
           AccessLog: [],
         )
-        server.mount('/', Servlet, self, state_token)
+        server.mount("/", Servlet, self, state_token)
         server
       end
     end
@@ -80,17 +80,17 @@ module ShopifyCli
     end
 
     def output_authentication_info(uri)
-      login_location = ctx.message(service == 'admin' ? 'core.oauth.location.admin' : 'core.oauth.location.partner')
-      ctx.puts(ctx.message('core.oauth.authentication_required', login_location))
+      login_location = ctx.message(service == "admin" ? "core.oauth.location.admin" : "core.oauth.location.partner")
+      ctx.puts(ctx.message("core.oauth.authentication_required", login_location))
       ctx.open_url!(uri)
     end
 
     def receive_access_code
       @access_code ||= begin
         @server_thread.join(240)
-        raise Error, ctx.message('core.oauth.error.timeout') if response_query.nil?
-        raise Error, response_query['error_description'] unless response_query['error'].nil?
-        response_query['code']
+        raise Error, ctx.message("core.oauth.error.timeout") if response_query.nil?
+        raise Error, response_query["error_description"] unless response_query["error"].nil?
+        response_query["code"]
       end
     end
 
@@ -105,8 +105,8 @@ module ShopifyCli
         }.merge(confirmation_param)
       )
       store.set(
-        "#{service}_access_token".to_sym => resp['access_token'],
-        "#{service}_refresh_token".to_sym => resp['refresh_token'],
+        "#{service}_access_token".to_sym => resp["access_token"],
+        "#{service}_refresh_token".to_sym => resp["refresh_token"],
       )
     end
 
@@ -130,8 +130,8 @@ module ShopifyCli
         client_id: client_id,
       )
       store.set(
-        "#{service}_access_token".to_sym => resp['access_token'],
-        "#{service}_refresh_token".to_sym => resp['refresh_token'],
+        "#{service}_access_token".to_sym => resp["access_token"],
+        "#{service}_refresh_token".to_sym => resp["refresh_token"],
       )
     end
 
@@ -155,7 +155,7 @@ module ShopifyCli
         scope: scopes,
         subject_token: store.get("#{service}_access_token".to_sym),
       )
-      store.set("#{service}_exchange_token".to_sym => resp['access_token'])
+      store.set("#{service}_exchange_token".to_sym => resp["access_token"])
     end
 
     def post_token_request(url, params)
@@ -163,17 +163,17 @@ module ShopifyCli
       https = Net::HTTP.new(uri.host, uri.port)
       https.use_ssl = true
       request = Net::HTTP::Post.new(uri.path)
-      request['User-Agent'] = "Shopify App CLI #{::ShopifyCli::VERSION}"
+      request["User-Agent"] = "Shopify App CLI #{::ShopifyCli::VERSION}"
       request.body = URI.encode_www_form(params)
       res = https.request(request)
-      raise Error, JSON.parse(res.body)['error_description'] unless res.is_a?(Net::HTTPSuccess)
+      raise Error, JSON.parse(res.body)["error_description"] unless res.is_a?(Net::HTTPSuccess)
       JSON.parse(res.body)
     end
 
     def challange_params
       {
         code_challenge: code_challenge,
-        code_challenge_method: 'S256',
+        code_challenge_method: "S256",
       }
     end
 

data/lib/shopify-cli/oauth/servlet.rb

@@ -26,18 +26,18 @@ module ShopifyCli
       end
 
       def do_GET(req, res) # rubocop:disable Naming/MethodName
-        if !req.query['error'].nil?
+        if !req.query["error"].nil?
           respond_with(
             res,
             400,
-            Context.message('core.oauth.servlet.invalid_request_response', req.query['error_description'])
+            Context.message("core.oauth.servlet.invalid_request_response", req.query["error_description"])
           )
-        elsif req.query['state'] != @state_token
-          response_message = Context.message('core.oauth.servlet.invalid_state_response')
-          req.query.merge!('error' => 'invalid_state', 'error_description' => response_message)
+        elsif req.query["state"] != @state_token
+          response_message = Context.message("core.oauth.servlet.invalid_state_response")
+          req.query.merge!("error" => "invalid_state", "error_description" => response_message)
           respond_with(res, 403, response_message)
         else
-          respond_with(res, 200, Context.message('core.oauth.servlet.success_response'))
+          respond_with(res, 200, Context.message("core.oauth.servlet.success_response"))
         end
         @oauth.response_query = req.query
         @server.shutdown
@@ -48,10 +48,10 @@ module ShopifyCli
         locals = {
           status: status,
           message: message,
-          color: successful ? 'black' : 'red',
+          color: successful ? "black" : "red",
           title:
-            Context.message(successful ? 'core.oauth.servlet.authenticated' : 'core.oauth.servlet.not_authenticated'),
-          autoclose: successful ? AUTOCLOSE_TEMPLATE : '',
+            Context.message(successful ? "core.oauth.servlet.authenticated" : "core.oauth.servlet.not_authenticated"),
+          autoclose: successful ? AUTOCLOSE_TEMPLATE : "",
         }
         response.status = status
         response.body = format(TEMPLATE, locals)

data/lib/shopify-cli/options.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'shopify_cli'
-require 'optparse'
+require "shopify_cli"
+require "optparse"
 
 module ShopifyCli
   class Options
@@ -31,7 +31,7 @@ module ShopifyCli
     def parser
       @parser ||= begin
         opt = OptionParser.new
-        opt.on('--help', '-h', Context.message('core.options.help_text')) do |v|
+        opt.on("--help", "-h", Context.message("core.options.help_text")) do |v|
           @help = v
         end
       end

data/lib/shopify-cli/packager.rb

@@ -1,17 +1,17 @@
 module ShopifyCli
   class Packager
-    PACKAGING_DIR = File.join(ShopifyCli::ROOT, 'packaging')
-    BUILDS_DIR = File.join(PACKAGING_DIR, 'builds', ShopifyCli::VERSION)
+    PACKAGING_DIR = File.join(ShopifyCli::ROOT, "packaging")
+    BUILDS_DIR = File.join(PACKAGING_DIR, "builds", ShopifyCli::VERSION)
 
     def initialize
       FileUtils.mkdir_p(BUILDS_DIR)
     end
 
     def build_debian
-      ensure_program_installed('dpkg-deb', 'brew install dpkg')
+      ensure_program_installed("dpkg-deb", "brew install dpkg")
 
-      root_dir = File.join(PACKAGING_DIR, 'debian')
-      debian_dir = File.join(root_dir, 'shopify-cli', 'DEBIAN')
+      root_dir = File.join(PACKAGING_DIR, "debian")
+      debian_dir = File.join(root_dir, "shopify-cli", "DEBIAN")
       FileUtils.mkdir_p(debian_dir)
 
       puts "\nBuilding Debian package"
@@ -24,15 +24,15 @@ module ShopifyCli
         file_path = File.join(debian_dir, file)
 
         file_contents = File.read(File.join(root_dir, "#{file}.base"))
-        file_contents = file_contents.gsub('SHOPIFY_CLI_VERSION', ShopifyCli::VERSION)
-        File.open(file_path, 'w', 0775) { |f| f.write(file_contents) }
+        file_contents = file_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCli::VERSION)
+        File.open(file_path, "w", 0775) { |f| f.write(file_contents) }
       end
 
       puts "Building package..."
       Dir.chdir(root_dir)
-      raise "Failed to build package" unless system('dpkg-deb', '-b', 'shopify-cli')
+      raise "Failed to build package" unless system("dpkg-deb", "-b", "shopify-cli")
 
-      output_path = File.join(root_dir, 'shopify-cli.deb')
+      output_path = File.join(root_dir, "shopify-cli.deb")
       final_path = File.join(BUILDS_DIR, "shopify-cli-#{ShopifyCli::VERSION}.deb")
 
       puts "Moving generated package: \n  From: #{output_path}\n  To: #{final_path}\n\n"
@@ -40,34 +40,34 @@ module ShopifyCli
     end
 
     def build_rpm
-      ensure_program_installed('rpmbuild', 'brew install rpm')
+      ensure_program_installed("rpmbuild", "brew install rpm")
 
-      root_dir = File.join(PACKAGING_DIR, 'rpm')
-      rpm_build_dir = File.join(root_dir, 'build')
+      root_dir = File.join(PACKAGING_DIR, "rpm")
+      rpm_build_dir = File.join(root_dir, "build")
       FileUtils.mkdir_p(rpm_build_dir)
 
-      spec_path = File.join(root_dir, 'shopify-cli.spec')
+      spec_path = File.join(root_dir, "shopify-cli.spec")
       puts "\nBuilding RPM package"
 
       puts "Generating spec file..."
       File.delete(spec_path) if File.exist?(spec_path)
 
-      spec_contents = File.read(File.join(root_dir, 'shopify-cli.spec.base'))
-      spec_contents = spec_contents.gsub('SHOPIFY_CLI_VERSION', ShopifyCli::VERSION)
+      spec_contents = File.read(File.join(root_dir, "shopify-cli.spec.base"))
+      spec_contents = spec_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCli::VERSION)
       File.write(spec_path, spec_contents)
 
       puts "Building package..."
       Dir.chdir(root_dir)
-      system('rpmbuild', '-bb', File.basename(spec_path))
+      system("rpmbuild", "-bb", File.basename(spec_path))
 
-      output_dir = File.join(root_dir, 'build', 'noarch')
+      output_dir = File.join(root_dir, "build", "noarch")
 
       puts "Moving generated packages: \n  From: #{output_dir}\n  To: #{BUILDS_DIR}\n\n"
       FileUtils.mv(Dir.glob("#{output_dir}/*.rpm"), BUILDS_DIR)
     end
 
     def build_homebrew
-      root_dir = File.join(PACKAGING_DIR, 'homebrew')
+      root_dir = File.join(PACKAGING_DIR, "homebrew")
 
       build_path = File.join(BUILDS_DIR, "shopify-cli.rb")
       puts "\nBuilding Homebrew package"
@@ -75,18 +75,18 @@ module ShopifyCli
       puts "Generating formula..."
       File.delete(build_path) if File.exist?(build_path)
 
-      spec_contents = File.read(File.join(root_dir, 'shopify-cli.base.rb'))
-      spec_contents = spec_contents.gsub('SHOPIFY_CLI_VERSION', ShopifyCli::VERSION)
+      spec_contents = File.read(File.join(root_dir, "shopify-cli.base.rb"))
+      spec_contents = spec_contents.gsub("SHOPIFY_CLI_VERSION", ShopifyCli::VERSION)
 
       puts "Grabbing sha256 checksum from Rubygems.org"
-      require 'digest/sha2'
-      require 'open-uri'
+      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 checksum for gem: #{gem_checksum}"
-      spec_contents = spec_contents.gsub('SHOPIFY_CLI_GEM_CHECKSUM', gem_checksum)
+      spec_contents = spec_contents.gsub("SHOPIFY_CLI_GEM_CHECKSUM", gem_checksum)
 
       puts "Writing generated formula\n  To: #{build_path}\n\n"
       File.write(build_path, spec_contents)
@@ -95,7 +95,7 @@ module ShopifyCli
     private
 
     def ensure_program_installed(program, installation_cmd)
-      unless system(program, '--version', out: File::NULL, err: File::NULL)
+      unless system(program, "--version", out: File::NULL, err: File::NULL)
         raise <<~MESSAGE
 
           Could not find program #{program} which is required to build the package.

data/lib/shopify-cli/partners_api.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   ##
@@ -6,17 +6,17 @@ module ShopifyCli
   # schema.
   #
   class PartnersAPI < API
-    autoload :Organizations, 'shopify-cli/partners_api/organizations'
+    autoload :Organizations, "shopify-cli/partners_api/organizations"
 
     # Defines the environment variable that this API looks for to operate on local
     # services. If you set this environment variable in your shell then the partners
-    # api will operation on your local instance
+    # API will operate on your local instance
     #
     # #### Example
     #
     #  SHOPIFY_APP_CLI_LOCAL_PARTNERS=1 shopify create
     #
-    LOCAL_DEBUG = 'SHOPIFY_APP_CLI_LOCAL_PARTNERS'
+    LOCAL_DEBUG = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
 
     class << self
       ##
@@ -27,7 +27,7 @@ module ShopifyCli
       # #### Parameters
       # - `ctx`: running context from your command
       # - `query_name`: name of the query you want to use, loaded from the `lib/graphql` directory.
-      # - `**variable`: a hash of variables to be supplied to the query ro mutation
+      # - `**variables`: a hash of variables to be supplied to the query or mutation
       #
       # #### Raises
       #
@@ -50,6 +50,13 @@ module ShopifyCli
         end
       end
 
+      def partners_url_for(organization_id, api_client_id, local_debug)
+        if ShopifyCli::Shopifolk.acting_as_shopify_organization?
+          organization_id = "internal"
+        end
+        "#{partners_endpoint(local_debug)}/#{organization_id}/apps/#{api_client_id}"
+      end
+
       private
 
       def authenticated_req(ctx)
@@ -58,7 +65,7 @@ module ShopifyCli
         authenticate(ctx)
         retry
       rescue API::APIRequestNotFoundError
-        ctx.puts(ctx.message('core.partners_api.error.account_not_found', ShopifyCli::TOOL_NAME))
+        ctx.puts(ctx.message("core.partners_api.error.account_not_found", ShopifyCli::TOOL_NAME))
       end
 
       def api_client(ctx)
@@ -79,31 +86,46 @@ module ShopifyCli
       def authenticate(ctx)
         OAuth.new(
           ctx: ctx,
-          service: 'identity',
+          service: "identity",
           client_id: cli_id,
-          scopes: 'openid https://api.shopify.com/auth/partners.app.cli.access',
+          scopes: scopes.join(" "),
           request_exchange: partners_id,
         ).authenticate("#{auth_endpoint}/oauth")
       end
 
       def partners_id
-        return '271e16d403dfa18082ffb3d197bd2b5f4479c3fc32736d69296829cbb28d41a6' if ENV[LOCAL_DEBUG].nil?
-        'df89d73339ac3c6c5f0a98d9ca93260763e384d51d6038da129889c308973978'
+        return "271e16d403dfa18082ffb3d197bd2b5f4479c3fc32736d69296829cbb28d41a6" if ENV[LOCAL_DEBUG].nil?
+        "df89d73339ac3c6c5f0a98d9ca93260763e384d51d6038da129889c308973978"
       end
 
       def cli_id
-        return 'fbdb2649-e327-4907-8f67-908d24cfd7e3' if ENV[LOCAL_DEBUG].nil?
-        'e5380e02-312a-7408-5718-e07017e9cf52'
+        return "fbdb2649-e327-4907-8f67-908d24cfd7e3" if ENV[LOCAL_DEBUG].nil?
+        "e5380e02-312a-7408-5718-e07017e9cf52"
       end
 
       def auth_endpoint
-        return 'https://accounts.shopify.com' if ENV[LOCAL_DEBUG].nil?
-        'https://identity.myshopify.io'
+        return "https://accounts.shopify.com" if ENV[LOCAL_DEBUG].nil?
+        "https://identity.myshopify.io"
       end
 
       def endpoint
-        return 'https://partners.shopify.com' if ENV[LOCAL_DEBUG].nil?
-        'https://partners.myshopify.io/'
+        return "https://partners.shopify.com" if ENV[LOCAL_DEBUG].nil?
+        "https://partners.myshopify.io/"
+      end
+
+      def partners_endpoint(local_debug)
+        domain = if local_debug
+          "partners.myshopify.io"
+        else
+          "partners.shopify.com"
+        end
+        "https://#{domain}"
+      end
+
+      def scopes
+        %w[openid https://api.shopify.com/auth/partners.app.cli.access].tap do |result|
+          result << "employee" if ShopifyCli::Shopifolk.acting_as_shopify_organization?
+        end
       end
     end
 

data/lib/shopify-cli/partners_api/organizations.rb

@@ -3,26 +3,26 @@ module ShopifyCli
     class Organizations
       class << self
         def fetch_all(ctx)
-          resp = PartnersAPI.query(ctx, 'all_organizations')
-          (resp.dig('data', 'organizations', 'nodes') || []).map do |org|
-            org['stores'] = (org.dig('stores', 'nodes') || [])
+          resp = PartnersAPI.query(ctx, "all_organizations")
+          (resp.dig("data", "organizations", "nodes") || []).map do |org|
+            org["stores"] = (org.dig("stores", "nodes") || [])
             org
           end
         end
 
         def fetch(ctx, id:)
-          resp = PartnersAPI.query(ctx, 'find_organization', id: id)
-          org = resp.dig('data', 'organizations', 'nodes').first
+          resp = PartnersAPI.query(ctx, "find_organization", id: id)
+          org = resp.dig("data", "organizations", "nodes").first
           return nil if org.nil?
-          org['stores'] = (org.dig('stores', 'nodes') || [])
+          org["stores"] = (org.dig("stores", "nodes") || [])
           org
         end
 
         def fetch_with_app(ctx)
-          resp = PartnersAPI.query(ctx, 'all_orgs_with_apps')
-          (resp.dig('data', 'organizations', 'nodes') || []).map do |org|
-            org['stores'] = (org.dig('stores', 'nodes') || [])
-            org['apps'] = (org.dig('apps', 'nodes') || [])
+          resp = PartnersAPI.query(ctx, "all_orgs_with_apps")
+          (resp.dig("data", "organizations", "nodes") || []).map do |org|
+            org["stores"] = (org.dig("stores", "nodes") || [])
+            org["apps"] = (org.dig("apps", "nodes") || [])
             org
           end
         end

data/lib/shopify-cli/process_supervision.rb

@@ -1,4 +1,4 @@
-require 'fileutils'
+require "fileutils"
 
 module ShopifyCli
   ##
@@ -19,7 +19,7 @@ module ShopifyCli
     class << self
       def run_dir
         # is the directory where the pid and logfile are kept
-        File.join(ShopifyCli.cache_dir, 'sv')
+        File.join(ShopifyCli.cache_dir, "sv")
       end
 
       ##
@@ -36,7 +36,7 @@ module ShopifyCli
       #   will be nil if the process is not running.
       #
       def for_ident(identifier)
-        pid, time = File.read(File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.pid")).split(':')
+        pid, time = File.read(File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.pid")).split(":")
         new(identifier, pid: Integer(pid), time: time)
       rescue Errno::ENOENT
         nil
@@ -66,7 +66,7 @@ module ShopifyCli
           pid_file = new(identifier)
 
           # Make sure the file exists and is empty, otherwise Windows fails
-          File.open(pid_file.log_path, 'w') {}
+          File.open(pid_file.log_path, "w") {}
           pid = Process.spawn(
             *args,
             out: pid_file.log_path,
@@ -128,7 +128,7 @@ module ShopifyCli
       end
     end
 
-    def initialize(identifier, pid: nil, time: Time.now.strftime('%s')) # :nodoc:
+    def initialize(identifier, pid: nil, time: Time.now.strftime("%s")) # :nodoc:
       @identifier = identifier
       @pid = pid
       @time = time
@@ -204,13 +204,13 @@ module ShopifyCli
 
       # Windows does not handle SIGTERM, go straight to SIGKILL
       unless ctx.windows?
-        Process.kill('TERM', id)
+        Process.kill("TERM", id)
         50.times do
-          sleep 0.1
+          sleep(0.1)
           break unless stat(id)
         end
       end
-      Process.kill('KILL', id) if stat(id)
+      Process.kill("KILL", id) if stat(id)
       sleep(0.1) if ctx.windows? # Give Windows a second to actually close the process
     end