shopify-cli 1.3.1 → 1.7.0

data/lib/project_types/theme/themekit.rb

@@ -0,0 +1,113 @@
+module Theme
+  class Themekit
+    THEMEKIT = File.join(ShopifyCli.cache_dir, "themekit")
+
+    class << self
+      def add_flags(flags)
+        flags.map do |key, value|
+          flag = "--#{key}"
+          flag += "=#{value}" if value.is_a?(String)
+          flag
+        end
+      end
+
+      def connect(ctx, store:, password:, themeid:, env:)
+        command = build_command("get", env)
+        command << "--password=#{password}"
+        command << "--store=#{store}"
+        command << "--themeid=#{themeid}"
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def create(ctx, password:, store:, name:, env:)
+        command = build_command("new", env)
+        command << "--password=#{password}"
+        command << "--store=#{store}"
+        command << "--name=#{name}"
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def deploy(ctx, flags: nil, env:)
+        unless push(ctx, flags: flags, env: env)
+          ctx.abort(ctx.message("theme.deploy.push_fail"))
+        end
+        ctx.done(ctx.message("theme.deploy.info.pushed"))
+
+        command = build_command("publish", env)
+        (command << flags).compact!
+        command.flatten!
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def generate_env(ctx, store:, password:, themeid:, env:)
+        command = build_command("configure", env)
+        command << "--password=#{password}"
+        command << "--store=#{store}"
+        command << "--themeid=#{themeid}"
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def push(ctx, files: nil, flags: nil, remove: false, env:)
+        action = remove ? "remove" : "deploy"
+        command = build_command(action, env)
+
+        (command << files << flags).compact!
+        command.flatten!
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def query_themes(ctx, store:, password:)
+        begin
+          resp = ::ShopifyCli::AdminAPI.rest_request(
+            ctx,
+            shop: store,
+            token: password,
+            path: "themes.json",
+          )
+        rescue ShopifyCli::API::APIRequestUnauthorizedError
+          ctx.abort(ctx.message("theme.themekit.query_themes.bad_password"))
+        rescue StandardError
+          ctx.abort(ctx.message("theme.themekit.query_themes.not_connect"))
+        end
+
+        resp[1]["themes"].map { |theme| [theme["name"], theme["id"]] }.to_h
+      end
+
+      def serve(ctx, flags: nil, env:)
+        command = build_command("open", env)
+        out, stat = ctx.capture2e(*command)
+        ctx.puts(out)
+        ctx.abort(ctx.message("theme.serve.open_fail")) unless stat.success?
+
+        command = build_command("watch", env)
+        (command << flags).compact!
+        command.flatten!
+        ctx.system(*command)
+      end
+
+      def update(ctx)
+        command = build_command("update")
+        ctx.system(*command)
+      end
+
+      private
+
+      def build_command(action, env = nil)
+        command = [THEMEKIT, action]
+        command << "--no-update-notifier"
+        command << "--env=#{env}" if env
+        command
+      end
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -1,5 +1,5 @@
 Gem.post_uninstall do |uninstaller|
-  if uninstaller.spec.name == 'shopify-cli'
+  if uninstaller.spec.name == "shopify-cli"
     if RUBY_PLATFORM.match(/mingw32/)
       bat_path = File.dirname(RbConfig.ruby)
       bat = "#{bat_path}\\shopify.bat"
@@ -7,9 +7,9 @@ Gem.post_uninstall do |uninstaller|
       # delete the auto-generated batch script
       File.unlink(bat)
     else
-      require 'fileutils'
+      require "fileutils"
 
-      symlink = '/usr/local/bin/shopify'
+      symlink = "/usr/local/bin/shopify"
 
       # delete the symbolic link IFF it exists AND it does not point to a file
       # (i.e., it's been left hanging as a result of the uninstall, as expected)

data/lib/shopify-cli/admin_api.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   ##
@@ -6,8 +6,8 @@ module ShopifyCli
   # these concerns are taken care of.
   #
   class AdminAPI < API
-    autoload :PopulateResourceCommand, 'shopify-cli/admin_api/populate_resource_command'
-    autoload :Schema, 'shopify-cli/admin_api/schema'
+    autoload :PopulateResourceCommand, "shopify-cli/admin_api/populate_resource_command"
+    autoload :Schema, "shopify-cli/admin_api/schema"
 
     class << self
       ##
@@ -43,6 +43,46 @@ module ShopifyCli
         end
       end
 
+      ##
+      #
+      #
+      #
+      # #### Parameters
+      # - `ctx`: running context from your command
+      # - `shop`: shop domain string for shop whose admin you are calling
+      # - `path`: path string (excluding prefixes and API version) for specific JSON that you are requesting
+      #     ex. "data.json" instead of "/admin/api/unstable/data.json"
+      # - `body`: data string for corresponding REST request types
+      # - `method`: REST request string for the type of request; if nil, will perform GET request
+      # - `api_version`: API version string to specify version; if nil, latest will be used
+      # - `token`: shop password string for authentication to shop
+      #
+      # #### Raises
+      #
+      # * http 404 will raise a ShopifyCli::API::APIRequestNotFoundError
+      # * http 400..499 will raise a ShopifyCli::API::APIRequestClientError
+      # * http 500..599 will raise a ShopifyCli::API::APIRequestServerError
+      # * All other codes will raise ShopifyCli::API::APIRequestUnexpectedError
+      #
+      # #### Returns
+      #
+      # * `resp` - JSON response array
+      #
+      # #### Example
+      #
+      #   ShopifyCli::AdminAPI.rest_request(@ctx,
+      #                                     shop: 'shop.myshopify.com',
+      #                                     path: 'data.json',
+      #                                     token: 'password')
+      #
+      def rest_request(ctx, shop:, path:, body: nil, method: "GET", api_version: nil, token: nil)
+        ShopifyCli::DB.set(admin_access_token: token) unless token.nil?
+        url = URI::HTTPS.build(host: shop, path: "/admin/api/#{fetch_api_version(ctx, api_version, shop)}/#{path}")
+        resp = api_client(ctx, api_version, shop, path: path).request(url: url.to_s, body: body, method: method)
+        ShopifyCli::DB.set(admin_access_token: nil) unless token.nil?
+        resp
+      end
+
       private
 
       def authenticated_req(ctx, shop)
@@ -56,21 +96,21 @@ module ShopifyCli
         env = Project.current.env
         ShopifyCli::OAuth.new(
           ctx: ctx,
-          service: 'admin',
+          service: "admin",
           client_id: env.api_key,
           secret: env.secret,
           scopes: env.scopes,
           token_path: "/access_token",
-          options: { 'grant_options[]' => 'per user' },
+          options: { "grant_options[]" => "per user" },
         ).authenticate("https://#{shop}/admin/oauth")
       end
 
-      def api_client(ctx, api_version, shop)
+      def api_client(ctx, api_version, shop, path: "graphql.json")
         new(
           ctx: ctx,
-          auth_header: 'X-Shopify-Access-Token',
+          auth_header: "X-Shopify-Access-Token",
           token: admin_access_token(ctx, shop),
-          url: "https://#{shop}/admin/api/#{fetch_api_version(ctx, api_version, shop)}/graphql.json",
+          url: "https://#{shop}/admin/api/#{fetch_api_version(ctx, api_version, shop)}/#{path}",
         )
       end
 
@@ -85,13 +125,13 @@ module ShopifyCli
         return api_version unless api_version.nil?
         client = new(
           ctx: ctx,
-          auth_header: 'X-Shopify-Access-Token',
+          auth_header: "X-Shopify-Access-Token",
           token: admin_access_token(ctx, shop),
           url: "https://#{shop}/admin/api/unstable/graphql.json",
         )
-        versions = client.query('api_versions')['data']['publicApiVersions']
-        latest = versions.find { |version| version['displayName'].include?('Latest') }
-        latest['handle']
+        versions = client.query("api_versions")["data"]["publicApiVersions"]
+        latest = versions.find { |version| version["displayName"].include?("Latest") }
+        latest["handle"]
       end
     end
   end

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

@@ -1,5 +1,5 @@
-require 'shopify_cli'
-require 'optparse'
+require "shopify_cli"
+require "optparse"
 
 module ShopifyCli
   class AdminAPI
@@ -36,7 +36,7 @@ module ShopifyCli
 
         if @help
           output = display_parent_extended_help
-          output += "\n#{@ctx.message('core.populate.options.header', camel_case_resource_type)}\n"
+          output += "\n#{@ctx.message("core.populate.options.header", camel_case_resource_type)}\n"
           output += resource_options.help
           return @ctx.puts(output)
         end
@@ -45,7 +45,7 @@ module ShopifyCli
 
         if @silent
           spin_group = CLI::UI::SpinGroup.new
-          spin_group.add(@ctx.message('core.populate.populating', @count, camel_case_resource_type)) do |spinner|
+          spin_group.add(@ctx.message("core.populate.populating", @count, camel_case_resource_type)) do |spinner|
             populate
             spinner.update_title(completion_message)
           end
@@ -78,18 +78,18 @@ module ShopifyCli
           opts.on(
             "-c #{DEFAULT_COUNT}",
             "--count=#{DEFAULT_COUNT}",
-            @ctx.message('core.populate.options.count_help')
+            @ctx.message("core.populate.options.count_help")
           ) do |value|
             @count = value.to_i
           end
 
-          opts.on('-h', '--help', 'print help') do |value|
+          opts.on("-h", "--help", "print help") do |value|
             @help = value
           end
 
           opts.on("--silent") { |v| @silent = v }
 
-          opts.on('--shop=', '-s') { |value| @shop = value }
+          opts.on("--shop=", "-s") { |value| @shop = value }
         end
       end
 
@@ -100,12 +100,12 @@ module ShopifyCli
       end
 
       def input_options
-        schema.type(self.class.input_type)['inputFields'].each do |field|
+        schema.type(self.class.input_type)["inputFields"].each do |field|
           resource_options.on(
-            "--#{field['name']}=#{field['defaultValue']}",
-            field['description']
+            "--#{field["name"]}=#{field["defaultValue"]}",
+            field["description"]
           ) do |value|
-            @input[field['name']] = value
+            @input[field["name"]] = value
           end
         end
       end
@@ -120,14 +120,14 @@ module ShopifyCli
         resp = AdminAPI.query(
           @ctx, "create_#{snake_case_resource_type}", **kwargs
         )
-        @ctx.abort(resp['errors']) if resp['errors']
-        @ctx.done(message(resp['data'])) unless @silent
+        @ctx.abort(resp["errors"]) if resp["errors"]
+        @ctx.done(message(resp["data"])) unless @silent
       end
 
       def completion_message
         plural = @count > 1 ? "s" : ""
         @ctx.message(
-          'core.populate.completion_message',
+          "core.populate.completion_message",
           @count,
           "#{camel_case_resource_type}#{plural}",
           Project.current.env.shop,
@@ -142,7 +142,7 @@ module ShopifyCli
       end
 
       def price
-        format('%.2f', rand(1..10))
+        format("%.2f", rand(1..10))
       end
 
       private
@@ -155,7 +155,7 @@ module ShopifyCli
       end
 
       def camel_case_resource_type
-        @camel_case_resource_type ||= self.class.to_s.split('::').last
+        @camel_case_resource_type ||= self.class.to_s.split("::").last
       end
 
       def snake_case_resource_type
@@ -167,7 +167,7 @@ module ShopifyCli
       end
 
       def parent_command_klass
-        @parent_command_klass ||= Module.const_get(self.class.to_s.split('::')[0..-2].join('::'))
+        @parent_command_klass ||= Module.const_get(self.class.to_s.split("::")[0..-2].join("::"))
       end
     end
   end

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

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   class AdminAPI
@@ -7,7 +7,7 @@ module ShopifyCli
         def get(ctx)
           unless ShopifyCli::DB.exists?(:shopify_admin_schema)
             shop = Project.current.env.shop || get_shop(ctx)
-            schema = AdminAPI.query(ctx, 'admin_introspection', shop: shop)
+            schema = AdminAPI.query(ctx, "admin_introspection", shop: shop)
             ShopifyCli::DB.set(shopify_admin_schema: JSON.dump(schema))
           end
           # This is ruby magic for making a new hash with another hash.
@@ -30,7 +30,7 @@ module ShopifyCli
         data = self["data"]
         schema = data["__schema"]
         schema["types"].find do |object|
-          object['name'] == name.to_s
+          object["name"] == name.to_s
         end
       end
 

data/lib/shopify-cli/api.rb

@@ -1,5 +1,4 @@
-require 'shopify_cli'
-require 'net/http'
+require "shopify_cli"
 
 module ShopifyCli
   class API
@@ -20,52 +19,36 @@ module ShopifyCli
     class APIRequestThrottledError < APIRequestRetriableError; end
 
     def self.gid_to_id(gid)
-      gid.split('/').last
+      gid.split("/").last
     end
 
     def query(query_name, variables: {})
       _, resp = request(
-        load_query(query_name),
-        variables: variables,
-        headers: default_headers,
-        graphql_url: url,
+        body: JSON.dump(query: load_query(query_name).tr("\n", ""), variables: variables),
+        url: url,
       )
       ctx.debug(resp)
       resp
-    rescue API::APIRequestServerError, API::APIRequestUnexpectedError
-      ctx.puts(ctx.message('core.api.error.internal_server_error'))
+    rescue API::APIRequestServerError, API::APIRequestUnexpectedError => e
+      ctx.puts(ctx.message("core.api.error.internal_server_error"))
+      ctx.debug(ctx.message("core.api.error.internal_server_error_debug", e.message))
     end
 
-    protected
-
-    def load_query(name)
-      project_type = ShopifyCli::Project.current_project_type
-      project_file_path = File.join(
-        ShopifyCli::ROOT, 'lib', 'project_types', project_type.to_s, 'graphql', "#{name}.graphql"
-      )
-      if !project_type.nil? && File.exist?(project_file_path)
-        File.read(project_file_path)
-      else
-        File.read(File.join(ShopifyCli::ROOT, 'lib', 'graphql', "#{name}.graphql"))
-      end
-    end
-
-    private
-
-    def request(body, graphql_url:, variables: {}, headers: {})
+    def request(url:, body: nil, headers: {}, method: "POST")
       CLI::Kit::Util.begin do
-        uri = URI.parse(graphql_url)
+        uri = URI.parse(url)
         unless uri.is_a?(URI::HTTP)
-          ctx.abort("Invalid URL: #{graphql_url}")
+          ctx.abort(ctx.message("core.api.error.invalid_url", url))
         end
-        http = ::Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
 
-        req = ::Net::HTTP::Post.new(uri.request_uri)
-        req.body = JSON.dump(query: body.tr("\n", ""), variables: variables)
-        req['Content-Type'] = 'application/json'
-        headers.each { |header, value| req[header] = value }
-        response = http.request(req)
+        # we delay this require so as to avoid a performance hit on starting the CLI
+        require "shopify-cli/http_request"
+        headers = default_headers.merge(headers)
+        response = if method == "POST"
+          HttpRequest.post(uri, body, headers)
+        elsif method == "GET"
+          HttpRequest.get(uri, body, headers)
+        end
 
         case response.code.to_i
         when 200..399
@@ -88,14 +71,32 @@ module ShopifyCli
       end
     end
 
+    protected
+
+    def load_query(name)
+      project_type = ShopifyCli::Project.current_project_type
+      project_file_path = File.join(
+        ShopifyCli::ROOT, "lib", "project_types", project_type.to_s, "graphql", "#{name}.graphql"
+      )
+      if !project_type.nil? && File.exist?(project_file_path)
+        File.read(project_file_path)
+      else
+        File.read(File.join(ShopifyCli::ROOT, "lib", "graphql", "#{name}.graphql"))
+      end
+    end
+
+    private
+
     def current_sha
       @current_sha ||= Git.sha(dir: ShopifyCli::ROOT)
     end
 
     def default_headers
       {
-        'User-Agent' => "Shopify App CLI #{ShopifyCli::VERSION} #{current_sha} | #{ctx.uname}",
-      }.merge(auth_headers(token))
+        "User-Agent" => "Shopify App CLI #{ShopifyCli::VERSION} #{current_sha} | #{ctx.uname}",
+      }.tap do |headers|
+        headers["X-Shopify-Cli-Employee"] = "1" if Shopifolk.acting_as_shopify_organization?
+      end.merge(auth_headers(token))
     end
 
     def auth_headers(token)