ruby-jss 1.0.4 → 1.1.0b1

data/lib/jss/api_object/netboot_server.rb

@@ -70,9 +70,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :netboot_server
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:protocol, :boot_args]
-
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}

data/lib/jss/api_object/network_segment.rb

@@ -59,9 +59,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :network_segment
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:distribution_point, :starting_address, :override_departments].freeze
-
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}

data/lib/jss/api_object/package.rb

@@ -61,9 +61,6 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :package
 
-    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = %i[fill_existing_users fill_user_template reboot_required].freeze
-
     # The pkg storage folder on the distribution point
     DIST_POINT_PKGS_FOLDER = 'Packages'.freeze
 

data/lib/jss/api_object/patch_source/patch_external_source.rb

@@ -48,8 +48,6 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :patch_external_source
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = %i[enabled ssl_enabled host_name].freeze
 
     # Instance Methods
     #####################################

data/lib/jss/api_object/patch_source/patch_internal_source.rb

@@ -47,9 +47,6 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :patch_internal_source
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = %i[enabled endpoint].freeze
-
   end # class PatchInternalSource
 
 end # module JSS

data/lib/jss/api_object/patch_title.rb

@@ -132,8 +132,7 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :patch_software_title
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = %i[notifications name_id source_id].freeze
+    NON_UNIQUE_NAMES = true
 
     # the object type for this object in
     # the object history table.

data/lib/jss/api_object/peripheral.rb

@@ -74,9 +74,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :peripheral
 
-    ### these keys, as well as :id and :name, are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:type, :bar_code_1, :computer_id ]
-
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}

data/lib/jss/api_object/peripheral_type.rb

@@ -69,8 +69,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :peripheral_type
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:fields]
 
     ### field types can be one of these, either String or Symbol
     FIELD_TYPES = [:text, :menu]

data/lib/jss/api_object/policy.rb

@@ -92,8 +92,26 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :policy
 
-    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = %i[scope user_interaction files_processes].freeze
+    # subsets available for fetching
+    # TODO: FilesProcesses and Maintenance don't seem to work
+    SUBSETS = %i[
+      general
+      scope
+      selfservice
+      self_service
+      packages
+      scripts
+      printers
+      dockitems
+      dock_items
+      reboot
+      userinteraction
+      user_interaction
+      disk_encryption
+      diskencryption
+      accountmaintenance
+      account_maintenance
+    ].freeze
 
     # policies can take uploaded icons
     UPLOAD_TYPES = { icon: :policies }.freeze

data/lib/jss/api_object/removable_macaddr.rb

@@ -72,9 +72,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :removable_mac_address
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = []
-
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}

data/lib/jss/api_object/restricted_software.rb

@@ -50,9 +50,6 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :restricted_software
 
-    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:scope].freeze
-
     # Our scopes deal with computers
     SCOPE_TARGET_KEY = :computers
 

data/lib/jss/api_object/scopable.rb

@@ -54,27 +54,19 @@ module JSS
   ###
   module Scopable
 
-    #####################################
     ###  Constants
     #####################################
 
     SCOPABLE = true
 
-    #####################################
-    ###  Variables
-    #####################################
-
-    #####################################
     ###  Attribtues
     #####################################
 
     attr_reader :scope
 
-    #####################################
     ###  Mixed-in Instance Methods
     #####################################
 
-    ###
     ### @api private
     ###
     ### Call this during initialization of objects that have a scope
@@ -87,8 +79,6 @@ module JSS
       @scope.container = self
     end
 
-
-    ###
     ### Change the scope
     ###
     ### @param new_scope[JSS::Scopable::Scope] the new scope
@@ -102,7 +92,6 @@ module JSS
       @need_to_update = true
     end
 
-    ###
     ### When the scope changes, it calls this to tell us that an update is needed.
     ###
     ### @return [void]
@@ -112,7 +101,6 @@ module JSS
     end
 
 
-    ###
     ### A wrapper around the update method, to try catching RestClient::Conflict
     ### 409 errors when we couldn't verify all ldap users/groups due to lack of ldap connections
     ###

data/lib/jss/api_object/scopable/scope.rb

@@ -178,7 +178,7 @@ module JSS
       # @param raw_scope[Hash] the JSON :scope data from an API query that is scopable, e.g. a Policy.
       #
       def initialize(target_key, raw_scope = nil)
-        raw_scope ||= DEFAULT_SCOPE
+        raw_scope ||= DEFAULT_SCOPE.dup
         raise JSS::InvalidDataError, "The target class of a Scope must be one of the symbols :#{TARGETS_AND_GROUPS.keys.join(', :')}" unless TARGETS_AND_GROUPS.key?(target_key)
 
         @target_key = target_key

data/lib/jss/api_object/script.rb

@@ -79,9 +79,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :script
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:parameters, :filename, :os_requirements].freeze
-
     ### The script storage folder on the distribution point, if used
     DIST_POINT_SCRIPTS_FOLDER = 'Scripts'.freeze
 

data/lib/jss/api_object/self_servable.rb

@@ -357,13 +357,15 @@ module JSS
     #
     # @return [void]
     #
-    def self_service_dislay_name=(new_val)
+    def self_service_display_name=(new_val)
       new_val.strip!
       return nil if @self_service_dislay_name == new_val
       raise JSS::InvalidDataError, 'Only macOS Self Service items have display names' unless self_service_targets.include? :macos
       @self_service_dislay_name = new_val
       @need_to_update = true
     end
+    # alias for backward compatibility with the typo
+    alias self_service_dislay_name self_service_display_name
 
     # @param new_val[String] the new install button text
     #

data/lib/jss/api_object/site.rb

@@ -55,9 +55,6 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :site
 
-    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [].freeze
-
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}

data/lib/jss/api_object/software_update_server.rb

@@ -69,9 +69,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :software_update_server
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:set_system_wide, :port]
-
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}

data/lib/jss/api_object/user.rb

@@ -70,9 +70,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :user
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:position, :full_name, :email]
-
     ### This class lets us seach for users
     SEARCH_CLASS = JSS::AdvancedUserSearch
 

data/lib/jss/api_object/webhook.rb

@@ -54,9 +54,6 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :webhook
 
-    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:event, :contact_type, :url, :enabled].freeze
-
     # the content types available for webhooks, internally we use Symbols,
     # but the API wants the proper MIME strings
     CONTENT_TYPES = {

data/lib/jss/compatibility.rb

@@ -1,67 +1,88 @@
-### 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.
-### 
-###
-
-
-###
-### Augmentation to make this code compatible with ruby 1.8.7
-###
-
-#############################################
-### Hash.key
-###
-### #key exists in ruby 1.9+, in 1.8 its called #index
-### it returns the hash key for a given value, if the value exists
-### in the hash
-###
+# 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.
+#
+#
+
+# backporting of some newer ruby methods into older rubies
+#
+
+# Hash.key
+#
+# #key exists in ruby 1.9+, in 1.8 its called #index
+# it returns the hash key for a given value, if the value exists
+# in the hash
+#
+###########################################
 unless {}.respond_to? :key
   class Hash
-    alias_method  :key, :index
+
+    alias key index
+
   end
 end
 
-#############################################
-### Array.sample
-###
-### #sample exists in ruby 1.9+, in 1.8 its called #choice
-### it returns a randomly chosen element of the given array
-### eg: [1, 2, 3].sample returns either 1, 2, or 3
-###
+# Array.sample
+#
+# #sample exists in ruby 1.9+, in 1.8 its called #choice
+# it returns a randomly chosen element of the given array
+# eg: [1, 2, 3].sample returns either 1, 2, or 3
+#
+###########################################
 unless [].respond_to? :sample
   class Array
-    alias_method :sample, :choice
+
+    alias sample choice
+
+  end
+end
+
+# String.force_encoding
+#
+#
+###########################################
+unless ''.respond_to? :force_encoding
+  class String
+
+    def force_encoding(_args = nil)
+      self
+    end
+
   end
 end
 
 
-#############################################
-### String.force_encoding
-###
-### Ruby 1.8 doesn't do encodings...
-###
-unless "".respond_to? :force_encoding
+# String.casecmp?
+#
+#
+###########################################
+unless ''.respond_to? :casecmp?
   class String
-    def force_encoding(args = nil); self; end
+
+    def casecmp?(other)
+      return nil unless other.is_a? String
+
+      casecmp(other).zero?
+    end
+
   end
 end

data/lib/jss/exceptions.rb

@@ -55,6 +55,11 @@ module JSS
   ###
   class AlreadyExistsError < RuntimeError; end
 
+  ### AmbiguousError - raise this error when a search
+  ### term that should find one object finds more.
+  ###
+  class AmbiguousError < RuntimeError; end
+
   ### FileServiceError - raise this error when
   ### there's a problem accessing file service on a
   ### distribution point.

data/lib/jss/ruby_extensions/string.rb

@@ -20,54 +20,10 @@
 #    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.
-#
-#
-
-#
-class String
-
-  # Convert the strings "true" and "false"
-  # (after stripping whitespace and downcasing)
-  # to TrueClass and FalseClass respectively
-  #
-  # Return nil if any other string.
-  #
-  # @return [Boolean,nil] the boolean value
-  #
-  def jss_to_bool
-    case strip.downcase
-    when 'true' then true
-    when 'false' then false
-    end # case
-  end # to bool
-
-  # Convert a string to a Time object
-  #
-  # returns nil if not parsable by JSS::parse_datetime
-  #
-  # @return [Time] the time represented by the string.
-  #
-  def jss_to_time
-    JSS.parse_time self
-  rescue
-    return nil
-  end
 
-  # Convert a String to a Pathname object
-  #
-  # @return [Pathname]
-  #
-  def jss_to_pathname
-    Pathname.new self
-  end
 
-  # Is this string also a positive integer?
-  # (i.e. it consists only of numberic digits)
-  #
-  # @return [Boolean]
-  #
-  def jss_integer?
-    self =~ /\A[0-9]+\Z/ ? true : false
-  end
+require 'jss/ruby_extensions/string/conversions.rb'
+require 'jss/ruby_extensions/string/predicates.rb'
 
-end # class
+String.include JSSRubyExtensions::String::Predicates
+String.include JSSRubyExtensions::String::Conversions