ruby_aem 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2603c82cd2ec0808f1153a92230a2c228b5d6fa9
-  data.tar.gz: 9edf06b032769cb9378bed54e68006e50dd23e96
+  metadata.gz: cd11af37ca8e9013b07f8ad6aa2b68d9920cbeb4
+  data.tar.gz: 95ed3e49a24c45cc43c7859eec883c17fe21240d
 SHA512:
-  metadata.gz: 5ef1da3b8e4f6ee8ebb105d9d9c638a66d03071c29dee24b077d195c057104489c1e2a9b1561c2f9115b8a3e4860f9c7ff779127fd2174047885fe581416c3d1
-  data.tar.gz: 25f03e2d4f9d77b3cb53882da9b1d2f8ed1a2aef6f2952fbdbef7bacdf07b2901c91908df370d8e8e77064dbcf9f21fa533eeaf947baee6c4e706c6d274d2210
+  metadata.gz: 274b7be5c5e4672805ba5af13f695c09fd4531533050c8cbcce2601faf2375fc13af8cdd7c4d3ff05bacc6bc9907d351902e0e1584b8c6e071805620a3f1a623
+  data.tar.gz: 06a4bea0b79068ac69e207572c9d8a9c30f80b1198c1552dcec35f8a054e738405d29a9e3d6ee97205704afe6e9b42982315e3f03dfe26961bd9beb56f591ede

data/conf/spec.yaml

@@ -62,6 +62,120 @@ aem:
         200:
           handler: xml_package_list
           message: 'All packages list retrieved successfully'
+authorizablekeystore:
+  responses:
+    404:
+      handler: simple_error
+      message: 'Authorizable keystore not found'
+  actions:
+    create:
+      api: sling
+      operation: postAuthorizableKeystore
+      params:
+        required:
+          intermediate_path: '%{intermediate_path}'
+          authorizable_id: '%{authorizable_id}'
+        optional:
+          new_password: '%{password}'
+          re_password: '%{password}'
+          operation: createStore
+      responses:
+        200:
+          handler: simple
+          message: 'Authorizable keystore created'
+        201:
+          handler: simple
+          message: 'Authorizable keystore created'
+    change_password:
+      api: sling
+      operation: postAuthorizableKeystore
+      params:
+        required:
+          intermediate_path: '%{intermediate_path}'
+          authorizable_id: '%{authorizable_id}'
+        optional:
+          current_password: '%{old_password}'
+          new_password: '%{new_password}'
+          re_password: '%{new_password}'
+      responses:
+        200:
+          handler: simple
+          message: 'Authorizable keystore password successfully changed'
+    upload:
+      api: sling
+      operation: postAuthorizableKeystore
+      params:
+        required:
+          intermediate_path: '%{intermediate_path}'
+          authorizable_id: '%{authorizable_id}'
+        optional:
+          new_alias: '%{new_alias}'
+          key_store: __FILE_PLAIN__
+          key_store_pass: '%{keystore_password}'
+          _alias: '%{private_key_alias}'
+          key_password: '%{private_key_password}'
+      responses:
+        200:
+          handler: simple
+          message: 'Authorizable keystore uploaded'
+        201:
+          handler: simple
+          message: 'Authorizable keystore uploaded'
+    download:
+      api: sling
+      operation: getKeystore
+      params:
+        required:
+          intermediate_path: '%{intermediate_path}'
+          authorizable_id: '%{authorizable_id}'
+      responses:
+        200:
+          handler: file_download
+          message: 'Authorizable keystore downloaded to %{file_path}'
+    delete:
+      api: sling
+      operation: postNode
+      params:
+        required:
+          path: '%{intermediate_path}/%{authorizable_id}/keystore'
+          name: store.p12
+        optional:
+          operation: delete
+      responses:
+        200:
+          handler: simple
+          message: 'Authorizable keystore deleted'
+        201:
+          handler: simple
+          message: 'Authorizable keystore deleted'
+        403:
+          handler: simple_error
+          message: 'Authorizable keystore not found'
+    exists:
+      api: sling
+      operation: getAuthorizableKeystore
+      params:
+        required:
+          intermediate_path: '%{intermediate_path}'
+          authorizable_id: '%{authorizable_id}'
+      responses:
+        200:
+          handler: json_authorizable_keystore_exists
+          message: 'Authorizable keystore exists'
+        404:
+          handler: json_authorizable_keystore_exists
+          message: 'Authorizable keystore not found'
+    info:
+      api: sling
+      operation: getAuthorizableKeystore
+      params:
+        required:
+          intermediate_path: '%{intermediate_path}'
+          authorizable_id: '%{authorizable_id}'
+      responses:
+        200:
+          handler: simple_body
+          message: 'Retrieved authorizable keystore info'
 bundle:
   responses:
     404:
@@ -90,6 +204,91 @@ bundle:
         200:
           handler: simple
           message: 'Bundle %{name} stopped'
+certificate:
+  actions:
+    import:
+      api: sling
+      operation: postTruststore
+      params:
+        optional:
+          certificate: __FILE_PLAIN__
+          key_store_type: jks
+      responses:
+        200:
+          handler: simple
+          message: 'Certificate imported'
+        201:
+          handler: simple
+          message: 'Certificate imported'
+    delete:
+      api: sling
+      operation: postTruststore
+      params:
+        optional:
+          remove_alias: '%{cert_alias}'
+      responses:
+        200:
+          handler: simple
+          message: 'Certificate %{serial_number} deleted'
+    exists:
+      api: sling
+      operation: getTruststoreInfo
+      params:
+        required:
+      responses:
+        200:
+          handler: json_certificate_exists
+          message: 'Certificate exists'
+        404:
+          handler: json_certificate_exists
+          message: 'Certificate not found'
+certificatechain:
+  actions:
+    import:
+      api: sling
+      operation: postAuthorizableKeystore
+      params:
+        required:
+          intermediate_path: '%{keystore_intermediate_path}'
+          authorizable_id: '%{keystore_authorizable_id}'
+        optional:
+          _alias: '%{private_key_alias}'
+          cert_chain: __FILE_CERTIFICATE__
+          pk: __FILE_PRIVATE_KEY__
+      responses:
+        200:
+          handler: simple
+          message: 'Certificate chain and private key successfully imported'
+        201:
+          handler: simple
+          message: 'Certificate chain and private key successfully imported'
+    delete:
+      api: sling
+      operation: postAuthorizableKeystore
+      params:
+        required:
+          intermediate_path: '%{keystore_intermediate_path}'
+          authorizable_id: '%{keystore_authorizable_id}'
+        optional:
+          remove_alias: '%{private_key_alias}'
+      responses:
+        200:
+          handler: simple
+          message: 'Certificate chain deleted'
+    exists:
+      api: sling
+      operation: getAuthorizableKeystore
+      params:
+        required:
+          intermediate_path: '%{keystore_intermediate_path}'
+          authorizable_id: '%{keystore_authorizable_id}'
+      responses:
+        200:
+          handler: json_certificate_chain_exists
+          message: 'Certificate chain exists'
+        404:
+          handler: json_certificate_chain_exists
+          message: 'Certificate chain not found'
 flushagent:
   responses:
     404:
@@ -415,7 +614,7 @@ package:
           version: '%{package_version}'
       responses:
         200:
-          handler: file_download
+          handler: package_file_download
           message: 'Package downloaded to %{file_path}/%{package_name}-%{package_version}.zip'
     upload:
       api: crx
@@ -426,7 +625,7 @@ package:
           cmd: upload
         optional:
           force: '%{force}'
-          package: __FILE__
+          package: __FILE_PACKAGE__
       responses:
         200:
           handler: json_package_service
@@ -492,7 +691,6 @@ configproperty:
       operation: postConfigApacheFelixJettyBasedHttpService
       params:
         required:
-          runmode: '%{run_mode}'
         optional:
           - org_apache_felix_https_nio
           - org_apache_felix_https_nio_type_hint
@@ -504,7 +702,7 @@ configproperty:
           - org_apache_felix_https_keystore_key_type_hint
           - 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_
           - org_apache_felix_https_truststore_key_type_hint
           - org_apache_felix_https_truststore_password
           - org_apache_felix_https_truststore_password_type_hint
@@ -519,16 +717,15 @@ configproperty:
       responses:
         200:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
         201:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
     createapacheslinggetservlet:
       api: sling
       operation: postConfigApacheSlingGetServlet
       params:
         required:
-          runmode: '%{run_mode}'
         optional:
           - json_maximumresults
           - json_maximumresults_type_hint
@@ -541,16 +738,15 @@ configproperty:
       responses:
         200:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
         201:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
     createapacheslingreferrerfilter:
       api: sling
       operation: postConfigApacheSlingReferrerFilter
       params:
         required:
-          runmode: '%{run_mode}'
         optional:
           - allow_empty
           - allow_empty_type_hint
@@ -558,19 +754,20 @@ configproperty:
           - allow_hosts_type_hint
           - allow_hosts_regexp
           - allow_hosts_regexp_type_hint
+          - filter_methods
+          - filter_methods_type_hint
       responses:
         200:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
         201:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
     createapacheslingdavexservlet:
       api: sling
       operation: postConfigApacheSlingDavExServlet
       params:
         required:
-          runmode: '%{run_mode}'
         optional:
           - _alias
           - alias_type_hint
@@ -579,42 +776,100 @@ configproperty:
       responses:
         200:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
         201:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
     createaempasswordresetactivator:
       api: custom
       operation: postConfigAemPasswordReset
       params:
         required:
-          runmode: '%{run_mode}'
         optional:
           - pwdreset_authorizables
           - pwdreset_authorizables_type_hint
       responses:
         200:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
         201:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
     createaemhealthcheckservlet:
       api: custom
       operation: postConfigAemHealthCheckServlet
       params:
         required:
-          runmode: '%{run_mode}'
         optional:
           - bundles_ignored
           - bundles_ignored_type_hint
       responses:
         200:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
         201:
           handler: simple
-          message: 'Set %{run_mode} %{config_node_name} config %{type} property %{name}=%{value}'
+          message: 'Set %{config_node_name} config %{type} property %{name}=%{value}'
+    createadobegranitesamlauthenticationhandler:
+      api: sling
+      operation: postConfigAdobeGraniteSamlAuthenticationHandler
+      params:
+        optional:
+          - key_store_password
+          - key_store_password_type_hint
+          - service_ranking
+          - service_ranking_type_hint
+          - idp_http_redirect
+          - idp_http_redirect_type_hint
+          - create_user
+          - create_user_type_hint
+          - default_redirect_url
+          - default_redirect_url_type_hint
+          - user_id_attribute
+          - user_id_attribute_type_hint
+          - default_groups
+          - default_groups_type_hint
+          - idp_cert_alias
+          - idp_cert_alias_type_hint
+          - add_group_memberships
+          - add_group_memberships_type_hint
+          - path
+          - path_type_hint
+          - synchronize_attributes
+          - synchronize_attributes_type_hint
+          - clock_tolerance
+          - clock_tolerance_type_hint
+          - group_membership_attribute
+          - group_membership_attribute_type_hint
+          - idp_url
+          - idp_url_type_hint
+          - logout_url
+          - logout_url_type_hint
+          - service_provider_entity_id
+          - service_provider_entity_id_type_hint
+          - assertion_consumer_service_url
+          - assertion_consumer_service_url_type_hint
+          - handle_logout
+          - handle_logout_type_hint
+          - sp_private_key_alias
+          - sp_private_key_alias_type_hint
+          - use_encryption
+          - use_encryption_type_hint
+          - name_id_format
+          - name_id_format_type_hint
+          - digest_method
+          - digestMethod_type_hint
+          - signature_method
+          - signature_method_type_hint
+          - user_intermediate_path
+          - user_intermediate_path_type_hint
+      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}'
 replicationagent:
   responses:
     404:
@@ -849,6 +1104,154 @@ repository:
         200:
           handler: simple
           message: 'Repository writes unblocked'
+saml:
+  actions:
+    get:
+      api: console
+      operation: postSamlConfiguration
+      params:
+        optional:
+          post: true
+      responses:
+        200:
+          handler: simple
+          message: 'SAML Configuration found'
+    create:
+      api: console
+      operation: postSamlConfiguration
+      params:
+        optional:
+          - post
+          - apply
+          - delete
+          - action
+          - location
+          - path
+          - service_ranking
+          - idp_url
+          - idp_cert_alias
+          - idp_http_redirect
+          - service_provider_entity_id
+          - assertion_consumer_service_url
+          - sp_private_key_alias
+          - key_store_password
+          - default_redirect_url
+          - user_id_attribute
+          - use_encryption
+          - create_user
+          - add_group_memberships
+          - group_membership_attribute
+          - default_groups
+          - name_id_format
+          - synchronize_attributes
+          - handle_logout
+          - logout_url
+          - clock_tolerance
+          - digest_method
+          - signature_method
+          - user_intermediate_path
+          - propertylist
+      responses:
+        200:
+          handler: simple
+          message: 'SAML Configuration found'
+        302:
+          handler: simple
+          message: 'SAML Configuration created'
+    delete:
+      api: console
+      operation: postSamlConfiguration
+      params:
+        optional:
+          - apply
+          - delete
+      responses:
+        200:
+          handler: simple
+          message: 'SAML Configuration successfully deleted'
+truststore:
+  responses:
+    404:
+      handler: simple_error
+      message: 'Truststore not found'
+  actions:
+    create:
+      api: sling
+      operation: postTruststore
+      params:
+        optional:
+          new_password: '%{password}'
+          re_password: '%{password}'
+          operation: createStore
+      responses:
+        200:
+          handler: simple
+          message: 'Truststore created'
+        201:
+          handler: simple
+          message: 'Truststore created'
+    upload:
+      api: sling
+      operation: post_truststore_pkcs12
+      params:
+        optional:
+          truststore_p12: __FILE_PLAIN__
+      responses:
+        200:
+          handler: simple
+          message: 'Truststore uploaded'
+        201:
+          handler: simple
+          message: 'Truststore uploaded'
+    download:
+      api: sling
+      operation: getTruststore
+      params:
+        required:
+      responses:
+        200:
+          handler: file_download
+          message: 'Truststore downloaded to %{file_path}'
+    delete:
+      api: sling
+      operation: postNode
+      params:
+        required:
+          path: /etc/truststore/
+          name: truststore.p12
+        optional:
+          operation: delete
+      responses:
+        200:
+          handler: simple
+          message: 'Truststore deleted'
+        201:
+          handler: simple
+          message: 'Truststore deleted'
+        403:
+          handler: simple_error
+          message: 'Truststore not found'
+    exists:
+      api: sling
+      operation: getTruststoreInfo
+      params:
+        required:
+      responses:
+        200:
+          handler: json_truststore_exists
+          message: 'Truststore exists'
+        404:
+          handler: json_truststore_exists
+          message: 'Truststore not found'
+    info:
+      api: sling
+      operation: getTruststoreInfo
+      params:
+        required:
+      responses:
+        200:
+          handler: simple_body
+          message: 'Retrieved truststore info'
 user:
   responses:
     404:

data/lib/ruby_aem/client.rb

@@ -93,8 +93,19 @@ module RubyAem
       # if value is provided in optional param spec,
       # then apply variable interpolation the same way as required param
       elsif value.class == String
-        if value == '__FILE__'
-          File.open("#{call_params[:file_path]}/#{call_params[:package_name]}-#{call_params[:package_version]}.zip", 'r') { |file|
+        case value
+        when '__FILE_PACKAGE__'
+          file_path = "#{call_params[:file_path]}/#{call_params[:package_name]}-#{call_params[:package_version]}.zip"
+        when '__FILE_PLAIN__'
+          file_path = call_params[:file_path]
+        when '__FILE_CERTIFICATE__'
+          file_path = call_params[:file_path_certificate]
+        when '__FILE_PRIVATE_KEY__'
+          file_path = call_params[:file_path_private_key]
+        end
+
+        if !file_path.nil?
+          File.open(file_path.to_s, 'r') { |file|
             params[-1][key.to_sym] = file
           }
         else

data/lib/ruby_aem/handlers/file.rb

@@ -23,7 +23,7 @@ module RubyAem
     # @param response_spec response specification as configured in conf/spec.yaml
     # @param call_params API call parameters
     # @return RubyAem::Result
-    def self.file_download(response, response_spec, call_params)
+    def self.package_file_download(response, response_spec, call_params)
       FileUtils.cp(response.body.path, "#{call_params[:file_path]}/#{call_params[:package_name]}-#{call_params[:package_version]}.zip")
       response.body.delete
 
@@ -31,5 +31,18 @@ module RubyAem
 
       RubyAem::Result.new(message, response)
     end
+
+    # @param response HTTP response containing status_code, body, and headers
+    # @param response_spec response specification as configured in conf/spec.yaml
+    # @param call_params API call parameters
+    # @return RubyAem::Result
+    def self.file_download(response, response_spec, call_params)
+      FileUtils.cp(response.body.path, call_params[:file_path].to_s)
+      response.body.delete
+
+      message = response_spec['message'] % call_params
+
+      RubyAem::Result.new(message, response)
+    end
   end
 end