ruby-jss 1.6.4 → 2.0.0b1

data/lib/{jss/api_object → jamf/api/classic/base_classes}/group.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
 
   # Classes
   #####################################
@@ -32,31 +32,31 @@ module JSS
   # namely, {ComputerGroup}, {MobileDeviceGroup}, and {UserGroup}
   #
   # It provides methods for working with the membership of static groups and, by
-  # including {JSS::Criteriable}, the criteria for smart groups.
+  # including {Jamf::Criteriable}, the criteria for smart groups.
   #
   # When changing the criteria of a smart group, use the #criteria attribute,
-  # which is a {JSS::Criteria} instance.
+  # which is a {Jamf::Criteria} instance.
   #
   # Subclasses must define these constants:
   # - MEMBER_CLASS: the ruby-jss class to which the group
-  #   members belong (e.g. JSS::MobileDevice)
+  #   members belong (e.g. Jamf::MobileDevice)
   # - ADD_MEMBERS_ELEMENT: the XML element tag for adding members to the group
   #   wuth a PUT call to the API, e.g. 'computer_additions'
   # - REMOVE_MEMBERS_ELEMENT: the XML element tag for removing members from the
   #   group wuth a PUT call to the API, e.g. 'computer_deletions'
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  # @see JSS::Criteriable
+  # @see Jamf::Criteriable
   #
-  class Group < JSS::APIObject
+  class Group < Jamf::APIObject
 
     # Mix-Ins
     #####################################
-    include JSS::Creatable
-    include JSS::Updatable
-    include JSS::Criteriable
-    include JSS::Sitable
+    include Jamf::Creatable
+    include Jamf::Updatable
+    include Jamf::Criteriable
+    include Jamf::Sitable
 
     # Class Constants
     #####################################
@@ -76,15 +76,19 @@ module JSS
     # Returns an Array of all the smart
     # groups.
     #
-    def self.all_smart(refresh = false, api: JSS.api)
-      all(refresh, api: api).select { |g| g[:is_smart] }
+    def self.all_smart(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).select { |g| g[:is_smart] }
     end
 
     # Returns an Array of all the static
     # groups.
     #
-    def self.all_static(refresh = false, api: JSS.api)
-      all(refresh, api: api).reject { |g| g[:is_smart] }
+    def self.all_static(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).reject { |g| g[:is_smart] }
     end
 
     # Immediatly add and/or remove members in a static group without
@@ -99,14 +103,16 @@ module JSS
     # @param remove_members [String, Integer, Array<String, Integer>] valid
     #   identifier(s) for members to remove
     #
-    # @param api [JSS::APIConnection] The API connetion to use, uses the default
+    # @param cnx [Jamf::Connection] The API connetion to use, uses the default
     #   connection if not specified
     #
     # @return [void]
     #
-    def self.change_membership(group, add_members: [], remove_members: [], api: JSS.api)
-      raise JSS::NoSuchItemError, "No #{self} matching '#{group}'" unless (group_id = valid_id group, api: api)
-      raise JSS::UnsupportedError, "Not a static group, can't change membership directly" if map_all_ids_to(:is_smart, api: api)[group_id]
+    def self.change_membership(group, add_members: [], remove_members: [], api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      raise Jamf::NoSuchItemError, "No #{self} matching '#{group}'" unless (group_id = valid_id group, cnx: cnx)
+      raise Jamf::UnsupportedError, "Not a static group, can't change membership" if map_all(:id, to: :is_smart, cnx: cnx)[group_id]
 
       add_members = [add_members].flatten
       remove_members = [remove_members].flatten
@@ -117,13 +123,15 @@ module JSS
       # that isn't in the group (which is kinda lame - it should just
       # ignore this, like it does when we add a member that's already
       # in the group.)
-      current_member_ids = fetch(id: group_id).member_ids
+      # Its even more lame because we have to instantiate the group
+      # and part of the point of this class method is to avoid that.
+      current_member_ids = fetch(id: group_id, cnx: cnx).member_ids
 
       # nil if no changes to be made
       xml_doc = change_membership_xml add_members, remove_members, current_member_ids
       return unless xml_doc
 
-      api.put_rsrc "#{self::RSRC_BASE}/id/#{group_id}", xml_doc.to_s
+      cnx.c_put "#{self::RSRC_BASE}/id/#{group_id}", xml_doc.to_s
     end
 
     # return [REXML::Document, nil]
@@ -134,7 +142,7 @@ module JSS
       remx = member_removals_xml(remove_members, current_member_ids)
       return nil unless addx || remx
 
-      doc = REXML::Document.new JSS::APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       groupelem = doc.add_element self::RSRC_OBJECT_KEY.to_s
       groupelem << addx if addx
       groupelem << remx if remx
@@ -151,7 +159,7 @@ module JSS
       member_added = false
       add_members.each do |am|
         am_id = self::MEMBER_CLASS.valid_id am
-        raise JSS::NoSuchItemError, "No #{self::MEMBER_CLASS} matching '#{am}'" unless am_id
+        raise Jamf::NoSuchItemError, "No #{self::MEMBER_CLASS} matching '#{am}'" unless am_id
         next if current_member_ids.include? am_id
 
         xam = additions.add_element self::MEMBER_CLASS::RSRC_OBJECT_KEY.to_s
@@ -183,7 +191,6 @@ module JSS
     end
     private_class_method :member_removals_xml
 
-
     # Attributes
     #####################################
 
@@ -201,10 +208,12 @@ module JSS
 
     # @return [Boolean] is this a smart group
     attr_reader :is_smart
+    alias smart? is_smart
 
     # @return [Boolean] does this group send notifications when it changes?
     attr_reader :notify_on_change
-
+    alias notify_on_change? notify_on_change
+    alias notify? notify_on_change
 
     # Constructor
     #####################################
@@ -212,23 +221,17 @@ module JSS
     # When creating a new group in the JSS, you must call .make with a :type key
     # and a value of :smart or :static, as well as a :name
     #
-    # @see JSS::APIObject
+    # @see Jamf::APIObject
     #
-    def initialize(args = {})
-      if args[:id] == :new
-        raise JSS::InvalidDataError, 'New group creation must specify a :type of :smart or :static' unless GROUP_TYPES.include? args[:type]
-      end
+    def initialize(**args)
+      raise Jamf::InvalidDataError, 'New group creation must specify a :type of :smart or :static' if args[:id] == :new && !(GROUP_TYPES.include? args[:type])
 
-      super args
+      super
 
       @is_smart = @init_data[:is_smart] || (args[:type] == :smart)
 
       @members =
-        if @init_data[self.class::MEMBER_CLASS::RSRC_LIST_KEY]
-          @init_data[self.class::MEMBER_CLASS::RSRC_LIST_KEY]
-        else
-          []
-        end
+        @init_data[self.class::MEMBER_CLASS::RSRC_LIST_KEY] || []
     end # init
 
     # Public Instance Methods
@@ -245,9 +248,8 @@ module JSS
     #   happens, try again this many times with a 1 second pause between attempts.
     #
     def create(calculate_members: true, retries: 10)
-      if @is_smart
-        raise JSS::MissingDataError, 'No criteria specified for smart group' unless @criteria
-      end
+      raise Jamf::MissingDataError, 'No criteria specified for smart group' if @is_smart && !@criteria
+
       super()
 
       if calculate_members
@@ -281,12 +283,12 @@ module JSS
       params[:refresh] = true if params[:refresh].nil?
 
       if @in_jss
-        raise JSS::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
-
+        raise Jamf::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
 
         update refresh: params[:refresh]
       else
-        raise JSS::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
+        raise Jamf::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
+
         create calculate_members: params[:calculate_members], retries: params[:retries]
       end
     end
@@ -303,7 +305,7 @@ module JSS
 
     # Apply a new set of criteria to a smart group
     #
-    # @param new_criteria[JSS::Criteria] the new criteria for the smart group
+    # @param new_criteria[Jamf::Criteria] the new criteria for the smart group
     #
     def criteria=(new_criteria)
       raise InvalidDataError, 'Only smart groups have criteria.' unless @is_smart
@@ -315,8 +317,10 @@ module JSS
     #
     # @param args[Hash] the options and settings use for switching the computer group from static group to smart group
     #
-    # @option args criteria[Array] The criterias to be user for the smart group
-    def set_smart(*params)
+    # @option args criteria[Array] The criteria to be user for the smart group
+    #
+    # @return [void]
+    def make_smart(**params)
       return if @is_smart
 
       params[:criteria] = [] if params[:criteria].nil?
@@ -326,22 +330,28 @@ module JSS
       @is_smart = true
       @need_to_update = true
     end
+    # backward compatility
+    alias set_smart make_smart
 
     # Change smart group to static group
     #
     # @param args[Hash] the options and settings use for switching the computer group from smart group to static group
     #
     # @option args preserve_members[Boolean] Should the smart group preserve it's current members?
-    def set_static(*params)
+    #
+    # @return [void]
+    def make_static(**params)
       return unless @is_smart
 
       preserve_members = params.include? :preserve_members
 
       @is_smart = false
 
-      clear() unless preserve_members
+      clear unless preserve_members
     end
-
+    # backward compatility
+    alias set_static make_static
+        
     # How many members of the group?
     #
     # @return [Integer] the number of members of the group
@@ -349,6 +359,13 @@ module JSS
     def size
       @members.count
     end
+    alias count size
+
+    # @return [Boolean] Is this a static group?
+    def static?
+      !smart?
+    end
+    alias is_static static?
 
     # @return [Array<String>] the names of the group members
     #
@@ -375,6 +392,7 @@ module JSS
     def members=(new_members)
       raise UnsupportedError, "Smart group members can't be changed." if @is_smart
       raise InvalidDataError, 'Arg must be an array of names and/or ids' unless new_members.is_a? Array
+
       ok_members = []
       new_members.each do |m|
         ok_members << check_member(m)
@@ -384,6 +402,7 @@ module JSS
 
       # make sure we've actually changed...
       return if members.map { |m| m[:id] }.sort == ok_members.map { |m| m[:id] }.sort
+
       @members = ok_members
       @need_to_update = true
     end
@@ -395,22 +414,32 @@ module JSS
     # @return [void]
     #
     def add_member(mem)
-      raise UnsupportedError, "Smart group members can't be changed." if @is_smart
+      raise UnsupportedError, "Smart group members can't be changed." if smart?
+
       @members << check_member(mem)
       @need_to_update = true
     end
 
     # Remove a member by id, or name
     #
-    # @param m[Integer,String] the id or name of the member to remove
+    # @param m[Integer,String] an identifier for the item to remove
     #
     # @return [void]
     #
     def remove_member(mem)
-      raise InvalidDataError, "Smart group members can't be changed." if @is_smart
-      raise InvalidDataError, "Can't remove nil" if mem.nil?
-      removed = @members.reject! { |mm| [mm[:id], mm[:name], mm[:username]].include? mem }
-      @need_to_update = true if removed
+      raise UnsupportedError, "Smart group members can't be changed." if smart?
+
+      # See if we have the identifier in the @members hash
+      id_to_remove = @members.select { |mm| mm.values.include? mem }.first&.dig :id
+      # But the members hash might not have SN, macaddr, etc, and never has udid, so
+      # look at the MEMBER_CLASS if needed
+      id_to_remove ||= self.class::MEMBER_CLASS.valid_id mem
+
+      # nothing to do if that id isn't one of our members
+      return unless id_to_remove && member_ids.include?(id_to_remove)
+
+      @members.delete_if { |k, v| k == :id && v == id_to_remove }
+      @need_to_update = true 
     end
 
     # Remove all members
@@ -420,6 +449,7 @@ module JSS
     def clear
       raise InvalidDataError, "Smart group members can't be changed." if @is_smart
       return if @members.empty?
+
       @members.clear
       @need_to_update = true
     end
@@ -435,13 +465,13 @@ module JSS
     # @param remove_members [String, Integer, Array<String, Integer>] valid
     #   identifier(s) for members to remove
     #
-    # @param api [JSS::APIConnection] The API connetion to use, uses the default
+    # @param cnx [Jamf::Connection] The API connetion to use, uses the default
     #   connection if not specified
     #
     # @return [void]
     #
     def change_membership(add_members: [], remove_members: [])
-      self.class.change_membership(@id, add_members: add_members, remove_members: remove_members, api: @api)
+      self.class.change_membership(@id, add_members: add_members, remove_members: remove_members, cnx: @cnx)
       refresh_members
     end
 
@@ -450,15 +480,9 @@ module JSS
     # @return [Array<Hash>] the refresh membership
     #
     def refresh_members
-      @members = @api.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY][self.class::MEMBER_CLASS::RSRC_LIST_KEY]
+      @members = @cnx.c_get(@rest_rsrc)[self.class::RSRC_OBJECT_KEY][self.class::MEMBER_CLASS::RSRC_LIST_KEY]
     end
-
-    # aliases
-
-    alias smart? is_smart
-    alias notify_on_change? notify_on_change
-    alias notify? notify_on_change
-    alias count size
+  
 
     # Public Instance Methods
     #####################################
@@ -471,19 +495,18 @@ module JSS
     # @return [Hash{:id=>Integer,:name=>String}] the valid id and name
     #
     def check_member(m)
-      potential_members = self.class::MEMBER_CLASS.map_all_ids_to(:name, api: @api)
-      if m.to_s =~ /^\d+$/
-        return { id: m.to_i, name: potential_members[m] } if potential_members.key?(m.to_i)
-      else
-        return { name: m, id: potential_members.invert[m] } if potential_members.value?(m)
-      end
-      raise JSS::NoSuchItemError, "No #{self.class::MEMBER_CLASS::RSRC_OBJECT_KEY} matching '#{m}' in the JSS."
+      desired_id = self.class::MEMBER_CLASS.valid_id m, cnx: @cnx
+      raise Jamf::NoSuchItemError, "No #{self.class::MEMBER_CLASS::RSRC_OBJECT_KEY} matching '#{m}' in the JSS." unless desired_id
+
+      desired_name = self.class::MEMBER_CLASS.map_all(:id, to: :name, cnx: @cnx)[desired_id]
+
+      { name: desired_name, id: desired_id }      
     end
 
     # the xml formated data for adding or updating this in the JSS,
     #
     def rest_xml
-      doc = REXML::Document.new JSS::APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       group = doc.add_element self.class::RSRC_OBJECT_KEY.to_s
       group.add_element('name').text = @name
       group.add_element('is_smart').text = @is_smart
@@ -500,8 +523,4 @@ module JSS
 
   end # class ComputerGroup
 
-end # module JSS
-
-require 'jss/api_object/group/computer_group'
-require 'jss/api_object/group/mobile_device_group'
-require 'jss/api_object/group/user_group'
+end # module Jamf