aemcrxpkgmgr 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 25e42cf987c2c0d2c02946a69e39c571f9b4f489
-  data.tar.gz: e85f1b2e45e9fc2862755bcc6a7f60dadee353a2
+SHA256:
+  metadata.gz: a24f0915b9577e735d320619e2d23162465df08c79036d0404f04e334da152c0
+  data.tar.gz: 393a36ccdb60bcb7131523e86a746c3aa99c448647ed6fa68cc26cbc6907ca76
 SHA512:
-  metadata.gz: e080da8e6823ebdf995bfe49798c90b9fb6cbcd819ef1c892aa1f51b63afb9bc797bd33ab6d491232414e053866848f46b1a94c827295840b4137363503a2064
-  data.tar.gz: aeab3ca6291b0f7174b7419235c7703c256ab9f0f0703184b8727163b472c62d481f2757108be3063f832f9dbfa65de9f66f516c1ed438dd6340438b33f7022e
+  metadata.gz: 439e17bfb6d3af0e74d0c624e3233c91e85894d715509197ef241e6f6774a793cf43d99682db8984f2acea9c6c1efdab47edadbdaa977819b5243260ce7e772f
+  data.tar.gz: 0e2af1b759fbbcfcfc37f8fe41a25d5b4d3c3fe132e3ba2eac89b2890845795df73659a0b252b28a64efaf853f5127fbf79d1fbe4bb9ae8155519a205e11d20b

data/.gitignore

@@ -10,3 +10,8 @@
 
 # rspec failure tracking
 .rspec_status
+
+.idea/
+
+# rbenv file
+.ruby-version

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.0
+  - 2.4.5
+before_install: gem install bundler -v 2.0

data/Gemfile.lock

@@ -1,35 +1,35 @@
 PATH
   remote: .
   specs:
-    aemcrxpkgmgr (0.1.0)
+    aemcrxpkgmgr (0.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rake (13.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   aemcrxpkgmgr!
-  bundler (~> 1.16)
-  rake (~> 10.0)
+  bundler (~> 2.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   2.2.27

data/README.md

@@ -26,10 +26,10 @@ TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `./bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `./bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aemcrxpkgmgr.
+Bug reports and pull requests are welcome on GitHub at https://github.com/vrtdev/aemcrxpkgmgr.

data/aemcrxpkgmgr.gemspec

@@ -6,8 +6,8 @@ require 'aemcrxpkgmgr/version'
 Gem::Specification.new do |spec|
   spec.name          = 'aemcrxpkgmgr'
   spec.version       = AemCrxPkgMgr::VERSION
-  spec.authors       = ['Stefan - Zipkid - Goethals']
-  spec.email         = ['stefan.goethals@vrt.be']
+  spec.authors       = ['Stefan - Zipkid - Goethals', 'Wim Symons']
+  spec.email         = ['stefan.goethals@vrt.be', 'wim.symons@vrt.be']
 
   spec.summary       = 'AEM CRX Package Manager script'
   spec.description   = 'AEM CRX Package Manager script'
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/bin/setup

@@ -3,6 +3,7 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
+gem install bundler
 bundle install
 
 # Do any other automated setup that you need to do here

data/changelog.md

@@ -5,16 +5,27 @@ Version format based on http://semver.org/
 
 ## [Unreleased]
 
-## [0.1.0] - 2018-01-30
+## [0.2.2] - 2022-09-28
+## Fixed
+- `--debug` did not function properly, causing debug output to be printed on stdout by default, which breaks valid (json) output.
+
+## [0.2.1] - 2021-12-15
+## Fixed
+- `filtergroup` and `filtername` paramters to pkg_query made optional. (the puppet fact does not pass them)
+
+## [0.2.0] - 2021-09-03
 ## Added
-- First working version
+- `--filtergroup` and `--filtername` options to provide extra filtering on queried packages as `--query` does not provide exact matches.
 
-## [0.0.0] - 2018-01-01
-### Added
-- ...
+## [0.1.2] - 2019-07-05
+## Changed
+- immediately stop retries when the given address is not available
+- added `max_retries` and `retry_timeout` options while keeping the current defaults
 
-### Changed
-- ...
+## [0.1.1] - 2018-01-30
+## Added
+- retry failed get
 
-### Removed
-- ...
+## [0.1.0] - 2018-01-30
+## Added
+- First working version

data/exe/aemcrxpkgmgr

@@ -23,9 +23,15 @@ def clidoc
     -p --pass:
     password
 
-    -q --query
+    -q --query:
     query string
 
+    -g --filtergroup:
+    the exact package group name to filter on
+
+    -n --filtername:
+    the exact package name to filter on
+
     -v --versions:
     include other versions of package
 
@@ -41,7 +47,7 @@ def clidoc
     ruby: native Array/Hash output
 
     -d --debug:
-    debug ....
+    enable debug output on stderr
 
   CLIDOC
 end
@@ -53,21 +59,25 @@ opts = GetoptLong.new(
   ['--user', '-u', GetoptLong::REQUIRED_ARGUMENT],
   ['--pass', '-p', GetoptLong::REQUIRED_ARGUMENT],
   ['--query', '-q', GetoptLong::REQUIRED_ARGUMENT],
+  ['--filtergroup', '-g', GetoptLong::OPTIONAL_ARGUMENT],
+  ['--filtername', '-n', GetoptLong::OPTIONAL_ARGUMENT],
   ['--versions', '-v', GetoptLong::NO_ARGUMENT],
   ['--keys', '-k', GetoptLong::REQUIRED_ARGUMENT],
   ['--output', '-o', GetoptLong::REQUIRED_ARGUMENT],
-  ['--debug', '-d', GetoptLong::OPTIONAL_ARGUMENT]
+  ['--debug', '-d', GetoptLong::NO_ARGUMENT]
 )
 
 action = 'query'
 host = 'http://localhost:4502'
 user = 'admin'
 pass = ENV['AEM_PASSWORD']
-query = ''
+query = nil
+filtergroup = nil
+filtername = nil
 includeversions = false
 keys_to_extract = %w[name description version group path]
 output = 'yaml'
-debug = 0
+debug = false
 
 # rubocop:disable Metrics/BlockLength
 opts.each do |opt, arg|
@@ -85,6 +95,10 @@ opts.each do |opt, arg|
     pass = arg
   when '--query'
     query = arg
+  when '--filtergroup'
+    filtergroup = arg
+  when '--filtername'
+    filtername = arg
   when '--versions'
     includeversions = true
   when '--keys'
@@ -92,11 +106,10 @@ opts.each do |opt, arg|
   when '--output'
     output = arg
   when '--debug'
-    debug = if arg == ''
-              1
-            else
-              arg.to_i
-            end
+    debug = true
+  else
+    STDERR.puts "Unknown option #{opt}"
+    exit 1
   end
 end
 # rubocop:enable Metrics/BlockLength
@@ -115,10 +128,10 @@ case action
 when 'delete_crx_zip'
   aemcrxpkgmgr.output = 'ruby'
   aemcrxpkgmgr.keys_to_extract = ['path']
-  list = aemcrxpkgmgr.pkg_query query
-  result = aemcrxpkgmgr.delete_crx_zip list
+  list = aemcrxpkgmgr.pkg_query(query, filtergroup, filtername)
+  result = aemcrxpkgmgr.delete_crx_zip(list)
 else
-  result = aemcrxpkgmgr.pkg_query query
+  result = aemcrxpkgmgr.pkg_query(query, filtergroup, filtername)
 end
 
 puts result

data/lib/aemcrxpkgmgr/version.rb

@@ -1,3 +1,3 @@
 class AemCrxPkgMgr
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/aemcrxpkgmgr.rb

@@ -9,35 +9,59 @@ require 'pp'
 # AEM CRX Package Manager
 class AemCrxPkgMgr
   attr_accessor :includeversions, :keys_to_extract, :output
+
   def initialize(options = {})
     @host = options[:host] || 'http://localhost:4502'
     @user = options[:user] || 'admin'
+    @max_retries = options[:max_retries] || 100
+    @retry_timeout = options[:retry_timeout] || 3
     @pass = options[:pass]
     @includeversions = options[:includeversions] || false
     @keys_to_extract = options[:keys_to_extract]
     @output = options[:output] || 'ruby'
-    @debug = options[:debug]
+    @debug = options[:debug] || false
+    STDERR.puts 'AemCrxPkgMgr Object initialised' if @debug
   end
 
   def get(uri)
+    retries ||= @max_retries
+
     request = Net::HTTP::Get.new(uri)
     request.basic_auth(@user, @pass)
 
     response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
       http.request(request)
     end
+    raise "AemCrxPkgMgr.get Response '#{response.code}' is not a Net::HTTPSuccess" unless response.is_a?(Net::HTTPSuccess)
+
     response
+  rescue Errno::EADDRNOTAVAIL
+    raise 'AemCrxPkgMgr.get AEM not available'
+  rescue RuntimeError => e
+    STDERR.puts "AemCrxPkgMgr.get : #{e.class} : #{e.message}"
+    will_retry = (retries -= 1) >= 0
+    if will_retry
+      sleep @retry_timeout
+      retry
+    end
+    raise
   end
 
   def pkg_query_uri(query)
+    STDERR.puts "pkg_query_uri Starting (#{query})" if @debug
     uri = URI.parse(@host + '/crx/packmgr/list.jsp')
-    params = { q: query, includeVersions: @includeversions }
+    params = { includeVersions: @includeversions }
+    unless query.nil?
+      params['q'] = query
+    end
     uri.query = URI.encode_www_form(params)
+    STDERR.puts "pkg_query_uri : discovered uri : #{uri}" if @debug
     uri
   end
 
   def delete_crx_zip(list)
     return unless list
+
     @delete_crx_zip_ok = 0
     @delete_crx_zip_status = []
     list.each do |path|
@@ -62,21 +86,36 @@ class AemCrxPkgMgr
     @delete_crx_zip_ok += 1 if response.is_a? Net::HTTPSuccess
   end
 
-  def pkg_query(query)
+  def pkg_query(query, filtergroup=nil, filtername=nil)
+    STDERR.puts "pkg_query Starting (#{query}, #{filtergroup}, #{filtername})" if @debug
     uri = pkg_query_uri(query)
     response = get uri
+    STDERR.puts 'pkg_query : got response' if @debug
 
     raise "HTTP response code : #{response.code}, message : #{response.message}" unless response.is_a? Net::HTTPSuccess
 
+    STDERR.puts "pkg_query : response.code : #{response.code}" if @debug
+
     @query_data = JSON.parse(response.body)['results']
 
+    unless filtergroup.nil?
+      @query_data = @query_data.select { |item| item['group'] == filtergroup }
+    end
+
+    unless filtername.nil?
+      @query_data = @query_data.select { |item| item['name'] == filtername }
+    end
+
     extract_keys
 
     format_output @query_data unless @query_data.empty?
   end
 
   def extract_keys
+    STDERR.puts 'extract_keys : Starting' if @debug
     return if @keys_to_extract.length.zero?
+
+    STDERR.puts "extract_keys : keys_to_extract : #{@keys_to_extract}" if @debug
     @query_data.map! do |element|
       if @keys_to_extract.length == 1
         element[@keys_to_extract.first]
@@ -99,6 +138,7 @@ class AemCrxPkgMgr
 
   def output_single(data)
     raise 'Resultset contains more than 1 element and "single" was requested.' if data.length != 1
+
     data.first
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: aemcrxpkgmgr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Stefan - Zipkid - Goethals
-autorequire: 
+- Wim Symons
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -55,6 +56,7 @@ dependencies:
 description: AEM CRX Package Manager script
 email:
 - stefan.goethals@vrt.be
+- wim.symons@vrt.be
 executables:
 - aemcrxpkgmgr
 extensions: []
@@ -79,7 +81,7 @@ homepage: http://github.com/vrtdev
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,9 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.4.21
+signing_key:
 specification_version: 4
 summary: AEM CRX Package Manager script
 test_files: []