zendesk_apps_support 4.40.0 → 4.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbb7abeb8f60d809e90a547a7dc7b21481c40044f53a4e0cc57be8024f09ccd3
-  data.tar.gz: ffcd6210fd4a37b282ba11e2ec716488e9e90dfd1e99b939054434c26ca42f40
+  metadata.gz: 4a4b57610d473248babf721ef9edd4adff8a6fb96aea6d3e323f3a6919d19f49
+  data.tar.gz: d2bc43a0736ebe9950423d77d5adba5549d83dab35671aae797d78233b7128ae
 SHA512:
-  metadata.gz: 556ebda9593531e22d67a452bbfc9f0e5cdbb30bb1512486f4c8401b516f70f80da87c50f78e113bf09c2baa1c2b124e6f5774a3444eec47d082dae87a404699
-  data.tar.gz: d0247a507c47584d6c14e5a531f551d5fffddc431c964cd1140085e373ee17bc8dbf8b7d269e92cc8c88568cada7aedb100e04f949796a2caaf7fed8de34688a
+  metadata.gz: bc6ab57adfa809e876b5fd03ade9fefd683a7d64fb65d4d44da6d03b4b1f5a4feacbfacf710b50281bbcaa890c91355742ece1e67384b4ce2d3569406ef24525
+  data.tar.gz: da3d8aceccf0e66f308718ecdc469e7d632ece824b578e6ec38b67e34ccb0577eeed3e7c35cba7068c9d5ce35ec8bd3184fa28054705470b17bcef4c7837c139

data/README.md

@@ -4,7 +4,7 @@
 Classes to manage and validate Zendesk Apps. This is a gem used in [Zendesk Apps Tools](https://github.com/zendesk/zendesk_apps_tools/).
 
 ## Owners
-This repo is owned and maintained by the Zendesk Apps team. You can reach us on vegemite@zendesk.com. We are located in Melbourne!
+This repo is owned and maintained by the Zendesk Apps team. You can reach us on wattle@zendesk.com. We are located in Melbourne!
 
 ## Getting Started
 When you want to help **develop** this tool, you will need to clone this repo.
@@ -16,7 +16,7 @@ This project uses Rspec, which can be run with `bundle exec rake`.
 
 ## Contribute
 * Put up a PR into the master branch.
-* CC and get two +1 from @zendesk/wattle, or @zendesk/vegemite.
+* CC and get two +1 from @zendesk/wattle.
 
 ## Bugs
 Bugs can be reported as an issue here on github, or submitted to support@zendesk.com. By mentioning this project it will assigned to the right team.

data/config/locales/en.yml

@@ -123,6 +123,8 @@ en:
                 for %{product}: %{missing_key}'
               products_do_not_match_manifest_products: Products in manifest (%{manifest_products})
                 do not match products in translations (%{translation_products})
+              password_parameter_deprecated: 'Password parameter type is deprecated and will not
+                be accepted in the future. Use Basic Access Authentication instead. Learn more: %{link}.'
               insecure_token_parameter_in_manifest: 'Make sure to set secure to true
                 when using keys in Settings. Learn more: %{link}'
               default_secure_or_hidden_parameter_in_manifest: Default values for secure
@@ -149,6 +151,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

@@ -354,6 +354,11 @@ parts:
       title: "Validation message to indicate missing secure(true) field in manifest's token parameter. Do not translate 'secure' and 'true'. Secure(true) in manifest refers to https://developer.zendesk.com/apps/docs/developer-guide/using_sdk#using-secure-settings"
       value: "Make sure to set secure to true when using keys in Settings. Learn more: %{link}"
       screenshot: "https://drive.google.com/open?id=1ss3nNN2RG29R7StjCtiH8qjuwFBlRApJ"
+  - translation:
+      key: "txt.apps.admin.error.app_build.translation.password_parameter_deprecated"
+      title: "Validation message to indicate deprecated password parameter is being used. Do not translate 'Password'."
+      value: "Password parameter type is deprecated and will not be accepted in the future. Use Basic Access Authentication instead. Learn more: %{link}."
+      screenshot: "https://drive.google.com/file/d/1S2cecD3h1pIoc5mpG-D966B0gHNlRvhz"
   - translation:
       key: "txt.apps.admin.error.app_build.translation.default_secure_or_hidden_parameter_in_manifest"
       title: "Validation message to indicate that a hidden or secure manifest parameter has a default value. Do not translate 'secure' and 'hidden'. Secure(true) in manifest refers to https://developer.zendesk.com/apps/docs/developer-guide/using_sdk#using-secure-settings"
@@ -415,3 +420,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, error_on_password_parameter: false)
       errors = []
-      errors << Validations::Manifest.call(self)
+      errors << Validations::Manifest.call(self, error_on_password_parameter: error_on_password_parameter)
 
       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, error_on_password_parameter: false)
+      errors = validate(marketplace: marketplace, skip_marketplace_translations: skip_marketplace_translations, error_on_password_parameter: error_on_password_parameter)
       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, error_on_password_parameter: 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,9 @@ module ZendeskAppsSupport
             return [ValidationError.new(:missing_manifest)]
           end
 
-          collate_manifest_errors(package)
+          package.warnings << password_parameter_warning unless error_on_password_parameter
+
+          collate_manifest_errors(package, error_on_password_parameter)
         rescue JSON::ParserError => e
           return [ValidationError.new(:manifest_not_json, errors: e)]
         rescue ZendeskAppsSupport::Manifest::OverrideError => e
@@ -31,7 +33,7 @@ module ZendeskAppsSupport
 
         private
 
-        def collate_manifest_errors(package)
+        def collate_manifest_errors(package, error_on_password_parameter)
           manifest = package.manifest
 
           errors = [
@@ -49,7 +51,10 @@ module ZendeskAppsSupport
                 missing_framework_version(manifest),
                 invalid_version_error(manifest) ]
             end,
-            ban_no_template(manifest)
+            ban_no_template(manifest),
+            if error_on_password_parameter
+             [ deprecate_password_parameter_type(manifest) ]
+            end
           ]
           errors.flatten.compact
         end
@@ -207,6 +212,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
@@ -439,6 +451,13 @@ module ZendeskAppsSupport
         rescue URI::InvalidURIError
           false
         end
+
+        def password_parameter_warning
+          I18n.t(
+            'txt.apps.admin.error.app_build.translation.password_parameter_deprecated',
+            link: 'https://developer.zendesk.com/documentation/apps/app-developer-guide/making-api-requests-from-a-zendesk-app/#using-basic-access-authentication'
+          )
+        end
       end
     end
   end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.40.0
+  version: 4.42.0
 platform: ruby
 authors:
 - James A. Rosen
 - Likun Liu
 - Sean Caffery
 - Daniel Ribeiro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2025-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -338,7 +338,7 @@ homepage: http://github.com/zendesk/zendesk_apps_support
 licenses:
 - Apache License Version 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -353,8 +353,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.
 test_files: []