shopify-cli 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b12fdb1aec476c1b05eee2e33817d3636f76927d4cdc5700347344b687e28d
-  data.tar.gz: 83411b72925dbe120a4c89fa1d715f3fe61a7596ed4d356f03b537ea6bb31481
+  metadata.gz: e0d2feda9dda6ab4615cc2c15d8afb30f33cac588acd3f2672cd7456e4ad4fd8
+  data.tar.gz: 0b2ad4137e51ab352a41719e370b98fe147062386c6696f0be9a59bf884c1954
 SHA512:
-  metadata.gz: 3557bcc2a93f0775a294b0c2d1c784949e84602155de21d3d3db89237ae7e50bbf3ba591bdc329ca6074ae27178444c6c939cd42ac361dcb5a9d50a9de4e8567
-  data.tar.gz: 78ebf53316d6bebf24bb04832a5b052512d46df48f9f71cc3f388305c6210cd0ec32b2f1ba9151cd80d8199a26142c8684775f93198d7d9b61bf1291d1d39732
+  metadata.gz: 0564124577f1f85d2597250792c27e3de0eda4a02fcb7ba6f9dd8b7b2a3bf36492e6b7a3dce9d48b946af8bfb81f3f39e3d0fa06966082f40b0232e5d8597e8b
+  data.tar.gz: 07f8d25b7e123b5d9c09de7cd49a31017174e9a7251d50ca461381d06219b0560f6223e9d1dd3d89cd273b65965ab42eb1b007fe6151d9cfcff32bf4d16b3b0e

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+Version 0.9.3
+------
+* Rebased to master
+* Removed auto-generated files from builds directory
+
 Version 0.9.2
 ------
 * Rebased to master, to pull in 7+ Pull Requests

data/docs/_config.yml

@@ -14,3 +14,6 @@ defaults:
       path: ""
     values:
       toc: true
+
+plugins:
+  - jekyll-redirect-from

data/docs/_data/nav.yml

@@ -5,6 +5,15 @@ sidebar:
   - title: Getting started
     section: getting-started
     url: /getting-started/
+    subnav:
+      - title: Install
+        url: /getting-started/install/
+      - title: Upgrade
+        url: /getting-started/upgrade/
+      - title: Uninstall
+        url: /getting-started/uninstall/
+      - title: Migrate from a legacy version
+        url: /getting-started/migrate/
   - title: Core commands
     section: core
     url: /core/

data/docs/getting-started/index.md

@@ -1,6 +1,7 @@
 ---
 title: Getting started
 section: getting-started
+toc: false
 ---
 
 Developers should have some prior knowledge of the [Shopify app ecosystem](https://shopify.dev/concepts/apps). Shopify App CLI creates apps using either [Node.js](https://nodejs.org/) or [Ruby on Rails](https://rubyonrails.org/).
@@ -8,11 +9,8 @@ Developers should have some prior knowledge of the [Shopify app ecosystem](https
 ## Requirements
 
 - [Ruby](https://www.ruby-lang.org) 2.5.1+ 
-- [Node.js](https://nodejs.org) 10.0.0+
-- [curl](https://curl.haxx.se)
 - A [Shopify partner account](https://partners.shopify.com/signup)
 - A [Shopify development store](https://help.shopify.com/en/partners/dashboard/development-stores#create-a-development-store) to install and test apps
-- An [ngrok](https://ngrok.com/) account (free or paid) for local development
 
 ### Windows requirements
 
@@ -21,41 +19,8 @@ You’ll need to install the following tools to use Shopify App CLI on Windows:
 - [Linux Subsystem for Windows](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
 - [Ubuntu VM](https://www.microsoft.com/en-ca/p/ubuntu/9nblggh4msv6)
 
-## Install
+## Next steps
 
-Shopify App CLI installs using a shell script. Download and run it in your terminal with one command:
-
-```console
-eval "$(curl -sS https://raw.githubusercontent.com/Shopify/shopify-app-cli/master/install.sh)"
-```
-
-[View shell script source](https://raw.githubusercontent.com/Shopify/shopify-app-cli/master/install.sh)
-
-
-## Uninstall
-
-There are two steps to completely uninstall Shopify App CLI:
-
-1. Delete the CLI files
-1. Remove the `shopify` command from your shell profile
-
-### 1. Delete the CLI files
-
-By default, Shopify App CLI is installed in your home directory. All the files are contained in a hidden directory called `.shopify-app-cli`. Delete that directory to uninstall.
-
-### 2. Remove the `shopify` command from your shell
-
-During the install process, Shopify App CLI adds a line to your shell configuration. This line is typically located in the `.bash_profile` file in your home directory (depending on your system, it may also be found in `.bash_login` or `.profile`). It will look similar to this:
-
-```sh
-# The line won’t look exactly like this. `HOME_DIR` will instead be the absolute path to your home directory.
-if [[ -f /HOME_DIR/.shopify-cli/shopify.sh ]]; then source /HOME_DIR/.shopify-cli/shopify.sh; fi
-```
-
-You can use `grep` to search for the correct file in your home directory. This command will return the name of the relevant file, and the line number where it appears:
-
-```console
-$ grep -Ens "^if.+\.shopify-app-cli/shopify\.sh.+fi$" ~/\.*
-```
-
-Deleting or commenting out the relevant line in your shell profile will remove `shopify` as a command. You may need to reload your shell.
+- [Install the CLI]({{ site.baseurl }}/getting-started/install/)
+- [Upgrade]({{ site.baseurl }}/getting-started/upgrade/)
+- [Uninstall]({{ site.baseurl }}/getting-started/uninstall/)

data/docs/getting-started/install/index.md

@@ -0,0 +1,39 @@
+---
+title: Install Shopify App CLI
+section: getting-started
+toc: false
+redirect_from: "/install/"
+---
+
+Shopify App CLI can be installed using a variety of package managers.
+
+### Homebrew (macOS)
+
+You’ll need to run `brew tap` first to add Shopify’s third-party repositories to Homebrew.
+
+```console
+$ brew tap shopify/shopify
+$ brew install shopify-cli
+```
+
+### apt (Debian, Ubuntu)
+
+You’ll need to install a downloaded .deb file with an explicit version number. Check the [releases page](https://github.com/Shopify/shopify-app-cli/releases) to make sure you install the latest package.
+
+```console
+$ sudo apt install shopify-cli-x.y.z.deb
+```
+
+### yum (CentOS 8+, Fedora, Red Hat, SUSE)
+
+You’ll need to install a downloaded .rpm file with an explicit version number. Check the [releases page](https://github.com/Shopify/shopify-app-cli/releases) to make sure you install the latest package.
+
+```console
+$ sudo yum install shopify-cli-x.y.x.rpm
+```
+
+### Ruby gem
+
+```console
+$ gem install shopify-cli
+```

data/docs/getting-started/migrate/index.md

@@ -0,0 +1,63 @@
+---
+title: Migrate from the legacy Shopify App CLI
+section: getting-started
+redirect_from: "/migrate/"
+---
+
+As of version 0.9.0, Shopify App CLI is installed and managed as a software package, instead of as a git repository. If you’re using a legacy version, you’ll need to perform a one-time migration to keep using the CLI. Follow these steps to remove the legacy version and reinstall as a package.
+
+## Check whether you’re using the legacy version
+
+Prior to version 0.9.0, Shopify App CLI was installed as a Git repository. You can determine if you’re running a legacy version by running this command:
+
+```console
+$ shopify version
+```
+
+If you get a “Command not found” error, then you’re using a legacy version and will need to uninstall it manually.
+
+## 1. Uninstall the legacy Shopify App CLI
+
+There are two steps to completely uninstall the legacy version of Shopify App CLI:
+
+1. Delete the legacy CLI files
+1. Remove the legacy `shopify` command from your shell profile
+
+### 1. Delete the CLI files
+
+By default, Shopify App CLI was installed in your home directory. All the files are contained in a hidden directory called `.shopify-app-cli`. Delete it to uninstall:
+
+```console
+$ rm -rf ~/.shopify-app-cli/
+```
+
+### 2. Remove the `shopify` command from your shell
+
+During the install process, Shopify App CLI added a line to your shell configuration. This line could be located in one of a few possible files in your home directory:
+
+- `~/.bash_profile`
+- `~/.zshrc`
+- `~/.bash_login`
+- `~/.profile`
+- `~/.config/fish/config.fish`
+
+It will look similar to one of the lines below. The exact syntax may vary depending on your system:
+
+```sh
+# The line won’t look *exactly* like this. `HOME_DIR` will instead be the absolute path to your home directory.
+if [[ -f /HOME_DIR/.shopify-cli/shopify.sh ]]; then source /HOME_DIR/.shopify-cli/shopify.sh; fi
+
+# The line might not be wrapped in an `if` statement. Example:
+[ -f "/HOME_DIR/.shopify-app-cli/shopify.sh" ] && source "/HOME_DIR/.shopify-app-cli/shopify.sh"
+```
+
+Deleting or commenting out the relevant line in your shell profile will remove `shopify` as a command. You may need to reload your shell.
+
+## 2. Install the new version
+
+Next, install the most recent version of Shopify App CLI. Follow the [install directions]({{ site.baseurl }}/getting-started/install/) for your platform.
+
+## 3. Re-authenticate the CLI
+
+The migration process moves some configuration files, so you’ll need to re-authenticate the CLI with your Shopify Partner Dashboard. The CLI will automatically prompt you to re-authenticate when needed.
+

data/docs/getting-started/uninstall/index.md

@@ -0,0 +1,37 @@
+---
+title: Uninstall Shopify App CLI
+section: getting-started
+toc: false
+redirect_from: "/uninstall/"
+---
+
+Shopify App CLI can be removed from your system using the same package manager you used to install it.
+
+### Homebrew (macOS)
+
+```console
+$ brew uninstall shopify-cli
+```
+
+### apt (Debian, Ubuntu)
+
+```console
+$ sudo apt remove shopify-cli
+```
+
+### yum (CentOS 8+, Fedora, Red Hat, SUSE)
+
+```console
+$ sudo yum remove shopify-cli
+```
+
+### Ruby gem
+
+```console
+$ gem uninstall shopify-cli
+```
+
+## Uninstall a legacy version
+
+If you’re using a legacy version of the CLI (`<0.9.0`), you’ll need to [uninstall it manually]({{ site.baseurl }}/getting-started/migrate/#1-uninstall-the-old-cli).
+

data/docs/getting-started/upgrade/index.md

@@ -0,0 +1,37 @@
+---
+title: Upgrade Shopify App CLI
+section: getting-started
+toc: false
+redirect_from: "/upgrade/"
+---
+
+You can manage upgrades to Shopify App CLI with the package manager for your platform.
+
+### Homebrew (macOS)
+
+```console
+$ brew update
+$ brew upgrade shopify-cli
+```
+
+### apt (Debian, Ubuntu)
+
+On Debian-based Linux distributions, download the latest `.deb` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
+
+```console
+$ sudo apt install shopify-cli-x.y.z.deb
+```
+
+### yum (CentOS 8+, Fedora, Red Hat, SUSE)
+
+On Red Hat–based Linux distributions, download the latest `.rpm` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
+
+```console
+$ sudo yum install shopify-cli-x.y.z.rpm
+```
+
+### Ruby gem
+
+```console
+$ gem update shopify-cli
+```

data/docs/index.md

@@ -10,18 +10,17 @@ Shopify App CLI helps you build Shopify apps faster. It quickly scaffolds Node.j
 
 ## Quick start
 
-1. Install Shopify App CLI:
-    ```console
-    $ eval "$(curl -sS https://raw.githubusercontent.com/Shopify/shopify-app-cli/master/install.sh)"
-    ```
+1. [Install Shopify App CLI]({{ site.baseurl }}{% link getting-started/install/index.md %}).
 2. Create an app:
     ```console
     $ shopify create
     ```
-3. Start and install your app on a Shopify Development store:
+3. Start and install your app on a Shopify development store:
     ```console
     $ shopify serve
     ```
     ```console
     $ shopify open
-    ```
+    ```
+
+**[Learn more in our Getting Started guide]({{ site.baseurl }}{% link getting-started/index.md %})**

data/lib/project_types/extension/cli.rb

@@ -30,6 +30,7 @@ module Extension
   module Tasks
     autoload :UserErrors, Project.project_filepath('tasks/user_errors')
     autoload :GetApps, Project.project_filepath('tasks/get_apps')
+    autoload :GetApp, Project.project_filepath('tasks/get_app')
     autoload :CreateExtension, Project.project_filepath('tasks/create_extension')
     autoload :UpdateDraft, Project.project_filepath('tasks/update_draft')
 
@@ -37,6 +38,7 @@ module Extension
       autoload :RegistrationConverter, Project.project_filepath('tasks/converters/registration_converter')
       autoload :VersionConverter, Project.project_filepath('tasks/converters/version_converter')
       autoload :ValidationErrorConverter, Project.project_filepath('tasks/converters/validation_error_converter')
+      autoload :AppConverter, Project.project_filepath('tasks/converters/app_converter')
     end
   end
 
@@ -51,7 +53,6 @@ module Extension
     autoload :ArgoSetupStep, Project.project_filepath('features/argo_setup_step')
     autoload :ArgoSetupSteps, Project.project_filepath('features/argo_setup_steps')
     autoload :ArgoDependencies, Project.project_filepath('features/argo_dependencies')
-    autoload :TunnelUrl, Project.project_filepath('features/tunnel_url')
   end
 
   module Models

data/lib/project_types/extension/commands/tunnel.rb

@@ -37,7 +37,7 @@ module Extension
       private
 
       def status
-        tunnel_url = Features::TunnelUrl.fetch
+        tunnel_url = ShopifyCli::Tunnel.urls.first
 
         if tunnel_url.nil?
           @ctx.puts(@ctx.message('tunnel.no_tunnel_running'))

data/lib/project_types/extension/forms/register.rb

@@ -16,13 +16,12 @@ module Extension
       attr_writer :app
 
       def ask_app
-        apps = load_apps
-
         if !api_key.nil?
-          found_app = apps.find { |app| app.api_key == api_key }
+          found_app = Tasks::GetApp.call(context: ctx, api_key: api_key)
           ctx.abort(ctx.message('register.invalid_api_key', api_key)) if found_app.nil?
           found_app
         else
+          apps = load_apps
           CLI::UI::Prompt.ask(ctx.message('register.ask_app')) do |handler|
             apps.each do |app|
               handler.option("#{app.title} by #{app.business_name}") { app }

data/lib/project_types/extension/graphql/get_app_by_api_key.graphql

@@ -0,0 +1,9 @@
+query getApp($api_key: String!) {
+  app(apiKey: $api_key) {
+    title
+    apiKey
+    apiSecretKeys{
+      secret
+    }
+  }
+}

data/lib/project_types/extension/tasks/converters/app_converter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'shopify_cli'
+
+module Extension
+  module Tasks
+    module Converters
+      module AppConverter
+        API_KEY_FIELD = 'apiKey'
+        API_SECRET_KEYS_FIELD = 'apiSecretKeys'
+        API_SECRET_FIELD = 'secret'
+        TITLE_FIELD = 'title'
+        ORGANIZATION_NAME_FIELD = 'businessName'
+
+        def self.from_hash(hash, organization = {})
+          return nil if hash.nil?
+
+          Models::App.new(
+            api_key: hash[API_KEY_FIELD],
+            secret: hash[API_SECRET_KEYS_FIELD].first[API_SECRET_FIELD],
+            title: hash[TITLE_FIELD],
+            business_name: organization[ORGANIZATION_NAME_FIELD]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/get_app.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'shopify_cli'
+
+module Extension
+  module Tasks
+    class GetApp < ShopifyCli::Task
+      GRAPHQL_FILE = 'get_app_by_api_key'
+
+      RESPONSE_FIELD = %w(data)
+      APP_FIELD = 'app'
+
+      def call(context:, api_key:)
+        input = { api_key: api_key }
+
+        response = ShopifyCli::PartnersAPI.query(context, GRAPHQL_FILE, input).dig(*RESPONSE_FIELD)
+        context.abort(context.message('tasks.errors.parse_error')) if response.nil?
+
+        Converters::AppConverter.from_hash(response.dig(APP_FIELD))
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/get_apps.rb

@@ -21,12 +21,7 @@ module Extension
         return [] unless organization.key?('apps') && organization['apps'].any?
 
         organization['apps'].map do |app|
-          Models::App.new(
-            api_key: app['apiKey'],
-            secret: app["apiSecretKeys"].first["secret"],
-            title: app['title'],
-            business_name: organization['businessName']
-          )
+          Converters::AppConverter.from_hash(app, organization)
         end
       end
     end