ruby-jss 0.9.2 → 0.10.0a1

data/lib/jss/api_object/locatable.rb

@@ -160,7 +160,7 @@ module JSS
     def building= (new_val)
       return nil if @building == new_val
       new_val = new_val.to_s.strip
-      raise JSS::NoSuchItemError, "No building named #{new_val} exists in the JSS" unless new_val.empty? or JSS::Building.all_names.include? new_val
+      raise JSS::NoSuchItemError, "No building named #{new_val} exists in the JSS" unless new_val.empty? or JSS::Building.all_names(api: @api).include? new_val
       @building = new_val
       @need_to_update = true
     end
@@ -169,7 +169,7 @@ module JSS
     def department= (new_val)
       return nil if @department == new_val
       new_val = new_val.to_s.strip
-      raise JSS::NoSuchItemError, "No department named #{new_val} exists in the JSS" unless new_val.empty? or JSS::Department.all_names.include? new_val
+      raise JSS::NoSuchItemError, "No department named #{new_val} exists in the JSS" unless new_val.empty? or JSS::Department.all_names(api: @api).include? new_val
       @department = new_val
       @need_to_update = true
     end

data/lib/jss/api_object/matchable.rb

@@ -1,26 +1,26 @@
 ### Copyright 2017 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.
-### 
+###
 ###
 
 ###
@@ -77,7 +77,6 @@ module JSS
     ###  Extended Class Methods
     #####################################
 
-    ###
     ### Perform a match, returning an Array of Hashes, one for each item matched
     ###
     ### At the moment, it appears the search is an "exact match" search
@@ -87,10 +86,10 @@ module JSS
     ###
     ### @return [Array<Hash>] the item smatched.
     ###
-    def match(term)
+    def match(term, api: JSS.api )
       raise JSS::InvalidDataError, "Match term may not be empty" if term.to_s.empty?
       rsrc = "#{self::RSRC_BASE}/#{JSS::Matchable::MATCH_RSRC}/#{term}"
-      JSS.api_connection.get_rsrc(rsrc)[self::RSRC_LIST_KEY]
+      api.get_rsrc(rsrc)[self::RSRC_LIST_KEY]
     end
 
   end # module Matchable

data/lib/jss/api_object/mobile_device.rb

@@ -192,53 +192,53 @@ module JSS
     #####################################
 
     # @return [Array<String>] all mobiledevice serial_numbers
-    def self.all_serial_numbers(refresh = false)
-      all(refresh).map { |i| i[:serial_number] }
+    def self.all_serial_numbers(refresh = false, api: JSS.api)
+      all(refresh, api: API).map { |i| i[:serial_number] }
     end
 
     # @return [Array<String>] all mobiledevice phone numbers
-    def self.all_phone_numbers(refresh = false)
-      all(refresh).map { |i| i[:phone_number] }.reject(&:empty?)
+    def self.all_phone_numbers(refresh = false, api: JSS.api)
+      all(refresh, api: API).map { |i| i[:phone_number] }.reject(&:empty?)
     end
 
     # @return [Array<String>] all mobiledevice wifi mac addrs
-    def self.all_wifi_mac_addresses(refresh = false)
-      all(refresh).map { |i| i[:wifi_mac_address] }
+    def self.all_wifi_mac_addresses(refresh = false, api: JSS.api)
+      all(refresh, api: API).map { |i| i[:wifi_mac_address] }
     end
 
     # @return [Array<String>] all mobiledevice wifi mac addrs
-    def self.all_mac_addresses(refresh = false)
-      all_wifi_mac_addresses(refresh)
+    def self.all_mac_addresses(refresh = false, api: JSS.api)
+      all_wifi_mac_addresses(refresh, api: API)
     end
 
     # @return [Array<String>] all mobiledevice udids
-    def self.all_udids(refresh = false)
-      all(refresh).map { |i| i[:udid] }
+    def self.all_udids(refresh = false, api: JSS.api)
+      all(refresh, api: API).map { |i| i[:udid] }
     end
 
     # @return [Array<Hash>] the list of all managed mobile devices
-    def self.all_managed(refresh = false)
-      all(refresh).select { |d| d[:managed] }
+    def self.all_managed(refresh = false, api: JSS.api)
+      all(refresh, api: API).select { |d| d[:managed] }
     end
 
     # @return [Array<Hash>] the list of all unmanaged mobile devices
-    def self.all_unmanaged(refresh = false)
-      all(refresh).reject { |d| d[:managed] }
+    def self.all_unmanaged(refresh = false, api: JSS.api)
+      all(refresh, api: API).reject { |d| d[:managed] }
     end
 
     # @return [Array<Hash>] the list of all iPhones
-    def self.all_iphones(refresh = false)
-      all(refresh).select { |d| d[:model].start_with? 'iPhone' }
+    def self.all_iphones(refresh = false, api: JSS.api)
+      all(refresh, api: API).select { |d| d[:model].start_with? 'iPhone' }
     end
 
     # @return [Array<Hash>] the list of all iPads
-    def self.all_ipads(refresh = false)
-      all(refresh).select { |d| d[:model].start_with? 'iPad' }
+    def self.all_ipads(refresh = false, api: JSS.api)
+      all(refresh, api: API).select { |d| d[:model].start_with? 'iPad' }
     end
 
     # @return [Array<Hash>] the list of all iPads
-    def self.all_apple_tvs(refresh = false)
-      all(refresh).select { |d| d[:model_identifier].start_with? 'AppleTV' }
+    def self.all_apple_tvs(refresh = false, api: JSS.api)
+      all(refresh, api: API).select { |d| d[:model_identifier].start_with? 'AppleTV' }
     end
 
     # Send an MDM command to one or more mobile devices by id or name
@@ -253,10 +253,13 @@ module JSS
     #
     # @param data[String] Some commands require extra data.
     #
+    # @param api[JSS::APIConnection] the APi to query. Defaults to the
+    #   currently active API, see {JSS::APIConnection}
+    #
     # @return [String] The uuid of the MDM command sent, if applicable
     #  (blank pushes do not generate uuids)
     #
-    def self.send_mdm_command(targets, command, data = nil)
+    def self.send_mdm_command(targets, command, data = nil, api: JSS.api)
       raise JSS::NoSuchItemError, "Unknown command '#{command}'" unless MDM_COMMANDS.keys.include? command
 
       command = MDM_COMMANDS[command]
@@ -271,10 +274,10 @@ module JSS
 
       # make sure its an array of ids
       targets.map! do |md|
-        if all_ids.include? md.to_i
+        if all_ids(api: api).include? md.to_i
           md.to_i
-        elsif all_names.include? md
-          map_all_ids_to(:name).invert[md]
+        elsif all_names(api: api).include? md
+          map_all_ids_to(:name, api: api.invert[md])
         else
           raise JSS::NoSuchItemError, "No mobile device found matching '#{md}'"
         end # if
@@ -282,26 +285,26 @@ module JSS
 
       cmd_rsrc << "/id/#{targets.join ','}"
 
-      result = JSS::API.post_rsrc cmd_rsrc, nil
+      result = api.post_rsrc cmd_rsrc, nil
       result =~ %r{<uuid>(.*)</uuid>}
       Regexp.last_match(1)
     end
 
-    def self.management_history(identifier, subset = nil )
+    def self.management_history(identifier, subset = nil, api: JSS.api)
       id = nil
       if identifier.is_a? Integer
         id = identifier
       else
         key = case identifier
-              when *all_names then :name
-              when *all_serial_numbers then :serial_number
-              when *all_mac_addresses then :mac_address
-              when *all_udids then :udid
-              end
-        id = map_all_ids_to(key).invert[identifier]
+        when *all_names(api: api) then :name
+        when *all_serial_numbers(api: api) then :serial_number
+        when *all_mac_addresses(api: api) then :mac_address
+        when *all_udids(api: api) then :udid
+        end
+        id = map_all_ids_to(key, api: api).invert[identifier]
       end # if identifier.is_a? Integer
 
-      raise JSS::NoSuchItemError, "No MobileDevice found matching #{identifier}" unless id && all_ids.include?(id)
+      raise JSS::NoSuchItemError, "No MobileDevice found matching #{identifier}" unless id && all_ids(api: api).include?(id)
 
       rsrc = "#{HISTORY_RSRC}/id/#{id}"
 
@@ -310,7 +313,7 @@ module JSS
         rsrc << "/subset/#{subset}"
       end
 
-      hist = JSS.api.get_rsrc(rsrc)[:mobile_device_history]
+      hist = api.get_rsrc(rsrc)[:mobile_device_history]
       subset ? hist[subset] : hist
     end
 
@@ -547,7 +550,7 @@ module JSS
     # @return [String] The command uuid
     #
     def blank_push
-      self.class.send_mdm_command @id, :blank_push
+      self.class.send_mdm_command @id, :blank_push, api: @api
     end #
 
     # Send an update_inventory MDM command
@@ -557,7 +560,7 @@ module JSS
     # @return [String] The command uuid
     #
     def update_inventory
-      self.class.send_mdm_command @id, :update_inventory
+      self.class.send_mdm_command @id, :update_inventory, api: @api
     end
 
     # Send a device_lock MDM command
@@ -569,7 +572,7 @@ module JSS
     # @return [String] The command uuid
     #
     def device_lock(message)
-      self.class.send_mdm_command @id, :device_lock, message
+      self.class.send_mdm_command @id, :device_lock, message, api: @api
     end
 
     # Send an erase_device MDM command
@@ -579,7 +582,7 @@ module JSS
     # @return [String] The command uuid
     #
     def erase_device
-      self.class.send_mdm_command @id, :erase_device
+      self.class.send_mdm_command @id, :erase_device, api: @api
     end
 
     # Send a clear_passcode MDM command
@@ -589,7 +592,7 @@ module JSS
     # @return [String] The command uuid
     #
     def clear_passcode
-      self.class.send_mdm_command @id, :clear_passcode
+      self.class.send_mdm_command @id, :clear_passcode, api: @api
     end
 
     # Send a unmanage_device MDM command
@@ -599,7 +602,7 @@ module JSS
     # @return [String] The command uuid
     #
     def unmanage_device
-      @managed = false if self.class.send_mdm_command(@id, :unmanage_device)
+      @managed = false if self.class.send_mdm_command(@id, :unmanage_device, api: @api)
     end
 
     # Send a ClearRestrictionsPassword MDM command
@@ -609,7 +612,7 @@ module JSS
     # @return [String] The command uuid
     #
     def clear_restrictions_password
-      self.class.send_mdm_command @id, :clear_restrictions_password
+      self.class.send_mdm_command @id, :clear_restrictions_password, api: @api
     end
 
     # Send a SettingsEnableDataRoaming MDM command
@@ -619,7 +622,7 @@ module JSS
     # @return [String] The command uuid
     #
     def enable_data_roaming
-      self.class.send_mdm_command @id, :enable_data_roaming
+      self.class.send_mdm_command @id, :enable_data_roaming, api: @api
     end
 
     # Send a disable_data_roaming MDM command
@@ -629,7 +632,7 @@ module JSS
     # @return [String] The command uuid
     #
     def disable_data_roaming
-      self.class.send_mdm_command @id, :disable_data_roaming
+      self.class.send_mdm_command @id, :disable_data_roaming, api: @api
     end
 
     # Send a enable_voice_roaming MDM command
@@ -639,7 +642,7 @@ module JSS
     # @return [String] The command uuid
     #
     def enable_voice_roaming
-      self.class.send_mdm_command @id, :enable_voice_roaming
+      self.class.send_mdm_command @id, :enable_voice_roaming, api: @api
     end
 
     # Send a disable_voice_roaming MDM command
@@ -649,7 +652,7 @@ module JSS
     # @return [String] The command uuid
     #
     def disable_voice_roaming
-      self.class.send_mdm_command @id, :disable_voice_roaming
+      self.class.send_mdm_command @id, :disable_voice_roaming, api: @api
     end
 
     # Send a enable_app_analytics MDM command
@@ -659,7 +662,7 @@ module JSS
     # @return [String] The command uuid
     #
     def enable_app_analytics
-      self.class.send_mdm_command @id, :enable_app_analytics
+      self.class.send_mdm_command @id, :enable_app_analytics, api: @api
     end
 
     # Send a disable_app_analytics MDM command
@@ -669,7 +672,7 @@ module JSS
     # @return [String] The command uuid
     #
     def disable_app_analytics
-      self.class.send_mdm_command @id, :disable_app_analytics
+      self.class.send_mdm_command @id, :disable_app_analytics, api: @api
     end
 
     # Send a enable_diagnostic_submission MDM command
@@ -679,7 +682,7 @@ module JSS
     # @return [String] The command uuid
     #
     def enable_diagnostic_submission
-      self.class.send_mdm_command @id, :enable_diagnostic_submission
+      self.class.send_mdm_command @id, :enable_diagnostic_submission, api: @api
     end
 
     # Send a disable_diagnostic_submission MDM command
@@ -689,7 +692,7 @@ module JSS
     # @return [String] The command uuid
     #
     def disable_diagnostic_submission
-      self.class.send_mdm_command @id, :disable_diagnostic_submission
+      self.class.send_mdm_command @id, :disable_diagnostic_submission, api: @api
     end
 
     # Send a device_name MDM command
@@ -701,7 +704,7 @@ module JSS
     # @return [String] The command uuid
     #
     def device_name(new_name)
-      self.class.send_mdm_command @id, :device_name, new_name
+      self.class.send_mdm_command @id, :device_name, new_name, api: @api
     end
 
     # Send a shutdown device MDM command
@@ -711,7 +714,7 @@ module JSS
     # @return [String] The command uuid
     #
     def shutdown
-      self.class.send_mdm_command @id, :shutdown
+      self.class.send_mdm_command @id, :shutdown, api: @api
     end
 
     # Send a restart device MDM command
@@ -721,10 +724,9 @@ module JSS
     # @return [String] The command uuid
     #
     def restart
-      self.class.send_mdm_command @id, :restart
+      self.class.send_mdm_command @id, :restart, api: @api
     end
 
-
     # The full management History data for this Mobile Device
     #
     # @return [Hash] Keys are:
@@ -736,7 +738,7 @@ module JSS
     #   ebooks: see managed
     #
     def management_history
-      self.class.management_history @id
+      self.class.management_history @id, api: @api
     end
 
     # The user_location subset of the full history
@@ -747,7 +749,7 @@ module JSS
     #   objects
     #
     def user_location_history
-      self.class.management_history @id, :user_location
+      self.class.management_history @id, :user_location, api: @api
     end
 
     # The management_commands subset of the full history
@@ -758,7 +760,7 @@ module JSS
     #   #failed_mdm_commands
     #
     def management_command_history
-      self.class.management_history @id, :management_commands
+      self.class.management_history @id, :management_commands, api: @api
     end
     alias mdm_command_history management_command_history
 
@@ -802,7 +804,7 @@ module JSS
     #   #failed_managed_apps
     #
     def managed_app_history
-      self.class.management_history @id, :applications
+      self.class.management_history @id, :applications, api: @api
     end
 
     # The apps that have been installed via MDM
@@ -860,7 +862,7 @@ module JSS
     # @return [Array<Hash>] One hash per event
     #
     def audit_history
-      self.class.management_history @id, :audits
+      self.class.management_history @id, :audits, api: @api
     end
 
     # The ebooks subset of the full history
@@ -870,7 +872,7 @@ module JSS
     #   #failed_managed_ebooks
     #
     def managed_ebook_history
-      self.class.management_history @id, :ebooks
+      self.class.management_history @id, :ebooks, api: @api
     end
 
     # The ebooks that have been installed via MDM

data/lib/jss/api_object/mobile_device_application.rb

@@ -52,8 +52,8 @@ module JSS
     # Class Methods
     #####################################
 
-    def self.all_bundle_ids(refresh = false)
-      all(refresh).map { |mda| mda[:bundle_id] }
+    def self.all_bundle_ids(refresh = false, api: JSS.api)
+      all(refresh, api: api).map { |mda| mda[:bundle_id] }
     end
 
     # Class Constants
@@ -422,7 +422,7 @@ module JSS
     #
     def refresh_ipa
       return nil unless @in_jss
-      fresh_data = JSS.api_connection.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
+      fresh_data = @api.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
       @ipa = fresh_data[:general][:ipa]
     end
 

data/lib/jss/api_object/network_segment.rb

@@ -72,14 +72,14 @@ module JSS
     ###
     ### Using the #include? method on those Ranges is very useful.
     ###
+    ### @param refresh[Boolean] re-read the data from the API?
+    ###
+    ### @param api[JSS::APIConnection] The API connection to query
+    ###
     ### @return [Hash{Integer => Range}] the network segments as IPv4 address Ranges
     ###
-    def self.network_ranges(refresh = false)
-      @network_ranges = nil if refresh
-      return @network_ranges if @network_ranges
-      @network_ranges = {}
-      all(refresh).each { |ns| @network_ranges[ns[:id]] = IPAddr.new(ns[:starting_address])..IPAddr.new(ns[:ending_address]) }
-      @network_ranges
+    def self.network_ranges(refresh = false, api: JSS.api)
+      api.network_ranges refresh
     end # def network_segments
 
     ### An alias for {NetworkSegment.network_ranges}
@@ -88,8 +88,8 @@ module JSS
     ###
     ### @see {NetworkSegment::network_ranges}
     ###
-    def self.subnets(refresh = false)
-      network_ranges refresh
+    def self.subnets(refresh = false, api: JSS.api)
+      network_ranges refresh, api: api
     end
 
     ### Given a starting address & ending address, mask, or cidr,
@@ -186,29 +186,34 @@ module JSS
     ###
     ### @param ip[String, IPAddr] the IP address to locate
     ###
+    ### @param refresh[Boolean] should the data be re-queried?
+    ###
+    ### @param api[JSS::APIConnection] The API connection to query
+    ###
     ### @return [Array<Integer>] the ids of the NetworkSegments containing the given ip
     ###
-    def self.network_segments_for_ip(ip)
-      ok_ip = IPAddr.new(ip)
-      matches = []
-      network_ranges.each { |id, subnet| matches << id if subnet.include?(ok_ip) }
-      matches
+    def self.network_segments_for_ip(ip, refresh = false, api: JSS.api)
+      api.network_segments_for_ip ip, refresh
     end
 
-    def self.network_segment_for_ip(ip)
-      network_segments_for_ip(ip)
+    # @deprecated use network_segments_for_ip
+    # Backward compatibility
+    def self.network_segment_for_ip(ip, api: JSS.api)
+      network_segments_for_ip(ip, api: api)
     end
 
     ### Find the current network segment ids for the machine running this code
     ###
     ### @return [Array<Integer>]  the NetworkSegment ids for this machine right now.
     ###
-    def self.my_network_segments
-      network_segment_for_ip JSS::Client.my_ip_address
+    def self.my_network_segments(api: JSS.api)
+      network_segment_for_ip JSS::Client.my_ip_address, api: api
     end
 
-    def self.my_network_segment
-      my_network_segments
+    # @deprecated use my_network_segments
+    # Backward compatibility
+    def self.my_network_segment(api: JSS.api)
+      my_network_segments api: api
     end
 
     ### Attributes