ruby-jss 1.2.6 → 1.4.1

data/lib/jss/validate.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# 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
@@ -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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -27,6 +27,6 @@
 module JSS
 
   ### The version of ruby-jss
-  VERSION = '1.2.6'.freeze
+  VERSION = '1.4.1'.freeze
 
 end # module

data/lib/jss/xml_workaround.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/ruby-jss.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/bin/runtests

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/lib/testhelper.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/lib/testhelper/auth.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/lib/testhelper/patch_mgmt.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/specs/api_connection_spec.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/specs/patch01_source_spec.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/specs/patch02_internal_source_spec.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/specs/patch03_external_source_spec.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/specs/patch04_titles_spec.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/specs/patch05_policies_spec.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/specs/patch06_cleanup_spec.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/test/specs/policy_spec.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.4.1
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -235,6 +235,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 +264,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 +279,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 +332,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 +347,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