shopify-cli 1.4.1 → 1.8.0

data/lib/shopify-cli/shopifolk.rb

@@ -5,24 +5,40 @@ module ShopifyCli
   # The Shopifolk Feature flag will persist between runs so if the flag is enabled or disabled,
   # it will still be in that same state until the next class invocation.
   class Shopifolk
-    GCLOUD_CONFIG_FILE = File.expand_path('~/.config/gcloud/configurations/config_default')
-    DEV_PATH = '/opt/dev'
-    SECTION = 'core'
-    FEATURE_NAME = 'shopifolk'
+    GCLOUD_CONFIG_FILE = File.expand_path("~/.config/gcloud/configurations/config_default")
+    DEV_PATH = "/opt/dev"
+    SECTION = "core"
+    FEATURE_NAME = "shopifolk"
 
-    ##
-    # will return if the user appears to be a Shopify employee, based on several heuristics
-    #
-    # #### Returns
-    #
-    # * `is_shopifolk` - returns true if the user is a Shopify Employee
-    #
-    # #### Example
-    #
-    #     ShopifyCli::Shopifolk.check
-    #
-    def self.check
-      ShopifyCli::Shopifolk.new.shopifolk?
+    class << self
+      attr_writer :acting_as_shopify_organization
+
+      ##
+      # will return if the user appears to be a Shopify employee, based on several heuristics
+      #
+      # #### Returns
+      #
+      # * `is_shopifolk` - returns true if the user is a Shopify Employee
+      #
+      # #### Example
+      #
+      #     ShopifyCli::Shopifolk.check
+      #
+      def check
+        ShopifyCli::Shopifolk.new.shopifolk?
+      end
+
+      def act_as_shopify_organization
+        @acting_as_shopify_organization = true
+      end
+
+      def acting_as_shopify_organization?
+        !!@acting_as_shopify_organization || (Project.has_current? && Project.current.config["shopify_organization"])
+      end
+
+      def reset
+        @acting_as_shopify_organization = nil
+      end
     end
 
     ##
@@ -35,6 +51,7 @@ module ShopifyCli
     #
     def shopifolk?
       return true if Feature.enabled?(FEATURE_NAME)
+
       if shopifolk_by_gcloud? && shopifolk_by_dev?
         ShopifyCli::Feature.enable(FEATURE_NAME)
         true
@@ -47,7 +64,7 @@ module ShopifyCli
     private
 
     def shopifolk_by_gcloud?
-      ini&.dig("[#{SECTION}]", 'account')&.match?(/@shopify.com\z/)
+      ini&.dig("[#{SECTION}]", "account")&.match?(/@shopify.com\z/)
     end
 
     def shopifolk_by_dev?

data/lib/shopify-cli/sub_command.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   class SubCommand < Command

data/lib/shopify-cli/task.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   class Task
@@ -6,5 +6,13 @@ module ShopifyCli
       task = new
       task.call(*args, **kwargs)
     end
+
+    private
+
+    def wants_to_run_against_shopify_org?
+      @ctx.puts(@ctx.message("core.tasks.select_org_and_shop.identified_as_shopify"))
+      message = @ctx.message("core.tasks.select_org_and_shop.first_party")
+      CLI::UI::Prompt.confirm(message, default: false)
+    end
   end
 end

data/lib/shopify-cli/tasks.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Tasks
@@ -30,11 +30,11 @@ module ShopifyCli
       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'
+    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/create_api_client.rb

@@ -1,15 +1,15 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Tasks
     class CreateApiClient < ShopifyCli::Task
       VALID_APP_TYPES = %w(public custom)
-      DEFAULT_APP_URL = 'https://shopify.github.io/shopify-app-cli/help/start-app/'
+      DEFAULT_APP_URL = "https://shopify.github.io/shopify-app-cli/help/start-app/"
 
       def call(ctx, org_id:, title:, type:)
         resp = ShopifyCli::PartnersAPI.query(
           ctx,
-          'create_app',
+          "create_app",
           org: org_id.to_i,
           title: title,
           type: type,
@@ -17,9 +17,18 @@ module ShopifyCli
           redir: [OAuth::REDIRECT_HOST]
         )
 
+        unless resp
+          ctx.abort("Error - empty response")
+        end
+
+        errors = resp.dig("errors")
+        if !errors.nil? && errors.any?
+          ctx.abort(errors.map { |err| "#{err["field"]} #{err["message"]}" }.join(", "))
+        end
+
         user_errors = resp.dig("data", "appCreate", "userErrors")
         if !user_errors.nil? && user_errors.any?
-          ctx.abort(user_errors.map { |err| "#{err['field']} #{err['message']}" }.join(", "))
+          ctx.abort(user_errors.map { |err| "#{err["field"]} #{err["message"]}" }.join(", "))
         end
 
         ShopifyCli::Core::Monorail.metadata[:api_key] = resp.dig("data", "appCreate", "app", "apiKey")

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

@@ -1,22 +1,22 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Tasks
     class EnsureDevStore < ShopifyCli::Task
       def call(ctx)
         @ctx = ctx
-        return ctx.puts(ctx.message(
-          'core.tasks.ensure_dev_store.could_not_verify_store', project.env.shop
+        return ctx.abort(ctx.message(
+          "core.tasks.ensure_dev_store.could_not_verify_store", project.env.shop
         )) if shop.nil?
-        return if shop['transferDisabled'] == true
+        return if shop["transferDisabled"] == true
         return unless CLI::UI::Prompt.confirm(
-          ctx.message('core.tasks.ensure_dev_store.convert_to_dev_store', project.env.shop)
+          ctx.message("core.tasks.ensure_dev_store.convert_to_dev_store", project.env.shop)
         )
-        ShopifyCli::PartnersAPI.query(ctx, 'convert_dev_to_test_store', input: {
-          organizationID: shop['orgID'].to_i,
-          shopId: shop['shopId'],
+        ShopifyCli::PartnersAPI.query(ctx, "convert_dev_to_test_store", input: {
+          organizationID: shop["orgID"].to_i,
+          shopId: shop["shopId"],
         })
-        ctx.puts(ctx.message('core.tasks.ensure_dev_store.transfer_disabled', project.env.shop))
+        ctx.puts(ctx.message("core.tasks.ensure_dev_store.transfer_disabled", project.env.shop))
       end
 
       private
@@ -29,9 +29,9 @@ module ShopifyCli
         @shop ||= begin
           current_domain = project.env.shop
           ShopifyCli::PartnersAPI::Organizations.fetch_all(@ctx).map do |org|
-            org['stores'].find do |store|
-              store['orgID'] = org['id']
-              store['shopDomain'] == current_domain
+            org["stores"].find do |store|
+              store["orgID"] = org["id"]
+              store["shopDomain"] == current_domain
             end
           end.compact.first
         end

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

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Tasks
@@ -22,14 +22,17 @@ module ShopifyCli
       private
 
       def fetch_org
+        if Shopifolk.check && wants_to_run_against_shopify_org?
+          Shopifolk.act_as_shopify_organization
+        end
         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|
+          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'])
+                @ctx.message("core.partners_api.org_name_and_id", org["businessName"], org["id"])
               ) { org["id"] }
             end
           end
@@ -41,15 +44,15 @@ module ShopifyCli
         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' }
+          @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|
+          CLI::UI::Prompt.ask(@ctx.message("core.tasks.ensure_env.app_select")) do |handler|
             apps.each { |app| handler.option(app["title"]) { app } }
           end
         end
@@ -59,9 +62,9 @@ module ShopifyCli
         if shops.count == 1
           shop = shops.first["shopDomain"]
         elsif shops.count == 0
-          @ctx.puts(@ctx.message('core.tasks.ensure_env.no_development_stores', id))
+          @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|
+          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
@@ -69,13 +72,13 @@ module ShopifyCli
       end
 
       def write_env(env_data, org)
-        id = org['id']
-        app = get_app(id, org['apps'])
+        id = org["id"]
+        app = get_app(id, org["apps"])
 
-        env_data[:shop] = get_shop(org['stores'], id)
+        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[:scopes] = "write_products,write_customers,write_draft_orders" if env_data[:scopes].nil?
         env_data[:extra] = {} if env_data[:extra].nil?
 
         Resources::EnvFile.new(

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

@@ -4,13 +4,13 @@ module ShopifyCli
       def call(ctx)
         @ctx = ctx
         api_key = Project.current.env.api_key
-        result = ShopifyCli::PartnersAPI.query(ctx, 'get_app_urls', apiKey: api_key)
+        result = ShopifyCli::PartnersAPI.query(ctx, "get_app_urls", apiKey: api_key)
         loopback = OAuth::REDIRECT_HOST
-        app = result['data']['app']
-        urls = app['redirectUrlWhitelist']
+        app = result["data"]["app"]
+        urls = app["redirectUrlWhitelist"]
         if urls.grep(/#{loopback}/).empty?
           with_loopback = urls.push(loopback)
-          ShopifyCli::PartnersAPI.query(@ctx, 'update_dashboard_urls', input: {
+          ShopifyCli::PartnersAPI.query(@ctx, "update_dashboard_urls", input: {
             redirectUrlWhitelist: with_loopback, apiKey: api_key
           })
         end

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

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   module Tasks
@@ -8,8 +8,13 @@ module ShopifyCli
       def call(ctx, organization_id: nil, shop_domain: nil)
         @ctx = ctx
         return response(organization_id.to_i, shop_domain) unless organization_id.nil? || shop_domain.nil?
+        if Shopifolk.check && wants_to_run_against_shopify_org?
+          Shopifolk.act_as_shopify_organization
+        end
         org = get_organization(organization_id)
-        shop_domain ||= get_shop_domain(org)
+        unless Shopifolk.acting_as_shopify_organization?
+          shop_domain ||= get_shop_domain(org)
+        end
         ShopifyCli::Core::Monorail.metadata[:organization_id] = org["id"].to_i
         response(org["id"].to_i, shop_domain)
       end
@@ -17,10 +22,9 @@ module ShopifyCli
       private
 
       def response(organization_id, shop_domain)
-        {
-          organization_id: organization_id,
-          shop_domain: shop_domain,
-        }
+        result = { organization_id: organization_id }
+        result[:shop_domain] = shop_domain if shop_domain
+        result
       end
 
       def organizations
@@ -31,45 +35,45 @@ module ShopifyCli
         @organization ||= if !organization_id.nil?
           org = ShopifyCli::PartnersAPI::Organizations.fetch(ctx, id: organization_id)
           if org.nil?
-            ctx.puts(ctx.message('core.tasks.select_org_and_shop.error.authentication_issue', ShopifyCli::TOOL_NAME))
-            ctx.abort(ctx.message('core.tasks.select_org_and_shop.error.organization_not_found'))
+            ctx.puts(ctx.message("core.tasks.select_org_and_shop.error.authentication_issue", ShopifyCli::TOOL_NAME))
+            ctx.abort(ctx.message("core.tasks.select_org_and_shop.error.organization_not_found"))
           end
           org
         elsif organizations.count == 0
-          ctx.puts(ctx.message('core.tasks.select_org_and_shop.error.partners_notice'))
-          ctx.puts(ctx.message('core.tasks.select_org_and_shop.authentication_issue', ShopifyCli::TOOL_NAME))
-          ctx.abort(ctx.message('core.tasks.select_org_and_shop.error.no_organizations'))
+          ctx.puts(ctx.message("core.tasks.select_org_and_shop.error.partners_notice"))
+          ctx.puts(ctx.message("core.tasks.select_org_and_shop.authentication_issue", ShopifyCli::TOOL_NAME))
+          ctx.abort(ctx.message("core.tasks.select_org_and_shop.error.no_organizations"))
         elsif organizations.count == 1
           org = organizations.first
-          ctx.puts(ctx.message('core.tasks.select_org_and_shop.organization', org['businessName'], org['id']))
+          ctx.puts(ctx.message("core.tasks.select_org_and_shop.organization", org["businessName"], org["id"]))
           org
         else
-          org_id = CLI::UI::Prompt.ask(ctx.message('core.tasks.select_org_and_shop.organization_select')) do |handler|
+          org_id = CLI::UI::Prompt.ask(ctx.message("core.tasks.select_org_and_shop.organization_select")) do |handler|
             organizations.each do |o|
-              handler.option(ctx.message('core.partners_api.org_name_and_id', o['businessName'], o['id'])) { o['id'] }
+              handler.option(ctx.message("core.partners_api.org_name_and_id", o["businessName"], o["id"])) { o["id"] }
             end
           end
-          organizations.find { |o| o['id'] == org_id }
+          organizations.find { |o| o["id"] == org_id }
         end
       end
 
       def get_shop_domain(organization)
-        valid_stores = organization['stores'].select do |store|
-          store['transferDisabled'] == true || store['convertableToPartnerTest'] == true
+        valid_stores = organization["stores"].select do |store|
+          store["transferDisabled"] == true || store["convertableToPartnerTest"] == true
         end
 
         if valid_stores.count == 0
-          ctx.puts(ctx.message('core.tasks.select_org_and_shop.error.no_development_stores'))
-          ctx.puts(ctx.message('core.tasks.select_org_and_shop.create_store', organization['id']))
-          ctx.puts(ctx.message('core.tasks.select_org_and_shop.authentication_issue', ShopifyCli::TOOL_NAME))
+          ctx.puts(ctx.message("core.tasks.select_org_and_shop.error.no_development_stores"))
+          ctx.puts(ctx.message("core.tasks.select_org_and_shop.create_store", organization["id"]))
+          ctx.puts(ctx.message("core.tasks.select_org_and_shop.authentication_issue", ShopifyCli::TOOL_NAME))
         elsif valid_stores.count == 1
-          domain = valid_stores.first['shopDomain']
-          ctx.puts(ctx.message('core.tasks.select_org_and_shop.development_store', domain))
+          domain = valid_stores.first["shopDomain"]
+          ctx.puts(ctx.message("core.tasks.select_org_and_shop.development_store", domain))
           domain
         else
           CLI::UI::Prompt.ask(
-            ctx.message('core.tasks.select_org_and_shop.development_store_select'),
-            options: valid_stores.map { |s| s['shopDomain'] }
+            ctx.message("core.tasks.select_org_and_shop.development_store_select"),
+            options: valid_stores.map { |s| s["shopDomain"] }
           )
         end
       end

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

@@ -7,24 +7,24 @@ module ShopifyCli
         @ctx = ctx
         project = ShopifyCli::Project.current
         api_key = project.env.api_key
-        result = ShopifyCli::PartnersAPI.query(ctx, 'get_app_urls', apiKey: api_key)
-        app = result['data']['app']
-        consent = check_application_url(app['applicationUrl'], url)
-        constructed_urls = construct_redirect_urls(app['redirectUrlWhitelist'], url, callback_url)
-        return if url == app['applicationUrl']
-        ShopifyCli::PartnersAPI.query(@ctx, 'update_dashboard_urls', input: {
-          applicationUrl: consent ? url : app['applicationUrl'],
+        result = ShopifyCli::PartnersAPI.query(ctx, "get_app_urls", apiKey: api_key)
+        app = result["data"]["app"]
+        consent = check_application_url(app["applicationUrl"], url)
+        constructed_urls = construct_redirect_urls(app["redirectUrlWhitelist"], url, callback_url)
+        return if url == app["applicationUrl"]
+        ShopifyCli::PartnersAPI.query(@ctx, "update_dashboard_urls", input: {
+          applicationUrl: consent ? url : app["applicationUrl"],
           redirectUrlWhitelist: constructed_urls, apiKey: api_key
         })
-        @ctx.puts(@ctx.message('core.tasks.update_dashboard_urls.updated'))
+        @ctx.puts(@ctx.message("core.tasks.update_dashboard_urls.updated"))
       rescue
-        @ctx.puts(@ctx.message('core.tasks.update_dashboard_urls.update_error', ShopifyCli::TOOL_NAME))
+        @ctx.puts(@ctx.message("core.tasks.update_dashboard_urls.update_error", ShopifyCli::TOOL_NAME))
         raise
       end
 
       def check_application_url(application_url, new_url)
         return false if application_url.match(new_url)
-        CLI::UI::Prompt.confirm(@ctx.message('core.tasks.update_dashboard_urls.update_prompt'))
+        CLI::UI::Prompt.confirm(@ctx.message("core.tasks.update_dashboard_urls.update_prompt"))
       end
 
       def construct_redirect_urls(urls, new_url, callback_url)

data/lib/shopify-cli/transform_data_structure.rb

@@ -0,0 +1,86 @@
+
+module ShopifyCli
+  ##
+  # `TransformDataStructure` helps to standardize data structure access. It
+  # traverses nested data structures and can convert
+  #
+  # * all strings used as keys to symbols,
+  # * all strings used as keys from `CamelCase` to `snake_case` and
+  # * associative array containers, e.g. from Hash to OpenStruct.
+  #
+  # Standardizing how a data structure is accessed greatly reduces the risk
+  # of subtle bugs especially when dealing with API responses.
+  #
+  #    TransformDataStructure.new(
+  #      symbolize_keys: true,
+  #      underscore_keys: true,
+  #      associative_array_container: OpenStruct
+  #    ).call([{"SomeKey" => "value"}]).tap do |result|
+  #      result.value # => [#<OpenStruct: some_key: "value">]
+  #    end
+  #
+  # Since `TransformDataStructure` is a method object, it can easily be chained:
+  #
+  #    require 'open-uri'
+  #    ShopifyCli::Result
+  #      .call { open("https://jsonplaceholder.typicode.com/todos/1") }
+  #      .map(&TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
+  #      .value # => { id: 1, user_id: 1, ... }
+  #
+  class TransformDataStructure
+    include ShopifyCli::MethodObject
+
+    class << self
+      private
+
+      def valid_associative_array_container(klass)
+        klass.respond_to?(:new) && klass.method_defined?(:[]=)
+      end
+    end
+
+    property! :underscore_keys, accepts: [true, false], default: false, reader: :underscore_keys?
+    property! :symbolize_keys, accepts: [true, false], default: false, reader: :symbolize_keys?
+    property! :associative_array_container,
+      accepts: ->(c) { c.respond_to?(:new) && c.method_defined?(:[]=) },
+      default: Hash
+
+    def call(object)
+      case object
+      when Array
+        object.map(&self).map(&:value)
+      when Hash
+        object.each.with_object(associative_array_container.new) do |(key, value), result|
+          result[transform_key(key)] = call(value).value
+        end
+      else
+        ShopifyCli::Result.success(object)
+      end
+    end
+
+    private
+
+    def transform_key(key)
+      key
+        .yield_self(&method(:underscore_key))
+        .yield_self(&method(:symbolize_key))
+    end
+
+    def underscore_key(key)
+      return key unless underscore_keys? && key.respond_to?(:to_str)
+
+      key.to_str.dup.tap do |k|
+        k.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        k.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        k.tr!("-", "_")
+        k.gsub!(/\s/, "_")
+        k.gsub!(/__+/, "_")
+        k.downcase!
+      end
+    end
+
+    def symbolize_key(key)
+      return key unless symbolize_keys? && key.respond_to?(:to_sym)
+      key.to_sym
+    end
+  end
+end