ruby-jss 1.6.0b1 → 2.0.0a10

data/lib/{jss/api_object → jamf/api/classic/api_objects}/criteriable.rb

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -23,7 +23,7 @@
 #
 #
 
-module JSS
+module Jamf
 
   # A mix-in module that allows objects to handle standardized search Criteria.
   #
@@ -31,18 +31,18 @@ module JSS
   # include a set of Criteria. (i.e conditions which, when met, signify inclusion
   # in a result set.)
   #
-  # A {JSS::Criteriable::Criteria} instance is a container for one or more
-  # {JSS::Criteriable::Criterion} instances and provides methods for dealing with
+  # A {Jamf::Criteriable::Criteria} instance is a container for one or more
+  # {Jamf::Criteriable::Criterion} instances and provides methods for dealing with
   # them easily.
   #
-  # When a {JSS::APIObject} subclass includes this module, that subclass
-  # will have a :criteria attribute, which holds a {JSS::Criteriable::Criteria}
+  # When a {Jamf::APIObject} subclass includes this module, that subclass
+  # will have a :criteria attribute, which holds a {Jamf::Criteriable::Criteria}
   # object and can be used to manipulate the Criterion objects inside.
   #
   # The including subclass also gains some instance methods:
   # * #parse_critera - sets up the :criteria attribute during initialization
   # * #criteria= - allows the wholesale replacement of the criteria
-  # * #need_to_update - allows the {JSS::Criteriable::Criteria} instance to
+  # * #need_to_update - allows the {Jamf::Criteriable::Criteria} instance to
   #   inform the subclass instance that it has changed and needs an #update
   #
   # Classes mixing in this module *must*
@@ -56,14 +56,14 @@ module JSS
   #   # These find all of jeauxbleaux's computers that have either
   #   # Excel or Word installed
   #
-  #   crtn_0 = JSS::Criteriable::Criterion.new(
+  #   crtn_0 = Jamf::Criteriable::Criterion.new(
   #     and_or: :and, # NOTE: the and_or value of the first criterion is ignored
   #     name: 'Username',
   #     search_type: 'is',
   #     value: 'jeauxbleaux'
   #   )
   #
-  #   crtn_1 = JSS::Criteriable::Criterion.new(
+  #   crtn_1 = Jamf::Criteriable::Criterion.new(
   #     and_or: :and,
   #     paren: :opening,
   #     name: 'Application Title',
@@ -71,7 +71,7 @@ module JSS
   #     value: 'Microsoft Excel.app'
   #   )
   #
-  #   crtn_2 = JSS::Criteriable::Criterion.new(
+  #   crtn_2 = Jamf::Criteriable::Criterion.new(
   #     and_or: :or,
   #     name: 'Application Title',
   #     search_type: 'has',
@@ -80,10 +80,10 @@ module JSS
   #   )
   #
   #   # use them to create a Criteria instance
-  #   crta = JSS::Criteriable::Criteria.new [crtn_0, crtn_1, crtn_2]
+  #   crta = Jamf::Criteriable::Criteria.new [crtn_0, crtn_1, crtn_2]
   #
   #   # create a new Advanced Search
-  #   srch = JSS::AdvancedComputerSearch.make, :name => "my computer search"
+  #   srch = Jamf::AdvancedComputerSearch.make, :name => "my computer search"
   #   srch.display_fields = ["Computer Name"]
   #
   #   # add our Criteria to it
@@ -94,7 +94,7 @@ module JSS
   #
   #   # append a new criterion to the criteria, limiting the search results farther
   #   # to those computers that have done a recon in the past week
-  #   srch.criteria.append_criterion JSS::Criteriable::Criterion.new(
+  #   srch.criteria.append_criterion Jamf::Criteriable::Criterion.new(
   #     and_or: :or,
   #     name: "Last Inventory Update",
   #     search_type: "less than x days ago",
@@ -109,7 +109,7 @@ module JSS
   #
   #   # oops - that last one should have been :and, not :or
   #   # so replace the last criterion with a correct one
-  #   srch.criteria.set_criterion 3, JSS::Criteriable::Criterion.new(
+  #   srch.criteria.set_criterion 3, Jamf::Criteriable::Criterion.new(
   #     and_or: :and,
   #     name: "Last Inventory Update",
   #     search_type: "less than x days ago",
@@ -121,8 +121,8 @@ module JSS
   #   # perform the requery  after the update.
   #   srch.update :requery
   #
-  # @see JSS::Criteriable::Criteria
-  # @see JSS::Criteriable::Criterion
+  # @see Jamf::Criteriable::Criteria
+  # @see Jamf::Criteriable::Criterion
   #
   module Criteriable
 
@@ -137,7 +137,7 @@ module JSS
     #  Mixed-in Attributes
     #####################################
 
-    # @return [JSS::Criteriable::Criteria] the criteria for the instance into which we're mixed.
+    # @return [Jamf::Criteriable::Criteria] the criteria for the instance into which we're mixed.
     attr_reader :criteria
 
     #  Mixed-in Instance Methods
@@ -145,30 +145,30 @@ module JSS
 
     #
     # During initialization, convert the @init_data[:criteria] Hash into
-    # a JSS::Criteriable::Criteria instance stored in @criteria
+    # a Jamf::Criteriable::Criteria instance stored in @criteria
     #
     # Classes mixing in this module must call this in #initialize
     #
     # @return [void]
     #
     def parse_criteria
-      @criteria = JSS::Criteriable::Criteria.new
-      @criteria.criteria = @init_data[:criteria].map { |c| JSS::Criteriable::Criterion.new c } if @init_data[:criteria]
+      @criteria = Jamf::Criteriable::Criteria.new
+      @criteria.criteria = @init_data[:criteria].map { |c| Jamf::Criteriable::Criterion.new c } if @init_data[:criteria]
 
       @criteria.container = self
     end
 
     #
-    # Change the criteria, it must be a JSS::Criteriable::Criteria instance
+    # Change the criteria, it must be a Jamf::Criteriable::Criteria instance
     #
-    # @param new_criteria[JSS::Criteriable::Criteria, nil] the new criteria. An
+    # @param new_criteria[Jamf::Criteriable::Criteria, nil] the new criteria. An
     #   empty criteria object is used if nil is passed.
     #
     # @return [void]
     #
     def criteria=(new_criteria)
-      new_criteria ||= JSS::Criteriable::Criteria.new
-      raise JSS::InvalidDataError, 'JSS::Criteriable::Criteria instance required' unless new_criteria.is_a?(JSS::Criteriable::Criteria)
+      new_criteria ||= Jamf::Criteriable::Criteria.new
+      raise Jamf::InvalidDataError, 'Jamf::Criteriable::Criteria instance required' unless new_criteria.is_a?(Jamf::Criteriable::Criteria)
 
       @criteria = new_criteria
       @criteria.container = self unless new_criteria.nil?
@@ -189,7 +189,4 @@ module JSS
 
     end # module Criteriable
 
-end # module JSS
-
-require 'jss/api_object/criteriable/criterion'
-require 'jss/api_object/criteriable/criteria'
+end # module Jamf

data/lib/{jss/api_object → jamf/api/classic/api_objects}/department.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   #####################################
   ### Module Variables
@@ -42,15 +42,15 @@ module JSS
   ### A department in the JSS.
   ### These are simple, in that they only have an ID and a name
   ###
-  ### @see JSS::APIObject
+  ### @see Jamf::APIObject
   ###
-  class Department < JSS::APIObject
+  class Department < Jamf::APIObject
 
     #####################################
     ### Mix-Ins
     #####################################
-    include JSS::Creatable
-    include JSS::Updatable
+    include Jamf::Creatable
+    include Jamf::Updatable
 
     #####################################
     ### Class Methods
@@ -84,7 +84,7 @@ module JSS
     #####################################
 
     ###
-    ### See JSS::APIObject#initialize
+    ### See Jamf::APIObject#initialize
     ###
 
     #####################################

data/lib/{jss/api_object → jamf/api/classic/api_objects}/directory_binding.rb

@@ -23,7 +23,7 @@
 ###
 ###
 
-module JSS
+module Jamf
 
     # Module Variables
     #####################################
@@ -37,17 +37,17 @@ module JSS
     # A Directory Binding object in the JSS
     # These are rather complex objects, and contain settings specific to the directory object's type.
     #
-    # @see JSS::APIObject
-    # @see JSS::DirectoryBindingType
-    # @note "JSS::DirectoryBinding.fetch name: 'BindingName'" seems to be returning a 500 error in my test evironment. Use "JSS::DirectoryBinding.fetch 'BindingName' instead."
+    # @see Jamf::APIObject
+    # @see Jamf::DirectoryBindingType
+    # @note "Jamf::DirectoryBinding.fetch name: 'BindingName'" seems to be returning a 500 error in my test evironment. Use "Jamf::DirectoryBinding.fetch 'BindingName' instead."
     #
-    class DirectoryBinding < JSS::APIObject
+    class DirectoryBinding < Jamf::APIObject
 
         # Mix-Ins
         #####################################
-        include JSS::Creatable
-        include JSS::Updatable
-        include JSS::DirectoryBindingType
+        include Jamf::Creatable
+        include Jamf::Updatable
+        include Jamf::DirectoryBindingType
 
         # Class Methods
         #####################################
@@ -65,11 +65,11 @@ module JSS
         }.freeze
 
         DIRECTORY_BINDING_TYPE_CLASSES = {
-            "Open Directory" => JSS::DirectoryBindingType::OpenDirectory,
-            "Active Directory" => JSS::DirectoryBindingType::ActiveDirectory,
-            "PowerBroker Identity Services" => JSS::DirectoryBindingType::PowerBroker,
-            "ADmitMac" => JSS::DirectoryBindingType::ADmitMac,
-            "Centrify" => JSS::DirectoryBindingType::Centrify
+            "Open Directory" => Jamf::DirectoryBindingType::OpenDirectory,
+            "Active Directory" => Jamf::DirectoryBindingType::ActiveDirectory,
+            "PowerBroker Identity Services" => Jamf::DirectoryBindingType::PowerBroker,
+            "ADmitMac" => Jamf::DirectoryBindingType::ADmitMac,
+            "Centrify" => Jamf::DirectoryBindingType::Centrify
         }
 
         # The base for REST resources of this class
@@ -101,14 +101,14 @@ module JSS
         attr_reader :password
 
         # Constructor
-        # @see JSS::APIObject.initialize
+        # @see Jamf::APIObject.initialize
         # @note When creating an object with specific properties use the
         # objects name and then the settings.
         # Ex: Creating an Active Directory object:
-        # JSS::DirectoryBinding.make name: "Example Binding", username: "BindingUser", password: "SuperMonkey123", computer_ou: "computers", active_directory: { multiple_domains: false }, domain: your.domain.server
+        # Jamf::DirectoryBinding.make name: "Example Binding", username: "BindingUser", password: "SuperMonkey123", computer_ou: "computers", active_directory: { multiple_domains: false }, domain: your.domain.server
         #####################################
-        def initialize(args = {})
-            super args
+        def initialize(**args)
+            super
 
             if self.in_jss?
                 @priority = @init_data[:priority]
@@ -122,13 +122,13 @@ module JSS
                 self.set_type_settings (DIRECTORY_BINDING_TYPE_CLASSES[@type.to_s].new @init_data[class_key])
             else
                 # Build
-                raise JSS::MissingDataError, "domain must be provided." if @init_data[:domain].nil?
-                raise JSS::MissingDataError, "username must be provided." if @init_data[:username].nil?
-                raise JSS::MissingDataError, "computer_ou must be provided." if @init_data[:computer_ou].nil?
-                raise JSS::MissingDataError, "password must be provided when creating a DirectoryBinding object." if @init_data[:password].nil?
-                raise JSS::MissingDataError, "Type must be provided, one of \":#{DIRECTORY_BINDING_TYPE.keys.join(",:")}\"." if @init_data[:type].nil?
-                raise JSS::InvalidDataError, "Type must be one of \":#{DIRECTORY_BINDING_TYPE.keys.join(",:")}\"." unless DIRECTORY_BINDING_TYPE.keys.include? @init_data[:type]
-                raise JSS::InvalidDataError, "Priority must be between 1 and 10" if !@init_data[:priority].nil? && (@init_data[:priority] <= 1 || @init_data[:priority] >= 10)
+                raise Jamf::MissingDataError, "domain must be provided." if @init_data[:domain].nil?
+                raise Jamf::MissingDataError, "username must be provided." if @init_data[:username].nil?
+                raise Jamf::MissingDataError, "computer_ou must be provided." if @init_data[:computer_ou].nil?
+                raise Jamf::MissingDataError, "password must be provided when creating a DirectoryBinding object." if @init_data[:password].nil?
+                raise Jamf::MissingDataError, "Type must be provided, one of \":#{DIRECTORY_BINDING_TYPE.keys.join(",:")}\"." if @init_data[:type].nil?
+                raise Jamf::InvalidDataError, "Type must be one of \":#{DIRECTORY_BINDING_TYPE.keys.join(",:")}\"." unless DIRECTORY_BINDING_TYPE.keys.include? @init_data[:type]
+                raise Jamf::InvalidDataError, "Priority must be between 1 and 10" if !@init_data[:priority].nil? && (@init_data[:priority] <= 1 || @init_data[:priority] >= 10)
 
                 @domain = @init_data[:domain]
                 @username = @init_data[:username]
@@ -156,11 +156,11 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def domain=(newvalue)
-            raise JSS::InvalidDataError, "Domain must be a String" unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "Domain must be a String" unless newvalue.is_a? String
 
             @domain = newvalue.to_s
             @need_to_update = true
@@ -173,11 +173,11 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def username=(newvalue)
-            raise JSS::InvalidDataError, "Username must be a String" unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "Username must be a String" unless newvalue.is_a? String
 
             @username = newvalue
             @need_to_update = true
@@ -190,31 +190,31 @@ module JSS
         #
         # @param newvalue [Integer]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not an Integer
-        # @raise [JSS::InvalidDataError] If newvalue is not between 1 and 10
+        # @raise [Jamf::InvalidDataError] If newvalue is not an Integer
+        # @raise [Jamf::InvalidDataError] If newvalue is not between 1 and 10
         #
         # @return [void]
         def priority=(newvalue)
-            raise JSS::InvalidDataError, "Priority must be a Integer" unless newvalue.is_a? Integer
-            raise JSS::InvalidDataError, "Priority cannot exceed 10" unless newvalue <= 10
-            raise JSS::InvalidDataError, "Priority must be greater than 0" unless newvalue > 0
+            raise Jamf::InvalidDataError, "Priority must be a Integer" unless newvalue.is_a? Integer
+            raise Jamf::InvalidDataError, "Priority cannot exceed 10" unless newvalue <= 10
+            raise Jamf::InvalidDataError, "Priority must be greater than 0" unless newvalue > 0
 
             @priority = newvalue
             @need_to_update = true
         end
 
-        
+
         # The OU path the computer object is to be placed
         #
         # @author Tyler Morgan
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def computer_ou=(newvalue)
-            raise JSS::InvalidDataError, "Computer OU must be a String" unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "Computer OU must be a String" unless newvalue.is_a? String
 
             @computer_ou = newvalue
             @need_to_update = true
@@ -228,11 +228,11 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def password=(newvalue)
-            raise JSS::InvalidDataError, "Password must be a string" unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "Password must be a string" unless newvalue.is_a? String
 
             @password = newvalue
             @need_to_update = true
@@ -250,7 +250,7 @@ module JSS
         #
         # @return [String]
         def rest_xml
-            doc = REXML::Document.new APIConnection::XML_HEADER
+            doc = REXML::Document.new Jamf::Connection::XML_HEADER
             ns = doc.add_element RSRC_OBJECT_KEY.to_s
             ns.add_element('id').text = @id.to_s
             ns.add_element('name').text = @name
@@ -270,4 +270,4 @@ module JSS
     end
 
 
-end
+end