ruby_aem 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d453de388f2dc00342d36f11040e2dff294a4dc
+  data.tar.gz: b60ea29a13c060f5ff2cb4d7dfa6d2c774bfe68b
+SHA512:
+  metadata.gz: 1e3f54abe4d1764f61a1eddb6dc8450f6b907b264c4bb23a62b077a7f30ccd4720c8e2438edfa748854ed6305a4be7127d55e6e54caf8b5b6a33c7aa1d93ec68
+  data.tar.gz: 0147ebd982bb243ba129958f588d4a9ddc89c788c2591f2750416b1152f6818566d8d54ab6e42f5709166dd1a15e8c632af23d259887e47b801dae98e5afb047

data/conf/spec.yaml

@@ -0,0 +1,581 @@
+bundle:
+  responses:
+    404:
+      status: failure
+      handler: simple
+      message: 'Bundle %{name} not found'
+  actions:
+    start:
+      api: console
+      operation: postBundle
+      params:
+        required:
+          name: '%{name}'
+          action: start
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Bundle %{name} started'
+    stop:
+      api: console
+      operation: postBundle
+      params:
+        required:
+          name: '%{name}'
+          action: stop
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Bundle %{name} stopped'
+flushagent:
+  responses:
+    404:
+      status: failure
+      handler: simple
+      message: 'Flush agent %{name} not found on %{run_mode}'
+  actions:
+    create_update:
+      api: sling
+      operation: postAgent
+      params:
+        required:
+          runmode: '%{run_mode}'
+          name: '%{name}'
+        optional:
+          jcrprimary_type: cq:Page
+          jcrcontentcqname: '%{name}'
+          jcrcontentjcrtitle: '%{title}'
+          jcrcontentjcrdescription: '%{description}'
+          jcrcontentslingresource_type: /libs/cq/replication/components/agent
+          jcrcontenttransport_uri: '%{dest_base_url}/dispatcher/invalidate.cache'
+          jcrcontentlog_level: error
+          jcrcontentno_versioning: true
+          jcrcontentprotocol_http_headers:
+            - 'CQ-Action:{action}'
+            - 'CQ-Handle:{path}'
+            - 'CQ-Path:{path}'
+          jcrcontentprotocol_http_headers_type_hint: String[]
+          jcrcontentprotocol_http_method: GET
+          jcrcontentretry_delay: 30000
+          jcrcontentserialization_type: flush
+          jcrcontentjcrmixin_types: cq:ReplicationStatus
+          jcrcontenttrigger_receive: true
+          jcrcontenttrigger_specific: true
+          jcrcontentcqtemplate: /libs/cq/replication/templates/agent
+          jcrcontentenabled: true
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Flush agent %{name} updated on %{run_mode}'
+        201:
+          status: success
+          handler: simple
+          message: 'Flush agent %{name} created on %{run_mode}'
+    delete:
+      api: sling
+      operation: deleteAgent
+      params:
+        required:
+          runmode: '%{run_mode}'
+          name: '%{name}'
+      responses:
+        204:
+          status: success
+          handler: simple
+          message: 'Flush agent %{name} deleted on %{run_mode}'
+    exists:
+      api: sling
+      operation: getAgent
+      params:
+        required:
+          runmode: '%{run_mode}'
+          name: '%{name}'
+      responses:
+        302:
+          status: success
+          handler: simple
+          message: 'Flush agent %{name} exists on %{run_mode}'
+group:
+  responses:
+    404:
+      status: failure
+      handler: simple
+      message: 'Group %{name} not found'
+  actions:
+    create:
+      api: sling
+      operation: postAuthorizables
+      params:
+        required:
+          authorizable_id: '%{name}'
+          intermediate_path: '%{path}'
+        optional:
+          create_group: ''
+          profilegiven_name: '%{name}'
+      responses:
+        201:
+          status: success
+          handler: html_authorizable_id
+          message: 'Group %{name} created at %{path}/%{authorizable_id}'
+    find_authorizable_id:
+      api: sling
+      operation: postQuery
+      params:
+        required:
+          path: '%{path}'
+          p_limit: '-1'
+          _1_property: rep:authorizableId
+          _1_property_value: '%{name}'
+      responses:
+        200:
+          status: success
+          handler: json_authorizable_id
+          message: 'Found group %{name} authorizable ID %{authorizable_id}'
+    delete:
+      api: sling
+      operation: deleteNode
+      params:
+        required:
+          path: '%{path}'
+          name: '%{authorizable_id}'
+      responses:
+        204:
+          status: success
+          handler: simple
+          message: 'Group %{name} deleted at /%{path}/%{authorizable_id}'
+    exists:
+      api: sling
+      operation: getNode
+      params:
+        required:
+          path: '%{path}'
+          name: '%{authorizable_id}'
+      responses:
+        302:
+          status: success
+          handler: simple
+          message: 'Group %{name} exists at /%{path}/%{authorizable_id}'
+    set_permission:
+      api: cq
+      operation: postCqActions
+      params:
+        required:
+          authorizable_id: '%{name}'
+          changelog: 'path:%{permission_path},%{permission_csv}'
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Permission %{permission_csv} on path %{permission_path} set for group %{name}'
+    add_member:
+      api: sling
+      operation: postNodeRw
+      params:
+        required:
+          path: '%{path}'
+          name: '%{authorizable_id}'
+        optional:
+          add_members: '%{member}'
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'User/group %{member} added to group %{name}'
+node:
+  responses:
+    404:
+      status: failure
+      handler: simple
+      message: 'Node %{path}/%{name} not found'
+  actions:
+    create:
+      api: sling
+      operation: postPath
+      params:
+        required:
+          path: '%{path}'
+          jcrprimary_type: '%{type}'
+          name: '%{name}'
+      responses:
+        201:
+          status: success
+          handler: simple
+          message: 'Node %{path}/%{name} created'
+    delete:
+      api: sling
+      operation: deleteNode
+      params:
+        required:
+          path: '%{path}'
+          name: '%{name}'
+      responses:
+        204:
+          status: success
+          handler: simple
+          message: 'Node %{path}/%{name} deleted'
+    exists:
+      api: sling
+      operation: getNode
+      params:
+        required:
+          path: '%{path}'
+          name: '%{name}'
+      responses:
+        302:
+          status: success
+          handler: simple
+          message: 'Node %{path}/%{name} exists'
+package:
+  actions:
+    create:
+      api: crx
+      operation: postPackageServiceJson
+      params:
+        required:
+          path: 'etc/packages/%{group_name}'
+          cmd: create
+        optional:
+          group_name: '%{group_name}'
+          package_name: '%{package_name}'
+          package_version: '%{package_version}'
+          charset: utf-8
+      responses:
+        200:
+          status: success
+          handler: json_package_service
+    update:
+      api: crx
+      operation: postPackageUpdate
+      params:
+        required:
+          groupName: '%{group_name}'
+          packageName: '%{package_name}'
+          version: '%{package_version}'
+          path: '/etc/packages/%{group_name}/%{package_name}-%{package_version}.zip'
+        optional:
+          filter: '%{filter}'
+          charset: utf-8
+      responses:
+        200:
+          status: success
+          handler: json_package_service
+    delete:
+      api: crx
+      operation: postPackageServiceJson
+      params:
+        required:
+          path: 'etc/packages/%{group_name}/%{package_name}-%{package_version}.zip'
+          cmd: delete
+      responses:
+        200:
+          status: success
+          handler: json_package_service
+    build:
+      api: crx
+      operation: postPackageServiceJson
+      params:
+        required:
+          path: 'etc/packages/%{group_name}/%{package_name}-%{package_version}.zip'
+          cmd: build
+      responses:
+        200:
+          status: success
+          handler: json_package_service
+    install:
+      api: crx
+      operation: postPackageServiceJson
+      params:
+        required:
+          path: 'etc/packages/%{group_name}/%{package_name}-%{package_version}.zip'
+          cmd: install
+      responses:
+        200:
+          status: success
+          handler: json_package_service
+    replicate:
+      api: crx
+      operation: postPackageServiceJson
+      params:
+        required:
+          path: 'etc/packages/%{group_name}/%{package_name}-%{package_version}.zip'
+          cmd: replicate
+      responses:
+        200:
+          status: success
+          handler: json_package_service
+    download:
+      api: sling
+      operation: getPackage
+      params:
+        required:
+          group: '%{group_name}'
+          name: '%{package_name}'
+          version: '%{package_version}'
+      responses:
+        200:
+          status: success
+          handler: file_download
+          message: 'Package downloaded to %{file_path}/%{package_name}-%{package_version}.zip'
+    upload:
+      api: crx
+      operation: postPackageServiceJson
+      params:
+        required:
+          path: ''
+          cmd: upload
+        optional:
+          force: '%{force}'
+          package: __FILE__
+      responses:
+        200:
+          status: success
+          handler: json_package_service
+    get_filter:
+      api: sling
+      operation: getPackageFilter
+      params:
+        required:
+          group: '%{group_name}'
+          name: '%{package_name}'
+          version: '%{package_version}'
+      responses:
+        200:
+          status: success
+          handler: json_package_filter
+          message: 'Filter retrieved successfully'
+    list_all:
+      api: crx
+      operation: postPackageService
+      params:
+        required:
+          cmd: ls
+      responses:
+        200:
+          status: success
+          handler: xml_package_list
+          message: 'Package list retrieved successfully'
+path:
+  actions:
+    activate:
+      api: sling
+      operation: postTreeActivation
+      params:
+        required:
+          ignoredeactivated: '%{ignoredeactivated}'
+          onlymodified: '%{onlymodified}'
+          path: '%{name}'
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Path %{name} activated'
+configproperty:
+  actions:
+    create:
+      api: sling
+      operation: postPath
+      params:
+        required:
+          runmode: '%{run_mode}'
+          name: '%{name}'
+        optional:
+          - org_apache_felix_https_nio
+          - org_apache_felix_https_nio_type_hint
+          - org_apache_felix_https_keystore
+          - org_apache_felix_https_keystore_type_hint
+          - org_apache_felix_https_keystore_password
+          - org_apache_felix_https_keystore_password_type_hint
+          - org_apache_felix_https_keystore_key
+          - 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_truststore_key_type_hint
+          - org_apache_felix_https_truststore_password
+          - org_apache_felix_https_truststore_password_type_hint
+          - org_apache_felix_https_clientcertificate
+          - org_apache_felix_https_clientcertificate_type_hint
+          - org_apache_felix_https_enable
+          - org_apache_felix_https_enable_type_hint
+          - org_osgi_service_http_port_secure
+          - org_osgi_service_http_port_secure_type_hint
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Set %{run_mode} config %{type} property %{name}=%{value}'
+        201:
+          status: success
+          handler: simple
+          message: 'Set %{run_mode} config %{type} property %{name}=%{value}'
+replicationagent:
+  responses:
+    404:
+      status: failure
+      handler: simple
+      message: 'Replication agent %{name} not found on %{run_mode}'
+  actions:
+    create_update:
+      api: sling
+      operation: postAgent
+      params:
+        required:
+          runmode: '%{run_mode}'
+          name: '%{name}'
+        optional:
+        jcrprimary_type: cq:Page
+        jcrcontentcqname: '%{name}'
+        jcrcontentjcrtitle: '%{title}'
+        jcrcontentjcrdescription: '%{description}'
+        jcrcontentslingresource_type: /libs/cq/replication/components/agent
+        jcrcontentserialization_type: durbo
+        jcrcontenttransport_uri: '%{dest_base_url}/bin/receive?sling:authRequestLogin=1'
+        jcrcontentlog_level: error
+        jcrcontentretry_delay: 30000
+        jcrcontentcqtemplate: /libs/cq/replication/templates/agent
+        jcrcontentenabled: true
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Replication agent %{name} updated on %{run_mode}'
+        201:
+          status: success
+          handler: simple
+          message: 'Replication agent %{name} created on %{run_mode}'
+    delete:
+      api: sling
+      operation: deleteAgent
+      params:
+        required:
+          runmode: '%{run_mode}'
+          name: '%{name}'
+      responses:
+        204:
+          status: success
+          handler: simple
+          message: 'Replication agent %{name} deleted on %{run_mode}'
+    exists:
+      api: sling
+      operation: getAgent
+      params:
+        required:
+          runmode: '%{run_mode}'
+          name: '%{name}'
+      responses:
+        302:
+          status: success
+          handler: simple
+          message: 'Replication agent %{name} exists on %{run_mode}'
+repository:
+  actions:
+    block_writes:
+      api: console
+      operation: postJmxRepository
+      params:
+        required:
+          action: blockRepositoryWrites
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Repository writes blocked'
+    unblock_writes:
+      api: console
+      operation: postJmxRepository
+      params:
+        required:
+          action: unblockRepositoryWrites
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Repository writes unblocked'
+user:
+  responses:
+    404:
+      status: failure
+      handler: simple
+      message: 'User %{name} not found'
+  actions:
+    create:
+      api: sling
+      operation: postAuthorizables
+      params:
+        required:
+          authorizable_id: '%{name}'
+          intermediate_path: '%{path}'
+        optional:
+          create_user: ''
+          reppassword: '%{password}'
+      responses:
+        201:
+          status: success
+          handler: html_authorizable_id
+          message: 'User %{name} created at %{path}/%{authorizable_id}'
+    find_authorizable_id:
+      api: sling
+      operation: postQuery
+      params:
+        required:
+          path: '%{path}'
+          p_limit: '-1'
+          _1_property: rep:authorizableId
+          _1_property_value: '%{name}'
+      responses:
+        200:
+          status: success
+          handler: json_authorizable_id
+          message: 'Found user %{name} authorizable ID %{authorizable_id}'
+    delete:
+      api: sling
+      operation: deleteNode
+      params:
+        required:
+          path: '%{path}'
+          name: '%{authorizable_id}'
+      responses:
+        204:
+          status: success
+          handler: simple
+          message: 'User %{name} deleted at /%{path}/%{authorizable_id}'
+    exists:
+      api: sling
+      operation: getNode
+      params:
+        required:
+          path: '%{path}'
+          name: '%{authorizable_id}'
+      responses:
+        302:
+          status: success
+          handler: simple
+          message: 'User %{name} exists at /%{path}/%{authorizable_id}'
+    set_permission:
+      api: cq
+      operation: postCqActions
+      params:
+        required:
+          authorizable_id: '%{name}'
+          changelog: 'path:%{permission_path},%{permission_csv}'
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Permission %{permission_csv} on path %{permission_path} set for user %{name}'
+    change_password:
+      api: crx
+      operation: postSetPassword
+      params:
+        required:
+          old: '%{old_password}'
+          plain: '%{new_password}'
+          verify: '%{new_password}'
+      responses:
+        200:
+          status: success
+          handler: simple
+          message: 'Logged in user password changed'

data/lib/ruby_aem/bundle.rb

@@ -0,0 +1,48 @@
+=begin
+Copyright 2016 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.
+=end
+
+module RubyAem
+  # Bundle class contains API calls related to managing an AEM bundle.
+  class Bundle
+
+    # Initialise a bundle.
+    #
+    # @param client RubyAem::Client
+    # @param name the bundle's name, e.g. com.adobe.cq.social.cq-social-forum
+    # @return new RubyAem::Bundle instance
+    def initialize(client, name)
+      @client = client
+      @info = {
+        name: name
+      }
+    end
+
+    # Start a bundle.
+    #
+    # @return RubyAem::Result
+    def start
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+    # Stop a bundle.
+    #
+    # @return RubyAem::Result
+    def stop
+      @client.call(self.class, __callee__.to_s, @info)
+    end
+
+  end
+end