shopify-cli 1.4.1 → 1.8.0

data/lib/project_types/theme/messages/messages.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+module Theme
+  module Messages
+    MESSAGES = {
+      theme: {
+        connect: {
+          duplicate: "Duplicate directory, theme files weren't connected",
+          help: <<~HELP,
+            {{command:%s connect theme}}: Connects an existing theme in your store to Shopify App CLI. Downloads a copy of the theme files to your local development environment.
+              Usage: {{command:%s connect theme}}
+              Options:
+                {{command:--store=MYSHOPIFYDOMAIN}} Store URL. Must be an existing store with private apps enabled.
+                {{command:--password=PASSWORD}} Private app password. App must have Read and Write Theme access.
+                {{command:--themeid=THEMEID}} Theme ID. Must be an existing theme on your store.
+          HELP
+          inside_project: "You are inside an existing theme, theme files weren't connected",
+          connect: "Downloading theme files...",
+          failed: "Couldn't download theme files from store",
+          connected: "{{green:%s}} files were downloaded from {{underline:%s}} to {{green:%s}}",
+        },
+        create: {
+          creating_theme: "Creating theme %s",
+          duplicate_theme: "Duplicate theme",
+          failed: "Couldn't create the theme",
+          help: <<~HELP,
+            {{command:%s create theme}}: Creates a theme.
+              Usage: {{command:%s create theme}}
+              Options:
+                {{command:--store=MYSHOPIFYDOMAIN}} Store URL. Must be an existing store with private apps enabled.
+                {{command:--password=PASSWORD}} Private app password. App must have Read and Write Theme access.
+                {{command:--name=NAME}} Theme name. Any string.
+          HELP
+          info: {
+            created: "{{green:%s}} was created for {{underline:%s}} in {{green:%s}}",
+          },
+        },
+        deploy: {
+          abort: "Theme wasn't deployed",
+          confirmation: "This will change your live theme. Do you wish to proceed?",
+          deploying: "Deploying theme",
+          error: "Theme couldn't be deployed",
+          help: <<~HELP,
+            {{command:%s deploy}}: Uploads your local theme files to Shopify, then sets your theme as the live theme.
+              Usage: {{command:%s deploy}}
+          HELP
+          info: {
+            deployed: "Theme was updated and set as the live theme",
+            pushed: "All theme files were updated",
+          },
+          push_fail: "Theme files couldn't be updated",
+        },
+        forms: {
+          ask_password: "Password:",
+          ask_store: "Store domain:",
+          create: {
+            ask_title: "Title:",
+            private_app: <<~APP,
+              To create a new theme, Shopify App CLI needs to connect with a private app installed on your store. Visit {{underline:%s/admin/apps/private}} to create a new API key and password, or retrieve an existing password.
+              If you create a new private app, ensure that it has Read and Write Theme access.
+            APP
+          },
+          connect: {
+            private_app: <<~APP,
+              To fetch your existing themes, Shopify App CLI needs to connect with your store. Visit {{underline:%s/admin/apps/private}} to create a new API key and password, or retrieve an existing password.
+              If you create a new private app, ensure that it has Read and Write Theme access.
+            APP
+          },
+          errors: "%s can't be blank",
+        },
+        generate: {
+          env: {
+            ask_password: "Password",
+            ask_password_default: "Password (defaults to {{green:%s}})",
+            ask_store: "Store",
+            ask_store_default: "Store (defaults to {{green:%s}})",
+            ask_theme: "Select theme",
+            help: <<~HELP,
+              Create or update configuration file in the current directory.
+                Usage: {{command:%s generate env}}
+                Options:
+                  {{command:--store=MYSHOPIFYDOMAIN}} Store URL. Must be an existing store with private apps enabled.
+                  {{command:--password=PASSWORD}} Private app password. App must have Read and Write Theme access.
+                  {{command:--themeid=THEMEID}} Theme ID. Must be an existing theme on your store.
+            HELP
+            no_themes: "Please create a new theme using %s create theme",
+          },
+          help: <<~HELP,
+            Generate code in your Theme. Currently supports generating new envs.
+              Usage: {{command:%s generate [ env ]}}
+          HELP
+        },
+        push: {
+          remove_abort: "Theme files weren't deleted",
+          remove_confirm: "This will delete the local and remote copies of the theme files. Do you wish to proceed?",
+          error: {
+            push_error: "Theme files couldn't be pushed to Shopify",
+            remove_error: "Theme files couldn't be removed from Shopify",
+          },
+          help: <<~HELP,
+            {{command:%s push}}: Uploads your local theme files to Shopify, overwriting the remote versions. If you specify filenames, separated by a space, only those files will be replaced. Otherwise, the whole theme will be replaced.
+              Usage: {{command:%s push}}
+              Options:
+                {{command:--remove}} Deletes both the local and the remote copies of the specified files. At least one filename must be specified.
+                {{command:--allow-live}} Allows Shopify App CLI to replace files on the store's live production theme.
+                {{command:--nodelete}} Runs the push command without deleting remote files from Shopify.
+          HELP
+          info: {
+            push: "Theme files were pushed from {{green:%s}} to Shopify",
+            remove: "Theme files were deleted from {{green:%s}} and Shopify",
+          },
+          push: "Pushing theme files to Shopify",
+          remove: "Deleting theme files",
+        },
+        serve: {
+          help: <<~HELP,
+            Sync your current changes, then view the active store in your default browser. Any theme edits will continue to update in real time. Also prints the active store's URL in your terminal.
+            Usage: {{command:%s serve}}
+          HELP
+          serve: "Viewing theme...",
+          open_fail: "Couldn't open the theme",
+        },
+        tasks: {
+          ensure_themekit_installed: {
+            auto_update: "Would you like to enable auto-updating?",
+            downloading: "Downloading Theme Kit %s",
+            errors: {
+              digest_fail: "Unable to verify download",
+              releases_fail: "Unable to fetch Theme Kit's list of releases",
+              update_fail: "Unable to update Theme Kit",
+              write_fail: "Unable to download Theme Kit",
+            },
+            installing_themekit: "Installing Theme Kit",
+            successful: "Theme Kit installed successfully",
+            updating_themekit: "Updating Theme Kit",
+            verifying: "Verifying download...",
+          },
+        },
+        themekit: {
+          query_themes: {
+            bad_password: "Bad password",
+            not_connect: "Couldn't connect to given shop",
+          },
+        },
+      },
+    }.freeze
+  end
+end

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/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