ruby-jss 1.2.4a3 → 1.3.2

data/lib/jss/api_object/configuration_profile/osx_configuration_profile.rb

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

data/lib/jss/api_object/creatable.rb

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

data/lib/jss/api_object/criteriable.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -152,21 +152,26 @@ module JSS
     # @return [void]
     #
     def parse_criteria
-      @criteria = (JSS::Criteriable::Criteria.new @init_data[:criteria].map { |c| JSS::Criteriable::Criterion.new c } if @init_data[:criteria])
-      @criteria.container = self if @criteria
+      @criteria = JSS::Criteriable::Criteria.new
+      @criteria.criteria = @init_data[:criteria].map { |c| JSS::Criteriable::Criterion.new c } if @init_data[:criteria]
+
+      @criteria.container = self
     end
 
     #
     # Change the criteria, it must be a JSS::Criteriable::Criteria instance
     #
-    # @param new_criteria[JSS::Criteriable::Criteria] the new criteria
+    # @param new_criteria[JSS::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)
+
       @criteria = new_criteria
-      @criteria.container = self
+      @criteria.container = self unless new_criteria.nil?
       @need_to_update = true
     end
 

data/lib/jss/api_object/criteriable/criteria.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -72,21 +72,18 @@ module JSS
       attr_reader :criteria
 
       ### @return [JSS::APIObject subclass] a reference to the object containing these Criteria
-      attr_reader :container
+      attr_writer :container
 
       ###
       ### @param new_criteria[Array<JSS::Criteriable::Criterion>]
       ###
-      def initialize(new_criteria)
+      def initialize(new_criteria = [])
         @criteria = []
+
+        # validates the param and fills @criteria
         self.criteria = new_criteria
       end # init
 
-      ### set the object we belong to, so we can set its @should_update value
-      def container= (a_thing)
-        @container = a_thing
-      end
-
       ###
       ### Provide a whole new array of JSS::Criteriable::Criterion instances for this Criteria
       ###
@@ -94,7 +91,7 @@ module JSS
       ###
       ### @return [void]
       ###
-      def criteria= (new_criteria)
+      def criteria=(new_criteria)
         unless new_criteria.is_a?(Array) && new_criteria.reject { |c| c.is_a?(JSS::Criteriable::Criterion) }.empty?
           raise JSS::InvalidDataError, 'Argument must be an Array of JSS::Criteriable::Criterion instances.'
         end
@@ -104,6 +101,14 @@ module JSS
         @container.should_update if @container
       end
 
+      # Remove all criterion objects
+      #
+      # @return [void]
+      def clear
+        @criteria = []
+        @container.should_update if @container
+      end
+
       ###
       ### Add a new criterion to the end of the criteria
       ###
@@ -192,6 +197,18 @@ module JSS
         @criteria.each_index { |ci| @criteria[ci].priority = ci }
       end
 
+      # Remove the various cached data
+      # from the instance_variables used to create
+      # pretty-print (pp) output.
+      #
+      # @return [Array] the desired instance_variables
+      #
+      def pretty_print_instance_variables
+        vars = instance_variables.sort
+        vars.delete :@container
+        vars
+      end
+
       ###
       ### @return [REXML::Element] the xml element for the criteria
       ###
@@ -200,7 +217,6 @@ module JSS
       ### @api private
       ###
       def rest_xml
-        raise JSS::MissingDataError, "Criteria can't be empty" if @criteria.empty?
         cr = REXML::Element.new 'criteria'
         @criteria.each { |c| cr << c.rest_xml }
         cr

data/lib/jss/api_object/criteriable/criterion.rb

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

data/lib/jss/api_object/department.rb

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

data/lib/jss/api_object/directory_binding.rb

@@ -0,0 +1,273 @@
+### Copyright 2019 Rixar
+
+###
+###    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 JSS
+
+    # Module Variables
+    #####################################
+
+    # Module Methods
+    #####################################
+
+    # Classes
+    #####################################
+
+    # 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."
+    #
+    class DirectoryBinding < JSS::APIObject
+
+        # Mix-Ins
+        #####################################
+        include JSS::Creatable
+        include JSS::Updatable
+        include JSS::DirectoryBindingType
+
+        # Class Methods
+        #####################################
+
+        # Class Constants
+        #####################################
+
+        #! You CAN update this
+        DIRECTORY_BINDING_TYPE = {
+            open_directory: "Open Directory",
+            active_directory: "Active Directory",
+            powerbroker_identity_services: "PowerBroker Identity Services",
+            admitmac: "ADmitMac",
+            centrify: "Centrify"
+        }.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
+        }
+
+        # The base for REST resources of this class
+        RSRC_BASE = 'directorybindings'.freeze
+
+        # the hash key used for the JSON list output of all objects in the JSS
+        RSRC_LIST_KEY = :directory_bindings
+
+        # The hash key used for the JSON object output.
+        # It's also used in various error messages
+        RSRC_OBJECT_KEY = :directory_binding
+
+        # the object type for this object in
+        # the object history table.
+        # See {APIObject#add_object_history_entry}
+        # OBJECT_HISTORY_OBJECT_TYPE = 41
+
+        # Attributes
+        #####################################
+        attr_reader :id
+        attr_reader :name
+        attr_reader :priority
+        attr_reader :domain
+        attr_reader :username
+        attr_reader :password_sha256
+        attr_reader :computer_ou
+        attr_reader :type
+        attr_reader :type_settings
+        attr_reader :password
+
+        # Constructor
+        # @see JSS::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
+        #####################################
+        def initialize(args = {})
+            super args
+
+            if self.in_jss?
+                @priority = @init_data[:priority]
+                @domain = @init_data[:domain]
+                @username = @init_data[:username]
+                @password_sha256 = @init_data[:password_sha256]
+                @computer_ou = @init_data[:computer_ou]
+                @type = @init_data[:type]
+
+                class_key = DIRECTORY_BINDING_TYPE.select { |k,v| v == @type }.map { |k,v| k }.first
+                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)
+
+                @domain = @init_data[:domain]
+                @username = @init_data[:username]
+                @computer_ou = @init_data[:computer_ou]
+                @type = DIRECTORY_BINDING_TYPE[@init_data[:type]]
+                @password = @init_data[:password]
+                @priority = @init_data[:priority]
+
+                @priority = 1 if @priority.nil?
+
+
+                class_key = DIRECTORY_BINDING_TYPE.select { |k,v| v == @type }.map { |k,v| k }.first
+                self.set_type_settings (DIRECTORY_BINDING_TYPE_CLASSES[@type.to_s].new @init_data[class_key])
+
+            end
+
+        end
+
+        # Public Instance Methods
+        #####################################
+
+        # The domain the device will be bound to.
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue [String]
+        #
+        # @raise [JSS::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
+
+            @domain = newvalue.to_s
+            @need_to_update = true
+        end
+
+
+        # The username used to attempt to bind the device to the domain.
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue [String]
+        #
+        # @raise [JSS::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
+
+            @username = newvalue
+            @need_to_update = true
+        end
+
+
+        # The priority the domain has over another one.
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue [Integer]
+        #
+        # @raise [JSS::InvalidDataError] If newvalue is not an Integer
+        # @raise [JSS::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
+
+            @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
+        #
+        # @return [void]
+        def computer_ou=(newvalue)
+            raise JSS::InvalidDataError, "Computer OU must be a String" unless newvalue.is_a? String
+
+            @computer_ou = newvalue
+            @need_to_update = true
+        end
+
+
+        # Sets the password used in conjunction with the username to attempt to bind
+        # the computer to the domain.
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue [String]
+        #
+        # @raise [JSS::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
+
+            @password = newvalue
+            @need_to_update = true
+        end
+
+        # private instance methods
+        ######################
+        private
+
+        # the xml formated data for adding or updating this in the JSS
+        #
+        # This method constructs a properly formatted XML document to be handled by the Jamf Pro API
+        #
+        # @author Tyler Morgan
+        #
+        # @return [String]
+        def rest_xml
+            doc = REXML::Document.new APIConnection::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
+            ns.add_element('priority').text = @priority.to_s
+            ns.add_element('domain').text = @domain.to_s
+            ns.add_element('username').text = @username.to_s
+            ns.add_element('computer_ou').text = @computer_ou.to_s
+            ns.add_element('type').text = @type.to_s
+            if !@password.nil?
+                ns.add_element('password').text = @password.to_s
+            end
+
+            ns << @type_settings.type_setting_xml
+
+            return doc.to_s
+        end # rest_xml
+    end
+
+
+end

data/lib/jss/api_object/directory_binding_type.rb

@@ -0,0 +1,90 @@
+### Copyright 2019 Rixar
+
+###
+###    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 JSS
+
+# Module for containing the different types of DirectoryBindings stored within the JSS
+module DirectoryBindingType
+
+        # Module Variables
+        #####################################
+
+        # Module Methods
+        #####################################
+        def should_update
+            @need_to_update = true
+        end
+
+        def set_type_settings(settings)
+            @type_settings = settings
+            @type_settings.container = self
+        end
+
+        # Classes
+        #####################################
+
+        # A generic binding type class that sets common variables, methods, and constructors 
+        # for all the different directory binding types.
+        #
+        # @author Tyler Morgan        
+        class DirectoryBindingType
+            # Mix-Ins
+            #####################################
+
+            # Class Methods
+            #####################################
+
+            # Class Constants
+            #####################################
+
+            # The different network protocols supported.
+            NETWORK_PROTOCOL = {
+                afp: "AFP",
+                smb: "SMB"
+            }.freeze
+
+
+            # The different home folder types.
+            HOME_FOLDER_TYPE = {
+                network: "Network",
+                local: "Local",
+                either: "Either",
+                mobile: "Mobile"
+            }.freeze
+
+            # Attributes
+            #####################################
+
+            # This is used to properly handle updating the containing object.
+            attr_accessor :container
+        end
+    end
+end
+
+require "jss/api_object/directory_binding_type/active_directory"
+require "jss/api_object/directory_binding_type/open_directory"
+require "jss/api_object/directory_binding_type/admitmac"
+require "jss/api_object/directory_binding_type/centrify"
+require "jss/api_object/directory_binding_type/powerbroker_identity_services"