PackageChanger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d2f7c832e92ce661bdfb8c674cd225389617b1c
-  data.tar.gz: 872b1ef82b5972f97dd065ce4d77e37e381c6000
+SHA256:
+  metadata.gz: e42fcbfef88337d942d5dc3d91e33252959b753a3d15cbdf1581bd8eb14463be
+  data.tar.gz: 04504df89dac7433c272baaf28b8f4d409f31932bc06c2cb009daa647ff107b7
 SHA512:
-  metadata.gz: fb1e68e7399a25358ad683503f7a310e4722007ed076ca053bc3d152bf5a75dc6069262d6e45f0a053fd4c37b2f9526b8d318c70771c4f9acf6cce453a7b2d0a
-  data.tar.gz: f4cec6c57c452d4534e98de28c7aa01a245f421f5d92076ff247a3c0bc7974faf2fb5e293551557ca2af3c9adca705f7b7de205b52f125a7e5cdb34b1689d45b
+  metadata.gz: cfc931f07224a433d2ee321f47dee9b8d068670a312ecf709f4a8eb6ea3cc7ff27b541d6901f639e90793c3c1d3b4fd47c1cd7d5bb1047b6246a8ee2005a15ae
+  data.tar.gz: d550a5ebb9334978ea5608ccc02aadcdeb9503b09ba731a74e9eec7de3085b3ca33078c96928a623cfcf6e462c3b35e334ba9c5c906bf9102ee70ba0917b13fc

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 .DS_Store
 .idea
+.idea/workspace.xml

data/PackageChanger.gemspec

@@ -1,44 +1,46 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "PackageChanger/version"
+require 'PackageChanger/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "PackageChanger"
+  spec.name          = 'PackageChanger'
   spec.version       = PackageChanger::VERSION
-  spec.authors       = ["Bernardo Prieto"]
-  spec.email         = ["bernardo.prieto.curiel@zalando.de"]
+  spec.authors       = ['Bernardo Prieto']
+  spec.email         = ['bernardo.prieto.curiel@zalando.de']
 
-  spec.summary       = %q{Uses the API to list or replace a package in all JSS policies in which it appears.}
-  spec.description   = %q{With the help or Ruby JSS, uses the API to list all the policies in which a package appears
-                              and gives the ability to replace the package in all these policies.}
-  spec.homepage      = "https://github.com/Bearzooka/PackageChanger"
-  spec.license       = "MIT"
+  spec.summary       = 'Uses the API to list or replace a package in all or one JSS policies in which it appears.'
+  spec.description   = 'With the help or Ruby JSS, uses the API to list all or one the policies in which a package appears
+                              and gives the ability to replace the package in all these policies.'
+  spec.homepage      = 'https://github.com/Bearzooka/PackageChanger'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
 
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/Bearzooka/PackageChanger"
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/Bearzooka/PackageChanger'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'bin'
+  spec.executables   << 'PackageChanger'
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency 'ruby-jss', '~> 1.0', '>= 1.0.2'
-  spec.add_runtime_dependency 'ruby-jss', '~> 1.0', '>= 1.0.2'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'ruby-jss', '~> 1.0', '>= 1.2.3'
+  spec.add_runtime_dependency 'ruby-jss', '~> 1.0', '>= 1.2.3'
 end

data/README.md

@@ -16,6 +16,8 @@ Once configured, you can use it:
 
 ```packagechanger [--silent] --old OldPackageName --new NewPackageName || --list ListedPackage```
 
+Run the first execution with sudo, or change the mode of the file `/private/var/log/packagechanger.log` so all users can write to it.
+
 
 ## Contributing
 

data/bin/PackageChanger

@@ -3,6 +3,7 @@
 
 require 'rubygems'
 require 'getoptlong'
+
 require_relative '../lib/PackageChanger/config'
 require_relative '../lib/PackageChanger/connection'
 require_relative '../lib/PackageChanger/messages'
@@ -11,22 +12,39 @@ require_relative '../lib/PackageChanger/log'
 old_package = nil
 new_package = nil
 list_package = nil
+target_policy = nil
 mode = nil
 result_array = []
 silent = false
 
 # The CLI options for GetoptLong
 OPTS = GetoptLong.new(
-    ['--old', '-o', GetoptLong::REQUIRED_ARGUMENT],
-    ['--new', '-n', GetoptLong::REQUIRED_ARGUMENT],
-    ['--list', '-l', GetoptLong::REQUIRED_ARGUMENT],
-    ['--silent', '-s', GetoptLong::NO_ARGUMENT]
+  ['--policy', '-p', GetoptLong::REQUIRED_ARGUMENT],
+  ['--old', '-o', GetoptLong::REQUIRED_ARGUMENT],
+  ['--new', '-n', GetoptLong::REQUIRED_ARGUMENT],
+  ['--list', '-l', GetoptLong::REQUIRED_ARGUMENT],
+  ['--silent', '-s', GetoptLong::NO_ARGUMENT]
 )
 
 logger = PackageChanger::Log.new
 
+# Default mode is change
+mode = 'change'
+
 OPTS.each do |opt, arg|
   case opt
+  when '--policy'
+    if arg == ''
+      puts PackageChanger::USAGE
+      logger.write('Missing arguments.')
+      exit 1
+    else
+      target_policy = arg
+
+      # Change mode to single if policy flag is used
+      mode = 'single'
+    end
+
   when '--old'
     if arg == ''
       puts PackageChanger::USAGE
@@ -34,7 +52,6 @@ OPTS.each do |opt, arg|
       exit 1
     else
       old_package = arg
-      mode = 'change'
     end
 
   when '--new'
@@ -53,22 +70,24 @@ OPTS.each do |opt, arg|
       exit 1
     else
       list_package = arg
-      mode = "list"
+
+      # Change mode to list if flag is used
+      mode = 'list'
     end
   when '--silent'
-   silent = true
+    silent = true
 
   end
 end
 
-unless (old_package and new_package) or list_package
+unless (old_package && new_package) || list_package
   puts PackageChanger::USAGE
   logger.write('Missing package names')
   exit 1
 end
 
 begin
-
+  puts PackageChanger::STARTUP unless silent
   if PackageChanger::Configuration::DEFAULT_CONF_FILE.file?
     @config_src = PackageChanger::Configuration::DEFAULT_CONF_FILE.to_s
   elsif PackageChanger::Configuration::SAMPLE_CONF_FILE.file?
@@ -77,7 +96,7 @@ begin
     exit 1
   end
 
-  PackageChanger.connect_to_jss
+  PackageChanger.connect_to_jss(silent)
 
   if mode == 'list'
     unless JSS::Package.valid_id list_package
@@ -86,10 +105,10 @@ begin
       exit 1
     end
 
-    result_array = PackageChanger.get_policies_with(list_package, silent)
+    result_array = PackageChanger.get_policies_with(list_package, silent, logger)
 
     if result_array.count > 0
-      puts "The package #{list_package} is used on the following policies: "
+      puts "\u{1F3C1} The package #{list_package} is used on the following policies: "
       result_array.each do |result|
         puts "\t#{result[:id]} - #{result[:name]}"
       end
@@ -98,8 +117,8 @@ begin
       exit 0
     end
 
-  elsif mode == "change"
-    unless JSS::Package.valid_id old_package and JSS::Package.valid_id new_package
+  elsif mode == 'change'
+    unless JSS::Package.valid_id(old_package) && JSS::Package.valid_id(new_package)
       logger.write("Either #{old_package} or #{new_package} do not exist")
       puts PackageChanger::MISSSING_PACKAGE
       exit 1
@@ -117,7 +136,7 @@ begin
 
       confirmation = ''
 
-      while confirmation !~ (/[yn]/i)
+      while confirmation !~ /[yn]/i
         puts 'Please confirm [y/n]:'
         confirmation = gets.chomp.downcase
       end
@@ -127,7 +146,7 @@ begin
         puts 'Processing changes.' unless silent
         logger.write('Starting changes.')
         PackageChanger.replace_packages(result_array, old_package, new_package, silent, logger)
-        puts 'Finished changing packages.' unless silent
+        puts "\u{1F3C1} Finished changing packages." unless silent
         logger.write('Finished changing.')
         exit 0
       when 'n'
@@ -146,6 +165,49 @@ begin
       exit 0
     end
 
-  end
+  elsif mode == 'single'
+    unless JSS::Package.valid_id(old_package) && JSS::Package.valid_id(new_package)
+      logger.write("Either #{old_package} or #{new_package} does not exist")
+      puts PackageChanger::MISSSING_PACKAGE
+      exit 1
+    end
 
+
+    target_policy = target_policy.match(/[^[:digit:]]+/) ? target_policy : target_policy.to_i
+    unless JSS::Policy.valid_id(target_policy)
+      logger.write("The policy with id #{target_policy} does not exist.")
+      puts PackageChanger::MISSSING_POLICY
+      exit 1
+    end
+
+    changed_pol = JSS::Policy.fetch target_policy
+
+    puts "\u{1F4E6} The package #{old_package}\n\u{27A1 FE0F}  will be replaced with #{new_package}\n\u{1F4CC} in #{changed_pol.name}"
+    logger.write("The package #{old_package} will be replaced with #{new_package} in #{changed_pol.name}")
+
+    confirmation = ''
+
+    while confirmation !~ /[yn]/i
+      puts 'Please confirm [y/n]:'
+      confirmation = gets.chomp.downcase
+    end
+
+    case confirmation
+    when 'y'
+      puts "\u{1F3A2} Processing changes." unless silent
+      logger.write('Starting changes.')
+      PackageChanger.replace_packages_in(changed_pol, old_package, new_package, silent, logger)
+      puts 'Finished changing packages.' unless silent
+      logger.write('Finished changing.')
+      exit 0
+    when 'n'
+      puts "\u{1F519} Cancelling changes."
+      logger.write('User cancelled.')
+      exit 0
+    else
+      puts PackageChanger::ERROR
+      logger.write(PackageChanger::ERROR)
+      exit 1
+    end
+  end
 end

data/bin/setup

@@ -5,4 +5,7 @@ set -vx
 
 bundle install
 
+touch /var/log/packagechanger.log
+chmod 777 /var/log/packagechanger.log
+
 # Do any other automated setup that you need to do here

data/lib/PackageChanger/config.rb

@@ -1,4 +1,3 @@
-
 require 'singleton'
 require 'pathname'
 
@@ -46,7 +45,7 @@ module PackageChanger
     def read(file)
       available_conf_keys = CONF_KEYS.keys
 
-      puts file
+      # puts file
       Pathname.new(file).read.each_line do |line|
         # skip blank lines and those starting with #
         next if line =~ /^\s*(#|$)/
@@ -87,4 +86,4 @@ module PackageChanger
   def self.config
     PackageChanger::Configuration.instance
   end
-end # module
+end # module

data/lib/PackageChanger/connection.rb

@@ -3,7 +3,7 @@ require_relative 'config'
 
 module PackageChanger
 
-  def self.connect_to_jss
+  def self.connect_to_jss(silent)
     # JSS Connection info
 
     begin
@@ -12,9 +12,9 @@ module PackageChanger
                       server: PackageChanger.config.jamf_server,
                       verify_cert: false
 
-      puts 'Connected to the JSS.'
+      puts "\u{1F50C} Connected to the JSS." unless silent
     rescue
-      puts 'Could not connect to JSS. Please check the configuration.'
+      puts "\u{1F6AB} Could not connect to JSS. Please check the configuration."
       # abort
     end
   end
@@ -37,27 +37,62 @@ module PackageChanger
     end
   end
 
-  def self.get_policies_with(list_package, silent)
+  def self.replace_packages_in(changed_pol, old_package, new_package, silent, logger)
+    puts 'Starting replacement process' unless silent
+
+    puts "Changing #{changed_pol.name}" unless silent
+    logger.write("Changing #{changed_pol.name}")
+    begin
+      changed_pol.remove_package(old_package)
+      changed_pol.add_package(new_package)
+      changed_pol.update
+    rescue StandardError => e
+      puts "\u{1F6AB} Changed failed due to error: #{e.message}"
+      logger.write("Changed on #{changed_pol.name} failed due to error: #{e.message}")
+    end
+  end
+
+  def self.get_policies_with(list_package, silent, logger)
     result_array = []
     all_policies = JSS::Policy.all.select { |p|
       !(p[:name].include? '[SelfService]') &&
         !(p[:name].include? '1 Computer')
     }
-    puts "There are #{all_policies.count} policies in your JSS…" unless silent
-    pol_count = 1
-    all_policies.each do |policy|
-      puts "\r#{pol_count} policies checked" unless silent
-      one_result = {}
-      fetched_policy = JSS::Policy.fetch(:id => policy[:id])
-      if fetched_policy.packages.any? {|package| package[:name] == list_package}
-        one_result[:id] = fetched_policy.id
-        one_result[:name] = fetched_policy.name
-        result_array.push(one_result)
+    puts "\u{203C FE0F}  There are #{all_policies.count} policies in your JSS…"
+
+    confirmation = ''
+
+    while confirmation !~ /[yn]/i
+      puts 'Would you like to continue? [y/n]:'
+      confirmation = gets.chomp.downcase
+    end
+
+    case confirmation
+    when 'y'
+      pol_count = 1
+      all_policies.each do |policy|
+        puts "\r#{pol_count} policies checked" unless silent
+        one_result = {}
+        fetched_policy = JSS::Policy.fetch(:id => policy[:id])
+        if fetched_policy.packages.any? {|package| package[:name] == list_package}
+          one_result[:id] = fetched_policy.id
+          one_result[:name] = fetched_policy.name
+          result_array.push(one_result)
+        end
+        #end
+        pol_count += 1
       end
-      #end
-      pol_count += 1
+      return result_array
+
+    when 'n'
+      puts 'Cancelling checks.'
+      logger.write('User cancelled.')
+      exit 0
+    else
+      puts PackageChanger::ERROR
+      logger.write(PackageChanger::ERROR)
+      exit 1
     end
-    return result_array
   end
 
-end # PackageChanger
+end # PackageChanger

data/lib/PackageChanger/messages.rb

@@ -5,7 +5,7 @@ module PackageChanger
 
 ≈≈≈ PackageChanger ≈≈≈
 
-  Usage: packagechanger [--silent] --old OldPackageName --new NewPackageName || --list ListedPackage
+  Usage: packagechanger [--silent] [--policy PolicyID] --old OldPackageName --new NewPackageName || --list ListedPackage
 "
 
 
@@ -24,28 +24,39 @@ module PackageChanger
 
 ≈≈≈ PackageChanger ≈≈≈
 
-  Missing packages: One or both of the provided packages do not exist. Please verify.
+  \u{1f4a9} Missing packages: One or both of the provided packages do not exist. Please verify.
+"
+
+  MISSSING_POLICY = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+  \u{1f4a9} Missing policy: The policy ID you provided does not exist. Please verify.
 "
 
   MISSSING_LIST_PACKAGE = "
 
 ≈≈≈ PackageChanger ≈≈≈
 
-  Missing package: The provided package does not exist. Please verify.
+  \u{1f4a9} Missing package: The provided package does not exist. Please verify.
 "
 
   NO_RESULTS_LIST = "
 
-  There are no policies using the provided package.
+  \u{1F6AB 1F4E6} There are no policies using the provided package.
 "
 
   NO_RESULTS_CHANGE = "
 
-  There are no policies using the package you intend to change.
+  \u{1F6AB 1F4E6} There are no policies using the package you intend to change.
 "
 
  ERROR = "
 
   Execution error.
 "
+
+STARTUP = "
+≈≈≈ PackageChanger ≈≈≈
+"
 end

data/lib/PackageChanger/version.rb

@@ -1,3 +1,3 @@
 module PackageChanger
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: PackageChanger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bernardo Prieto
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-06-03 00:00:00.000000000 Z
+date: 2020-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: ruby-jss
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +61,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: ruby-jss
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,13 +91,14 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.2.3
 description: |-
-  With the help or Ruby JSS, uses the API to list all the policies in which a package appears
+  With the help or Ruby JSS, uses the API to list all or one the policies in which a package appears
                                 and gives the ability to replace the package in all these policies.
 email:
 - bernardo.prieto.curiel@zalando.de
-executables: []
+executables:
+- PackageChanger
 extensions: []
 extra_rdoc_files: []
 files:
@@ -112,6 +113,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
+- PackageChanger-0.1.0.gem
 - PackageChanger.gemspec
 - README.md
 - Rakefile
@@ -149,10 +151,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Uses the API to list or replace a package in all JSS policies in which it
-  appears.
+summary: Uses the API to list or replace a package in all or one JSS policies in which
+  it appears.
 test_files: []