ruby-jss 1.6.0 → 2.0.0a11

data/lib/jss/api_object/app_store_country_codes.rb

@@ -1,298 +0,0 @@
-### Copyright 2020 Pixar
-
-###
-###    Licensed under the Apache License, Version 2.0 (the "Apache License")
-###    with the following modification; you may not use this file except in
-###    compliance with the Apache License and the following modification to it:
-###    Section 6. Trademarks. is deleted and replaced with:
-###
-###    6. Trademarks. This License does not grant permission to use the trade
-###       names, trademarks, service marks, or product names of the Licensor
-###       and its affiliates, except as required to comply with Section 4(c) of
-###       the License and to reproduce the content of the NOTICE file.
-###
-###    You may obtain a copy of the Apache License at
-###
-###        http://www.apache.org/licenses/LICENSE-2.0
-###
-###    Unless required by applicable law or agreed to in writing, software
-###    distributed under the Apache License with the above modification is
-###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-###    KIND, either express or implied. See the Apache License for the specific
-###    language governing permissions and limitations under the Apache License.
-###
-###
-
-###
-module JSS
-
-  # Return the names and codes containing a given string
-  # (case insentitive).
-  #
-  # @param str [String] the string to look for, must be >=2 chars long
-  #
-  # @return [Hash] the country names => codes that contain the string.
-  #
-  def self.country_code_match(str)
-    raise ArgumentError, 'Match string must be at least 2 characters long' if str.size < 2
-
-    str = str.to_s.upcase
-    APP_STORE_COUNTRY_CODES.select { |n, c| n.upcase.include?(str) || c.include?(str) }
-  end
-
-  # The official names and two-letter codes for countries known to the App Store.
-  # These were retrieved from the Jamf Pro API endpoint in August 2020.
-  # They should be updated regularly. To do so using the Jamf Module, just
-  # replace this Hash with the one you get from:
-  #    Jamf::AppStoreCountryCodes.codes_by_name
-  #
-  APP_STORE_COUNTRY_CODES = {
-    'Afghanistan' => 'AF',
-    'Aland Islands' => 'AX',
-    'Albania' => 'AL',
-    'Algeria' => 'DZ',
-    'American Samoa' => 'AS',
-    'Andorra' => 'AD',
-    'Angola' => 'AO',
-    'Anguilla' => 'AI',
-    'Antarctica' => 'AQ',
-    'Antigua and Barbuda' => 'AG',
-    'Argentina' => 'AR',
-    'Armenia' => 'AM',
-    'Aruba' => 'AW',
-    'Australia' => 'AU',
-    'Austria' => 'AT',
-    'Azerbaijan' => 'AZ',
-    'Bahamas' => 'BS',
-    'Bahrain' => 'BH',
-    'Bangladesh' => 'BD',
-    'Barbados' => 'BB',
-    'Belarus' => 'BY',
-    'Belgium' => 'BE',
-    'Belize' => 'BZ',
-    'Benin' => 'BJ',
-    'Bermuda' => 'BM',
-    'Bhutan' => 'BT',
-    'Bolivia, Plurinational State of' => 'BO',
-    'Bosnia and Herzegovina' => 'BA',
-    'Botswana' => 'BW',
-    'Bouvet Island' => 'BV',
-    'Brazil' => 'BR',
-    'British Indian Ocean Territory' => 'IO',
-    'Brunei Darussalam' => 'BN',
-    'Bulgaria' => 'BG',
-    'Burkina Faso' => 'BF',
-    'Burundi' => 'BI',
-    'Cambodia' => 'KH',
-    'Cameroon' => 'CM',
-    'Canada' => 'CA',
-    'Cape Verde' => 'CV',
-    'Cayman Islands' => 'KY',
-    'Central African Republic' => 'CF',
-    'Chad' => 'TD',
-    'Chile' => 'CL',
-    'China' => 'CN',
-    'Christmas Island' => 'CX',
-    'Cocos (Keeling) Islands' => 'CC',
-    'Colombia' => 'CO',
-    'Comoros' => 'KM',
-    'Congo' => 'CG',
-    'Congo, the Democratic Republic of the' => 'CD',
-    'Cook Islands' => 'CK',
-    'Costa Rica' => 'CR',
-    "Cote d'Ivoire" => 'CI',
-    'Croatia' => 'HR',
-    'Cuba' => 'CU',
-    'Cyprus' => 'CY',
-    'Czech Republic' => 'CZ',
-    'Denmark' => 'DK',
-    'Djibouti' => 'DJ',
-    'Dominica' => 'DM',
-    'Dominican Republic' => 'DO',
-    'Ecuador' => 'EC',
-    'Egypt' => 'EG',
-    'El Salvador' => 'SV',
-    'Equatorial Guinea' => 'GQ',
-    'Eritrea' => 'ER',
-    'Estonia' => 'EE',
-    'Ethiopia' => 'ET',
-    'Falkland Islands (Malvinas)' => 'FK',
-    'Faroe Islands' => 'FO',
-    'Fiji' => 'FJ',
-    'Finland' => 'FI',
-    'France' => 'FR',
-    'French Guiana' => 'GF',
-    'French Polynesia' => 'PF',
-    'French Southern Territories' => 'TF',
-    'Gabon' => 'GA',
-    'Gambia' => 'GM',
-    'Georgia' => 'GE',
-    'Germany' => 'DE',
-    'Ghana' => 'GH',
-    'Gibraltar' => 'GI',
-    'Greece' => 'GR',
-    'Greenland' => 'GL',
-    'Grenada' => 'GD',
-    'Guadeloupe' => 'GP',
-    'Guam' => 'GU',
-    'Guatemala' => 'GT',
-    'Guernsey' => 'GG',
-    'Guinea' => 'GN',
-    'Guinea-Bissau' => 'GW',
-    'Guyana' => 'GY',
-    'Haiti' => 'HT',
-    'Heard Island and McDonald Islands' => 'HM',
-    'Holy See (Vatican City State)' => 'VA',
-    'Honduras' => 'HN',
-    'Hong Kong' => 'HK',
-    'Hungary' => 'HU',
-    'Iceland' => 'IS',
-    'India' => 'IN',
-    'Indonesia' => 'ID',
-    'Iran, Islamic Republic of' => 'IR',
-    'Iraq' => 'IQ',
-    'Ireland' => 'IE',
-    'Isle of Man' => 'IM',
-    'Israel' => 'IL',
-    'Italy' => 'IT',
-    'Jamaica' => 'JM',
-    'Japan' => 'JP',
-    'Jersey' => 'JE',
-    'Jordan' => 'JO',
-    'Kazakhstan' => 'KZ',
-    'Kenya' => 'KE',
-    'Kiribati' => 'KI',
-    "Korea, Democratic People's Republic of" => 'KP',
-    'Korea, Republic of' => 'KR',
-    'Kuwait' => 'KW',
-    'Kyrgyzstan' => 'KG',
-    "Lao People's Democratic Republic" => 'LA',
-    'Latvia' => 'LV',
-    'Lebanon' => 'LB',
-    'Lesotho' => 'LS',
-    'Liberia' => 'LR',
-    'Libyan Arab Jamahiriya' => 'LY',
-    'Liechtenstein' => 'LI',
-    'Lithuania' => 'LT',
-    'Luxembourg' => 'LU',
-    'Macao' => 'MO',
-    'Macedonia, the former Yugoslav Republic of' => 'MK',
-    'Madagascar' => 'MG',
-    'Malawi' => 'MW',
-    'Malaysia' => 'MY',
-    'Maldives' => 'MV',
-    'Mali' => 'ML',
-    'Malta' => 'MT',
-    'Marshall Islands' => 'MH',
-    'Martinique' => 'MQ',
-    'Mauritania' => 'MR',
-    'Mauritius' => 'MU',
-    'Mayotte' => 'YT',
-    'Mexico' => 'MX',
-    'Micronesia, Federated States of' => 'FM',
-    'Moldova, Republic of' => 'MD',
-    'Monaco' => 'MC',
-    'Mongolia' => 'MN',
-    'Montenegro' => 'ME',
-    'Montserrat' => 'MS',
-    'Morocco' => 'MA',
-    'Mozambique' => 'MZ',
-    'Myanmar' => 'MM',
-    'Namibia' => 'NA',
-    'Nauru' => 'NR',
-    'Nepal' => 'NP',
-    'Netherlands' => 'NL',
-    'Netherlands Antilles' => 'AN',
-    'New Caledonia' => 'NC',
-    'New Zealand' => 'NZ',
-    'Nicaragua' => 'NI',
-    'Niger' => 'NE',
-    'Nigeria' => 'NG',
-    'Niue' => 'NU',
-    'Norfolk Island' => 'NF',
-    'Northern Mariana Islands' => 'MP',
-    'Norway' => 'NO',
-    'Oman' => 'OM',
-    'Pakistan' => 'PK',
-    'Palau' => 'PW',
-    'Palestinian Territory, Occupied' => 'PS',
-    'Panama' => 'PA',
-    'Papua New Guinea' => 'PG',
-    'Paraguay' => 'PY',
-    'Peru' => 'PE',
-    'Philippines' => 'PH',
-    'Pitcairn' => 'PN',
-    'Poland' => 'PL',
-    'Portugal' => 'PT',
-    'Puerto Rico' => 'PR',
-    'Qatar' => 'QA',
-    'Reunion' => 'RE',
-    'Romania' => 'RO',
-    'Russian Federation' => 'RU',
-    'Rwanda' => 'RW',
-    'Saint Barthelemy' => 'BL',
-    'Saint Helena, Ascension and Tristan da Cunha' => 'SH',
-    'Saint Kitts and Nevis' => 'KN',
-    'Saint Lucia' => 'LC',
-    'Saint Martin (French part)' => 'MF',
-    'Saint Pierre and Miquelon' => 'PM',
-    'Saint Vincent and the Grenadines' => 'VC',
-    'Samoa' => 'WS',
-    'San Marino' => 'SM',
-    'Sao Tome and Principe' => 'ST',
-    'Saudi Arabia' => 'SA',
-    'Senegal' => 'SN',
-    'Serbia' => 'RS',
-    'Seychelles' => 'SC',
-    'Sierra Leone' => 'SL',
-    'Singapore' => 'SG',
-    'Slovakia' => 'SK',
-    'Slovenia' => 'SI',
-    'Solomon Islands' => 'SB',
-    'Somalia' => 'SO',
-    'South Africa' => 'ZA',
-    'South Georgia and the South Sandwich Islands' => 'GS',
-    'Spain' => 'ES',
-    'Sri Lanka' => 'LK',
-    'Sudan' => 'SD',
-    'Suriname' => 'SR',
-    'Svalbard and Jan Mayen' => 'SJ',
-    'Swaziland' => 'SZ',
-    'Sweden' => 'SE',
-    'Switzerland' => 'CH',
-    'Syrian Arab Republic' => 'SY',
-    'Taiwan, Province of China' => 'TW',
-    'Tajikistan' => 'TJ',
-    'Tanzania, United Republic of' => 'TZ',
-    'Thailand' => 'TH',
-    'Timor-Leste' => 'TL',
-    'Togo' => 'TG',
-    'Tokelau' => 'TK',
-    'Tonga' => 'TO',
-    'Trinidad and Tobago' => 'TT',
-    'Tunisia' => 'TN',
-    'Turkey' => 'TR',
-    'Turkmenistan' => 'TM',
-    'Turks and Caicos Islands' => 'TC',
-    'Tuvalu' => 'TV',
-    'Uganda' => 'UG',
-    'Ukraine' => 'UA',
-    'United Arab Emirates' => 'AE',
-    'United Kingdom' => 'GB',
-    'United States' => 'US',
-    'United States Minor Outlying Islands' => 'UM',
-    'Uruguay' => 'UY',
-    'Uzbekistan' => 'UZ',
-    'Vanuatu' => 'VU',
-    'Venezuela, Bolivarian Republic of' => 'VE',
-    'Viet Nam' => 'VN',
-    'Virgin Islands, British' => 'VG',
-    'Virgin Islands, U.S.' => 'VI',
-    'Wallis and Futuna' => 'WF',
-    'Western Sahara' => 'EH',
-    'Yemen' => 'YE',
-    'Zambia' => 'ZM',
-    'Zimbabwe' => 'ZW'
-  }.freeze
-
-end # JSS

data/lib/jss/api_object/computer/application_installs.rb

@@ -1,118 +0,0 @@
-# Copyright 2020 Pixar
-
-#
-#    Licensed under the Apache License, Version 2.0 (the "Apache License")
-#    with the following modification; you may not use this file except in
-#    compliance with the Apache License and the following modification to it:
-#    Section 6. Trademarks. is deleted and replaced with:
-#
-#    6. Trademarks. This License does not grant permission to use the trade
-#       names, trademarks, service marks, or product names of the Licensor
-#       and its affiliates, except as required to comply with Section 4(c) of
-#       the License and to reproduce the content of the NOTICE file.
-#
-#    You may obtain a copy of the Apache License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the Apache License with the above modification is
-#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-#    KIND, either express or implied. See the Apache License for the specific
-#    language governing permissions and limitations under the Apache License.
-#
-#
-
-#
-module JSS
-
-  # This file implements the 'computerapplications' API endpoint, used
-  # for searching for computers with certain applications installed.
-  #
-  # All the methods defined here are class methods on JSS::Computer
-  # since they all return lists of computers and apps.
-  #
-  # The apps installed on a JSS::Computer instance are available via the
-  # #apps instance method (a shortcut that looks into the 'software' subset)
-  #
-
-  #
-  class Computer < JSS::APIObject
-
-    COMPUTER_APPLICATIONS_RSRC = 'computerapplications/application'.freeze
-
-    # Query the JSS for computers with some app installed. An app name is required
-    # as the first parameter.
-    #
-    # If no other parameters are given, returns a Hash, one key per version of the
-    # app. For each version there is an array of Hashes, one Hash for each
-    # computer with that version. The sub hashes contain keys for the computer's
-    # identifiers, i.e. :name, :id, :udid, :serial_number, :mac_address.
-    #
-    # If one or more inventory fields are provided in the 'fields' parameter,
-    # each computer's hash also has keys and values for those fields if they
-    # exist in the JSS. These fields are those available in the display options
-    # for Advanced Computer Searches (including extention attribute names) and
-    # their names are case-sensitive, so 'Username', not 'username'
-    #
-    # If a specific version is provided in the 'version' parameter, only computers
-    # containing that version of the app are returned as an Array of Hashes.
-    #
-    # If the ids_only parameter is truthy, an Array of JSS id numbers for
-    # computers with this app is returned. In this case the 'fields' parameter
-    # is ignored, however the 'version' parameters is still valid and will
-    # restrict the list to those computer ids with that version installed.
-    #
-    # This method implements the 'computerapplications' API endpoint.
-    #
-    # NOTE: To see all the apps installed on a specific computer, fetch the
-    # JSS::Computer instance and call its {JSS::Computer#apps} method.
-    #
-    # @param appname [String] The name of the app to look for, e.g. 'Transmogrifier.app'
-    #
-    # @param fields [String,Array<String>] Additional 'inventory fields' to return
-    #    with each computer's data
-    #
-    # @param version [String] Limit search to a specific version of the app
-    #
-    # @param ids_only [Boolean] Just return an array of the id's of computers
-    #  found with this query. Defaults to false
-    #
-    # @param api [JSS::APIConnection] The API connection to use for the query.
-    #   default: JSS.api
-    #
-    # @return [Array<Integer>] When ids_only == true, the ids of computers with
-    #   the app installed (possibly limited to version)
-    #
-    # @return [Array<Hash>] When version is provided, An Array of Hashes, one
-    #   for each computer, with keys for identifiers plus any requested fields.
-    #
-    # @return [Hash{String => Array<Hash>}] When no version is provided, a Hash
-    #   with keys for each version, pointing to an array of Hashes, one for
-    #   each computer with that version. Each computer's Hash has keys for
-    #   identifiers plus any requested fields.
-    #
-    #
-    def self.application_installs(appname, fields: [], version: nil, ids_only: false, api: JSS.api)
-      fields = [fields] unless fields.is_a? Array
-
-      rsrc = "#{COMPUTER_APPLICATIONS_RSRC}/#{CGI.escape appname.to_s}"
-      rsrc << "/version/#{CGI.escape version.to_s}" if version
-      rsrc << "/inventory/#{CGI.escape fields.join(',')}" unless ids_only || fields.empty?
-
-      result = api.get_rsrc(rsrc)[:computer_applications]
-
-      return result[:unique_computers].map { |c| c[:id] } if ids_only
-
-      if version.nil?
-        hash_by_version = {}
-        result[:versions].each { |v| hash_by_version[v[:number]] = v[:computers] }
-        return hash_by_version
-      end
-
-      result[:versions].first[:computers]
-    end # self.application_search
-
-  end # Computer
-
-end # JSS

data/lib/jss/client/jamf_binary.rb

@@ -1,132 +0,0 @@
-### Copyright 2020 Pixar
-
-###
-###    Licensed under the Apache License, Version 2.0 (the "Apache License")
-###    with the following modification; you may not use this file except in
-###    compliance with the Apache License and the following modification to it:
-###    Section 6. Trademarks. is deleted and replaced with:
-###
-###    6. Trademarks. This License does not grant permission to use the trade
-###       names, trademarks, service marks, or product names of the Licensor
-###       and its affiliates, except as required to comply with Section 4(c) of
-###       the License and to reproduce the content of the NOTICE file.
-###
-###    You may obtain a copy of the Apache License at
-###
-###        http://www.apache.org/licenses/LICENSE-2.0
-###
-###    Unless required by applicable law or agreed to in writing, software
-###    distributed under the Apache License with the above modification is
-###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-###    KIND, either express or implied. See the Apache License for the specific
-###    language governing permissions and limitations under the Apache License.
-###
-###
-
-###
-module JSS
-
-  #
-  class Client
-
-    # Constants
-    #####################################
-
-    # The Pathname to the jamf binary executable
-    # Before SIP (macOS 10.10 and below)
-    ORIG_JAMF_BINARY = Pathname.new '/usr/sbin/jamf'
-
-    # The Pathname to the jamf binary executable
-    # After SIP (OS X 10.11 and above)
-    SIP_JAMF_BINARY = USR_LOCAL_BIN_FOLDER + 'jamf'
-
-    # The path to the jamf binary
-    JAMF_BINARY = SIP_JAMF_BINARY.executable? ? SIP_JAMF_BINARY : ORIG_JAMF_BINARY
-
-    # These jamf commands don't need root privs (most do)
-    ROOTLESS_JAMF_COMMANDS = %i[
-      about
-      checkJSSConnection
-      getARDFields
-      getComputerName
-      help
-      listUsers
-      version
-    ].freeze
-
-    # the option that makes the jamf binary verbose
-    JAMF_VERBOSE_OPT = ' -verbose'.freeze
-
-    # class Methods
-    #####################################
-
-    # Run an arbitrary jamf binary command.
-    #
-    # @note Most jamf commands require superuser/root privileges.
-    #
-    # @param command[String,Symbol] the jamf binary command to run
-    #   The command is the single jamf command that comes after the/usr/bin/jamf.
-    #
-    # @param args[String,Array] the arguments passed to the jamf command.
-    #   This is to be passed to Kernel.` (backtick), after being combined with the
-    #   jamf binary and the jamf command
-    #
-    # @param verbose[Boolean] Should the stdout & stderr of the jamf binary be sent to
-    #  the current stdout in realtime, as well as returned as a string?
-    #
-    # @return [String] the stdout & stderr of the jamf binary.
-    #
-    # @example
-    #   These two are equivalent:
-    #
-    #     JSS::Client.run_jamf "recon", "-assetTag 12345 -department 'IT Support'"
-    #
-    #     JSS::Client.run_jamf :recon, ['-assetTag', '12345', '-department', 'IT Support'"]
-    #
-    #
-    # The details of the Process::Status for the jamf binary process can be
-    # captured from $CHILD_STATUS immediately after calling. (See Process::Status)
-    #
-    def self.run_jamf(command, args = nil, verbose = false)
-      raise JSS::UnmanagedError, 'The jamf binary is not installed on this computer.' unless installed?
-      unless ROOTLESS_JAMF_COMMANDS.include?(command.to_sym) || JSS.superuser?
-        raise JSS::UnsupportedError, 'You must have root privileges to run that jamf binary command'
-      end
-      cmd = build_jamf_command command, args
-      cmd += " #{JAMF_VERBOSE_OPT}" if verbose && !cmd.include?(JAMF_VERBOSE_OPT)
-      execute_jamf cmd, verbose
-    end # run_jamf
-
-    private_class_method
-
-    def self.build_jamf_command(command, args)
-      case args
-      when nil
-        "#{JAMF_BINARY} #{command}"
-      when String
-        "#{JAMF_BINARY} #{command} #{args}"
-      when Array
-        ([JAMF_BINARY.to_s, command] + args).join(' ')
-      else
-        raise JSS::InvalidDataError, 'args must be a String or Array of Strings'
-      end # case
-    end
-
-    def self.execute_jamf(cmd, verbose)
-      puts "Running: #{cmd}" if verbose
-      output = ''
-      IO.popen("#{cmd} 2>&1") do |proc|
-        loop do
-          line = proc.gets
-          break unless line
-          output << line
-          puts line if verbose
-        end
-      end
-      output.force_encoding('UTF-8')
-      output
-    end
-
-  end # class Client
-
-end # module