ruby_aem 1.1.2 → 1.2.0

data/lib/ruby_aem/resources/bundle.rb

@@ -1,24 +1,21 @@
-=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
+# Copyright 2016-2017 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.
 
 module RubyAem
   module Resources
     # Bundle class contains API calls related to managing an AEM bundle.
     class Bundle
-
       # Initialise a bundle.
       #
       # @param client RubyAem::Client
@@ -44,7 +41,6 @@ module RubyAem
       def stop
         @client.call(self.class, __callee__.to_s, @call_params)
       end
-
     end
   end
 end

data/lib/ruby_aem/resources/config_property.rb

@@ -1,25 +1,22 @@
-=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
+# Copyright 2016-2017 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/swagger'
 
 module RubyAem
   module Resources
     # ConfigProperty class contains API calls related to managing an AEM config property.
     class ConfigProperty
-
       # Initialise a config property
       #
       # @param client RubyAem::Client
@@ -42,7 +39,6 @@ module RubyAem
       # @param @param config_node_name the node name of a given OSGI config
       # @return RubyAem::Result
       def create(run_mode, config_node_name)
-
         name = RubyAem::Swagger.property_to_parameter(@call_params[:name])
         type_hint_prefix = name.gsub(/^_/, '')
 
@@ -54,7 +50,6 @@ module RubyAem
         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)
       end
-
     end
   end
 end

data/lib/ruby_aem/resources/flush_agent.rb

@@ -1,25 +1,22 @@
-=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
+# Copyright 2016-2017 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 'uri'
 
 module RubyAem
   module Resources
     # FlushAgent class contains API calls related to managing an AEM flush agent.
     class FlushAgent
-
       # Initialise a flush agent.
       #
       # @param client RubyAem::Client
@@ -41,13 +38,17 @@ module RubyAem
       # @param dest_base_url base URL of the agent target destination, e.g. http://somedispatcher:8080
       # @param opts optional parameters:
       # - log_level: error, info, debug, default is error
-      # - retry_delay: in milliseconds, default is 30000
+      # - retry_delay: in milliseconds, default is 30_000
       # @return RubyAem::Result
-      def create_update(title, description, dest_base_url,
-          opts = {
-            log_level: 'error',
-            retry_delay: 30000
-          })
+      def create_update(
+        title,
+        description,
+        dest_base_url,
+        opts = {
+          log_level: 'error',
+          retry_delay: 30_000
+        }
+      )
         @call_params[:title] = title
         @call_params[:description] = description
         @call_params[:dest_base_url] = dest_base_url
@@ -62,7 +63,7 @@ module RubyAem
       # Delete the flush agent.
       #
       # @return RubyAem::Result
-      def delete()
+      def delete
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -71,10 +72,9 @@ module RubyAem
       # false otherwise.
       #
       # @return RubyAem::Result
-      def exists()
+      def exists
         @client.call(self.class, __callee__.to_s, @call_params)
       end
-
     end
   end
 end

data/lib/ruby_aem/resources/group.rb

@@ -1,24 +1,21 @@
-=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
+# Copyright 2016-2017 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.
 
 module RubyAem
   module Resources
     # Group class contains API calls related to managing an AEM group.
     class Group
-
       # Initialise a group.
       #
       # @param client RubyAem::Client
@@ -36,17 +33,15 @@ module RubyAem
       # Create a new group.
       #
       # @return RubyAem::Result
-      def create()
-        if !@call_params[:path].match(/^\//)
-          @call_params[:path] = "/#{@call_params[:path]}"
-        end
+      def create
+        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].match(%r{^/})
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
       # Delete the group.
       #
       # @return RubyAem::Result
-      def delete()
+      def delete
         result = find_authorizable_id
         @call_params[:authorizable_id] = result.data
         @call_params[:path] = RubyAem::Swagger.path(@call_params[:path])
@@ -58,7 +53,7 @@ module RubyAem
       # false otherwise.
       #
       # @return RubyAem::Result
-      def exists()
+      def exists
         result = find_authorizable_id
         @call_params[:authorizable_id] = result.data
         @call_params[:path] = RubyAem::Swagger.path(@call_params[:path])
@@ -93,13 +88,10 @@ module RubyAem
       # cannot be found.
       #
       # @return RubyAem::Result
-      def find_authorizable_id()
-        if !@call_params[:path].match(/^\//)
-          @call_params[:path] = "/#{@call_params[:path]}"
-        end
+      def find_authorizable_id
+        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].match(%r{^/})
         @client.call(self.class, __callee__.to_s, @call_params)
       end
-
     end
   end
 end

data/lib/ruby_aem/resources/node.rb

@@ -1,24 +1,21 @@
-=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
+# Copyright 2016-2017 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.
 
 module RubyAem
   module Resources
     # Node class contains API calls related to managing an AEM node.
     class Node
-
       # Initialise a node.
       #
       # @param client RubyAem::Client
@@ -47,7 +44,7 @@ module RubyAem
       # Delete the node.
       #
       # @return RubyAem::Result
-      def delete()
+      def delete
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -56,10 +53,9 @@ module RubyAem
       # false otherwise.
       #
       # @return RubyAem::Result
-      def exists()
+      def exists
         @client.call(self.class, __callee__.to_s, @call_params)
       end
-
     end
   end
 end

data/lib/ruby_aem/resources/outbox_replication_agent.rb

@@ -1,24 +1,21 @@
-=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
+# Copyright 2016-2017 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.
 
 module RubyAem
   module Resources
     # OutboxReplicationAgent class contains API calls related to managing an AEM outbox replication agent.
     class OutboxReplicationAgent
-
       # Initialise a outbox replication agent.
       #
       # @param client RubyAem::Client
@@ -41,14 +38,18 @@ module RubyAem
       # @param opts optional parameters:
       # - user_id: outbox agent's user ID, default is admin
       # - log_level: error, info, debug, default is error
-      # - retry_delay: in milliseconds, default is 30000
+      # - retry_delay: in milliseconds, default is 30_000
       # @return RubyAem::Result
-      def create_update(title, description, dest_base_url,
+      def create_update(
+        title,
+        description,
+        dest_base_url,
         opts = {
           user_id: 'admin',
           log_level: 'error',
-          retry_delay: 30000
-        })
+          retry_delay: 30_000
+        }
+      )
         @call_params[:title] = title
         @call_params[:description] = description
         @call_params[:dest_base_url] = dest_base_url
@@ -59,7 +60,7 @@ module RubyAem
       # Delete the outbox replication agent.
       #
       # @return RubyAem::Result
-      def delete()
+      def delete
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -68,10 +69,9 @@ module RubyAem
       # false otherwise.
       #
       # @return RubyAem::Result
-      def exists()
+      def exists
         @client.call(self.class, __callee__.to_s, @call_params)
       end
-
     end
   end
 end

data/lib/ruby_aem/resources/package.rb

@@ -1,18 +1,16 @@
-=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
+# Copyright 2016-2017 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 'retries'
 
@@ -20,7 +18,6 @@ module RubyAem
   module Resources
     # Package class contains API calls related to managing an AEM package.
     class Package
-
       # Initialise a package.
       # Package name and version will then be used to construct the package file in the filesystem.
       # E.g. package name 'somepackage' with version '1.2.3' will translate to somepackage-1.2.3.zip in the filesystem.
@@ -42,7 +39,7 @@ module RubyAem
       # Create the package.
       #
       # @return RubyAem::Result
-      def create()
+      def create
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -59,14 +56,14 @@ module RubyAem
       # Delete the package.
       #
       # @return RubyAem::Result
-      def delete()
+      def delete
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
       # Build the package.
       #
       # @return RubyAem::Result
-      def build()
+      def build
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -76,8 +73,8 @@ module RubyAem
       # - recursive: if true then subpackages will also be installed, false otherwise
       # @return RubyAem::Result
       def install(opts = {
-          recursive: true
-        })
+        recursive: true
+      })
         @call_params = @call_params.merge(opts)
         @client.call(self.class, __callee__.to_s, @call_params)
       end
@@ -85,7 +82,7 @@ module RubyAem
       # Uninstall the package.
       #
       # @return RubyAem::Result
-      def uninstall()
+      def uninstall
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -93,7 +90,7 @@ module RubyAem
       # Package will then be added to replication agents.
       #
       # @return RubyAem::Result
-      def replicate()
+      def replicate
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -112,10 +109,12 @@ module RubyAem
       # @param opts optional parameters:
       # - force: if false then a package file will not be uploaded when the package already exists with the same group, name, and version, default is true (will overwrite existing package file)
       # @return RubyAem::Result
-      def upload(file_path,
+      def upload(
+        file_path,
         opts = {
           force: true
-        })
+        }
+      )
         @call_params[:file_path] = file_path
         @call_params = @call_params.merge(opts)
         @client.call(self.class, __callee__.to_s, @call_params)
@@ -125,7 +124,7 @@ module RubyAem
       # Filter value is stored as result data as an array of paths.
       #
       # @return RubyAem::Result
-      def get_filter()
+      def get_filter
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -138,7 +137,7 @@ module RubyAem
       # @param modified_only if true, then only modified items in the path will be activated
       # @return an array of RubyAem::Result
       def activate_filter(ignore_deactivated, modified_only)
-        result = get_filter()
+        result = get_filter
 
         results = [result]
         result.data.each { |filter_path|
@@ -151,7 +150,7 @@ module RubyAem
       # List all packages available in AEM instance.
       #
       # @return RubyAem::Result
-      def list_all()
+      def list_all
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -159,8 +158,8 @@ module RubyAem
       # True result data indicates that the package is uploaded, false otherwise.
       #
       # @return RubyAem::Result
-      def is_uploaded()
-        packages = list_all().data
+      def is_uploaded
+        packages = list_all.data
         package = packages.xpath("//packages/package[group=\"#{@call_params[:group_name]}\" and name=\"#{@call_params[:package_name]}\" and version=\"#{@call_params[:package_version]}\"]")
 
         if package.to_s != ''
@@ -180,8 +179,8 @@ module RubyAem
       # True result data indicates that the package is installed, false otherwise.
       #
       # @return RubyAem::Result
-      def is_installed()
-        packages = list_all().data
+      def is_installed
+        packages = list_all.data
         package = packages.xpath("//packages/package[group=\"#{@call_params[:group_name]}\" and name=\"#{@call_params[:package_name]}\" and version=\"#{@call_params[:package_version]}\"]")
         last_unpacked_by = package.xpath('lastUnpackedBy')
 
@@ -205,7 +204,8 @@ module RubyAem
       # - force: if false then a package file will not be uploaded when the package already exists with the same group, name, and version, default is true (will overwrite existing package file)
       # - _retries: retries library's options (http://www.rubydoc.info/gems/retries/0.0.5#Usage), restricted to max_trie, base_sleep_seconds, max_sleep_seconds
       # @return RubyAem::Result
-      def upload_wait_until_ready(file_path,
+      def upload_wait_until_ready(
+        file_path,
         opts = {
           force: true,
           _retries: {
@@ -213,7 +213,8 @@ module RubyAem
             base_sleep_seconds: 2,
             max_sleep_seconds: 2
           }
-        })
+        }
+      )
         opts[:force] ||= true
         opts[:_retries] ||= {}
         opts[:_retries][:max_tries] ||= 30
@@ -226,9 +227,9 @@ module RubyAem
         opts[:_retries][:max_sleep_seconds] = opts[:_retries][:max_sleep_seconds].to_i
 
         result = upload(file_path, opts)
-        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|
-          check_result = is_uploaded()
-          puts 'Upload check #%d: %s - %s' % [retries_count, check_result.data, check_result.message]
+        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|
+          check_result = is_uploaded
+          puts format('Upload check #%d: %s - %s', retries_count, check_result.data, check_result.message)
           if check_result.data == false
             raise StandardError.new(check_result.message)
           end
@@ -259,10 +260,10 @@ module RubyAem
         opts[:_retries][:base_sleep_seconds] = opts[:_retries][:base_sleep_seconds].to_i
         opts[:_retries][:max_sleep_seconds] = opts[:_retries][:max_sleep_seconds].to_i
 
-        result = install()
-        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|
-          check_result = is_installed()
-          puts 'Install check #%d: %s - %s' % [retries_count, check_result.data, check_result.message]
+        result = install
+        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|
+          check_result = is_installed
+          puts format('Install check #%d: %s - %s', retries_count, check_result.data, check_result.message)
           if check_result.data == false
             raise StandardError.new(check_result.message)
           end
@@ -293,17 +294,16 @@ module RubyAem
         opts[:_retries][:base_sleep_seconds] = opts[:_retries][:base_sleep_seconds].to_i
         opts[:_retries][:max_sleep_seconds] = opts[:_retries][:max_sleep_seconds].to_i
 
-        result = delete()
-        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|
-          check_result = is_uploaded()
-          puts 'Delete check #%d: %s - %s' % [retries_count, !check_result.data, check_result.message]
+        result = delete
+        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|
+          check_result = is_uploaded
+          puts format('Delete check #%d: %s - %s', retries_count, !check_result.data, check_result.message)
           if check_result.data == true
             raise StandardError.new(check_result.message)
           end
         }
         result
       end
-
     end
   end
 end