ruby-jss 1.2.9 → 1.5.1

data/lib/jss/composer.rb

@@ -147,7 +147,7 @@ module JSS
 
       ### now build the pkg
       begin
-        it_built = system "#{PKGBUILD} --identifier '#{pkg_id}' --version '#{version}' --ownership #{pkg_ownership} --install-location / --root '#{root}' #{signing} #{comp_plist_arg} '#{pkg_out}' "
+        it_built = system "#{PKGBUILD} --identifier '#{pkg_id}' --version '#{version}' --ownership #{pkg_ownership} --install-location / --root '#{root}' #{signing} #{comp_plist_arg} '#{pkg_out}'"
 
         raise 'There was an error building the .pkg' unless it_built
       ensure

data/lib/jss/exceptions.rb

@@ -87,6 +87,9 @@ module JSS
   ###
   class AuthenticationError < RuntimeError; end
 
+  ###
+  class AuthorizationError < RuntimeError ; end
+
   ### ConflictError - raise this when
   ### attempts to PUT or PUSH to the API
   ### result in a 409 Conflict http error.

data/lib/jss/server.rb

@@ -110,6 +110,21 @@ module JSS
       @act_code_data[:code]
     end
 
+    # Update the activation code and organization name for this server
+    #
+    # @param org: [String] the organization to which the server is licensed
+    # @param code: [String ]  the activation code for the server licence
+    #
+    # @return [void]
+    def update_activation_code(org:, code:)
+      xml = REXML::Document.new JSS::APIConnection::XML_HEADER
+      acode = xml.add_element ACTIVATION_CODE_KEY.to_s
+      acode.add_element('organization_name').text = org
+      acode.add_element('code').text = code
+
+      @api.put_rsrc ACTIVATION_CODE_RSRC, xml.to_s
+    end
+
     # Remove the api object from
     # the instance_variables used to create
     # pretty-print (pp) output.

data/lib/jss/utility.rb

@@ -32,7 +32,7 @@ module JSS
 
   # Converts an OS Version into an Array of higher OS versions.
   #
-  # It's unlikely that this library will still be in use as-is by the release of OS X 10.19.15.
+  # It's unlikely that this library will still be in use as-is by the release of OS X 10.30.
   # Hopefully well before then JAMF will implement a "minimum OS" in the JSS itself.
   #
   # @param min_os [String] the mimimum OS version to expand, e.g. ">=10.6.7"  or "10.6.7"
@@ -43,26 +43,12 @@ module JSS
   #   JSS.expand_min_os ">=10.6.7" # => returns this array
   #    # ["10.6.7",
   #    #  "10.6.8",
-  #    #  "10.6.9",
-  #    #  "10.6.10",
-  #    #  "10.6.11",
-  #    #  "10.6.12",
-  #    #  "10.6.13",
-  #    #  "10.6.14",
-  #    #  "10.6.15",
+  #    #  ...
+  #    #  "10.6.25",
   #    #  "10.7.x",
   #    #  "10.8.x",
-  #    #  "10.9.x",
-  #    #  "10.10.x",
-  #    #  "10.11.x",
-  #    #  "10.12.x",
-  #    #  "10.13.x",
-  #    #  "10.14.x",
-  #    #  "10.15.x",
-  #    #  "10.16.x",
-  #    #  "10.17.x",
-  #    #  "10.18.x",
-  #    #  "10.19.x"]
+  #    #  ...
+  #    #  "10.30.x"]
   #
   #
   def self.expand_min_os(min_os)
@@ -80,14 +66,14 @@ module JSS
     # (and hope apple doesn't do more than 15 maint releases for an OS)
     else
       ok_oses = []
-      (maint.to_i..15).each do |m|
+      (maint.to_i..25).each do |m|
         ok_oses << maj + '.' + min + '.' + m.to_s
       end # each m
     end
 
     # now account for all OS X versions starting with 10.
-    # up to at least 10.19.x
-    ((min.to_i + 1)..19).each do |v|
+    # up to 10.30.x
+    ((min.to_i + 1)..30).each do |v|
       ok_oses << maj + '.' + v.to_s + '.x'
     end # each v
     ok_oses

data/lib/jss/validate.rb

@@ -111,8 +111,8 @@ module JSS
 
     # Confirm that the given value is a boolean value, accepting
     # strings and symbols and returning real booleans as needed
-    # Accepts: true, false, 'true', 'false', :true, :false, 'yes', 'no', :yes,
-    # or :no (all Strings and Symbols are case insensitive)
+    # Accepts: true, false, 'true', 'false', 'yes', 'no', 't','f', 'y', or 'n'
+    # as strings or symbols, case insensitive
     #
     # TODO: use this throughout ruby-jss
     #
@@ -123,11 +123,11 @@ module JSS
     # @return [Boolean] the valid boolean
     #
     def self.boolean(bool, msg = nil)
-      msg ||= 'Value must be boolean true or false'
       return bool if JSS::TRUE_FALSE.include? bool
-      return true if bool.to_s =~ /^(true|yes)$/i
-      return false if bool.to_s =~ /^(false|no)$/i
+      return true if bool.to_s =~ /^(t(rue)?|y(es)?)$/i
+      return false if bool.to_s =~ /^(f(alse)?|no?)$/i
 
+      msg ||= 'Value must be boolean true or false, or an equivalent string or symbol'
       raise JSS::InvalidDataError, msg
     end
 
@@ -176,10 +176,10 @@ module JSS
     # @return [String] the valid uuid string
     #
     def self.uuid(val, msg = nil)
-      msg ||= 'value must be valid uuid'
-      raise JSS::InvalidDataError, msg unless val.is_a?(String) && val =~ UUID_RE
+      return val if val.is_a?(String) && val =~ UUID_RE
 
-      val
+      msg ||= 'value must be valid uuid'
+      raise JSS::InvalidDataError, msg
     end
 
     # validate that the given value is an integer in the JSS::IBeacon::MAJOR_MINOR_RANGE
@@ -191,13 +191,56 @@ module JSS
     # @return [String] the valid integer
     #
     def self.ibeacon_major_minor(val, msg = nil)
-      msg ||= "value must be an integer in the range #{JSS::IBeacon::MAJOR_MINOR_RANGE}"
       val = val.to_i if val.is_a?(String) && val.jss_integer?
       ok = val.is_a? Integer
       ok = JSS::IBeacon::MAJOR_MINOR_RANGE.include? val if ok
+      return val if ok
+
+      msg ||= "value must be an integer in the range #{JSS::IBeacon::MAJOR_MINOR_RANGE}"
       raise JSS::InvalidDataError, msg unless ok
+    end
 
-      val
+    # validate a country name or code from JSS::APP_STORE_COUNTRY_CODES
+    # returning the validated code, or raising an error
+    #
+    # @param country[String] The country name or code
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [String] the valid two-letter country code
+    #
+    def self.app_store_country_code(country, msg = nil)
+      country = country.to_s.upcase
+      return country if JSS::APP_STORE_COUNTRY_CODES.value? country
+
+      JSS::APP_STORE_COUNTRY_CODES.each do |name, code|
+        return code if name.upcase == country
+      end
+
+      msg ||= 'Unknown country name or code. See JSS::APP_STORE_COUNTRY_CODES or JSS.country_code_match(str)'
+      raise JSS::InvalidDataError, msg
+    end
+
+    # validate an email address - must match the RegEx /^\S+@\S+\.\S+$/
+    # i.e.:
+    #  1 or more non-whitespace chars, followed by
+    #  an @ character, followed by
+    #  1 or more non-whitespace chars, followed by
+    #  a dot, followed by
+    #  1 or more non-whitespace chars
+    #
+    # @param email[String] The email address
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [String] the validly formatted email address
+    #
+    def self.email_address(email, msg = nil)
+      msg ||= "'#{email}' is not formatted as a valid email address"
+      email = email.to_s
+      return email if email =~ /^\S+@\S+\.\S+$/
+
+      raise JSS::InvalidDataError, msg
     end
 
   end # module validate

data/lib/jss/version.rb

@@ -27,6 +27,6 @@
 module JSS
 
   ### The version of ruby-jss
-  VERSION = '1.2.9'.freeze
+  VERSION = '1.5.1'.freeze
 
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.5.1
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -46,39 +46,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.9.12
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - "<"
+        version: 1.0.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
-    - - "<"
+        version: 1.0.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: net-ldap
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: immutable-struct
   requirement: !ruby/object:Gem::Requirement
@@ -120,11 +126,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 description: |2
-      The ruby-jss gem provides the JSS module, a framework for interacting with the REST API
-      of the Jamf Software Server (JSS), the core of Jamf Pro, an enterprise/education
-      tool for managing Apple devices, from Jamf Software LLC.
-      JSS API objects are implemented as Ruby classes, and interact with each oher to
-      allow simpler automation of Jamf-related tasks. For details see the README file."
+      The ruby-jss gem provides native ruby access to the REST APIs of Jamf Pro,
+      an enterprise/education tool for managing Apple devices, from jamf.com.
+      The JSS module provides access to the 'Classic' API, while the Jamf module
+      provides access to the more modern 'Jamf Pro' API. Jamf Pro objects are
+      implemented as classes and, within each module, can interact with each other.
+      The underlying data transfer using JSON or XML is handled automatically
+      under the hood to allow simpler, intuitive automation of Jamf-related Tasks.
 email: ruby-jss@pixar.com
 executables:
 - cgrouper
@@ -171,6 +179,7 @@ files:
 - lib/jamf/api/json_objects/country.rb
 - lib/jamf/api/json_objects/criterion.rb
 - lib/jamf/api/json_objects/device_enrollment_device.rb
+- lib/jamf/api/json_objects/device_enrollment_device_sync_state.rb
 - lib/jamf/api/json_objects/device_enrollment_sync_status.rb
 - lib/jamf/api/json_objects/extension_attribute_value.rb
 - lib/jamf/api/json_objects/installed_application.rb
@@ -180,6 +189,7 @@ files:
 - lib/jamf/api/json_objects/installed_provisioning_profile.rb
 - lib/jamf/api/json_objects/inventory_preload_extension_attribute.rb
 - lib/jamf/api/json_objects/ios_details.rb
+- lib/jamf/api/json_objects/locale.rb
 - lib/jamf/api/json_objects/location.rb
 - lib/jamf/api/json_objects/md_prestage_name.rb
 - lib/jamf/api/json_objects/md_prestage_names.rb
@@ -192,15 +202,19 @@ files:
 - lib/jamf/api/json_objects/prestage_scope.rb
 - lib/jamf/api/json_objects/prestage_sync_status.rb
 - lib/jamf/api/json_objects/purchasing_data.rb
+- lib/jamf/api/json_objects/time_zone.rb
 - lib/jamf/api/mixins/abstract.rb
 - lib/jamf/api/mixins/bulk_deletable.rb
 - lib/jamf/api/mixins/change_log.rb
 - lib/jamf/api/mixins/extendable.rb
+- lib/jamf/api/mixins/filterable.rb
 - lib/jamf/api/mixins/immutable.rb
 - lib/jamf/api/mixins/locatable.rb
 - lib/jamf/api/mixins/lockable.rb
+- lib/jamf/api/mixins/pageable.rb
 - lib/jamf/api/mixins/referable.rb
 - lib/jamf/api/mixins/searchable.rb
+- lib/jamf/api/mixins/sortable.rb
 - lib/jamf/api/mixins/uncreatable.rb
 - lib/jamf/api/mixins/undeletable.rb
 - lib/jamf/api/resources/collection_resources/account.rb
@@ -218,11 +232,12 @@ files:
 - lib/jamf/api/resources/collection_resources/mobile_device_prestage.rb
 - lib/jamf/api/resources/collection_resources/script.rb
 - lib/jamf/api/resources/collection_resources/site.rb
-- lib/jamf/api/resources/collection_resources/time_zone.rb
 - lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb
 - lib/jamf/api/resources/singleton_resources/authorization.rb
 - lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb
+- lib/jamf/api/resources/singleton_resources/locales.rb
 - lib/jamf/api/resources/singleton_resources/reenrollment_settings.rb
+- lib/jamf/api/resources/singleton_resources/time_zones.rb
 - lib/jamf/client.rb
 - lib/jamf/client/jamf_binary.rb
 - lib/jamf/client/jamf_helper.rb
@@ -235,6 +250,7 @@ files:
 - lib/jamf/ruby_extensions/array.rb
 - lib/jamf/ruby_extensions/array/predicates.rb
 - lib/jamf/ruby_extensions/array/utils.rb
+- lib/jamf/ruby_extensions/dig.rb
 - lib/jamf/ruby_extensions/filetest.rb
 - lib/jamf/ruby_extensions/filetest/predicates.rb
 - lib/jamf/ruby_extensions/hash.rb
@@ -263,6 +279,7 @@ files:
 - lib/jss/api_object/advanced_search/advanced_computer_search.rb
 - lib/jss/api_object/advanced_search/advanced_mobile_device_search.rb
 - lib/jss/api_object/advanced_search/advanced_user_search.rb
+- lib/jss/api_object/app_store_country_codes.rb
 - lib/jss/api_object/building.rb
 - lib/jss/api_object/categorizable.rb
 - lib/jss/api_object/category.rb
@@ -277,7 +294,16 @@ files:
 - lib/jss/api_object/criteriable/criteria.rb
 - lib/jss/api_object/criteriable/criterion.rb
 - lib/jss/api_object/department.rb
+- lib/jss/api_object/directory_binding.rb
+- lib/jss/api_object/directory_binding_type.rb
+- lib/jss/api_object/directory_binding_type/active_directory.rb
+- lib/jss/api_object/directory_binding_type/admitmac.rb
+- lib/jss/api_object/directory_binding_type/centrify.rb
+- lib/jss/api_object/directory_binding_type/open_directory.rb
+- lib/jss/api_object/directory_binding_type/powerbroker_identity_services.rb
+- lib/jss/api_object/disk_encryption_configurations.rb
 - lib/jss/api_object/distribution_point.rb
+- lib/jss/api_object/dock_item.rb
 - lib/jss/api_object/ebook.rb
 - lib/jss/api_object/extendable.rb
 - lib/jss/api_object/extension_attribute.rb
@@ -321,6 +347,7 @@ files:
 - lib/jss/api_object/peripheral.rb
 - lib/jss/api_object/peripheral_type.rb
 - lib/jss/api_object/policy.rb
+- lib/jss/api_object/printer.rb
 - lib/jss/api_object/purchasable.rb
 - lib/jss/api_object/removable_macaddr.rb
 - lib/jss/api_object/restricted_software.rb
@@ -335,6 +362,7 @@ files:
 - lib/jss/api_object/updatable.rb
 - lib/jss/api_object/uploadable.rb
 - lib/jss/api_object/user.rb
+- lib/jss/api_object/vpp_account.rb
 - lib/jss/api_object/vppable.rb
 - lib/jss/api_object/webhook.rb
 - lib/jss/client.rb
@@ -394,7 +422,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -404,5 +432,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A Ruby interface to the Jamf Pro REST API
+summary: A Ruby interface to the Jamf Pro REST APIs
 test_files: []