zendesk_apps_support 4.40.0 → 4.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbb7abeb8f60d809e90a547a7dc7b21481c40044f53a4e0cc57be8024f09ccd3
-  data.tar.gz: ffcd6210fd4a37b282ba11e2ec716488e9e90dfd1e99b939054434c26ca42f40
+  metadata.gz: a867de06df6934328f28746767d50097a5d5b385c8da990d94a2daff49aa3c2d
+  data.tar.gz: d651c97273656fb230011b9e7acc31cc2cb4f655bd2277ff696f2097d1b100d1
 SHA512:
-  metadata.gz: 556ebda9593531e22d67a452bbfc9f0e5cdbb30bb1512486f4c8401b516f70f80da87c50f78e113bf09c2baa1c2b124e6f5774a3444eec47d082dae87a404699
-  data.tar.gz: d0247a507c47584d6c14e5a531f551d5fffddc431c964cd1140085e373ee17bc8dbf8b7d269e92cc8c88568cada7aedb100e04f949796a2caaf7fed8de34688a
+  metadata.gz: 561065d305edf5ca0d45479a0fd601aa095cd191b667ddabeb95ffacf1aee801287f82469ab1e72189bbb60cb6c25b1f2001ea567dc2833ee62e2d230fb367f8
+  data.tar.gz: 1836657e718f8eda2e38299ad23010e68e57c88fdfcd675673a4bbd5c353c67308e8538dc274637d00261bec45a248c2e5fd4988cf133509004e83f881cf2647

data/config/locales/en.yml

@@ -149,6 +149,8 @@ en:
             oauth_parameter_cannot_be_secure: oauth parameter cannot be set to be
               secure.
             invalid_url: '%{field} must be a valid URL, got "%{value}".'
+            password_parameter_type_deprecated: 'Password parameter type can no longer
+              be used. Use Secure settings instead. Learn more: %{link}.'
         warning:
           app_build:
             deprecated_version: You are targeting a deprecated version of the framework.

data/config/locales/translations/zendesk_apps_support.yml

@@ -415,3 +415,7 @@ parts:
       key: "txt.apps.admin.error.app_build.invalid_url"
       title: "App builder job: this value needs to be a valid URL, but something else was passed in. placeholder value is taken from user input. You can translate as: The value %{field} must be a valid URL... to avoid any gender issues."
       value: "%{field} must be a valid URL, got \"%{value}\"."
+  - translation:
+      key: "txt.apps.admin.error.app_build.password_parameter_type_deprecated"
+      title: "App builder job: Password parameter type is deprecated"
+      value: "Password parameter type can no longer be used. Use Secure settings instead. Learn more: %{link}."

data/lib/zendesk_apps_support/package.rb

@@ -31,9 +31,9 @@ module ZendeskAppsSupport
       @warnings = []
     end
 
-    def validate(marketplace: true, skip_marketplace_translations: false)
+    def validate(marketplace: true, skip_marketplace_translations: false, apply_password_parameter_check: false)
       errors = []
-      errors << Validations::Manifest.call(self)
+      errors << Validations::Manifest.call(self, apply_password_parameter_check: apply_password_parameter_check)
 
       if has_valid_manifest?(errors)
         errors << Validations::Marketplace.call(self) if marketplace
@@ -61,8 +61,8 @@ module ZendeskAppsSupport
       errors.flatten.compact
     end
 
-    def validate!(marketplace: true, skip_marketplace_translations: false)
-      errors = validate(marketplace: marketplace, skip_marketplace_translations: skip_marketplace_translations)
+    def validate!(marketplace: true, skip_marketplace_translations: false, apply_password_parameter_check: false)
+      errors = validate(marketplace: marketplace, skip_marketplace_translations: skip_marketplace_translations, apply_password_parameter_check: apply_password_parameter_check)
       raise errors.first if errors.any?
       true
     end

data/lib/zendesk_apps_support/validations/manifest.rb

@@ -13,7 +13,7 @@ module ZendeskAppsSupport
       OAUTH_MANIFEST_LINK = 'https://developer.zendesk.com/apps/docs/developer-guide/manifest#oauth'
 
       class << self
-        def call(package)
+        def call(package, apply_password_parameter_check: false)
           unless package.has_file?('manifest.json')
             nested_manifest = package.files.find { |file| file =~ %r{\A[^/]+?/manifest\.json\Z} }
             if nested_manifest
@@ -22,7 +22,7 @@ module ZendeskAppsSupport
             return [ValidationError.new(:missing_manifest)]
           end
 
-          collate_manifest_errors(package)
+          collate_manifest_errors(package, apply_password_parameter_check)
         rescue JSON::ParserError => e
           return [ValidationError.new(:manifest_not_json, errors: e)]
         rescue ZendeskAppsSupport::Manifest::OverrideError => e
@@ -31,7 +31,7 @@ module ZendeskAppsSupport
 
         private
 
-        def collate_manifest_errors(package)
+        def collate_manifest_errors(package, apply_password_parameter_check)
           manifest = package.manifest
 
           errors = [
@@ -49,7 +49,10 @@ module ZendeskAppsSupport
                 missing_framework_version(manifest),
                 invalid_version_error(manifest) ]
             end,
-            ban_no_template(manifest)
+            ban_no_template(manifest),
+            if apply_password_parameter_check
+             [ deprecate_password_parameter_type(manifest) ]
+            end
           ]
           errors.flatten.compact
         end
@@ -207,6 +210,13 @@ module ZendeskAppsSupport
           ValidationError.new(:no_framework_version_required) unless manifest.framework_version.nil?
         end
 
+        def deprecate_password_parameter_type(manifest)
+          secure_settings_link = 'https://developer.zendesk.com/documentation/apps/app-developer-guide/making-api-requests-from-a-zendesk-app/#using-secure-settings'
+          if manifest.parameters.any? { |p| p.type == 'password' }
+            ValidationError.new(:password_parameter_type_deprecated, link: secure_settings_link)
+          end
+        end
+
         def private_marketing_app_error(manifest)
           ValidationError.new(:marketing_only_app_cant_be_private) if manifest.private?
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.40.0
+  version: 4.41.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -353,7 +353,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.