ruby_aem 3.3.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46d97b74d2f3cfd1c5702001a169427c5be4865a
-  data.tar.gz: 75ae679a7fc78f70e39bf31734575f1c05e1badd
+  metadata.gz: b2ed1677a7b7238645bdef9c119ec97633a878a4
+  data.tar.gz: f45bd3492b51cdaecfc4d5bac3a653d024629f9e
 SHA512:
-  metadata.gz: ec8453f2b50fc61619725a79ed8faddb3412181d96e248422cbb39434ed8a84b84f3f1cfaea43ffb0615509004f1ae993e982b689cc717b60339cc9380f633ea
-  data.tar.gz: c4abdc405b9b96cc34f99c5355f577df0d272560624854294b2ac0b2bb3e28250b9b88f72bad9a9310a77f19e4568f2b86ed36297921d875e25c09f816e125bb
+  metadata.gz: 3b98cf357bedb502071301b796274c8f299a85d23b484aefbb46cb6ba1203ce65998b4598d74ffe02db88a3e3eda0a62284f41b0c54d52221086f47044f12282
+  data.tar.gz: 9499e464235a2712ad434c7100bec694057e90b532f6ea42ebfd8e3fe128f603919b6b0a54992f374eb98ef401a8694810f53c0ea14c942fb16d51a8a3c6df12

data/conf/gem.yaml

@@ -1 +1 @@
-version: 3.3.0
+version: 3.9.0

data/conf/spec.yaml

@@ -417,7 +417,7 @@ group:
           authorizable_id: '%{name}'
           intermediate_path: '%{path}'
         optional:
-          create_group: ''
+          create_group: 'true'
           profilegiven_name: '%{name}'
       responses:
         201:
@@ -447,7 +447,7 @@ group:
           path: '%{path}'
           name: '%{authorizable_id}'
         optional:
-          delete_authorizable: ''
+          delete_authorizable: '%{name}'
       responses:
         200:
           handler: simple
@@ -721,6 +721,21 @@ path:
           message: 'Path %{path} deleted'
 configproperty:
   actions:
+    create:
+      api: sling
+      operation: postConfigProperty
+      params:
+        required:
+          config_node_name: '%{config_node_name}'
+        optional:
+          - query_params
+      responses:
+        200:
+          handler: simple
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
+        201:
+          handler: simple
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
     createapachefelixjettybasedhttpservice:
       api: sling
       operation: postConfigApacheFelixJettyBasedHttpService
@@ -1277,7 +1292,7 @@ truststore:
       operation: postNode
       params:
         required:
-          path: /etc/truststore/
+          path: etc/truststore
           name: truststore.p12
         optional:
           operation: delete
@@ -1326,7 +1341,7 @@ user:
           authorizable_id: '%{name}'
           intermediate_path: '%{path}'
         optional:
-          create_user: ''
+          create_user: 'true'
           reppassword: '%{password}'
       responses:
         201:
@@ -1356,7 +1371,7 @@ user:
           path: '%{path}'
           name: '%{authorizable_id}'
         optional:
-          delete_authorizable: ''
+          delete_authorizable: '%{name}'
       responses:
         200:
           handler: simple
@@ -1407,3 +1422,44 @@ user:
         200:
           handler: html_change_password
           message: 'User %{user}''s password has been changed'
+ssl:
+  actions:
+    enable:
+      api: granite
+      operation: sslSetup
+      params:
+        required:
+          keystore_password: '%{keystore_password}'
+          keystore_passwordConfirm: '%{keystore_passwordConfirm}'
+          truststore_password: '%{truststore_password}'
+          truststore_passwordConfirm: '%{truststore_passwordConfirm}'
+          https_hostname: '%{https_hostname}'
+          https_port: '%{https_port}'
+        optional:
+          privatekey_file: __FILE_PRIVATE_KEY__
+          certificate_file: __FILE_CERTIFICATE__
+      responses:
+        200:
+          handler: simple
+          message: 'HTTPS has been configured on port %{https_port}'
+    get:
+      api: configmgr
+      operation: comAdobeGraniteJettySslInternalGraniteSslConnectorFactory
+      params:
+        optional:
+          post: true
+      responses:
+        200:
+          handler: simple
+          message: 'HTTPS Configuration found'
+    disable:
+      api: configmgr
+      operation: comAdobeGraniteJettySslInternalGraniteSslConnectorFactory
+      params:
+        optional:
+          apply: true
+          delete: true
+      responses:
+        200:
+          handler: simple
+          message: 'HTTPS has been disabled'

data/lib/ruby_aem.rb

@@ -29,6 +29,7 @@ require 'ruby_aem/resources/replication_agent'
 require 'ruby_aem/resources/outbox_replication_agent'
 require 'ruby_aem/resources/reverse_replication_agent'
 require 'ruby_aem/resources/saml'
+require 'ruby_aem/resources/ssl'
 require 'ruby_aem/resources/repository'
 require 'ruby_aem/resources/truststore'
 require 'ruby_aem/resources/user'
@@ -87,7 +88,8 @@ module RubyAem
         custom: SwaggerAemClient::CustomApi.new,
         cq: SwaggerAemClient::CqApi.new,
         crx: SwaggerAemClient::CrxApi.new,
-        sling: SwaggerAemClient::SlingApi.new
+        sling: SwaggerAemClient::SlingApi.new,
+        granite: SwaggerAemClient::GraniteApi.new
       }
 
       spec = YAML.load_file(File.expand_path('../../conf/spec.yaml', __FILE__))
@@ -254,6 +256,13 @@ module RubyAem
       RubyAem::Resources::Saml.new(@client)
     end
 
+    # Create a SSL instance.
+    #
+    # @return new RubyAem::Resources::Saml instance
+    def ssl
+      RubyAem::Resources::Ssl.new(@client)
+    end
+
     # Create a Truststore instance.
     #
     # @return new RubyAem::Resources::Truststore instance

data/lib/ruby_aem/resources/config_property.rb

@@ -29,8 +29,11 @@ module RubyAem
         @call_params = {
           name: name,
           type: type,
-          value: value
+          value: value,
+          query_params: {}
         }
+        @call_params[:query_params][@call_params[:name]] = @call_params[:value]
+        @call_params[:query_params]["#{@call_params[:name]}@TypeHint"] = @call_params[:type]
       end
 
       # Create a new config property.
@@ -38,15 +41,8 @@ module RubyAem
       # @param config_node_name the node name of a given OSGI config
       # @return RubyAem::Result
       def create(config_node_name)
-        name = RubyAem::Swagger.property_to_parameter(@call_params[:name])
-        type_hint_prefix = name.gsub(/^_/, '')
-
         @call_params[:config_node_name] = config_node_name
-        @call_params[name.to_sym] = @call_params[:value]
-        @call_params["#{type_hint_prefix}_type_hint".to_sym] = @call_params[:type]
-
-        config_name = Swagger.config_node_name_to_config_name(config_node_name)
-        @client.call(self.class, __callee__.to_s.concat(config_name.downcase.gsub(/\s+/, '')), @call_params)
+        @client.call(self.class, __callee__.to_s, @call_params)
       end
     end
   end

data/lib/ruby_aem/resources/ssl.rb

@@ -0,0 +1,148 @@
+# Copyright 2016-2018 Shine Solutions
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'ruby_aem/error'
+
+module RubyAem
+  module Resources
+    # AEM class contains API calls related to managing SSL via Granite.
+    class Ssl
+      # Initialise Ssl resource.
+      #
+      # @param client RubyAem::Client
+      # @return new RubyAem::Resources::Ssl instance
+      def initialize(client)
+        @client = client
+        @call_params = {
+        }
+      end
+
+      # Disable SSL
+      #
+      # @return RubyAem::Result
+      def disable
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Enable SSL
+      #
+      # @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.
+      # @return RubyAem::Result
+      def enable(opts = {
+        keystore_password: nil,
+        truststore_password: nil,
+        https_hostname: nil,
+        https_port: nil,
+        certificate_file_path: nil,
+        privatekey_file_path: nil
+      })
+        @call_params[:keystore_password] = opts[:keystore_password]
+        @call_params[:keystore_passwordConfirm] = opts[:keystore_password]
+        @call_params[:truststore_password] = opts[:truststore_password]
+        @call_params[:truststore_passwordConfirm] = opts[:truststore_password]
+        @call_params[:https_hostname] = opts[:https_hostname]
+        @call_params[:https_port] = opts[:https_port]
+        @call_params[:file_path_certificate] = opts[:certificate_file_path]
+        @call_params[:file_path_private_key] = opts[:privatekey_file_path]
+
+        @client.call(self.class, __callee__.to_s, @call_params)
+      end
+
+      # Get SSL Granite configuration
+      #
+      # @return RubyAem::Result
+      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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby_aem
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Shine Solutions
 - Cliffano Subagio
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2020-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retries
@@ -31,14 +31,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: swagger_aem_osgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +117,7 @@ files:
 - lib/ruby_aem/resources/repository.rb
 - lib/ruby_aem/resources/reverse_replication_agent.rb
 - lib/ruby_aem/resources/saml.rb
+- lib/ruby_aem/resources/ssl.rb
 - lib/ruby_aem/resources/truststore.rb
 - lib/ruby_aem/resources/user.rb
 - lib/ruby_aem/response.rb
@@ -112,7 +127,7 @@ homepage: https://github.com/shinesolutions/ruby_aem
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,9 +142,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.6.14.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: AEM API Ruby client
 test_files: []