ruby_aem 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d3edd03b7ed33a824fb199d38cd2826ac5d4286
-  data.tar.gz: ad09c1cb27debd298c45d0d31e757840b41bb3ef
+  metadata.gz: 25e7edffa5c553d72473f08ca4e6ed7c9da856ea
+  data.tar.gz: ce2f8e0bfb47609012a4d88c86d72b5f3156d514
 SHA512:
-  metadata.gz: a3ebda8cc4e9289ccbb90e95cd5e557e93d257a881f58f8d5f6518cf062fe8df8569780050a34396bd235abd7e9e9b20c3f35a61c44c96a942fdd2abc52981f8
-  data.tar.gz: 978832d663c6b9dd1d070780aa65bce960894e9a810f82fd3775473acb489b074a1d80ceefd52bca5e460577411ca016f44ad64b03ddabcbe8ac3d5c3b9b9af9
+  metadata.gz: 7f42fc2cbd77cacb92037e10ed9bab8006165a89783b71399dac02f3a3fe3efddcbe40fb7a9b7aa37fe1ca0e5647294af7aa56520d5e0e41967b4aff7bdbd623
+  data.tar.gz: 3994a1a156167b4707eb6bed1d0cc8d88643b87c40ee7da609bf9e0fb772f21962bd68a299ae32c6f15154c1be3d90393ddd23fed81c827c32a8569de3d42e97

data/conf/gem.yaml

@@ -1 +1 @@
-version: 3.7.0
+version: 3.8.0

data/lib/ruby_aem/resources/ssl.rb

@@ -71,6 +71,78 @@ module RubyAem
       def get
         @client.call(self.class, __callee__.to_s, @call_params)
       end
+
+      # Check if SSL is enabled via Granite
+      #
+      # @return RubyAem::Result
+      def is_enabled
+        get_ssl = get
+
+        response = get_ssl.response
+        ssl_properties = response.body.properties
+        ssl_enabled = ssl_properties.com_adobe_granite_jetty_ssl_port.is_set
+        ssl_port = ssl_properties.com_adobe_granite_jetty_ssl_port.value
+
+        message = if ssl_enabled.eql?(true)
+                    "HTTPS has been configured on port #{ssl_port}"
+                  else
+                    'HTTPS is not configured'
+                  end
+
+        result = RubyAem::Result.new(message, response)
+        result.data = ssl_enabled
+
+        result
+      end
+
+      # Enable SSL via granite and wait until SSL was enabled
+      #
+      # @param opts hash of the following values:
+      # - keystore_password: Authorizable Keystore password for system-user ssl-service. keystore will be created if it  doesn't exist.
+      # - truststore_password: AEM Global Truststore password. Truststore will be created if it  doesn't exist.
+      # - https_hostname: Hostname for enabling HTTPS listener matching the certificate's common name.
+      # - https_port: Port to listen on for HTTPS requests.
+      # - certificate_file_path:  Path to the HTTPS public certificate file.
+      # - privatekey_file_path: Path to the HTTPS Private Key file.
+      # - _retries: retries library's options (http://www.rubydoc.info/gems/retries/0.0.5#Usage), restricted to max_tries, base_sleep_seconds, max_sleep_seconds
+      # @return RubyAem::Result
+      def enable_wait_until_ready(
+        opts = {
+          force: true,
+          _retries: {
+            max_tries: 30,
+            base_sleep_seconds: 2,
+            max_sleep_seconds: 2
+          }
+        }
+      )
+        opts[:_retries] ||= {}
+        opts[:_retries][:max_tries] ||= 30
+        opts[:_retries][:base_sleep_seconds] ||= 2
+        opts[:_retries][:max_sleep_seconds] ||= 2
+
+        # ensure integer retries setting (Puppet 3 passes numeric string)
+        opts[:_retries][:max_tries] = opts[:_retries][:max_tries].to_i
+        opts[:_retries][:base_sleep_seconds] = opts[:_retries][:base_sleep_seconds].to_i
+        opts[:_retries][:max_sleep_seconds] = opts[:_retries][:max_sleep_seconds].to_i
+
+        # The AEM Granite API to enable SSl is unstable and in some cases it response with response code 0.
+        # This is because the HTTP service is getting restarted during the process of enabling SSL via Granite.
+        # To not end with an error we have to rescue this behaviour and verify afterwards if SSL was enabled.
+        begin
+          result = enable(**opts)
+        rescue RubyAem::Error => e
+          raise StandardError.new(result) unless e.result.response.status_code.zero?
+
+          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|
+            result = is_enabled
+            message = 'SSL could not be configured or connection timeout please try again.'
+            puts format('SSL Enable check #%<retries_count>d: %<check_result_data>s - %<check_result_message>s', retries_count: retries_count, check_result_data: result.data, check_result_message: result.message)
+            raise StandardError.new(message) if result.data == false
+          }
+        end
+        result
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_aem
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Shine Solutions
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retries