shopify-cli 1.0.0 → 1.0.5

data/lib/shopify-cli/db.rb

@@ -14,7 +14,7 @@ module ShopifyCli
 
     attr_reader :db # :nodoc:
 
-    def initialize(path: File.join(ShopifyCli::CACHE_DIR, ".db.pstore")) # :nodoc:
+    def initialize(path: File.join(ShopifyCli.cache_dir, ".db.pstore")) # :nodoc:
       @db = PStore.new(path)
     end
 

data/lib/shopify-cli/feature.rb

@@ -0,0 +1,97 @@
+module ShopifyCli
+  ##
+  # ShopifyCli::Feature contains the logic to hide and show features across the CLI
+  # These features can be either commands or project types currently.
+  #
+  # Feature flags will persist between runs so if the flag is enabled or disabled,
+  # it will still be in that same state on the next cli invocation.
+  class Feature
+    SECTION = 'features'
+
+    ##
+    # ShopifyCli::Feature::Set is included on commands and projects to allow you to hide
+    # and enable projects and commands based on feature flags.
+    module Set
+      ##
+      # will hide a feature, either a project_type or a command
+      #
+      # #### Parameters
+      #
+      # * `feature_set` - either a single, or array of symbols that represent feature sets
+      #
+      # #### Example
+      #
+      #    module ShopifyCli
+      #      module Commands
+      #        class Config < ShopifyCli::Command
+      #          hidden_feature(feature_set: :basic)
+      #          ....
+      #
+      def hidden_feature(feature_set: [])
+        @feature_hidden = true
+        @hidden_feature_set = Array(feature_set).compact
+      end
+
+      ##
+      # will return if the feature has been hidden or not
+      #
+      # #### Returns
+      #
+      # * `is_hidden` - returns true if the feature has been hidden and false otherwise
+      #
+      # #### Example
+      #
+      #     ShopifyCli::Commands::Config.hidden?
+      #
+      def hidden?
+        enabled = (@hidden_feature_set || []).any? do |feature|
+          Feature.enabled?(feature)
+        end
+        @feature_hidden && !enabled
+      end
+    end
+
+    class << self
+      ##
+      # will enable a feature in the CLI.
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing the flag to be enabled
+      def enable(feature)
+        set(feature, true)
+      end
+
+      ##
+      # will disable a feature in the CLI.
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing the flag to be disabled
+      def disable(feature)
+        set(feature, false)
+      end
+
+      ##
+      # will check if the feature has been enabled
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing a flag that the status should be requested
+      #
+      # #### Returns
+      #
+      # * `is_enabled` - will be true if the feature has been enabled.
+      def enabled?(feature)
+        return false if feature.nil?
+        ShopifyCli::Config.get_bool(SECTION, feature.to_s)
+      end
+
+      private
+
+      def set(feature, value)
+        ShopifyCli::Config.set(SECTION, feature.to_s, value)
+      end
+    end
+  end
+end

data/lib/shopify-cli/heroku.rb

@@ -36,7 +36,7 @@ module ShopifyCli
     def download
       return if installed?
 
-      result = @ctx.system('curl', '-o', download_path, DOWNLOAD_URLS[@ctx.os], chdir: ShopifyCli::CACHE_DIR)
+      result = @ctx.system('curl', '-o', download_path, DOWNLOAD_URLS[@ctx.os], chdir: ShopifyCli.cache_dir)
       @ctx.abort(@ctx.message('core.heroku.error.download')) unless result.success?
       @ctx.abort(@ctx.message('core.heroku.error.download')) unless File.exist?(download_path)
     end
@@ -44,7 +44,7 @@ module ShopifyCli
     def install
       return if installed?
 
-      result = @ctx.system('tar', '-xf', download_path, chdir: ShopifyCli::CACHE_DIR)
+      result = @ctx.system('tar', '-xf', download_path, chdir: ShopifyCli.cache_dir)
       @ctx.abort(@ctx.message('core.heroku.error.install')) unless result.success?
 
       @ctx.rm(download_path)
@@ -70,7 +70,7 @@ module ShopifyCli
     end
 
     def download_path
-      File.join(ShopifyCli::CACHE_DIR, download_filename)
+      File.join(ShopifyCli.cache_dir, download_filename)
     end
 
     def git_remote
@@ -79,7 +79,7 @@ module ShopifyCli
     end
 
     def heroku_command
-      local_path = File.join(ShopifyCli::CACHE_DIR, 'heroku', 'bin', 'heroku').to_s
+      local_path = File.join(ShopifyCli.cache_dir, 'heroku', 'bin', 'heroku').to_s
       if File.exist?(local_path)
         local_path
       else

data/lib/shopify-cli/messages/messages.rb

@@ -16,13 +16,6 @@ module ShopifyCli
           already_connected_warning: "{{yellow:! This app appears to be already connected}}",
           connected: "{{v}} Project now connected to {{green:%s}}",
           project_type_select: "What type of project would you like to connect?",
-          organization_select: "To which partner organization does this project belong?",
-          app_select: "To which app does this project belong?",
-          no_development_stores: <<~MESSAGE,
-          No development stores available.
-          Visit {{underline:https://partners.shopify.com/%d/stores}} to create one
-          MESSAGE
-          development_store_select: "Which development store would you like to use?",
           cli_yml_saved: ".shopify-cli.yml saved to project root",
         },
 
@@ -52,6 +45,19 @@ module ShopifyCli
           saved: "%s saved to project root",
         },
 
+        config: {
+          help: <<~HELP,
+          Change configuration of how the CLI operates
+            Usage: {{command:%s config [ feature ] [ feature_name ] }}
+          HELP
+          feature: {
+            enabled: "{{v}} feature {{green:%s}} was enabled",
+            disabled: "{{v}} feature {{green:%s}} was disabled",
+            is_enabled: "{{v}} feature {{green:%s}} is enabled",
+            is_disabled: "{{v}} feature {{green:%s}} is disabled",
+          },
+        },
+
         git: {
           error: {
             directory_exists: "Project directory already exists. Please create a project with a new name.",
@@ -232,9 +238,21 @@ module ShopifyCli
 
         tasks: {
           ensure_env: {
-            api_key_question: "What is your Shopify API key?",
-            api_secret_key_question: "What is your Shopify API secret key?",
-            development_store_question: "What is your development store URL? (Example: my-dev-store.myshopify.com)",
+            organization_select: "To which partner organization does this project belong?",
+            no_development_stores: <<~MESSAGE,
+            No development stores available.
+            Visit {{underline:https://partners.shopify.com/%d/stores}} to create one
+            MESSAGE
+            development_store_select: "Which development store would you like to use?",
+            app_select: "To which app does this project belong?",
+            no_apps: 'You have no apps to connect to, creating a new app.',
+            app_name: "App name",
+            app_type: {
+              select: "What type of app are you building?",
+              select_public: "Public: An app built for a wide merchant audience.",
+              select_custom: "Custom: An app custom built for a single client.",
+              selected: "App type {{green:%s}}",
+            },
           },
           ensure_dev_store: {
             could_not_verify_store: "Couldn't verify your store %s",
@@ -251,6 +269,20 @@ module ShopifyCli
               "{{x}} error: For authentication issues, run {{command:%s logout}} to clear invalid credentials",
             update_prompt: "Do you want to update your application url?",
           },
+          select_org_and_shop: {
+            authentication_issue: "For authentication issues, run {{command:%s logout}} to clear invalid credentials",
+            create_store: "Visit {{underline:https://partners.shopify.com/%s/stores}} to create one",
+            development_store: "Using development store {{green:%s}}",
+            development_store_select: "Select a development store",
+            error: {
+              no_development_stores: "{{x}} No Development Stores available.",
+              no_organizations: "No partner organizations available.",
+              organization_not_found: "Cannot find a partner organization with that ID",
+              partners_notice: "Please visit https://partners.shopify.com/ to create a partners account",
+            },
+            organization: "Partner organization {{green:%s (%s)}}",
+            organization_select: "Select partner organization",
+          },
         },
 
         tunnel: {
@@ -259,10 +291,17 @@ module ShopifyCli
             url_fetch_failure: "Unable to fetch external url",
           },
 
-          stopped: "{{green:x}} ngrok tunnel stopped",
           not_running: "{{green:x}} ngrok tunnel not running",
-          start_with_account: "{{v}} ngrok tunnel running at {{underline:%s}}, with account %s",
+          signup_suggestion: <<~MESSAGE,
+          {{*}} To avoid tunnels that timeout, it is recommended to signup for a free ngrok
+          account at {{underline:https://ngrok.com/signup}}. After you signup, install your
+          personalized authorization token using {{command:%s tunnel auth <token>}}.
+          MESSAGE
           start: "{{v}} ngrok tunnel running at {{underline:%s}}",
+          start_with_account: "{{v}} ngrok tunnel running at {{underline:%s}}, with account %s",
+          stopped: "{{green:x}} ngrok tunnel stopped",
+          timed_out: "{{x}} ngrok tunnel has timed out, restarting ...",
+          will_timeout: "{{*}} This tunnel will timeout in {{red:%s}}",
         },
 
         version: {

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

@@ -4,25 +4,25 @@ module ShopifyCli
       class << self
         def fetch_all(ctx)
           resp = PartnersAPI.query(ctx, 'all_organizations')
-          resp['data']['organizations']['nodes'].map do |org|
-            org['stores'] = org['stores']['nodes']
+          (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['data']['organizations']['nodes'].first
+          org = resp.dig('data', 'organizations', 'nodes').first
           return nil if org.nil?
-          org['stores'] = org['stores']['nodes']
+          org['stores'] = (org.dig('stores', 'nodes') || [])
           org
         end
 
         def fetch_with_app(ctx)
           resp = PartnersAPI.query(ctx, 'all_orgs_with_apps')
-          resp['data']['organizations']['nodes'].map do |org|
-            org['stores'] = org['stores']['nodes']
-            org['apps'] = org['apps']['nodes']
+          (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

@@ -5,9 +5,6 @@ module ShopifyCli
   # ProcessSupervision wraps a running process spawned by `exec` and keeps track
   # if its `pid` and keeps a log file for it as well
   class ProcessSupervision
-    # is the directory where the pid and logfile are kept
-    RUN_DIR = File.join(ShopifyCli::CACHE_DIR, 'sv')
-
     # a string or a symbol to identify this process by
     attr_reader :identifier
     # process ID for the running process
@@ -20,6 +17,11 @@ module ShopifyCli
     attr_reader :log_path
 
     class << self
+      def run_dir
+        # is the directory where the pid and logfile are kept
+        File.join(ShopifyCli.cache_dir, 'sv')
+      end
+
       ##
       # Will find and create a new instance of ProcessSupervision for a running process
       # if it is currently running. It will return nil if the process is not running.
@@ -34,7 +36,7 @@ module ShopifyCli
       #   will be nil if the process is not running.
       #
       def for_ident(identifier)
-        pid, time = File.read(File.join(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
@@ -108,8 +110,8 @@ module ShopifyCli
       @identifier = identifier
       @pid = pid
       @time = time
-      @pid_path = File.join(RUN_DIR, "#{identifier}.pid")
-      @log_path = File.join(RUN_DIR, "#{identifier}.log")
+      @pid_path = File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.pid")
+      @log_path = File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.log")
     end
 
     ##

data/lib/shopify-cli/project_type.rb

@@ -1,11 +1,12 @@
 module ShopifyCli
   class ProjectType
+    extend Feature::Set
+
     class << self
       attr_accessor :project_type,
         :project_name,
         :project_creator_command_class,
         :project_load_shallow
-      attr_reader :hidden
 
       def repository
         @repository ||= []
@@ -13,6 +14,7 @@ module ShopifyCli
       alias_method :all_loaded, :repository
 
       def inherited(klass)
+        super
         repository << klass
         klass.project_type = @current_type
         klass.project_load_shallow = @shallow_load
@@ -31,7 +33,7 @@ module ShopifyCli
 
       def load_all
         Dir.glob(File.join(ShopifyCli::ROOT, 'lib', 'project_types', '*', 'cli.rb')).map do |filepath|
-          load_type(filepath.split(File::Separator)[-2], true)
+          load_type(filepath.split(File::Separator)[-2].to_sym, true)
         end
       end
 
@@ -53,10 +55,6 @@ module ShopifyCli
         const_get(@project_creator_command_class)
       end
 
-      def hidden_project_type
-        @hidden = true
-      end
-
       def register_command(const, cmd)
         return if project_load_shallow
         Context.new.abort(
@@ -67,7 +65,7 @@ module ShopifyCli
 
       def register_task(task, name)
         return if project_load_shallow
-        Task::Registry.add(const_get(task), name)
+        ShopifyCli::Task.register(task, name)
       end
 
       def register_messages(messages)

data/lib/shopify-cli/sub_command.rb

@@ -8,6 +8,7 @@ module ShopifyCli
         cmd = new(@ctx)
         args = cmd.options.parse(@_options, args[1..-1] || [])
         return call_help(parent_command, command_name) if cmd.options.help
+        run_prerequisites
         cmd.call(args, command_name)
       end
     end

data/lib/shopify-cli/task.rb

@@ -2,9 +2,9 @@ require 'shopify_cli'
 
 module ShopifyCli
   class Task
-    def self.call(*args)
+    def self.call(*args, **kwargs)
       task = new
-      task.call(*args)
+      task.call(*args, **kwargs)
     end
   end
 end

data/lib/shopify-cli/tasks.rb

@@ -12,21 +12,29 @@ module ShopifyCli
       end
 
       def [](name)
-        @tasks[name]
+        class_or_proc = @tasks[name]
+        if class_or_proc.is_a?(Class)
+          class_or_proc
+        elsif class_or_proc.respond_to?(:call)
+          class_or_proc.call
+        else
+          class_or_proc
+        end
       end
     end
 
     Registry = TaskRegistry.new
 
-    def self.register(task, name, path)
-      autoload(task, path)
-      Registry.add(const_get(task), name)
+    def self.register(task, name, path = nil)
+      autoload(task, path) if path
+      Registry.add(-> () { const_get(task) }, name)
     end
 
     register :CreateApiClient, :create_api_client, 'shopify-cli/tasks/create_api_client'
     register :EnsureEnv, :ensure_env, 'shopify-cli/tasks/ensure_env'
     register :EnsureLoopbackURL, :ensure_loopback_url, 'shopify-cli/tasks/ensure_loopback_url'
     register :EnsureDevStore, :ensure_dev_store, 'shopify-cli/tasks/ensure_dev_store'
+    register :SelectOrgAndShop, :select_org_and_shop, 'shopify-cli/tasks/select_org_and_shop'
     register :UpdateDashboardURLS, :update_dashboard_urls, 'shopify-cli/tasks/update_dashboard_urls'
   end
 end

data/lib/shopify-cli/tasks/ensure_env.rb

@@ -3,28 +3,84 @@ require 'shopify_cli'
 module ShopifyCli
   module Tasks
     class EnsureEnv < ShopifyCli::Task
-      def call(ctx)
+      def call(ctx, regenerate: false, required: [:api_key, :secret])
         @ctx = ctx
-        Resources::EnvFile.read(ctx.root)
-      rescue Errno::ENOENT
-        ask
+        env_data =
+          begin
+            Resources::EnvFile.parse_external_env
+          rescue Errno::ENOENT
+            {}
+          end
+
+        return {} if !regenerate && required.all? { |property| env_data[property] }
+
+        org = fetch_org
+        write_env(env_data, org)
+        org
+      end
+
+      private
+
+      def fetch_org
+        orgs = PartnersAPI::Organizations.fetch_with_app(@ctx)
+        org_id = if orgs.count == 1
+          orgs.first["id"]
+        else
+          CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.organization_select')) do |handler|
+            orgs.each do |org|
+              handler.option(
+                @ctx.message('core.partners_api.org_name_and_id', org['businessName'], org['id'])
+              ) { org["id"] }
+            end
+          end
+        end
+        orgs.find { |o| o["id"] == org_id }
+      end
+
+      def get_app(org_id, apps)
+        if apps.count == 1
+          apps.first
+        elsif apps.count == 0
+          @ctx.puts(@ctx.message('core.tasks.ensure_env.no_apps'))
+          title = CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.app_name'))
+          type = CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.app_type.select')) do |handler|
+            handler.option(@ctx.message('core.tasks.ensure_env.app_type.select_public')) { 'public' }
+            handler.option(@ctx.message('core.tasks.ensure_env.app_type.select_custom')) { 'custom' }
+          end
+          ShopifyCli::Tasks::CreateApiClient.call(@ctx, org_id: org_id, title: title, type: type)
+        else
+          CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.app_select')) do |handler|
+            apps.each { |app| handler.option(app["title"]) { app } }
+          end
+        end
+      end
+
+      def get_shop(shops, id)
+        if shops.count == 1
+          shop = shops.first["shopDomain"]
+        elsif shops.count == 0
+          @ctx.puts(@ctx.message('core.tasks.ensure_env.no_development_stores', id))
+        else
+          shop = CLI::UI::Prompt.ask(@ctx.message('core.tasks.ensure_env.development_store_select')) do |handler|
+            shops.each { |s| handler.option(s["shopName"]) { s["shopDomain"] } }
+          end
+        end
+        shop
       end
 
-      def ask
-        api_key = CLI::UI.ask(@ctx.message('core.tasks.ensure_env.api_key_question'))
-        api_secret = CLI::UI.ask(@ctx.message('core.tasks.ensure_env.api_secret_key_question'))
-        shop = CLI::UI.ask(@ctx.message('core.tasks.ensure_env.development_store_question'))
+      def write_env(env_data, org)
+        id = org['id']
+        app = get_app(id, org['apps'])
 
-        shop.gsub!(/https?\:\/\//, '')
+        env_data[:shop] = get_shop(org['stores'], id)
+        env_data[:api_key] = app["apiKey"]
+        env_data[:secret] = app["apiSecretKeys"].first["secret"]
+        env_data[:scopes] = 'write_products,write_customers,write_draft_orders' if env_data[:scopes].nil?
+        env_data[:extra] = {} if env_data[:extra].nil?
 
-        env = Resources::EnvFile.new(
-          api_key: api_key,
-          secret: api_secret,
-          shop: shop,
-          host: ShopifyCli::Tunnel.start(@ctx),
-          scopes: 'write_products,write_customers,write_draft_orders',
+        Resources::EnvFile.new(
+          env_data
         ).write(@ctx)
-        env
       end
     end
   end