ruby_aem 3.17.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8b67651bb5d91c7c47fbf2c7e72ca001e1284a2d
-  data.tar.gz: d01102a6a5a9c5c9093a5f79dd8cd60e4719a30f
+SHA256:
+  metadata.gz: 364f15252d0e15d5109deb5162c2e68a064436f754fda9839ad0bee7d69a4dbd
+  data.tar.gz: bb40460d828167a6b44b3bb921a3cc79621ca063f498a180a9a5b269cc243031
 SHA512:
-  metadata.gz: f7b35781431f722c4ce220d7a265fc6f3252bde5b5bffdf4540aa6c1e249134298a2cdc5f363a67013075fe36728c6e863c5ec801e2f12878d0cfafe8fbc4a53
-  data.tar.gz: 524b7b9cee894e54bf1cac8d4264fec340483470f0fa48531492fe99a52ef50ed34adb95f84c5d865e918a791657c6196f63cb5682c5e5b7b5b24cc21f92f7e5
+  metadata.gz: dfab4aa798fbed53e5fe4b705324db3ba770b1d7b673b6e9508c59d7481fe59d2493ea22c49b6dfd17959062491d6c7693722de6f333f382ac38f833f0847d0c
+  data.tar.gz: 394b101dad00b640afb6d207ef0d5e6666b72fc9f1c891b30a2fccdd2a39603b41e3011640eaf3cc872ed61becd07c4dc9eb5f2e9b7f80a1a31e3dcdbf5fbc1e

data/conf/gem.yaml

@@ -1 +1,2 @@
-version: 3.17.0
+---
+version: 4.1.0

data/conf/spec.yaml

@@ -1,3 +1,13 @@
+---
+# Message, path and URI templates are kept on one line, wrapping them risks
+# changing their parsed values.
+# yamllint disable rule:line-length
+
+# Optional param names must match the opts keys of the swagger_aem / swagger_aem_osgi
+# generated *_api.rb methods exactly, unknown keys are silently ignored by the client.
+# e.g. swagger_aem 4.0.0 renamed jcrcontent_* to jcr_content_*, reppassword to rep_password,
+# and operation to _operation (plain :operation is overwritten by the generated client).
+# test/unit/spec_yaml_spec.rb checks these names against the installed gems.
 aem:
   actions:
     get_login_page:
@@ -16,7 +26,7 @@ aem:
         required:
         optional:
           tags: '%{tags}'
-          combinetagsor: '%{combine_tags_or}'
+          combine_tags_or: '%{combine_tags_or}'
       responses:
         200:
           handler: json_aem_health_check
@@ -102,7 +112,7 @@ authorizablekeystore:
         optional:
           new_password: '%{password}'
           re_password: '%{password}'
-          operation: createStore
+          _operation: createStore
       responses:
         200:
           handler: simple
@@ -164,7 +174,7 @@ authorizablekeystore:
           path: '%{intermediate_path}/%{authorizable_id}/keystore'
           name: store.p12
         optional:
-          operation: delete
+          _operation: delete
       responses:
         200:
           handler: simple
@@ -348,28 +358,29 @@ flushagent:
           runmode: '%{run_mode}'
           name: '%{name}'
         optional:
-          jcrprimary_type: cq:Page
-          jcrcontent_cqname: '%{name}'
-          jcrcontent_jcrtitle: '%{title}'
-          jcrcontent_jcrdescription: '%{description}'
-          jcrcontent_slingresource_type: cq/replication/components/agent
-          jcrcontent_transport_uri: '%{dest_base_url}/dispatcher/invalidate.cache'
-          jcrcontent_log_level: '%{log_level}'
-          jcrcontent_no_versioning: true
-          jcrcontent_protocol_http_headers:
+          jcr_primary_type: cq:Page
+          jcr_content_cq_name: '%{name}'
+          jcr_content_jcr_title: '%{title}'
+          jcr_content_jcr_description: '%{description}'
+          jcr_content_sling_resource_type: cq/replication/components/agent
+          jcr_content_transport_uri: '%{dest_base_url}/dispatcher/invalidate.cache'
+          jcr_content_alias_update: '%{alias_update}'
+          jcr_content_log_level: '%{log_level}'
+          jcr_content_no_versioning: true
+          jcr_content_protocol_http_headers:
             - 'CQ-Action:{action}'
             - 'CQ-Handle:{path}'
             - 'CQ-Path:{path}'
-          jcrcontent_protocol_http_headers_type_hint: String[]
-          jcrcontent_protocol_http_method: GET
-          jcrcontent_retry_delay: '%{retry_delay}'
-          jcrcontent_serialization_type: flush
-          jcrcontent_jcrmixin_types: cq:ReplicationStatus
-          jcrcontent_trigger_receive: true
-          jcrcontent_trigger_specific: true
-          jcrcontent_cqtemplate: /libs/cq/replication/templates/agent
-          jcrcontent_enabled: true
-          jcrcontent_ssl: '%{ssl}'
+          jcr_content_protocol_http_headers_type_hint: String[]
+          jcr_content_protocol_http_method: GET
+          jcr_content_retry_delay: '%{retry_delay}'
+          jcr_content_serialization_type: flush
+          jcr_content_jcr_mixin_types: cq:ReplicationStatus
+          jcr_content_trigger_receive: true
+          jcr_content_trigger_specific: true
+          jcr_content_cq_template: /libs/cq/replication/templates/agent
+          jcr_content_enabled: true
+          jcr_content_ssl: '%{ssl}'
       responses:
         200:
           handler: simple
@@ -385,7 +396,7 @@ flushagent:
           runmode: '%{run_mode}'
           name: '%{name}'
         optional:
-          operation: delete
+          _operation: delete
       responses:
         200:
           handler: simple
@@ -521,7 +532,7 @@ node:
       params:
         required:
           path: '%{path}'
-          jcrprimary_type: '%{type}'
+          jcr_primary_type: '%{type}'
           name: '%{name}'
       responses:
         201:
@@ -535,7 +546,7 @@ node:
           path: '%{path}'
           name: '%{name}'
         optional:
-          operation: delete
+          _operation: delete
       responses:
         200:
           handler: simple
@@ -573,7 +584,7 @@ package:
           group_name: '%{group_name}'
           package_name: '%{package_name}'
           package_version: '%{package_version}'
-          charset: utf-8
+          _charset_: utf-8
       responses:
         200:
           handler: json_package_service
@@ -590,7 +601,7 @@ package:
           path: '/etc/packages/%{group_name}/%{package_name}-%{package_version}.zip'
         optional:
           filter: '%{filter}'
-          charset: utf-8
+          _charset_: utf-8
       responses:
         200:
           handler: json_package_service
@@ -719,7 +730,7 @@ path:
           path: '%{path}'
           name: '%{name}'
         optional:
-          operation: delete
+          _operation: delete
       responses:
         200:
           handler: simple
@@ -747,6 +758,8 @@ configproperty:
         201:
           handler: simple
           message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
+    # TODO: remove the create<config> actions below, unused since a170df6 (2020, #31) when
+    # ConfigProperty#create switched to the generic create action (postConfigProperty)
     createapachefelixjettybasedhttpservice:
       api: sling
       operation: postConfigApacheFelixJettyBasedHttpService
@@ -764,7 +777,10 @@ configproperty:
           - org_apache_felix_https_keystore_key_password
           - org_apache_felix_https_keystore_key_password_type_hint
           - org_apache_felix_https_truststore
-          - org_apache_felix_https_truststore_key_type_hint
+          # org.apache.felix.https.truststore@TypeHint, read as org_apache_felix_https_truststore_type_hint:
+          # https://github.com/shinesolutions/swagger-aem/blob/4.0.0/specification/swagger-aem.yml#L257
+          # https://github.com/shinesolutions/swagger-aem/blob/4.0.0/clients/ruby/generated/lib/swagger_aem/api/sling_api.rb#L1457
+          - org_apache_felix_https_truststore_type_hint
           - org_apache_felix_https_truststore_password
           - org_apache_felix_https_truststore_password_type_hint
           - org_apache_felix_https_clientcertificate
@@ -773,8 +789,11 @@ configproperty:
           - org_apache_felix_https_enable_type_hint
           - org_osgi_service_http_port_secure
           - org_osgi_service_http_port_secure_type_hint
-          - json_maximumresults
-          - json_maximumresults_type_hint
+          # json_maximumresults and json_maximumresults_type_hint were removed from this action:
+          # postConfigApacheFelixJettyBasedHttpService has no json.maximumresults parameter in any
+          # swagger_aem release (1.0.0 to 4.0.0), so they were never sent. They were copied from the
+          # Sling GET servlet action in ruby_aem a626c5d (2017) and stay on createapacheslinggetservlet.
+          # https://github.com/shinesolutions/swagger-aem/blob/4.0.0/specification/swagger-aem.yml#L198-L306
       responses:
         200:
           handler: simple
@@ -788,6 +807,9 @@ configproperty:
       params:
         required:
         optional:
+          # json.maximumresults and json.maximumresults@TypeHint:
+          # https://github.com/shinesolutions/swagger-aem/blob/4.0.0/specification/swagger-aem.yml#L311-L320
+          # https://github.com/shinesolutions/swagger-aem/blob/4.0.0/clients/ruby/generated/lib/swagger_aem/api/sling_api.rb#L1683-L1684
           - json_maximumresults
           - json_maximumresults_type_hint
           - enable_html
@@ -919,7 +941,10 @@ configproperty:
           - name_id_format
           - name_id_format_type_hint
           - digest_method
-          - digestMethod_type_hint
+          # digestMethod@TypeHint, read as digest_method_type_hint:
+          # https://github.com/shinesolutions/swagger-aem/blob/4.0.0/specification/swagger-aem.yml#L1517
+          # https://github.com/shinesolutions/swagger-aem/blob/4.0.0/clients/ruby/generated/lib/swagger_aem/api/sling_api.rb#L1350
+          - digest_method_type_hint
           - signature_method
           - signature_method_type_hint
           - user_intermediate_path
@@ -970,20 +995,20 @@ replicationagent:
           runmode: '%{run_mode}'
           name: '%{name}'
         optional:
-          jcrprimary_type: cq:Page
-          jcrcontent_cqname: '%{name}'
-          jcrcontent_jcrtitle: '%{title}'
-          jcrcontent_jcrdescription: '%{description}'
-          jcrcontent_slingresource_type: cq/replication/components/agent
-          jcrcontent_serialization_type: durbo
-          jcrcontent_transport_uri: '%{dest_base_url}/bin/receive?sling:authRequestLogin=1'
-          jcrcontent_transport_user: '%{transport_user}'
-          jcrcontent_transport_password: '%{transport_password}'
-          jcrcontent_log_level: '%{log_level}'
-          jcrcontent_retry_delay: '%{retry_delay}'
-          jcrcontent_cqtemplate: /libs/cq/replication/templates/agent
-          jcrcontent_enabled: true
-          jcrcontent_ssl: '%{ssl}'
+          jcr_primary_type: cq:Page
+          jcr_content_cq_name: '%{name}'
+          jcr_content_jcr_title: '%{title}'
+          jcr_content_jcr_description: '%{description}'
+          jcr_content_sling_resource_type: cq/replication/components/agent
+          jcr_content_serialization_type: durbo
+          jcr_content_transport_uri: '%{dest_base_url}/bin/receive?sling:authRequestLogin=1'
+          jcr_content_transport_user: '%{transport_user}'
+          jcr_content_transport_password: '%{transport_password}'
+          jcr_content_log_level: '%{log_level}'
+          jcr_content_retry_delay: '%{retry_delay}'
+          jcr_content_cq_template: /libs/cq/replication/templates/agent
+          jcr_content_enabled: true
+          jcr_content_ssl: '%{ssl}'
       responses:
         200:
           handler: simple
@@ -999,7 +1024,7 @@ replicationagent:
           runmode: '%{run_mode}'
           name: '%{name}'
         optional:
-          operation: delete
+          _operation: delete
       responses:
         200:
           handler: simple
@@ -1041,20 +1066,20 @@ outboxreplicationagent:
           runmode: '%{run_mode}'
           name: '%{name}'
         optional:
-          jcrprimary_type: cq:Page
-          jcrcontent_cqname: '%{name}'
-          jcrcontent_jcrtitle: '%{title}'
-          jcrcontent_jcrdescription: '%{description}'
-          jcrcontent_slingresource_type: cq/replication/components/agent
-          jcrcontent_transport_uri: repo://var/replication/outbox
-          jcrcontent_no_versioning: true
-          jcrcontent_log_level: '%{log_level}'
-          jcrcontent_cqtemplate: /libs/cq/replication/templates/agent
-          jcrcontent_enabled: true
-          jcrcontent_trigger_distribute: true
-          jcrcontent_trigger_modified: false
-          jcrcontent_trigger_specific: true
-          jcrcontent_user_id: '%{user_id}'
+          jcr_primary_type: cq:Page
+          jcr_content_cq_name: '%{name}'
+          jcr_content_jcr_title: '%{title}'
+          jcr_content_jcr_description: '%{description}'
+          jcr_content_sling_resource_type: cq/replication/components/agent
+          jcr_content_transport_uri: repo://var/replication/outbox
+          jcr_content_no_versioning: true
+          jcr_content_log_level: '%{log_level}'
+          jcr_content_cq_template: /libs/cq/replication/templates/agent
+          jcr_content_enabled: true
+          jcr_content_trigger_distribute: true
+          jcr_content_trigger_modified: false
+          jcr_content_trigger_specific: true
+          jcr_content_user_id: '%{user_id}'
       responses:
         200:
           handler: simple
@@ -1070,7 +1095,7 @@ outboxreplicationagent:
           runmode: '%{run_mode}'
           name: '%{name}'
         optional:
-          operation: delete
+          _operation: delete
       responses:
         200:
           handler: simple
@@ -1112,20 +1137,20 @@ reversereplicationagent:
           runmode: '%{run_mode}'
           name: '%{name}'
         optional:
-          jcrprimary_type: cq:Page
-          jcrcontent_cqname: '%{name}'
-          jcrcontent_jcrtitle: '%{title}'
-          jcrcontent_jcrdescription: '%{description}'
-          jcrcontent_slingresource_type: cq/replication/components/agent
-          jcrcontent_serialization_type: durbo
-          jcrcontent_transport_uri: '%{dest_base_url}/bin/receive?sling:authRequestLogin=1'
-          jcrcontent_transport_user: '%{transport_user}'
-          jcrcontent_transport_password: '%{transport_password}'
-          jcrcontent_log_level: '%{log_level}'
-          jcrcontent_retry_delay: '%{retry_delay}'
-          jcrcontent_cqtemplate: /libs/cq/replication/templates/agent
-          jcrcontent_enabled: true
-          jcrcontent_reverse_replication: true
+          jcr_primary_type: cq:Page
+          jcr_content_cq_name: '%{name}'
+          jcr_content_jcr_title: '%{title}'
+          jcr_content_jcr_description: '%{description}'
+          jcr_content_sling_resource_type: cq/replication/components/agent
+          jcr_content_serialization_type: durbo
+          jcr_content_transport_uri: '%{dest_base_url}/bin/receive?sling:authRequestLogin=1'
+          jcr_content_transport_user: '%{transport_user}'
+          jcr_content_transport_password: '%{transport_password}'
+          jcr_content_log_level: '%{log_level}'
+          jcr_content_retry_delay: '%{retry_delay}'
+          jcr_content_cq_template: /libs/cq/replication/templates/agent
+          jcr_content_enabled: true
+          jcr_content_reverse_replication: true
       responses:
         200:
           handler: simple
@@ -1141,7 +1166,7 @@ reversereplicationagent:
           runmode: '%{run_mode}'
           name: '%{name}'
         optional:
-          operation: delete
+          _operation: delete
       responses:
         200:
           handler: simple
@@ -1269,7 +1294,7 @@ truststore:
         optional:
           new_password: '%{password}'
           re_password: '%{password}'
-          operation: createStore
+          _operation: createStore
       responses:
         200:
           handler: simple
@@ -1307,7 +1332,7 @@ truststore:
           path: etc/truststore
           name: truststore.p12
         optional:
-          operation: delete
+          _operation: delete
       responses:
         200:
           handler: simple
@@ -1354,7 +1379,7 @@ user:
           intermediate_path: '%{path}'
         optional:
           create_user: 'true'
-          reppassword: '%{password}'
+          rep_password: '%{password}'
       responses:
         201:
           handler: html_authorizable_id

data/lib/ruby_aem/client.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -73,9 +73,7 @@ module RubyAem
         method = RubyAem::Swagger.operation_to_method(operation)
         data, status_code, headers = api.send("#{method}_with_http_info", *params)
         response = RubyAem::Response.new(status_code, data, headers)
-      rescue SwaggerAemClient::ApiError => e
-        response = RubyAem::Response.new(e.code, e.response_body, e.response_headers)
-      rescue SwaggerAemOsgiClient::ApiError => e
+      rescue SwaggerAemClient::ApiError, SwaggerAemOsgiClient::ApiError => e
         response = RubyAem::Response.new(e.code, e.response_body, e.response_headers)
       end
       handle(response, responses_spec, call_params)
@@ -94,7 +92,7 @@ module RubyAem
         params[-1][key.to_sym] = call_params[key.to_sym] if call_params.key? key.to_sym
       # if value is provided in optional param spec,
       # then apply variable interpolation the same way as required param
-      elsif value.class == String
+      elsif value.instance_of?(String)
         case value
         when '__FILE_PACKAGE__'
           file_path = "#{call_params[:file_path]}/#{call_params[:package_name]}-#{call_params[:package_version]}.zip"
@@ -106,12 +104,12 @@ module RubyAem
           file_path = call_params[:file_path_private_key]
         end
 
-        if !file_path.nil?
+        if file_path.nil?
+          params[-1][key.to_sym] = value % call_params
+        else
           File.open(file_path.to_s, 'r') { |file|
             params[-1][key.to_sym] = file
           }
-        else
-          params[-1][key.to_sym] = value % call_params
         end
       else
         params[-1][key.to_sym] = value

data/lib/ruby_aem/error.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,6 +18,11 @@ module RubyAem
   class Error < StandardError
     attr_accessor :result
 
+    # Initialise an error.
+    #
+    # @param message error message
+    # @param result RubyAem::Result
+    # @return new RubyAem::Error instance
     def initialize(message, result)
       super(message)
       self.result = result

data/lib/ruby_aem/handlers/file.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/handlers/html.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@ module RubyAem
   # dependency.
   module Handlers
     include REXML
+
     # Parse authorizable ID from response body data.
     # This is used to get the authorizable ID of a newly created user/group.
     #
@@ -108,6 +109,7 @@ module RubyAem
     # @param html HTML response body string
     # @param regex Ruby regular expression, all regex matches will be replaced
     # @param replacement all existence of the regex will be replaced with this string
+    # @return sanitised HTML string
     def self._sanitise_html(html, regex, replacement)
       if regex.match?(html)
         html.gsub!(regex, replacement)

data/lib/ruby_aem/handlers/json.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -144,8 +144,8 @@ module RubyAem
       result
     end
 
-    # Authorizable keystore payload handler, checks for the existence of certificate within
-    # AEM Truststore, identified by cert_alias call parameter.
+    # Authorizable keystore payload handler, checks for the existence of certificate chain within
+    # AEM Authorizable Keystore, identified by private_key_alias call parameter.
     #
     # @param response HTTP response containing status_code, body, and headers
     # @param response_spec response specification as configured in conf/spec.yaml

data/lib/ruby_aem/handlers/simple.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/handlers/xml.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/aem.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -28,8 +28,7 @@ module RubyAem
       # @return new RubyAem::Resources::Aem instance
       def initialize(client)
         @client = client
-        @call_params = {
-        }
+        @call_params = {}
       end
 
       # Retrieve AEM login page.
@@ -96,11 +95,11 @@ module RubyAem
         with_retries(max_tries: opts[:_retries][:max_tries], base_sleep_seconds: opts[:_retries][:base_sleep_seconds], max_sleep_seconds: opts[:_retries][:max_sleep_seconds]) { |retries_count|
           begin
             result = get_login_page
-            if result.response.body !~ /QUICKSTART_HOMEPAGE/
+            if result.response.body =~ /QUICKSTART_HOMEPAGE/
+              puts format('Retrieve login page attempt #%<retries_count>d: %<message>s and ready', retries_count: retries_count, message: result.message)
+            else
               puts format('Retrieve login page attempt #%<retries_count>d: %<message>s but not ready yet', retries_count: retries_count, message: result.message)
               raise StandardError.new(result.message)
-            else
-              puts format('Retrieve login page attempt #%<retries_count>d: %<message>s and ready', retries_count: retries_count, message: result.message)
             end
           rescue RubyAem::Error => e
             puts format('Retrieve login page attempt #%<retries_count>d: %<message>s', retries_count: retries_count, message: e.message)

data/lib/ruby_aem/resources/aem_configmgr.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,11 +23,10 @@ module RubyAem
       # Initialise an AEM instance.
       #
       # @param client RubyAem::Client
-      # @return new RubyAem::Resources::Aem instance
+      # @return new RubyAem::Resources::AemConfigMgr instance
       def initialize(client)
         @client = client
-        @call_params = {
-        }
+        @call_params = {}
       end
 
       # Connect to AEM /system/console/configMgr to collect

data/lib/ruby_aem/resources/authorizable_keystore.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@ module RubyAem
       # @param client RubyAem::Client
       # @param intermediate_path AEM User home path
       # @param authorizable_id AEM User id
-      # @return new RubyAem::Resources::AuhtorizableKeystore instance
+      # @return new RubyAem::Resources::AuthorizableKeystore instance
       def initialize(client, intermediate_path, authorizable_id)
         @client = client
         @call_params = {
@@ -50,7 +50,6 @@ module RubyAem
       #
       # @param old_password Current password for the authorizable keystore
       # @param new_password New password for the authorizable keystore
-
       # @return RubyAem::Result
       def change_password(old_password, new_password)
         @call_params[:old_password] = old_password

data/lib/ruby_aem/resources/bundle.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/certificate.rb

@@ -105,6 +105,10 @@ module RubyAem
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
+      # Retrieve the alias of the certificate from AEM Truststore info,
+      # the certificate is identified by its serial number.
+      #
+      # @return the certificate's alias, nil if the certificate does not exist in AEM Truststore
       def _get_alias
         truststore_info = @truststore.info.data
         cert_alias = nil

data/lib/ruby_aem/resources/certificate_chain.rb

@@ -28,7 +28,7 @@ module RubyAem
       # @param private_key_alias Alias of the private key associated to this certificate chain
       # @param keystore_intermediate_path AEM User home path
       # @param keystore_authorizable_id AEM User id
-      # @return new RubyAem::Resources::AuhtorizableKeystore instance
+      # @return new RubyAem::Resources::CertificateChain instance
       def initialize(client, private_key_alias, keystore_intermediate_path, keystore_authorizable_id)
         @client = client
         @truststore = RubyAem::Resources::Truststore.new(client)

data/lib/ruby_aem/resources/config_property.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/flush_agent.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -37,6 +37,7 @@ module RubyAem
       # @param description flush agent description
       # @param dest_base_url base URL of the agent target destination, e.g. http://somedispatcher:8080
       # @param opts optional parameters:
+      # - alias_update: true, false, default is false
       # - log_level: error, info, debug, default is error
       # - retry_delay: in milliseconds, default is 30_000
       # @return RubyAem::Result
@@ -45,6 +46,7 @@ module RubyAem
         description,
         dest_base_url,
         opts = {
+          alias_update: false,
           log_level: 'error',
           retry_delay: 30_000
         }

data/lib/ruby_aem/resources/group.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/node.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/outbox_replication_agent.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/package.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@ module RubyAem
     # Package class contains API calls related to managing an AEM package.
     class Package
       include REXML
+
       # Initialise a package.
       # Package name and version will then be used to construct the package file in the filesystem.
       # E.g. package name 'somepackage' with version '1.2.3' will translate to somepackage-1.2.3.zip in the filesystem.
@@ -185,12 +186,12 @@ module RubyAem
         packages = list_all.data
         package = XPath.first(packages, "//packages/package[group=\"#{@call_params[:group_name]}\" and name=\"#{@call_params[:package_name]}\" and version=\"#{@call_params[:package_version]}\"]")
 
-        if package.to_s != ''
-          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} exists"
-          exists = true
-        else
+        if package.to_s == ''
           message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} does not exist"
           exists = false
+        else
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} exists"
+          exists = true
         end
         result = RubyAem::Result.new(message, nil)
         result.data = exists
@@ -224,12 +225,12 @@ module RubyAem
         package = XPath.first(packages, "//packages/package[group=\"#{@call_params[:group_name]}\" and name=\"#{@call_params[:package_name]}\" and version=\"#{@call_params[:package_version]}\"]")
         last_unpacked_by = XPath.first(package, 'lastUnpackedBy') if package
 
-        if !['', '<lastUnpackedBy/>', '<lastUnpackedBy>null</lastUnpackedBy>'].include? last_unpacked_by.to_s
-          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is installed"
-          is_installed = true
-        else
+        if ['', '<lastUnpackedBy/>', '<lastUnpackedBy>null</lastUnpackedBy>'].include? last_unpacked_by.to_s
           message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is not installed"
           is_installed = false
+        else
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is installed"
+          is_installed = true
         end
         result = RubyAem::Result.new(message, nil)
         result.data = is_installed

data/lib/ruby_aem/resources/path.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/replication_agent.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/repository.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/reverse_replication_agent.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/saml.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/resources/ssl.rb

@@ -24,8 +24,7 @@ module RubyAem
       # @return new RubyAem::Resources::Ssl instance
       def initialize(client)
         @client = client
-        @call_params = {
-        }
+        @call_params = {}
       end
 
       # Disable SSL

data/lib/ruby_aem/resources/truststore.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -43,6 +43,8 @@ module RubyAem
       # and convert it to PKCS12 Truststore object.
       #
       # @param file_path path to Truststore file
+      # @param password Password for AEM Truststore
+      # @return OpenSSL::PKCS12 Truststore object
       def read(file_path, password)
         truststore_raw = File.read file_path
         OpenSSL::PKCS12.new(truststore_raw, password)

data/lib/ruby_aem/resources/user.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/ruby_aem/response.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,9 +15,7 @@
 module RubyAem
   # Response wraps HTTP response data returned by swagger_aem.
   class Response
-    attr_accessor :status_code
-    attr_accessor :body
-    attr_accessor :headers
+    attr_accessor :status_code, :body, :headers
 
     # Initialise a result.
     #

data/lib/ruby_aem/result.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,9 +21,8 @@ module RubyAem
   # e.g. is_* and exists method provide result with boolean data.
   # Some API calls result doesn't contain any data.
   class Result
-    attr_accessor :message
+    attr_accessor :message, :data
     attr_reader :response
-    attr_accessor :data
 
     # Initialise a result.
     #

data/lib/ruby_aem/swagger.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@ module RubyAem
     # @return swagger_aem method name
     def self.operation_to_method(operation)
       operation.gsub(/[A-Z]/) { |char|
-        '_' + char.downcase
+        "_#{char.downcase}"
       }
     end
 
@@ -54,7 +54,7 @@ module RubyAem
     # @param config_node_name the name of the node for a given config
     # @return config name
     def self.config_node_name_to_config_name(config_node_name)
-      case config_node_name
+      case config_node_name # rubocop:disable Style/HashLikeCase
       when 'org.apache.felix.http'
         'Apache Felix Jetty Based HTTP Service'
       when 'org.apache.sling.servlets.get.DefaultGetServlet'

data/lib/ruby_aem.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 Shine Solutions Group
+# Copyright 2016-2026 Shine Solutions Group
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -98,6 +98,8 @@ module RubyAem
     end
 
     # Set default configuration values and handle numeric/boolean String values
+    #
+    # @param conf configuration hash, the hash will be modified with the sanitised values
     def sanitise_conf(conf)
       conf[:username] ||= 'admin'
       conf[:password] ||= 'admin'
@@ -122,7 +124,7 @@ module RubyAem
 
     # Create an AEM ConfigMgr instance.
     #
-    # @return new RubyAem::Resources::Aem instance
+    # @return new RubyAem::Resources::AemConfigMgr instance
     def aem_configmgr
       RubyAem::Resources::AemConfigMgr.new(@client)
     end
@@ -143,12 +145,12 @@ module RubyAem
       RubyAem::Resources::Certificate.new(@client, serial_number)
     end
 
-    # # Create a certificate chain instance.
-    # #
+    # Create a certificate chain instance.
+    #
     # @param private_key_alias Alias of the private key associated to this certificate chain
     # @param keystore_intermediate_path AEM User home path
     # @param keystore_authorizable_id AEM User id
-    # # @return new RubyAem::Resources::CertificateChain instance
+    # @return new RubyAem::Resources::CertificateChain instance
     def certificate_chain(private_key_alias, keystore_intermediate_path, keystore_authorizable_id)
       RubyAem::Resources::CertificateChain.new(@client, private_key_alias, keystore_intermediate_path, keystore_authorizable_id)
     end
@@ -183,7 +185,9 @@ module RubyAem
 
     # Create a Keystore instance for given authorizable id.
     #
-    # @return new RubyAem::Resources::AuhtorizableKeystore instance
+    # @param intermediate_path AEM User home path
+    # @param authorizable_id AEM User id
+    # @return new RubyAem::Resources::AuthorizableKeystore instance
     def authorizable_keystore(intermediate_path, authorizable_id)
       RubyAem::Resources::AuthorizableKeystore.new(@client, intermediate_path, authorizable_id)
     end
@@ -258,7 +262,7 @@ module RubyAem
 
     # Create a SSL instance.
     #
-    # @return new RubyAem::Resources::Saml instance
+    # @return new RubyAem::Resources::Ssl instance
     def ssl
       RubyAem::Resources::Ssl.new(@client)
     end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_aem
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Shine Solutions
 - Cliffano Subagio
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retries
@@ -26,61 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.5
 - !ruby/object:Gem::Dependency
-  name: swagger_aem
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.4.4
 - !ruby/object:Gem::Dependency
-  name: swagger_aem_osgi
+  name: swagger_aem
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.8.0
-- !ruby/object:Gem::Dependency
-  name: yard
+  name: swagger_aem_osgi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.19
-  type: :development
+        version: 2.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.19
+        version: 2.0.0
 description: ruby_aem is a Ruby client for Adobe Experience Manager (AEM) API, written
   on top of swagger_aem
 email:
@@ -126,8 +111,8 @@ files:
 homepage: https://github.com/shinesolutions/ruby_aem
 licenses:
 - Apache-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -135,16 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
-signing_key: 
+rubygems_version: 4.0.20
 specification_version: 4
 summary: AEM API Ruby client
 test_files: []