ruby-jss 1.2.3 → 1.2.4a1

data/lib/jamf/validate.rb

@@ -0,0 +1,224 @@
+# Copyright 2019 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.
+#
+#
+
+# The Module
+module Jamf
+
+  # A collection of methods for validating values. Mostly for
+  # ensuring the validity of data being set as attributes of APIObject
+  # subclass instances.
+  #
+  # Some of these methods can take multiple input types, such as a String
+  # or an Array.  All of them will either raise an exception
+  # if the value isn't valid, or will return a standardized form of the input
+  # (e.g. an Array, even if given a String)
+  #
+  module Validate
+
+    # The regular expression that matches a valid MAC address.
+    MAC_ADDR_RE = /^[a-f0-9]{2}(:[a-f0-9]{2}){5}$/i
+
+    # Validate the format and content of a MAC address
+    #
+    # @param val[String] The value to validate
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [String] The valid value
+    #
+    def self.mac_address(val, msg = nil)
+      msg ||= "Not a valid MAC address: '#{val}'"
+      raise Jamf::InvalidDataError, msg unless val =~ MAC_ADDR_RE
+      val
+    end
+
+    # Validate the format and content of an IPv4 address
+    #
+    # @param val[String] The value to validate
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [String] The valid value
+    #
+    def self.ip_address(val, msg = nil)
+      msg ||= "Not a valid IPv4 address: '#{val}'"
+      ok = true
+      parts = val.strip.split '.'
+      ok = false unless parts.size == 4
+      parts.each { |p| ok = false unless p.j_integer? && p.to_i < 256 && p.to_i >= 0 }
+      raise Jamf::InvalidDataError, msg unless ok
+      val
+    end
+
+    # Does a give JSONObject class have a given JSON attribute?
+    #
+    # @param klass [<JSONObject] A class descended from JSONObject
+    #
+    # @param attr_name [Symbol] The attribute to validate
+    #
+    # @return [Symbol] The valid attribute
+    #
+    def self.json_attribute_name(klass, attr_name)
+      raise "#{klass} is not a descendent of JSONObject" unless klass < Jamf::JSONObject
+
+      raise Jamf::NoSuchItemError, "No attribute #{attr_name} for class #{klass}" unless klass::OBJECT_MODEL.key? attrib
+      attr_name
+    end
+
+    # Validate that a value doesn't already exist for a given identifier of
+    # a given CollectionResource class
+    #
+    # e.g. when klass = Jamf::Computer, identifier = :name, and val = 'foo'
+    # will raise an error when a computer named 'foo' already exists
+    #
+    # Otherwise returns val.
+    #
+    # @param val[Object] The value to check for uniqueness
+    #
+    # @param klass[Jamf::CollectionResource] A descendent of Jamf::CollectionResource, e.g. Jamf::Computer
+    #
+    # @param identifier[Symbol] One of the values of klass.identifiers
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @param cnx[Jamf::Connection] The api connection to use for validation
+    #
+    # @return [Object] the validated unique value
+    #
+    def self.unique_identifier(val, klass, identifier, msg = nil, cnx: Jamf.cnx)
+      msg ||= "A #{klass} already exists with #{identifier} '#{val}'"
+
+      raise Jamf::InvalidDataError, "No identifier '#{identfier}' for #{klass}" unless klass.identifiers.include? identifier
+
+      return val unless klass.send("all_#{identfier}s", refresh: true, cnx: cnx).include? val
+
+      raise Jamf::AlreadyExistsError, msg
+    end
+
+    # Confirm that the given value is a boolean value, accepting
+    # Strings and Symbols,  returning real booleans as needed
+    #
+    # Accepted True values: true, 'true', :true, 'yes', :yes
+    #
+    # Accepted False values: false, 'false', :false, 'no', :no
+    #
+    # all Strings and Symbols are case insensitive
+    #
+    # @param val [Boolean,String,Symbol] The value to validate
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [Boolean] the valid boolean
+    #
+    def self.boolean(val, msg = nil)
+      msg ||= 'Value must be boolean true or false'
+      return true if val.to_s =~ /^(true|yes)$/i
+      return false if val.to_s =~ /^(false|no)$/i
+
+      raise Jamf::InvalidDataError, msg
+    end
+
+    # Confirm that a value is an Integer or a String representation of an
+    # Integer. Return the integer, or raise an error
+    #
+    # @param val[Object] the value to validate
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [Integer] the valid integer
+    #
+    def self.integer(val, msg = nil)
+      msg ||= 'Value must be an Integer'
+      val = val.to_i if val.is_a?(String) && val.j_integer?
+      raise Jamf::InvalidDataError, msg unless val.is_a? Integer
+      val
+    end
+
+    # Confirm that a value is a Float or a String representation of a Float.
+    # Return the Float, or raise an error
+    #
+    # @param val[Object] the value to validate
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [Float] the valid float
+    #
+    def self.float(val, msg = nil)
+      msg ||= 'Value must be a Floating Point number'
+      val = val.to_f if val.is_a?(String) && val.j_float?
+      raise Jamf::InvalidDataError, msg unless val.is_a? Flot
+      val
+    end
+
+    # Confirm that a value is a string, symbol, or nil,
+    # all of which will be returned as a string
+    #
+    # @param val[Object] the value to validate
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [String] the valid String
+    #
+    def self.string(val, msg = nil)
+      msg ||= 'Value must be a String'
+      return Jamf::BLANK if val.nil?
+      val = val.to_s if val.is_a? Symbol
+      raise Jamf::InvalidDataError, msg unless val.is_a? String
+      val
+    end
+
+    # validate that the given value is a non-empty string
+    # Symbols are accepted and returned as strings
+    #
+    # @param val [Object] the thing to validate
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [String] the valid non-empty string
+    #
+    def self.non_empty_string(val, msg = nil)
+      msg ||= 'value must be a non-empty String'
+      val = val.to_s if val.is_a? Symbol
+      raise Jamf::InvalidDataError, msg unless val.is_a?(String) && !val.empty?
+      val
+    end
+
+    SCRIPT_SHEBANG = '#!'.freeze
+
+    # validate that the given value is a string that starts with #!
+    #
+    # @param val [Object] the thing to validate
+    #
+    # @param msg[String] A custom error message when the value is invalid
+    #
+    # @return [String] the validated string
+    #
+    def self.script_contents(val, msg = nil)
+      msg ||= "value must be a String starting with '#!'"
+      raise Jamf::InvalidDataError, msg unless val.is_a?(String) && val.start_with?(SCRIPT_SHEBANG)
+      val
+    end
+  end # module validate
+
+end # module JSS

data/lib/jamf/version.rb

@@ -0,0 +1,32 @@
+### Copyright 2019 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 Jamf
+
+  ### The version of the Jamf module
+  VERSION = '0.0.0a1'.freeze
+
+end # module

data/lib/jpapi.rb

@@ -0,0 +1,26 @@
+# Copyright 2019 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.
+#
+#
+
+require 'jamf'

data/lib/jss/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4a1
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -146,6 +146,106 @@ files:
 - bin/jamfHelperBackgrounder
 - bin/netseg-update
 - data/ruby-jss.conf.example
+- lib/jamf.rb
+- lib/jamf/api/abstract_classes/collection_resource.rb
+- lib/jamf/api/abstract_classes/generic_reference.rb
+- lib/jamf/api/abstract_classes/json_object.rb
+- lib/jamf/api/abstract_classes/prestage.rb
+- lib/jamf/api/abstract_classes/prestage_skip_setup_items.rb
+- lib/jamf/api/abstract_classes/resource.rb
+- lib/jamf/api/abstract_classes/singleton_resource.rb
+- lib/jamf/api/attribute_classes/ip_address.rb
+- lib/jamf/api/attribute_classes/timestamp.rb
+- lib/jamf/api/connection.rb
+- lib/jamf/api/connection/api_error.rb
+- lib/jamf/api/connection/api_error_styleguide.rb
+- lib/jamf/api/connection/token.rb
+- lib/jamf/api/json_objects/account_prefs.rb
+- lib/jamf/api/json_objects/android_details.rb
+- lib/jamf/api/json_objects/appletv_details.rb
+- lib/jamf/api/json_objects/attachment.rb
+- lib/jamf/api/json_objects/cellular_network.rb
+- lib/jamf/api/json_objects/change_log_entry.rb
+- lib/jamf/api/json_objects/computer_prestage_skip_setup_items.rb
+- lib/jamf/api/json_objects/country.rb
+- lib/jamf/api/json_objects/extension_attribute_value.rb
+- lib/jamf/api/json_objects/installed_application.rb
+- lib/jamf/api/json_objects/installed_certificate.rb
+- lib/jamf/api/json_objects/installed_configuration_profile.rb
+- lib/jamf/api/json_objects/installed_ebook.rb
+- 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/location.rb
+- lib/jamf/api/json_objects/md_prestage_name.rb
+- lib/jamf/api/json_objects/md_prestage_names.rb
+- lib/jamf/api/json_objects/md_prestage_skip_setup_items.rb
+- lib/jamf/api/json_objects/mobile_device_details.rb
+- lib/jamf/api/json_objects/mobile_device_security.rb
+- lib/jamf/api/json_objects/prestage_assignment.rb
+- lib/jamf/api/json_objects/prestage_location.rb
+- lib/jamf/api/json_objects/prestage_purchasing_data.rb
+- 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/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/immutable.rb
+- lib/jamf/api/mixins/locatable.rb
+- lib/jamf/api/mixins/lockable.rb
+- lib/jamf/api/mixins/referable.rb
+- lib/jamf/api/mixins/searchable.rb
+- lib/jamf/api/mixins/uncreatable.rb
+- lib/jamf/api/mixins/undeletable.rb
+- lib/jamf/api/resources/collection_resources/account.rb
+- lib/jamf/api/resources/collection_resources/building.rb
+- lib/jamf/api/resources/collection_resources/category.rb
+- lib/jamf/api/resources/collection_resources/computer.rb
+- lib/jamf/api/resources/collection_resources/computer_prestage.rb
+- lib/jamf/api/resources/collection_resources/department.rb
+- lib/jamf/api/resources/collection_resources/extension_attribute.rb
+- lib/jamf/api/resources/collection_resources/inventory_preload_record.rb
+- lib/jamf/api/resources/collection_resources/md_prestage.rb
+- lib/jamf/api/resources/collection_resources/mobile_device.rb
+- lib/jamf/api/resources/collection_resources/script.rb
+- lib/jamf/api/resources/collection_resources/site.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/reenrollment_settings.rb
+- lib/jamf/client.rb
+- lib/jamf/client/jamf_binary.rb
+- lib/jamf/client/jamf_helper.rb
+- lib/jamf/client/management_action.rb
+- lib/jamf/compatibility.rb
+- lib/jamf/composer.rb
+- lib/jamf/configuration.rb
+- lib/jamf/exceptions.rb
+- lib/jamf/ruby_extensions.rb
+- lib/jamf/ruby_extensions/array.rb
+- lib/jamf/ruby_extensions/array/predicates.rb
+- lib/jamf/ruby_extensions/array/utils.rb
+- lib/jamf/ruby_extensions/filetest.rb
+- lib/jamf/ruby_extensions/filetest/predicates.rb
+- lib/jamf/ruby_extensions/hash.rb
+- lib/jamf/ruby_extensions/hash/backports.rb
+- lib/jamf/ruby_extensions/ipaddr.rb
+- lib/jamf/ruby_extensions/ipaddr/utils.rb
+- lib/jamf/ruby_extensions/object.rb
+- lib/jamf/ruby_extensions/object/predicates.rb
+- lib/jamf/ruby_extensions/pathname.rb
+- lib/jamf/ruby_extensions/pathname/predicates.rb
+- lib/jamf/ruby_extensions/pathname/utils.rb
+- lib/jamf/ruby_extensions/string.rb
+- lib/jamf/ruby_extensions/string/backports.rb
+- lib/jamf/ruby_extensions/string/conversions.rb
+- lib/jamf/ruby_extensions/string/predicates.rb
+- lib/jamf/utility.rb
+- lib/jamf/validate.rb
+- lib/jamf/version.rb
+- lib/jpapi.rb
 - lib/jss-api.rb
 - lib/jss.rb
 - lib/jss/api_connection.rb
@@ -289,9 +389,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: