shopify-cli 1.3.0 → 1.6.0

data/lib/project_types/theme/tasks/ensure_themekit_installed.rb

@@ -0,0 +1,78 @@
+module Theme
+  module Tasks
+    class EnsureThemekitInstalled < ShopifyCli::Task
+      URL = 'https://shopify-themekit.s3.amazonaws.com/releases/latest.json'
+      OSMAP = {
+        mac: 'darwin-amd64',
+        linux: 'linux-amd64',
+        windows: 'windows-amd64',
+      }
+      VERSION_CHECK_INTERVAL = 604800
+      VERSION_CHECK_SECTION = 'themekit_version_check'
+      LAST_CHECKED_AT_FIELD = 'last_checked_at'
+
+      def call(ctx)
+        _out, stat = ctx.capture2e(Themekit::THEMEKIT)
+        unless stat.success?
+          CLI::UI::Frame.open(ctx.message('theme.tasks.ensure_themekit_installed.installing_themekit')) do
+            install_themekit(ctx)
+          end
+        end
+
+        now = Time.now.to_i
+        if ShopifyCli::Feature.enabled?(:themekit_auto_update) && (time_of_last_check + VERSION_CHECK_INTERVAL) < now
+          CLI::UI::Frame.open(ctx.message('theme.tasks.ensure_themekit_installed.updating_themekit')) do
+            unless Themekit.update(ctx)
+              ctx.abort(ctx.message('theme.tasks.ensure_themekit_installed.errors.update_fail'))
+            end
+            update_time_of_last_check(now)
+          end
+        end
+      end
+
+      private
+
+      def install_themekit(ctx)
+        require 'json'
+        require 'fileutils'
+        require 'digest'
+        require 'open-uri'
+
+        begin
+          begin
+            releases = JSON.parse(Net::HTTP.get(URI(URL)))
+            release = releases["platforms"].find { |r| r["name"] == OSMAP[ctx.os] }
+          rescue
+            ctx.abort(ctx.message('theme.tasks.ensure_themekit_installed.errors.releases_fail'))
+          end
+
+          ctx.puts(ctx.message('theme.tasks.ensure_themekit_installed.downloading', releases['version']))
+          _out, stat = ctx.capture2e('curl', '-o', Themekit::THEMEKIT, release["url"])
+          ctx.abort(ctx.message('theme.tasks.ensure_themekit_installed.errors.write_fail')) unless stat.success?
+
+          ctx.puts(ctx.message('theme.tasks.ensure_themekit_installed.verifying'))
+          if Digest::MD5.file(Themekit::THEMEKIT) == release['digest']
+            FileUtils.chmod("+x", Themekit::THEMEKIT)
+            ctx.puts(ctx.message('theme.tasks.ensure_themekit_installed.successful'))
+
+            auto = CLI::UI.confirm(ctx.message('theme.tasks.ensure_themekit_installed.auto_update'))
+            ShopifyCli::Feature.set(:themekit_auto_update, auto)
+          else
+            ctx.abort(ctx.message('theme.tasks.ensure_themekit_installed.errors.digest_fail'))
+          end
+        rescue StandardError, ShopifyCli::Abort => e
+          FileUtils.rm(Themekit::THEMEKIT) if File.exist?(Themekit::THEMEKIT)
+          raise e
+        end
+      end
+
+      def time_of_last_check
+        (val = ShopifyCli::Config.get(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD)) ? val.to_i : 0
+      end
+
+      def update_time_of_last_check(time)
+        ShopifyCli::Config.set(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD, time)
+      end
+    end
+  end
+end

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/shopify-cli/admin_api.rb

@@ -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)
@@ -65,12 +105,12 @@ module ShopifyCli
         ).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',
           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
 

data/lib/shopify-cli/api.rb

@@ -1,5 +1,4 @@
 require 'shopify_cli'
-require 'net/http'
 
 module ShopifyCli
   class API
@@ -25,47 +24,31 @@ module ShopifyCli
 
     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
+    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,6 +71,22 @@ 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
@@ -95,7 +94,9 @@ module ShopifyCli
     def default_headers
       {
         'User-Agent' => "Shopify App CLI #{ShopifyCli::VERSION} #{current_sha} | #{ctx.uname}",
-      }.merge(auth_headers(token))
+      }.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)

data/lib/shopify-cli/commands/config.rb

@@ -7,6 +7,7 @@ module ShopifyCli
 
       subcommand :Feature, 'feature'
       subcommand :Analytics, 'analytics'
+      subcommand :ShopifolkBeta, 'shopifolk-beta'
 
       def call(*)
         @ctx.puts(self.class.help)
@@ -71,6 +72,29 @@ module ShopifyCli
           end
         end
       end
+
+      class ShopifolkBeta < ShopifyCli::SubCommand
+        options do |parser, flags|
+          parser.on('--enable') { flags[:action] = 'enable' }
+          parser.on('--disable') { flags[:action] = 'disable' }
+          parser.on('--status') { flags[:action] = 'status' }
+        end
+
+        def call(_args, _name)
+          is_enabled = ShopifyCli::Config.get_bool('shopifolk-beta', 'enabled')
+          if options.flags[:action] == 'disable' && is_enabled
+            ShopifyCli::Config.set('shopifolk-beta', 'enabled', false)
+            @ctx.puts(@ctx.message('core.config.shopifolk_beta.disabled'))
+          elsif options.flags[:action] == 'enable' && !is_enabled
+            ShopifyCli::Config.set('shopifolk-beta', 'enabled', true)
+            @ctx.puts(@ctx.message('core.config.shopifolk_beta.enabled'))
+          elsif is_enabled
+            @ctx.puts(@ctx.message('core.config.shopifolk_beta.is_enabled'))
+          else
+            @ctx.puts(@ctx.message('core.config.shopifolk_beta.is_disabled'))
+          end
+        end
+      end
     end
   end
 end

data/lib/shopify-cli/commands/connect.rb

@@ -3,23 +3,33 @@ require 'shopify_cli'
 module ShopifyCli
   module Commands
     class Connect < ShopifyCli::Command
-      def call(*)
-        project_type = ask_project_type unless Project.has_current?
-
-        if Project.has_current? && Project.current && Project.current.env
-          @ctx.puts @ctx.message('core.connect.already_connected_warning')
-          prod_warning = @ctx.message('core.connect.production_warning')
-          @ctx.puts prod_warning if [:rails, :node].include?(Project.current_project_type)
+      class << self
+        def call(args, command_name)
+          ProjectType.load_type(args[0]) unless args.empty?
+          super
         end
 
-        org = ShopifyCli::Tasks::EnsureEnv.call(@ctx, regenerate: true)
-        write_cli_yml(project_type, org['id']) unless Project.has_current?
-        api_key = Project.current(force_reload: true).env['api_key']
-        @ctx.puts(@ctx.message('core.connect.connected', get_app(org['apps'], api_key).first["title"]))
+        def help
+          ShopifyCli::Context.message('core.connect.help', ShopifyCli::TOOL_NAME)
+        end
       end
 
-      def get_app(apps, api_key)
-        apps.select { |app| app["apiKey"] == api_key }
+      def call(args, command_name)
+        if Project.current&.env
+          @ctx.puts(@ctx.message('core.connect.already_connected_warning'))
+        end
+
+        project_type = ask_project_type
+
+        klass = ProjectType.load_type(project_type)&.connect_command
+
+        if klass
+          klass.ctx = @ctx
+          klass.call(args, command_name, 'connect')
+        else
+          app = default_connect(project_type)
+          @ctx.done(@ctx.message('core.connect.connected', app))
+        end
       end
 
       def ask_project_type
@@ -30,6 +40,13 @@ module ShopifyCli
         end
       end
 
+      def default_connect(project_type)
+        org = ShopifyCli::Tasks::EnsureEnv.call(@ctx, regenerate: true)
+        write_cli_yml(project_type, org['id']) unless Project.has_current?
+        api_key = Project.current(force_reload: true).env['api_key']
+        get_app(org['apps'], api_key).first['title']
+      end
+
       def write_cli_yml(project_type, org_id)
         ShopifyCli::Project.write(
           @ctx,
@@ -39,8 +56,8 @@ module ShopifyCli
         @ctx.done(@ctx.message('core.connect.cli_yml_saved'))
       end
 
-      def self.help
-        ShopifyCli::Context.message('core.connect.help', ShopifyCli::TOOL_NAME)
+      def get_app(apps, api_key)
+        apps.select { |app| app["apiKey"] == api_key }
       end
     end
   end