zendesk_apps_support 4.41.0 → 4.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a867de06df6934328f28746767d50097a5d5b385c8da990d94a2daff49aa3c2d
-  data.tar.gz: d651c97273656fb230011b9e7acc31cc2cb4f655bd2277ff696f2097d1b100d1
+  metadata.gz: bb1263460bfbe9c194c8fda9e78daf072564bef7a21aedb306de03b559ce5421
+  data.tar.gz: ddabccda72e04ab33db2a26175ca262da66981b683b1a1c5160553d14b59ebfd
 SHA512:
-  metadata.gz: 561065d305edf5ca0d45479a0fd601aa095cd191b667ddabeb95ffacf1aee801287f82469ab1e72189bbb60cb6c25b1f2001ea567dc2833ee62e2d230fb367f8
-  data.tar.gz: 1836657e718f8eda2e38299ad23010e68e57c88fdfcd675673a4bbd5c353c67308e8538dc274637d00261bec45a248c2e5fd4988cf133509004e83f881cf2647
+  metadata.gz: 44bc5bd9f53ed9a6b3d7ddd41fa235056967e5cd53a6b8e6a12cd5cc27e69e4cf3314e8f2b318cc336d182295965aa14f54b29de8d923915b2aec4bc007ea8a3
+  data.tar.gz: faaa6f86ad8e7cf652853817570b8b56b3fc27121a8d6c6451b4c07492582432a7794929d2dbe9890639883a017628ea8eda1c0afda0dcecf114d2ad18f53fa8

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.
@@ -15,8 +15,23 @@ Very likely you want to try out your changes with the use of ZAT. See [ZAT](http
 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.
+* Put up a PR into the main branch.
+* CC and get two +1 from @zendesk/wattle.
+
+### Releasing a new version
+A new version is published to RubyGems.org every time a change to `version.rb` is pushed to the `main` branch.
+In short, follow these steps:
+1. Update `version.rb`,
+2. run `bundle lock` to update `Gemfile.lock`,
+3. merge this change into `main`, and
+4. look at [the action](https://github.com/zendesk/zendesk_apps_support/actions/workflows/publish.yml) for output.
+
+To create a pre-release from a non-main branch:
+1. change the version in `version.rb` to something like `1.2.0.pre.1` or `2.0.0.beta.2`,
+2. push this change to your branch,
+3. go to [Actions → “Publish to RubyGems.org” on GitHub](https://github.com/zendesk/zendesk_apps_support/actions/workflows/publish.yml),
+4. click the “Run workflow” button,
+5. pick your branch from a dropdown.
 
 ## 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

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"

data/lib/zendesk_apps_support/package.rb

@@ -31,9 +31,9 @@ module ZendeskAppsSupport
       @warnings = []
     end
 
-    def validate(marketplace: true, skip_marketplace_translations: false, apply_password_parameter_check: false)
+    def validate(marketplace: true, skip_marketplace_translations: false, error_on_password_parameter: false)
       errors = []
-      errors << Validations::Manifest.call(self, apply_password_parameter_check: apply_password_parameter_check)
+      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, apply_password_parameter_check: false)
-      errors = validate(marketplace: marketplace, skip_marketplace_translations: skip_marketplace_translations, apply_password_parameter_check: apply_password_parameter_check)
+    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, apply_password_parameter_check: false)
+        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, apply_password_parameter_check)
+          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, apply_password_parameter_check)
+        def collate_manifest_errors(package, error_on_password_parameter)
           manifest = package.manifest
 
           errors = [
@@ -50,7 +52,7 @@ module ZendeskAppsSupport
                 invalid_version_error(manifest) ]
             end,
             ban_no_template(manifest),
-            if apply_password_parameter_check
+            if error_on_password_parameter
              [ deprecate_password_parameter_type(manifest) ]
             end
           ]
@@ -449,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

data/lib/zendesk_apps_support/validations/secrets.rb

@@ -9,7 +9,7 @@ module ZendeskAppsSupport
       ].freeze
 
       APPLICATION_SECRETS = {
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         'Slack Token' => /(xox[p|b|o|a]-*.[a-z0-9])/,
         'RSA Private Key' => /-----BEGIN RSA PRIVATE KEY-----/,
         'SSH Private Key (OpenSSH)' => /-----BEGIN OPENSSH PRIVATE KEY-----/,
@@ -45,7 +45,7 @@ module ZendeskAppsSupport
         'Attachment Token Key' => /(attachment_token_key.*.[0-9a-f]{24,72})/,
         'Password' => /([pP][aA][sS][sS][wW][oO][rR][dD].*.[0-9a-zA-Z+_.-]{4,156})/,
         'Token' => /([tT][oO][kK][eE][nN]( [:\"=-]|[:\"=-]).*.[0-9a-zA-Z+_.-]{4,156})/
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
       }.freeze
 
       class << self

data/lib/zendesk_apps_support/validations/translations.rb

@@ -19,7 +19,7 @@ module ZendeskAppsSupport
             errors << locale_error(file, path_match[1]) << json_error(file) << format_error(file)
             next unless errors.compact.empty?
             if file.relative_path == 'translations/en.json'
-              # rubocop:disable Metrics/LineLength
+              # rubocop:disable Layout/LineLength
               errors.push(*validate_marketplace_content(file, package, opts.fetch(:skip_marketplace_translations, false)))
             end
           end.compact

data/lib/zendesk_apps_support/version.rb

@@ -0,0 +1,3 @@
+module ZendeskAppsSupport
+  VERSION = "4.43.0"
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_support
 version: !ruby/object:Gem::Version
-  version: 4.41.0
+  version: 4.43.0
 platform: ruby
 authors:
 - James A. Rosen
 - Likun Liu
 - Sean Caffery
 - Daniel Ribeiro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2025-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -233,16 +233,16 @@ dependencies:
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 9.0.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 9.0.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -334,11 +334,12 @@ files:
 - lib/zendesk_apps_support/validations/templates.rb
 - lib/zendesk_apps_support/validations/translations.rb
 - lib/zendesk_apps_support/validations/validation_error.rb
+- lib/zendesk_apps_support/version.rb
 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
@@ -346,15 +347,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Support to help you develop Zendesk Apps.
 test_files: []