ruby_aem 1.1.2 → 1.2.0

data/lib/ruby_aem/resources/path.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
     # Path class contains API calls related to managing an AEM path.
     class Path
-
       # Initialise a path.
       #
       # @param client RubyAem::Client
@@ -42,7 +39,6 @@ module RubyAem
 
         @client.call(self.class, __callee__.to_s, @call_params)
       end
-
     end
   end
 end

data/lib/ruby_aem/resources/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
     # ReplicationAgent class contains API calls related to managing an AEM replication agent.
     class ReplicationAgent
-
       # Initialise a replication agent.
       #
       # @param client RubyAem::Client
@@ -42,15 +39,19 @@ module RubyAem
       # - transport_user: username for transport user, default is admin
       # - transport_password: password for transport user, 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 = {
           transport_user: 'admin',
           transport_password: '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
@@ -61,7 +62,7 @@ module RubyAem
       # Delete the replication agent.
       #
       # @return RubyAem::Result
-      def delete()
+      def delete
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -70,10 +71,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/repository.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
     # Repository class contains API calls related to managing an AEM repository.
     class Repository
-
       # Initialise repository.
       #
       # @param client RubyAem::Client
@@ -41,7 +38,6 @@ module RubyAem
       def unblock_writes
         @client.call(self.class, __callee__.to_s, @call_params)
       end
-
     end
   end
 end

data/lib/ruby_aem/resources/reverse_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
     # ReverseReplicationAgent class contains API calls related to managing an AEM reverse replication agent.
     class ReverseReplicationAgent
-
       # Initialise a reverse replication agent.
       #
       # @param client RubyAem::Client
@@ -42,15 +39,19 @@ module RubyAem
       # - transport_user: username for transport user, default is admin
       # - transport_password: password for transport user, 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 = {
           transport_user: 'admin',
           transport_password: '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
@@ -61,7 +62,7 @@ module RubyAem
       # Delete the reverse replication agent.
       #
       # @return RubyAem::Result
-      def delete()
+      def delete
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -70,10 +71,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/user.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
     # User class contains API calls related to managing an AEM user.
     class User
-
       # Initialise a user.
       #
       # @param client RubyAem::Client
@@ -39,16 +36,14 @@ module RubyAem
       # @return RubyAem::Result
       def create(password)
         @call_params[:password] = password
-        if !@call_params[:path].match(/^\//)
-          @call_params[:path] = "/#{@call_params[:path]}"
-        end
+        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].match(%r{^/})
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
       # Delete the user.
       #
       # @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])
@@ -60,7 +55,7 @@ module RubyAem
       # 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])
@@ -106,13 +101,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/response.rb

@@ -1,23 +1,20 @@
-=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
   # Response wraps HTTP response data returned by swagger_aem.
   class Response
-
     attr_accessor :status_code
     attr_accessor :body
     attr_accessor :headers
@@ -33,6 +30,5 @@ module RubyAem
       @body = body
       @headers = headers
     end
-
   end
 end

data/lib/ruby_aem/result.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.
 
 module RubyAem
   # Result class represents the result of a client call.
@@ -23,7 +21,6 @@ module RubyAem
   # e.g. is_* and exists method provide result with boolean data.
   # Some API calls result doesn't contain any data.
   class Result
-
     attr_reader :message
     attr_reader :response
     attr_accessor :data
@@ -37,6 +34,5 @@ module RubyAem
       @message = message
       @response = response
     end
-
   end
 end

data/lib/ruby_aem/swagger.rb

@@ -1,29 +1,26 @@
-=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
   # Swagger module contains logic related to swagger_aem.
   module Swagger
-
     # Convert ruby_aem spec's operation (consistent with Swagger spec's operationId)
     # into swagger_aem's generated method name.
     #
     # @param operation operation ID
     # @return swagger_aem method name
-    def Swagger.operation_to_method(operation)
+    def self.operation_to_method(operation)
       operation.gsub(/[A-Z]/) { |char|
         '_' + char.downcase
       }
@@ -34,11 +31,11 @@ module RubyAem
     #
     # @param property property name
     # @return swagger_aem parameter name
-    def Swagger.property_to_parameter(property)
-      if (['alias'].include? property)
+    def self.property_to_parameter(property)
+      if ['alias'].include? property
         "_#{property}"
       else
-        property.gsub(/\./, '_').gsub(/-/, '_')
+        property.tr('.', '_').tr('-', '_')
       end
     end
 
@@ -47,8 +44,8 @@ module RubyAem
     #
     # @param path path name
     # @return sanitised path name
-    def Swagger.path(path)
-      path.gsub(/^\//, '').gsub(/\/$/, '')
+    def self.path(path)
+      path.gsub(%r{^/}, '').gsub(%r{/$}, '')
     end
 
     # Given a config node name, return the corresponding OSGI config name.
@@ -56,7 +53,7 @@ module RubyAem
     #
     # @param config_node_name the name of the node for a given config
     # @return config name
-    def Swagger.config_node_name_to_config_name(config_node_name)
+    def self.config_node_name_to_config_name(config_node_name)
       case config_node_name
       when 'org.apache.felix.http'
         'Apache Felix Jetty Based HTTP Service'
@@ -70,10 +67,7 @@ module RubyAem
         'AEM Password Reset Activator'
       when 'com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck'
         'AEM Health Check Servlet'
-      else
-        nil
       end
     end
-
   end
 end

data/lib/ruby_aem.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 'ruby_aem/client'
 require 'ruby_aem/resources/aem'
@@ -34,7 +32,6 @@ require 'yaml'
 module RubyAem
   # Aem class represents an AEM client instance.
   class Aem
-
     # Initialise a Ruby AEM instance.
     #
     # @param conf configuration hash of the following configuration values:
@@ -47,7 +44,6 @@ module RubyAem
     # - debug: if true, then additional debug messages will be included, default: false
     # @return new RubyAem::Aem instance
     def initialize(conf = {})
-
       conf[:username] ||= 'admin'
       conf[:password] ||= 'admin'
       conf[:protocol] ||= 'http'
@@ -56,21 +52,23 @@ module RubyAem
       conf[:timeout] ||= 300
       conf[:debug] ||= false
 
-      SwaggerAemClient.configure { |swagger_conf| [
-        swagger_conf.host = "#{conf[:protocol]}://#{conf[:host]}:#{conf[:port]}",
-        swagger_conf.username = conf[:username],
-        swagger_conf.password = conf[:password],
-        swagger_conf.timeout = conf[:timeout],
-        swagger_conf.debugging = conf[:debug],
-        swagger_conf.params_encoding = :multi
-      ]}
+      SwaggerAemClient.configure { |swagger_conf|
+        [
+          swagger_conf.host = "#{conf[:protocol]}://#{conf[:host]}:#{conf[:port]}",
+          swagger_conf.username = conf[:username],
+          swagger_conf.password = conf[:password],
+          swagger_conf.timeout = conf[:timeout],
+          swagger_conf.debugging = conf[:debug],
+          swagger_conf.params_encoding = :multi
+        ]
+      }
 
       apis = {
-        :console => SwaggerAemClient::ConsoleApi.new,
-        :custom => SwaggerAemClient::CustomApi.new,
-        :cq => SwaggerAemClient::CqApi.new,
-        :crx => SwaggerAemClient::CrxApi.new,
-        :sling => SwaggerAemClient::SlingApi.new
+        console: SwaggerAemClient::ConsoleApi.new,
+        custom: SwaggerAemClient::CustomApi.new,
+        cq: SwaggerAemClient::CqApi.new,
+        crx: SwaggerAemClient::CrxApi.new,
+        sling: SwaggerAemClient::SlingApi.new
       }
 
       spec = YAML.load_file(File.expand_path('../../conf/spec.yaml', __FILE__))
@@ -81,7 +79,7 @@ module RubyAem
     # Create an AEM instance.
     #
     # @return new RubyAem::Resources::Aem instance
-    def aem()
+    def aem
       RubyAem::Resources::Aem.new(@client)
     end
 
@@ -190,6 +188,5 @@ module RubyAem
     def user(path, name)
       RubyAem::Resources::User.new(@client, path, name)
     end
-
   end
 end