PackageChanger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d2f7c832e92ce661bdfb8c674cd225389617b1c
+  data.tar.gz: 872b1ef82b5972f97dd065ce4d77e37e381c6000
+SHA512:
+  metadata.gz: fb1e68e7399a25358ad683503f7a310e4722007ed076ca053bc3d152bf5a75dc6069262d6e45f0a053fd4c37b2f9526b8d318c70771c4f9acf6cce453a7b2d0a
+  data.tar.gz: f4cec6c57c452d4534e98de28c7aa01a245f421f5d92076ff247a3c0bc7974faf2fb5e293551557ca2af3c9adca705f7b7de205b52f125a7e5cdb34b1689d45b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+.idea

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in PackageChanger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 bprieto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/PackageChanger.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "PackageChanger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "PackageChanger"
+  spec.version       = PackageChanger::VERSION
+  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"
+
+  # 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["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."
+  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
+    `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.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'
+end

data/README.md

@@ -0,0 +1,26 @@
+# PackageChanger
+
+Using Ruby-JSS to work with the JSS API, PackageChange lists the policies in which a package is used and gives the ability to change this package for a new one.
+
+## Installation
+
+    $ gem install PackageChanger
+
+## Usage
+
+Once installed, create a configuration file in /etc/packagechanger.conf
+
+You can copy a sample file from the data folder inside the installation path of *PackageChanger* and fill the JSS URL, User and Password.
+
+Once configured, you can use it:
+
+```packagechanger [--silent] --old OldPackageName --new NewPackageName || --list ListedPackage```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Bearzooka/PackageChanger.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/PackageChanger

@@ -0,0 +1,151 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'getoptlong'
+require_relative '../lib/PackageChanger/config'
+require_relative '../lib/PackageChanger/connection'
+require_relative '../lib/PackageChanger/messages'
+require_relative '../lib/PackageChanger/log'
+
+old_package = nil
+new_package = nil
+list_package = 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]
+)
+
+logger = PackageChanger::Log.new
+
+OPTS.each do |opt, arg|
+  case opt
+  when '--old'
+    if arg == ''
+      puts PackageChanger::USAGE
+      logger.write('Missing arguments.')
+      exit 1
+    else
+      old_package = arg
+      mode = 'change'
+    end
+
+  when '--new'
+    if arg == ''
+      puts PackageChanger::USAGE
+      logger.write('Missing arguments.')
+      exit 1
+    else
+      new_package = arg
+    end
+
+  when '--list'
+    if arg == ''
+      puts PackageChanger::USAGE
+      logger.write('Missing arguments.')
+      exit 1
+    else
+      list_package = arg
+      mode = "list"
+    end
+  when '--silent'
+   silent = true
+
+  end
+end
+
+unless (old_package and new_package) or list_package
+  puts PackageChanger::USAGE
+  logger.write('Missing package names')
+  exit 1
+end
+
+begin
+
+  if PackageChanger::Configuration::DEFAULT_CONF_FILE.file?
+    @config_src = PackageChanger::Configuration::DEFAULT_CONF_FILE.to_s
+  elsif PackageChanger::Configuration::SAMPLE_CONF_FILE.file?
+    puts PackageChanger::CONFIG_ERROR
+    logger.write('Missing configuration file.')
+    exit 1
+  end
+
+  PackageChanger.connect_to_jss
+
+  if mode == 'list'
+    unless JSS::Package.valid_id list_package
+      logger.write("#{list_package} does not exist")
+      puts PackageChanger::MISSSING_LIST_PACKAGE
+      exit 1
+    end
+
+    result_array = PackageChanger.get_policies_with(list_package, silent)
+
+    if result_array.count > 0
+      puts "The package #{list_package} is used on the following policies: "
+      result_array.each do |result|
+        puts "\t#{result[:id]} - #{result[:name]}"
+      end
+    else
+      puts PackageChanger::NO_RESULTS_LIST
+      exit 0
+    end
+
+  elsif mode == "change"
+    unless JSS::Package.valid_id old_package and JSS::Package.valid_id new_package
+      logger.write("Either #{old_package} or #{new_package} do not exist")
+      puts PackageChanger::MISSSING_PACKAGE
+      exit 1
+    end
+
+    result_array = PackageChanger.get_policies_with(old_package, silent)
+
+    if result_array.count > 0
+      puts "The package #{old_package} will be replaced with #{new_package}: "
+      logger.write("The package #{old_package} will be replaced with #{new_package}")
+      result_array.each do |result|
+        puts "\t#{result[:id]} - #{result[:name]}"
+        logger.write("\t#{result[:id]} - #{result[:name]}")
+      end
+
+      confirmation = ''
+
+      while confirmation !~ (/[yn]/i)
+        puts 'Please confirm [y/n]:'
+        confirmation = gets.chomp.downcase
+      end
+
+      case confirmation
+      when 'y'
+        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
+        logger.write('Finished changing.')
+        exit 0
+      when 'n'
+        puts 'Cancelling changes.'
+        logger.write('User cancelled.')
+        exit 0
+      else
+        puts PackageChanger::ERROR
+        logger.write(PackageChanger::ERROR)
+        exit 1
+      end
+
+    else
+      puts PackageChanger::NO_RESULTS_CHANGE
+      logger.write(PackageChanger::NO_RESULTS_CHANGE)
+      exit 0
+    end
+
+  end
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "PackageChanger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/packagechanger.conf.example

@@ -0,0 +1,20 @@
+#################
+# This config file uses default settings.
+#
+# Each setting is defined on one line like so:
+#
+#     key: value
+#
+# Values may have spaces.
+#
+# Blank lines and those starting with # are ignored.
+
+jamf_server:
+
+jamf_port:
+
+jamf_use_ssl:
+
+jamf_user:
+
+jamf_password:

data/lib/PackageChanger.rb

@@ -0,0 +1,5 @@
+require "PackageChanger/version"
+
+module PackageChanger
+  class Error < StandardError; end
+end

data/lib/PackageChanger/config.rb

@@ -0,0 +1,90 @@
+
+require 'singleton'
+require 'pathname'
+
+module PackageChanger
+
+  silent = false
+
+  class Configuration
+    include ::Singleton
+
+    # The location of the default config file
+    DEFAULT_CONF_FILE = Pathname.new '/etc/packagechanger.conf'
+
+    SAMPLE_CONF_FILE = Pathname.new(__FILE__).parent.parent.parent + 'data/packagechanger.conf.example'
+
+    CONF_KEYS = {
+        jamf_server: nil,
+        jamf_port: :to_i,
+        jamf_use_ssl: nil,
+        jamf_user: nil,
+        jamf_password: nil
+    }.freeze
+
+    # automatically create accessors for all the CONF_KEYS
+    CONF_KEYS.keys.each { |k| attr_accessor k }
+
+    # Initialize!
+    #
+    def initialize
+      read_global
+    end
+
+    def read_global
+      return false unless DEFAULT_CONF_FILE.file? && DEFAULT_CONF_FILE.readable?
+
+      read DEFAULT_CONF_FILE
+    end
+
+    def print
+      CONF_KEYS.keys.sort.each { |k| puts "#{k}: #{send k}" }
+    end
+
+    private
+
+    def read(file)
+      available_conf_keys = CONF_KEYS.keys
+
+      puts file
+      Pathname.new(file).read.each_line do |line|
+        # skip blank lines and those starting with #
+        next if line =~ /^\s*(#|$)/
+
+        line.strip =~ /^(\w+?):\s*(\S.*)$/
+        key = Regexp.last_match(1)
+        next unless key
+
+        attr = key.to_sym
+        next unless available_conf_keys.include? attr
+
+        setter = "#{key}=".to_sym
+        value = Regexp.last_match(2).strip
+
+        # convert the string value read from the file
+        # to the correct class
+        value &&= case CONF_KEYS[attr]
+                  when Proc
+                    # If its a proc, pass it to the proc
+                    CONF_KEYS[attr].call value
+
+                  when Symbol
+                    # otherwise its a symbol method name to call on the string
+                    value.send(CONF_KEYS[attr])
+
+                  else
+                    value
+
+                  end
+
+        send(setter, value)
+      end # do line
+      true
+    end # read file
+  end # class Configuration
+
+  # The single instance of Configuration
+  def self.config
+    PackageChanger::Configuration.instance
+  end
+end # module

data/lib/PackageChanger/connection.rb

@@ -0,0 +1,63 @@
+require 'ruby-jss'
+require_relative 'config'
+
+module PackageChanger
+
+  def self.connect_to_jss
+    # JSS Connection info
+
+    begin
+      JSS.api.connect user: PackageChanger.config.jamf_user,
+                      pw: PackageChanger.config.jamf_password,
+                      server: PackageChanger.config.jamf_server,
+                      verify_cert: false
+
+      puts 'Connected to the JSS.'
+    rescue
+      puts 'Could not connect to JSS. Please check the configuration.'
+      # abort
+    end
+  end
+
+  def self.replace_packages(policies, old_package, new_package, silent, logger)
+    puts 'Starting replacement process' unless silent
+
+    policies.each do |policy|
+      puts "Changing #{policy[:name]}" unless silent
+      logger.write("Changing #{policy[:name]}")
+      begin
+        changed_pol = JSS::Policy.fetch :id => policy[:id]
+        changed_pol.remove_package(old_package)
+        changed_pol.add_package(new_package)
+        changed_pol.update
+      rescue StandardError => e
+        puts "Changed failed due to error: #{e.message}"
+        logger.write("Changed on #{policy} failed due to error: #{e.message}")
+      end
+    end
+  end
+
+  def self.get_policies_with(list_package, silent)
+    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)
+      end
+      #end
+      pol_count += 1
+    end
+    return result_array
+  end
+
+end # PackageChanger

data/lib/PackageChanger/foundation.rb

@@ -0,0 +1,6 @@
+require 'pathname'
+
+require_relative 'config'
+require_relative 'connection'
+require_relative 'messages'
+require_relative 'log'

data/lib/PackageChanger/log.rb

@@ -0,0 +1,28 @@
+
+module PackageChanger
+
+  class Log
+
+    DEFAULT_FILE = Pathname.new '/var/log/packagechanger.log'
+
+    # date and line format
+    DATE_FORMAT = '%Y-%m-%d %H:%M:%S'
+
+    def initialize
+      unless DEFAULT_FILE.file? && DEFAULT_FILE.writable?
+        File.write(DEFAULT_FILE, "≈≈≈ PackageChanger ≈≈≈\n", mode: 'a')
+      end
+    end
+
+    def write(message)
+      File.write(DEFAULT_FILE, "#{Time.now.strftime(DATE_FORMAT)} - #{message}\n", mode: 'a')
+    end
+
+    def putsandlog(message)
+      puts message
+      write message
+    end
+
+  end # Class Log
+
+end # MOdule

data/lib/PackageChanger/messages.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module PackageChanger
+  USAGE = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+  Usage: packagechanger [--silent] --old OldPackageName --new NewPackageName || --list ListedPackage
+"
+
+
+  CONFIG_ERROR = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+  [ERROR] The configuration file is missing in /etc/packagechanger.conf
+
+  You can copy a sample file from the data folder inside the installation path of PackageChanger and
+  fill the JSS URL, User and Password.
+
+"
+
+  MISSSING_PACKAGE = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+  Missing packages: One or both of the provided packages do not exist. Please verify.
+"
+
+  MISSSING_LIST_PACKAGE = "
+
+≈≈≈ PackageChanger ≈≈≈
+
+  Missing package: The provided package does not exist. Please verify.
+"
+
+  NO_RESULTS_LIST = "
+
+  There are no policies using the provided package.
+"
+
+  NO_RESULTS_CHANGE = "
+
+  There are no policies using the package you intend to change.
+"
+
+ ERROR = "
+
+  Execution error.
+"
+end

data/lib/PackageChanger/version.rb

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

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: PackageChanger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bernardo Prieto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-jss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: ruby-jss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: |-
+  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.
+email:
+- bernardo.prieto.curiel@zalando.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".idea/.rakeTasks"
+- ".idea/PackageChanger.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- PackageChanger.gemspec
+- README.md
+- Rakefile
+- bin/PackageChanger
+- bin/console
+- bin/setup
+- data/packagechanger.conf.example
+- lib/.DS_Store
+- lib/PackageChanger.rb
+- lib/PackageChanger/config.rb
+- lib/PackageChanger/connection.rb
+- lib/PackageChanger/foundation.rb
+- lib/PackageChanger/log.rb
+- lib/PackageChanger/messages.rb
+- lib/PackageChanger/version.rb
+homepage: https://github.com/Bearzooka/PackageChanger
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/Bearzooka/PackageChanger
+  source_code_uri: https://github.com/Bearzooka/PackageChanger
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Uses the API to list or replace a package in all JSS policies in which it
+  appears.
+test_files: []