ruby_aem 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfcbbc34c1b0c32618de4ed051e3200d0075d745
-  data.tar.gz: a781563d14864bcd3556fb09478e6552afb6dcca
+  metadata.gz: 26336e9934e2dff340acbba3e5dc86357252968e
+  data.tar.gz: 84fa257232101ccbe014877c885463a8d8a61f15
 SHA512:
-  metadata.gz: 40382b1e0af6ee9bd28e295eb5ca44a0d2789cad9dbdfcf7351d70971b46cd2f44a7cff445a6b39a8ba8eb8c112ec5a5c5d77fbb7e4adf425012a9f5d93965d4
-  data.tar.gz: 94aef808d85f0110e23b00c991b18024b0bb0d80930f958f05541591af4a7a72dd0efb44342038b56330641c256b8eb2e17fc49bdc6e573015e37ac00f748688
+  metadata.gz: 7c5dbcbd9a7c505dfaebff56d17e46dc48cf7e16909e7e01e04518e9ebca2bb17f245e8b05782bc9db0de4187b6790ec8265c06c2a94fe5ccf162c7244dd29b6
+  data.tar.gz: 470897acaf690a61bdba8efa5fb5b2018cbd53870aeadbef7b6fd9e108f3b5d96ad475de990a0be42ed9979b3a4fb9a3530d557d8bfd0cb547c66d43a4ca65f5

data/lib/ruby_aem.rb

@@ -52,6 +52,12 @@ module RubyAem
       conf[:timeout] ||= 300
       conf[:debug] ||= false
 
+      # handle custom configuration value being passed as a String
+      # e.g. when the values are passed via environment variables
+      conf[:port] = conf[:port].to_i
+      conf[:timeout] = conf[:timeout].to_i
+      conf[:debug] = conf[:debug] == 'true' if conf[:debug].is_a? String
+
       SwaggerAemClient.configure { |swagger_conf|
         [
           swagger_conf.host = "#{conf[:protocol]}://#{conf[:host]}:#{conf[:port]}",

data/lib/ruby_aem/client.rb

@@ -56,7 +56,7 @@ module RubyAem
 
       params = []
       required_params = action_spec['params']['required'] || {}
-      required_params.each { |key, value|
+      required_params.each { |_key, value|
         params.push(value % call_params)
       }
       params.push({})
@@ -94,18 +94,16 @@ module RubyAem
         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("#{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 % call_params
-          end
+      elsif value.class == String
+        if value == '__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
+          params[-1][key.to_sym] = value % call_params
         end
+      else
+        params[-1][key.to_sym] = value
       end
     end
 

data/lib/ruby_aem/error.rb

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 module RubyAem
+  # RubyAem error, contains a message and RubyAem::Result object
+  # useful for debugging the result and response when an error occurs
   class Error < StandardError
     attr_accessor :result
 

data/lib/ruby_aem/handlers/json.rb

@@ -46,17 +46,14 @@ module RubyAem
     # @param response_spec response specification as configured in conf/spec.yaml
     # @param call_params additional call_params information
     # @return RubyAem::Result
-    def self.json_package_service(response, response_spec, call_params)
+    def self.json_package_service(response, _response_spec, _call_params)
       json = JSON.parse(response.body)
 
       message = json['msg']
       result = RubyAem::Result.new(message, response)
 
-      if json['success'] == true
-        result
-      else
-        raise RubyAem::Error.new(message, result)
-      end
+      return result if json['success'] == true
+      raise RubyAem::Error.new(message, result)
     end
 
     # Handle package filter JSON payload.
@@ -69,7 +66,7 @@ module RubyAem
       json = JSON.parse(response.body)
 
       filter = []
-      json.each do |key, value|
+      json.each do |key, _value|
         filter.push(json[key]['root']) unless json[key]['root'].nil?
       end
 
@@ -106,8 +103,8 @@ module RubyAem
       json = JSON.parse(response.body)
 
       agent_names = []
-      json.each do |key, value|
-        if !key.start_with? 'jcr:' and !key.start_with? 'rep:'
+      json.each do |key, _value|
+        if (!key.start_with? 'jcr:') && (!key.start_with? 'rep:')
           agent_names.push(key)
         end
       end

data/lib/ruby_aem/resources/aem.rb

@@ -61,7 +61,8 @@ module RubyAem
             base_sleep_seconds: 2,
             max_sleep_seconds: 2
           }
-        })
+        }
+      )
         opts[:_retries] ||= {}
         opts[:_retries][:max_tries] ||= 30
         opts[:_retries][:base_sleep_seconds] ||= 2
@@ -102,7 +103,8 @@ module RubyAem
             base_sleep_seconds: 2,
             max_sleep_seconds: 2
           }
-        })
+        }
+      )
         opts[:_retries] ||= {}
         opts[:_retries][:max_tries] ||= 30
         opts[:_retries][:base_sleep_seconds] ||= 2

data/lib/ruby_aem/resources/config_property.rb

@@ -44,7 +44,7 @@ module RubyAem
 
         @call_params[:run_mode] = run_mode
         @call_params[:config_node_name] = config_node_name
-        @call_params["#{name}".to_sym] = @call_params[:value]
+        @call_params[name.to_sym] = @call_params[:value]
         @call_params["#{type_hint_prefix}_type_hint".to_sym] = @call_params[:type]
 
         config_name = Swagger.config_node_name_to_config_name(config_node_name)

data/lib/ruby_aem/resources/group.rb

@@ -34,7 +34,7 @@ module RubyAem
       #
       # @return RubyAem::Result
       def create
-        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].match(%r{^/})
+        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].start_with? '/'
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -89,7 +89,7 @@ module RubyAem
       #
       # @return RubyAem::Result
       def find_authorizable_id
-        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].match(%r{^/})
+        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].start_with? '/'
         @client.call(self.class, __callee__.to_s, @call_params)
       end
     end

data/lib/ruby_aem/resources/package.rb

@@ -154,23 +154,61 @@ module RubyAem
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
-      # Check if this package is uploaded.
-      # True result data indicates that the package is uploaded, false otherwise.
+      # Find all versions of the package
+      # Result data should contain an array of version values, empty array if there's none.
       #
       # @return RubyAem::Result
-      def is_uploaded
+      def get_versions
+        packages = list_all.data
+        package_versions = packages.xpath("//packages/package[group=\"#{@call_params[:group_name]}\" and name=\"#{@call_params[:package_name]}\"]")
+
+        versions = []
+        package_versions.each do |package|
+          version = package.xpath('version/text()')
+          versions.push(version.to_s) if version.to_s != ''
+        end
+
+        message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} has #{versions.length} version(s)"
+        result = RubyAem::Result.new(message, nil)
+        result.data = versions
+
+        result
+      end
+
+      # Check if this package exists.
+      # True result data indicates that the package exists, false otherwise.
+      #
+      # @return RubyAem::Result
+      def exists
         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 != ''
-          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is uploaded"
-          is_uploaded = true
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} exists"
+          exists = true
         else
-          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is not uploaded"
-          is_uploaded = false
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} does not exist"
+          exists = false
         end
         result = RubyAem::Result.new(message, nil)
-        result.data = is_uploaded
+        result.data = exists
+
+        result
+      end
+
+      # Check if this package is uploaded. The indicator whether a package is uploaded is when it exists
+      # True result data indicates that the package is uploaded, false otherwise.
+      #
+      # @return RubyAem::Result
+      def is_uploaded
+        result = exists
+
+        result.message =
+          if result.data == true
+            "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is uploaded"
+          else
+            "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is not uploaded"
+          end
 
         result
       end
@@ -184,7 +222,7 @@ module RubyAem
         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')
 
-        if not ['', '<lastUnpackedBy/>', '<lastUnpackedBy>null</lastUnpackedBy>'].include? last_unpacked_by.to_s
+        if !['', '<lastUnpackedBy/>', '<lastUnpackedBy>null</lastUnpackedBy>'].include? last_unpacked_by.to_s
           message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is installed"
           is_installed = true
         else
@@ -197,12 +235,60 @@ module RubyAem
         result
       end
 
+      # Check if this package is empty (has size 0).
+      # True result data indicates that the package is empty, false otherwise.
+      #
+      # @return RubyAem::Result
+      def is_empty
+        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]}\"]")
+        size = package.xpath('size/text()').to_s.to_i
+
+        if size.zero?
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is empty"
+          is_empty = true
+        else
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is not empty"
+          is_empty = false
+        end
+        result = RubyAem::Result.new(message, nil)
+        result.data = is_empty
+
+        result
+      end
+
+      # Check if this package is built. The indicator whether a package is built is when it exists and is not empty.
+      # True result data indicates that the package is built, false otherwise.
+      #
+      # @return RubyAem::Result
+      def is_built
+        exists_result = exists
+
+        if exists_result.data == true
+          is_empty_result = is_empty
+          if is_empty_result.data == false
+            message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is built"
+            is_built = true
+          else
+            message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is not built because it is empty"
+            is_built = false
+          end
+        else
+          message = "Package #{@call_params[:group_name]}/#{@call_params[:package_name]}-#{@call_params[:package_version]} is not built because it does not exist"
+          is_built = false
+        end
+        result = RubyAem::Result.new(message, nil)
+        result.data = is_built
+
+        result
+      end
+
       # Upload the package and wait until the package status states it is uploaded.
       #
       # @param file_path the directory where the package file to be uploaded is
       # @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)
-      # - _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
+      # - _retries: retries library's options (http://www.rubydoc.info/gems/retries/0.0.5#Usage), restricted to max_tries, base_sleep_seconds, max_sleep_seconds
       # @return RubyAem::Result
       def upload_wait_until_ready(
         file_path,
@@ -240,7 +326,7 @@ module RubyAem
       # Install the package and wait until the package status states it is installed.
       #
       # @param opts optional parameters:
-      # - _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
+      # - _retries: retries library's options (http://www.rubydoc.info/gems/retries/0.0.5#Usage), restricted to max_tries, base_sleep_seconds, max_sleep_seconds
       # @return RubyAem::Result
       def install_wait_until_ready(
         opts = {
@@ -249,7 +335,8 @@ module RubyAem
             base_sleep_seconds: 2,
             max_sleep_seconds: 2
           }
-        })
+        }
+      )
         opts[:_retries] ||= {}
         opts[:_retries][:max_tries] ||= 30
         opts[:_retries][:base_sleep_seconds] ||= 2
@@ -274,7 +361,7 @@ module RubyAem
       # Delete the package and wait until the package status states it is not uploaded.
       #
       # @param opts optional parameters:
-      # - _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
+      # - _retries: retries library's options (http://www.rubydoc.info/gems/retries/0.0.5#Usage), restricted to max_tries, base_sleep_seconds, max_sleep_seconds
       # @return RubyAem::Result
       def delete_wait_until_ready(
         opts = {
@@ -283,7 +370,8 @@ module RubyAem
             base_sleep_seconds: 2,
             max_sleep_seconds: 2
           }
-        })
+        }
+      )
         opts[:_retries] ||= {}
         opts[:_retries][:max_tries] ||= 30
         opts[:_retries][:base_sleep_seconds] ||= 2
@@ -304,6 +392,41 @@ module RubyAem
         }
         result
       end
+
+      # Build the package and wait until the package status states it is built (exists and not empty).
+      #
+      # @param opts optional parameters:
+      # - _retries: retries library's options (http://www.rubydoc.info/gems/retries/0.0.5#Usage), restricted to max_tries, base_sleep_seconds, max_sleep_seconds
+      # @return RubyAem::Result
+      def build_wait_until_ready(
+        opts = {
+          _retries: {
+            max_tries: 30,
+            base_sleep_seconds: 2,
+            max_sleep_seconds: 2
+          }
+        }
+      )
+        opts[:_retries] ||= {}
+        opts[:_retries][:max_tries] ||= 30
+        opts[:_retries][:base_sleep_seconds] ||= 2
+        opts[:_retries][:max_sleep_seconds] ||= 2
+
+        # ensure integer retries setting (Puppet 3 passes numeric string)
+        opts[:_retries][:max_tries] = opts[:_retries][:max_tries].to_i
+        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 = build
+        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_built
+          puts format('Build check #%d: %s - %s', retries_count, check_result.data, check_result.message)
+          if check_result.data == false
+            raise StandardError.new(check_result.message)
+          end
+        }
+        result
+      end
     end
   end
 end

data/lib/ruby_aem/resources/user.rb

@@ -36,7 +36,7 @@ module RubyAem
       # @return RubyAem::Result
       def create(password)
         @call_params[:password] = password
-        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].match(%r{^/})
+        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].start_with? '/'
         @client.call(self.class, __callee__.to_s, @call_params)
       end
 
@@ -102,7 +102,7 @@ module RubyAem
       #
       # @return RubyAem::Result
       def find_authorizable_id
-        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].match(%r{^/})
+        @call_params[:path] = "/#{@call_params[:path]}" unless @call_params[:path].start_with? '/'
         @client.call(self.class, __callee__.to_s, @call_params)
       end
     end

data/lib/ruby_aem/result.rb

@@ -21,7 +21,7 @@ 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_accessor :message
     attr_reader :response
     attr_accessor :data
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_aem
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Shine Solutions
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri