ruby-jss 1.2.9 → 1.5.1

data/lib/jss/api_object.rb

@@ -849,11 +849,7 @@ module JSS
         raise ArgumentError, 'Missing searchterm or fetch key'
       end
 
-      begin
-        return new fetch_rsrc: fetch_rsrc, api: api
-      rescue RestClient::NotFound
-        raise JSS::NoSuchItemError, "No #{self::RSRC_OBJECT_KEY} found #{err_detail}" unless fetch_rsrc
-      end
+      new fetch_rsrc: fetch_rsrc, api: api
     end # fetch
 
     # Fetch the mostly- or fully-raw JSON or XML data for an object of this
@@ -895,8 +891,6 @@ module JSS
       return data if format == :json || as_string
 
       REXML::Document.new(data)
-    rescue RestClient::NotFound
-      raise JSS::NoSuchItemError, "No #{self} with id #{id}"
     end
 
     # PUT some raw XML to the API for a given id in this subclass.
@@ -925,8 +919,6 @@ module JSS
       validate_not_metaclass(self)
       rsrc = "#{self::RSRC_BASE}/id/#{id}"
       REXML::Document.new(api.put_rsrc rsrc, xml.to_s)
-    rescue RestClient::NotFound
-      raise JSS::NoSuchItemError, "No #{self} with id #{id}"
     end
 
     # POST some raw XML to the API for a given id in this subclass.
@@ -1222,8 +1214,10 @@ module JSS
     # @return [void]
     #
     def delete
-      return nil unless @in_jss
+      return unless @in_jss
+
       @api.delete_rsrc @rest_rsrc
+
       @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name.to_s}"
       @id = nil
       @in_jss = false
@@ -1350,7 +1344,10 @@ module JSS
     #
     def ppx
       return nil unless creatable? || updatable?
-      REXML::Document.new(rest_xml).write $stdout, 2
+
+      formatter = REXML::Formatters::Pretty.new(2)
+      formatter.compact = true
+      formatter.write(REXML::Document.new(rest_xml), $stdout)
       puts
     end
 
@@ -1422,8 +1419,6 @@ module JSS
         end
 
       raw_json[args[:rsrc_object_key]]
-    rescue RestClient::ResourceNotFound
-      raise NoSuchItemError, "No #{self.class::RSRC_OBJECT_KEY} found matching resource #{rsrc}"
     end
 
     # Start examining the @init_data recieved from the API
@@ -1655,9 +1650,13 @@ require 'jss/api_object/category'
 require 'jss/api_object/computer'
 require 'jss/api_object/computer_invitation'
 require 'jss/api_object/department'
+require 'jss/api_object/disk_encryption_configurations'
+require "jss/api_object/directory_binding_type"
+require 'jss/api_object/directory_binding'
 require 'jss/api_object/distribution_point'
 require 'jss/api_object/ebook'
 require 'jss/api_object/ibeacon'
+require 'jss/api_object/dock_item'
 require 'jss/api_object/ldap_server'
 require 'jss/api_object/mac_application'
 require 'jss/api_object/mobile_device'
@@ -1677,5 +1676,9 @@ require 'jss/api_object/site'
 require 'jss/api_object/software_update_server'
 require 'jss/api_object/user'
 require 'jss/api_object/webhook'
+require 'jss/api_object/printer'
+
+### Other
+require 'jss/api_object/app_store_country_codes'
 
 JSS::APIObject.define_identifier_list_methods

data/lib/jss/api_object/advanced_search.rb

@@ -62,6 +62,7 @@ module JSS
     include JSS::Criteriable
     include JSS::Sitable
 
+
     # Class Constants
     #####################################
 
@@ -85,6 +86,22 @@ module JSS
     #
     attr_reader :search_results
 
+    # @return [Array<String>] the fields to be returned with the search results
+    #
+    # The API delivers these as an array of Hashes,
+    # where each hash has only one key, :name => the name of the fields/ExtAttrib
+    # to display. It should probably not have the underlying Hashes, and just
+    # be an array of names. This class converts it to just an Array of field names
+    # (Strings) for internal use.
+    #
+    # These fields are returned in the @search_results
+    # data along with :id, :name, and other unique identifiers
+    # for each found item. In that data, their names have colons removed, abd
+    # spaces and dashes converted to underscores, and they are
+    # symbolized. See attribute result_display_keys
+    #
+    attr_reader :display_fields
+
     # @return [Array<Symbol>]
     #
     # The search result Hash keys for the {#display_fields} of the search
@@ -95,8 +112,9 @@ module JSS
     # methods are for.
     #
     # However, when those names come back as the Hash Keys of the {#search_results}
-    # they (inconsistently) have spaces and/or dashes converted to underscores, and,
-    # the JSON module converts the keys to Symbols, so they don't match the {#display_fields}.
+    # they (inconsistently) have spaces and/or dashes converted to underscores,
+    # and colons are removed. The JSON module then converts the keys to Symbols,
+    # so they don't match the {#display_fields}.
     #
     # For example, the display field "Last Check-in" might come back as any of these Symbols:
     # - :"Last Check-in"
@@ -147,13 +165,13 @@ module JSS
       # make sure each hash of the search results
       # has a key matching a standard key.
       #
-      @search_results.each do |hash|
-        hash.keys.each do |key|
-          std_key = key.to_s.gsub(/ |-/, '_').to_sym
-          next if hash[std_key]
-          hash[std_key] = hash[key]
-        end
-      end
+      # @search_results.each do |hash|
+      #   hash.keys.each do |key|
+      #     std_key = key.to_s.gsub(':', '').gsub(/ |-/, '_').to_sym
+      #     next if hash[std_key]
+      #     hash[std_key] = hash[key]
+      #   end
+      # end
     end # init
 
     # Public Instance Methods
@@ -231,23 +249,6 @@ module JSS
       end
     end
 
-    # @return [Array<String>] the fields to be returned with the search results
-    #
-    # The API delivers these as an array of Hashes,
-    # where each hash has only one key, :name => the name of the fields/ExtAttrib
-    # to display. It should probably not have the underlying Hashes, and just
-    # be an array of names. This class converts it to just an Array of field names
-    # (Strings) for internal use.
-    #
-    # These fields are returned in the @search_results
-    # data along with :id, :name, and other unique identifiers
-    # for each found item. In that data, their names have
-    # spaces and dashes converted to underscores, and they are
-    # symbolized.
-    #
-    #
-    attr_reader :display_fields
-
     # Set the list of fields to be retrieved with the
     # search results.
     #

data/lib/jss/api_object/app_store_country_codes.rb

@@ -0,0 +1,298 @@
+### 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