ruby_aem 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d453de388f2dc00342d36f11040e2dff294a4dc
-  data.tar.gz: b60ea29a13c060f5ff2cb4d7dfa6d2c774bfe68b
+  metadata.gz: d0f1ce4ed2a578ad6207b8ee2084a68fc33add63
+  data.tar.gz: 40234461975d56d98f46114379bfdce1db25bae1
 SHA512:
-  metadata.gz: 1e3f54abe4d1764f61a1eddb6dc8450f6b907b264c4bb23a62b077a7f30ccd4720c8e2438edfa748854ed6305a4be7127d55e6e54caf8b5b6a33c7aa1d93ec68
-  data.tar.gz: 0147ebd982bb243ba129958f588d4a9ddc89c788c2591f2750416b1152f6818566d8d54ab6e42f5709166dd1a15e8c632af23d259887e47b801dae98e5afb047
+  metadata.gz: 3fe281388b41b35867c105caa54eb8904d0e77f9287c13e021ebf3437fe09e70f090aae218deea7ffc9efac332b3995f698668b02e3f472b2896c75b75480e9f
+  data.tar.gz: e1068b423cd27d207b10be4ec13e082869c7e159dc7df892c49d3a7b47bd66fa5154aeeb251e0be668c150f4feb1435cf796703421e9cf156ed5a33baef5b79b

data/conf/spec.yaml

@@ -1,8 +1,7 @@
 bundle:
   responses:
     404:
-      status: failure
-      handler: simple
+      handler: simple_error
       message: 'Bundle %{name} not found'
   actions:
     start:
@@ -14,7 +13,6 @@ bundle:
           action: start
       responses:
         200:
-          status: success
           handler: simple
           message: 'Bundle %{name} started'
     stop:
@@ -26,14 +24,12 @@ bundle:
           action: stop
       responses:
         200:
-          status: success
           handler: simple
           message: 'Bundle %{name} stopped'
 flushagent:
   responses:
     404:
-      status: failure
-      handler: simple
+      handler: simple_error
       message: 'Flush agent %{name} not found on %{run_mode}'
   actions:
     create_update:
@@ -50,7 +46,7 @@ flushagent:
           jcrcontentjcrdescription: '%{description}'
           jcrcontentslingresource_type: /libs/cq/replication/components/agent
           jcrcontenttransport_uri: '%{dest_base_url}/dispatcher/invalidate.cache'
-          jcrcontentlog_level: error
+          jcrcontentlog_level: '%{log_level}'
           jcrcontentno_versioning: true
           jcrcontentprotocol_http_headers:
             - 'CQ-Action:{action}'
@@ -58,7 +54,7 @@ flushagent:
             - 'CQ-Path:{path}'
           jcrcontentprotocol_http_headers_type_hint: String[]
           jcrcontentprotocol_http_method: GET
-          jcrcontentretry_delay: 30000
+          jcrcontentretry_delay: '%{retry_delay}'
           jcrcontentserialization_type: flush
           jcrcontentjcrmixin_types: cq:ReplicationStatus
           jcrcontenttrigger_receive: true
@@ -67,11 +63,9 @@ flushagent:
           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:
@@ -83,7 +77,6 @@ flushagent:
           name: '%{name}'
       responses:
         204:
-          status: success
           handler: simple
           message: 'Flush agent %{name} deleted on %{run_mode}'
     exists:
@@ -95,14 +88,15 @@ flushagent:
           name: '%{name}'
       responses:
         302:
-          status: success
-          handler: simple
+          handler: simple_true
           message: 'Flush agent %{name} exists on %{run_mode}'
+        404:
+          handler: simple_false
+          message: 'Flush agent %{name} not found on %{run_mode}'
 group:
   responses:
     404:
-      status: failure
-      handler: simple
+      handler: simple_error
       message: 'Group %{name} not found'
   actions:
     create:
@@ -117,7 +111,6 @@ group:
           profilegiven_name: '%{name}'
       responses:
         201:
-          status: success
           handler: html_authorizable_id
           message: 'Group %{name} created at %{path}/%{authorizable_id}'
     find_authorizable_id:
@@ -131,9 +124,11 @@ group:
           _1_property_value: '%{name}'
       responses:
         200:
-          status: success
           handler: json_authorizable_id
           message: 'Found group %{name} authorizable ID %{authorizable_id}'
+        404:
+          handler: simple_nil
+          message: 'Group %{name} not found'
     delete:
       api: sling
       operation: deleteNode
@@ -143,7 +138,6 @@ group:
           name: '%{authorizable_id}'
       responses:
         204:
-          status: success
           handler: simple
           message: 'Group %{name} deleted at /%{path}/%{authorizable_id}'
     exists:
@@ -155,9 +149,11 @@ group:
           name: '%{authorizable_id}'
       responses:
         302:
-          status: success
-          handler: simple
+          handler: simple_true
           message: 'Group %{name} exists at /%{path}/%{authorizable_id}'
+        404:
+          handler: simple_false
+          message: 'Group %{name} not found'
     set_permission:
       api: cq
       operation: postCqActions
@@ -167,7 +163,6 @@ group:
           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:
@@ -181,14 +176,12 @@ group:
           add_members: '%{member}'
       responses:
         200:
-          status: success
           handler: simple
           message: 'User/group %{member} added to group %{name}'
 node:
   responses:
     404:
-      status: failure
-      handler: simple
+      handler: simple_error
       message: 'Node %{path}/%{name} not found'
   actions:
     create:
@@ -201,7 +194,6 @@ node:
           name: '%{name}'
       responses:
         201:
-          status: success
           handler: simple
           message: 'Node %{path}/%{name} created'
     delete:
@@ -213,7 +205,6 @@ node:
           name: '%{name}'
       responses:
         204:
-          status: success
           handler: simple
           message: 'Node %{path}/%{name} deleted'
     exists:
@@ -225,9 +216,11 @@ node:
           name: '%{name}'
       responses:
         302:
-          status: success
-          handler: simple
+          handler: simple_true
           message: 'Node %{path}/%{name} exists'
+        404:
+          handler: simple_false
+          message: 'Node %{path}/%{name} not found'
 package:
   actions:
     create:
@@ -244,7 +237,6 @@ package:
           charset: utf-8
       responses:
         200:
-          status: success
           handler: json_package_service
     update:
       api: crx
@@ -260,7 +252,6 @@ package:
           charset: utf-8
       responses:
         200:
-          status: success
           handler: json_package_service
     delete:
       api: crx
@@ -271,7 +262,6 @@ package:
           cmd: delete
       responses:
         200:
-          status: success
           handler: json_package_service
     build:
       api: crx
@@ -282,7 +272,6 @@ package:
           cmd: build
       responses:
         200:
-          status: success
           handler: json_package_service
     install:
       api: crx
@@ -293,7 +282,6 @@ package:
           cmd: install
       responses:
         200:
-          status: success
           handler: json_package_service
     replicate:
       api: crx
@@ -304,7 +292,6 @@ package:
           cmd: replicate
       responses:
         200:
-          status: success
           handler: json_package_service
     download:
       api: sling
@@ -316,7 +303,6 @@ package:
           version: '%{package_version}'
       responses:
         200:
-          status: success
           handler: file_download
           message: 'Package downloaded to %{file_path}/%{package_name}-%{package_version}.zip'
     upload:
@@ -331,7 +317,6 @@ package:
           package: __FILE__
       responses:
         200:
-          status: success
           handler: json_package_service
     get_filter:
       api: sling
@@ -343,7 +328,6 @@ package:
           version: '%{package_version}'
       responses:
         200:
-          status: success
           handler: json_package_filter
           message: 'Filter retrieved successfully'
     list_all:
@@ -354,7 +338,6 @@ package:
           cmd: ls
       responses:
         200:
-          status: success
           handler: xml_package_list
           message: 'Package list retrieved successfully'
 path:
@@ -369,7 +352,6 @@ path:
           path: '%{name}'
       responses:
         200:
-          status: success
           handler: simple
           message: 'Path %{name} activated'
 configproperty:
@@ -404,18 +386,15 @@ configproperty:
           - 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
+      handler: simple_error
       message: 'Replication agent %{name} not found on %{run_mode}'
   actions:
     create_update:
@@ -426,24 +405,24 @@ replicationagent:
           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
+          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'
+          jcrcontenttransport_user: '%{transport_user}'
+          jcrcontenttransport_password: '%{transport_password}'
+          jcrcontentlog_level: '%{log_level}'
+          jcrcontentretry_delay: '%{retry_delay}'
+          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:
@@ -455,7 +434,6 @@ replicationagent:
           name: '%{name}'
       responses:
         204:
-          status: success
           handler: simple
           message: 'Replication agent %{name} deleted on %{run_mode}'
     exists:
@@ -467,9 +445,11 @@ replicationagent:
           name: '%{name}'
       responses:
         302:
-          status: success
-          handler: simple
+          handler: simple_true
           message: 'Replication agent %{name} exists on %{run_mode}'
+        404:
+          handler: simple_false
+          message: 'Replication agent %{name} not found on %{run_mode}'
 repository:
   actions:
     block_writes:
@@ -480,7 +460,6 @@ repository:
           action: blockRepositoryWrites
       responses:
         200:
-          status: success
           handler: simple
           message: 'Repository writes blocked'
     unblock_writes:
@@ -491,14 +470,12 @@ repository:
           action: unblockRepositoryWrites
       responses:
         200:
-          status: success
           handler: simple
           message: 'Repository writes unblocked'
 user:
   responses:
     404:
-      status: failure
-      handler: simple
+      handler: simple_error
       message: 'User %{name} not found'
   actions:
     create:
@@ -513,7 +490,6 @@ user:
           reppassword: '%{password}'
       responses:
         201:
-          status: success
           handler: html_authorizable_id
           message: 'User %{name} created at %{path}/%{authorizable_id}'
     find_authorizable_id:
@@ -527,9 +503,11 @@ user:
           _1_property_value: '%{name}'
       responses:
         200:
-          status: success
           handler: json_authorizable_id
           message: 'Found user %{name} authorizable ID %{authorizable_id}'
+        404:
+          handler: simple_nil
+          message: 'User %{name} not found'
     delete:
       api: sling
       operation: deleteNode
@@ -539,7 +517,6 @@ user:
           name: '%{authorizable_id}'
       responses:
         204:
-          status: success
           handler: simple
           message: 'User %{name} deleted at /%{path}/%{authorizable_id}'
     exists:
@@ -551,9 +528,11 @@ user:
           name: '%{authorizable_id}'
       responses:
         302:
-          status: success
-          handler: simple
+          handler: simple_true
           message: 'User %{name} exists at /%{path}/%{authorizable_id}'
+        404:
+          handler: simple_false
+          message: 'User %{name} not found'
     set_permission:
       api: cq
       operation: postCqActions
@@ -563,7 +542,6 @@ user:
           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:
@@ -576,6 +554,5 @@ user:
           verify: '%{new_password}'
       responses:
         200:
-          status: success
           handler: simple
           message: 'Logged in user password changed'

data/lib/ruby_aem/client.rb

@@ -14,11 +14,13 @@ See the License for the specific language governing permissions and
 limitations under the License.
 =end
 
+require 'ruby_aem/error'
 require 'ruby_aem/handlers/file'
 require 'ruby_aem/handlers/html'
 require 'ruby_aem/handlers/json'
 require 'ruby_aem/handlers/simple'
 require 'ruby_aem/handlers/xml'
+require 'ruby_aem/response'
 require 'ruby_aem/swagger'
 require 'swagger_aem'
 
@@ -40,15 +42,18 @@ module RubyAem
     # Make an API call using the relevant Swagger AEM API client.
     # Clazz and action parameters are used to identify the action, API, and params
     # from ruby_aem specification, alongside the response handlers.
+    # Call parameters are used to construct HTTP request parameters based on the
+    # specification.
     #
     # @param clazz the class name of the caller resource
     # @param action the action of the API call
-    # @param info additional information of the API call
+    # @param call_params API call parameters
     # @return RubyAem::Result
-    def call(clazz, action, info)
+    def call(clazz, action, call_params)
 
-      component = clazz.name.downcase.sub('rubyaem::', '')
-      action_spec = @spec[component]['actions'][action]
+      resource_name = clazz.name.downcase.sub('rubyaem::resources::', '')
+      resource = @spec[resource_name]
+      action_spec = resource['actions'][action]
 
       api = @apis[action_spec['api'].to_sym]
       operation = action_spec['operation']
@@ -56,25 +61,26 @@ module RubyAem
       params = []
       required_params = action_spec['params']['required'] || {}
       required_params.each { |key, value|
-        params.push(value % info)
+        params.push(value % call_params)
       }
       params.push({})
       optional_params = action_spec['params']['optional'] || {}
       optional_params.each { |key, value|
-        add_optional_param(key, value, params, info)
+        add_optional_param(key, value, params, call_params)
       }
 
-      base_responses = @spec[component]['responses'] || {}
-      action_responses = action_spec['responses'] || {}
-      responses = base_responses.merge(action_responses)
+      base_responses_spec = resource['responses'] || {}
+      action_responses_spec = action_spec['responses'] || {}
+      responses_spec = base_responses_spec.merge(action_responses_spec)
 
       begin
         method = RubyAem::Swagger.operation_to_method(operation)
         data, status_code, headers = api.send("#{method}_with_http_info", *params)
-        handle(data, status_code, headers, responses, info)
+        response = RubyAem::Response.new(status_code, data, headers)
       rescue SwaggerAemClient::ApiError => err
-        handle(err.response_body, err.code, err.response_headers, responses, info)
+        response = RubyAem::Response.new(err.code, err.response_body, err.response_headers)
       end
+      handle(response, responses_spec, call_params)
     end
 
     # Add optional param into params list.
@@ -82,24 +88,24 @@ module RubyAem
     # @param key optional param key
     # @param value optional param value
     # @param params combined list of required and optional parameters
-    # @param info additional information
-    def add_optional_param(key, value, params, info)
+    # @param call_params API call parameters
+    def add_optional_param(key, value, params, call_params)
       # if there is no value in optional param spec,
-      # then only add optional param that is set in info
+      # then only add optional param that is set in call parameters
       if !value
-        if info.key? key.to_sym
-          params[-1][key.to_sym] = info[key.to_sym]
+        if call_params.key? key.to_sym
+          params[-1][key.to_sym] = call_params[key.to_sym]
         end
       # if value is provided in optional param spec,
       # then apply variable interpolation the same way as required param
       else
         if value.class == String
           if value == '__FILE__'
-            File.open("#{info[:file_path]}/#{info[:package_name]}-#{info[:package_version]}.zip", 'r') { |file|
+            File.open("#{call_params[:file_path]}/#{call_params[:package_name]}-#{call_params[:package_version]}.zip", 'r') { |file|
               params[-1][key.to_sym] = file
             }
           else
-            params[-1][key.to_sym] = value % info
+            params[-1][key.to_sym] = value % call_params
           end
         else
           params[-1][key.to_sym] = value
@@ -111,19 +117,20 @@ module RubyAem
     # If none of the response specifications contains the status code, a failure result
     # will then be returned.
     #
-    # @param data data payload
-    # @param status_code response HTTP status code
-    # @param headers response HTTP headers
-    # @param responses a list of response specifications as configured in conf/spec.yaml
-    # @param info additional information
+    # @param response response containing HTTP status code, body, and headers
+    # @param responses_spec a list of response specifications as configured in conf/spec.yaml
+    # @param call_params API call parameters
     # @return RubyAem::Result
-    def handle(data, status_code, headers, responses, info)
-      if responses.key?(status_code)
-        response_spec = responses[status_code]
+    # @raise RubyAem::Error when the response status code is unexpected
+    def handle(response, responses_spec, call_params)
+      if responses_spec.key?(response.status_code)
+        response_spec = responses_spec[response.status_code]
         handler = response_spec['handler']
-        result = Handlers.send(handler, data, status_code, headers, response_spec, info)
+        result = Handlers.send(handler, response, response_spec, call_params)
       else
-        result = Result.new('failure', "Unexpected response\nstatus code: #{status_code}\nheaders: #{headers}\ndata: #{data}")
+        message = "Unexpected response\nstatus code: #{response.status_code}\nheaders: #{response.headers}\nbody: #{response.body}"
+        result = Result.new(message, response)
+        raise RubyAem::Error.new(message, result)
       end
     end
 

data/lib/ruby_aem/error.rb

@@ -0,0 +1,28 @@
+=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
+
+  class Error < StandardError
+    attr_accessor :result
+
+    def initialize(message, result)
+      super(message)
+      self.result = result
+    end
+
+  end
+end

data/lib/ruby_aem/handlers/file.rb

@@ -18,24 +18,22 @@ module RubyAem
   # Response handlers for file payload.
   module Handlers
 
-    # Handle downloaded file by copying from temporary location to file_path info.
+    # Handle downloaded file by copying from temporary location to file_path call param.
     # The downloaded file in temporary location will then be deleted.
     # data, status_code, and headers are all returned from RubyAem::Client call.
     #
-    # @param data data payload
-    # @param status_code response HTTP status code
-    # @param headers response HTTP headers
+    # @param response HTTP response containing status_code, body, and headers
     # @param response_spec response specification as configured in conf/spec.yaml
-    # @param info additional information
+    # @param call_params API call parameters
     # @return RubyAem::Result
-    def Handlers.file_download(data, status_code, headers, response_spec, info)
+    def Handlers.file_download(response, response_spec, call_params)
 
-      FileUtils.cp(data.path, "#{info[:file_path]}/#{info[:package_name]}-#{info[:package_version]}.zip")
-      data.delete
+      FileUtils.cp(response.body.path, "#{call_params[:file_path]}/#{call_params[:package_name]}-#{call_params[:package_version]}.zip")
+      response.body.delete
 
-      message = response_spec['message'] % info
+      message = response_spec['message'] % call_params
 
-      RubyAem::Result.new('success', message)
+      RubyAem::Result.new(message, response)
     end
 
   end

data/lib/ruby_aem/handlers/html.rb

@@ -23,23 +23,20 @@ module RubyAem
     # Parse authorizable ID from response body data.
     # This is used to get the authorizable ID of a newly created user/group.
     #
-    # @param data data payload
-    # @param status_code response HTTP status code
-    # @param headers response HTTP headers
+    # @param response HTTP response containing status_code, body, and headers
     # @param response_spec response specification as configured in conf/spec.yaml
-    # @param info additional information
+    # @param call_params API call parameters
     # @return RubyAem::Result
-    def Handlers.html_authorizable_id(data, status_code, headers, response_spec, info)
+    def Handlers.html_authorizable_id(response, response_spec, call_params)
 
-      html = Nokogiri::HTML(data)
+      html = Nokogiri::HTML(response.body)
       authorizable_id = html.xpath('//title/text()').to_s
-      authorizable_id.slice! "Content created #{info[:path]}"
-      info[:authorizable_id] = authorizable_id.sub(/^\//, '')
+      authorizable_id.slice! "Content created #{call_params[:path]}"
+      call_params[:authorizable_id] = authorizable_id.sub(/^\//, '')
 
-      status = response_spec['status']
-      message = response_spec['message'] % info
+      message = response_spec['message'] % call_params
 
-      RubyAem::Result.new(status, message)
+      RubyAem::Result.new(message, response)
     end
 
   end