ruby-jss 0.7.0 → 0.8.1

data/lib/jss/api_object/mobile_device_configuration_profile.rb

@@ -0,0 +1,21 @@
+# This is just a stub for now.
+
+#
+module JSS
+
+  #
+  class MobileDeviceConfigurationProfile < APIObject
+
+    ### The base for REST resources of this class
+    RSRC_BASE = 'mobiledeviceconfigurationprofiles'.freeze
+
+    ### the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :configuration_profiles
+
+    ### The hash key used for the JSON object output.
+    ### It's also used in various error messages
+    RSRC_OBJECT_KEY = :configuration_profile
+
+  end
+
+end

data/lib/jss/api_object/osx_configuration_profile.rb

@@ -141,9 +141,6 @@ module JSS
       @uuid = @main_subset[:uuid]
       @redeploy_on_update = @main_subset[:redeploy_on_update]
       @payloads = @main_subset[:payloads]
-
-      self.parse_scope
-      self.parse_self_service
     end
 
     #####################################

data/lib/jss/api_object/package.rb

@@ -48,6 +48,7 @@ module JSS
     ### Mix-Ins
     #####################################
 
+    include JSS::Categorizable
     include JSS::Creatable
     include JSS::Updatable
 
@@ -127,9 +128,6 @@ module JSS
     ### @return [Boolean] can this item be uninstalled? Some, e.g. OS Updates, can't
     attr_reader :allow_uninstalled
 
-    ### @return [String] the category of this pkg, stored in the JSS as the id number from the categories table
-    attr_reader :category
-
     ### @return [String] the info field for this pkg - stores d3's basename & swupdate values
     attr_reader :info
 
@@ -156,8 +154,6 @@ module JSS
       ### now we have pkg_data with something in it, so fill out the instance vars
       @allow_uninstalled = @init_data[:allow_uninstalled]
       @boot_volume_required = @init_data[:boot_volume_required]
-      @category = JSS::APIObject.get_name(@init_data[:category])
-      @category = nil if @category.to_s.casecmp('No category assigned').zero?
       @filename = @init_data[:filename] || @init_data[:name]
       @fill_existing_users = @init_data[:fill_existing_users]
       @fill_user_template = @init_data[:fill_user_template]
@@ -214,21 +210,6 @@ module JSS
       @need_to_update = true
     end
 
-    ### Change the category in the JSS
-    ###
-    ### @param new_val[String]  must be one listed by 'JSS::Category.all_names'
-    ###
-    ### @return [void]
-    ###
-    def category=(new_val)
-      return nil if new_val == @category
-      new_val = nil if new_val == ''
-      new_val ||= JSS::Category::DEFAULT_CATEGORY
-      raise JSS::InvalidDataError, "Category #{new_val} is not known to the JSS" unless JSS::Category.all_names.include? new_val
-      @category = new_val
-      @need_to_update = true
-    end
-
     ### Change the package filename.
     ### Setting it to nil or empty will make it match the display name
     ###
@@ -459,7 +440,10 @@ module JSS
 
     ### Upload a locally-readable file to the master distribution point.
     ### If the file is a directory (like a bundle .pk/.mpkg) it will be zipped before
-    ### uploading and the @filename will be adjusted accordingly
+    ### uploading and the @filename will be adjusted accordingly by adding a .zip extension
+    ###
+    ### The name of the local file doesn't matter, the file on the dist. point will
+    ### use the @filename (possibly with .zip)
     ###
     ### If you'll be uploading several files you can specify unmount as false, and do it manually when all
     ### are finished with JSS::DistributionPoint.master_distribution_point.unmount
@@ -485,34 +469,37 @@ module JSS
       ### should we zip it?
       if local_path.directory?
         begin
-          zipdir = Pathname.new "/tmp/jssgemtmp-#{Time.new.strftime '%Y%m%d%H%M%S'}-#{$PROCESS_ID}"
-          zipdir.mkpath
-          zipdir.chmod 0o700
-          zipfile = zipdir + (local_path.basename.to_s + '.zip')
-
           ### go to the same dir as the local file
           wd = Dir.pwd
           Dir.chdir local_path.parent
 
           ### the contents of the zip file have to have the same name as the zip file itself (minus the .zip)
           ### so temporarily rename the source
-          local_path.rename(local_path.parent + @filename)
-          raise 'There was a problem zipping the pkg bundle' unless system "/usr/bin/zip -qr '#{zipfile}' '#{@filename}'"
+          local_path_to_upload = local_path.parent + @filename
+          local_path.rename local_path_to_upload unless local_path_to_upload == local_path
+
+          zipdir = Pathname.new "/tmp/rubyjsstmp-#{Time.new.strftime '%Y%m%d%H%M%S'}-#{$PROCESS_ID}"
+          zipdir.mkpath
+          zipdir.chmod 0o700
+          zipfile = zipdir + (local_path_to_upload.basename.to_s + '.zip')
+
+          raise 'There was a problem zipping the pkg bundle' unless system "/usr/bin/zip -qr '#{zipfile}' '#{local_path_to_upload}'"
 
         ensure
           ### rename the source to the original name
-          (local_path.parent + @filename).rename local_path if (local_path.parent + @filename).exist?
+          local_path_to_upload.rename local_path if local_path_to_upload.exist? && local_path_to_upload != local_path
           ### go back where we started
           Dir.chdir wd
         end # begin
 
         ### update our info
         local_path = zipfile
-
-        self.filename = zipfile.basename.to_s
-
+        destination = destination.to_s + '.zip'
+        @filename = zipfile.basename.to_s
+        @need_to_update = true
+        update
       end # if directory
-      update
+
       FileUtils.copy_entry local_path, destination
 
       mdp.unmount if unmount
@@ -796,7 +783,6 @@ module JSS
       pkg = doc.add_element 'package'
       pkg.add_element('allow_uninstalled').text = @allow_uninstalled
       pkg.add_element('boot_volume_required').text = @boot_volume_required
-      pkg.add_element('category').text = @category.to_s.casecmp('No category assigned').zero? ? '' : @category
       pkg.add_element('filename').text = @filename
       pkg.add_element('fill_existing_users').text = @fill_existing_users
       pkg.add_element('fill_user_template').text = @fill_user_template
@@ -810,6 +796,7 @@ module JSS
       pkg.add_element('required_processor').text = @required_processor.to_s.empty? ? 'None' : @required_processor
       pkg.add_element('send_notification').text = @send_notification
       pkg.add_element('switch_with_package').text = @switch_with_package
+      add_category_to_xml(doc)
       doc.to_s
     end # rest xml
 

data/lib/jss/api_object/peripheral.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.
-### 
+###
 ###
 
 ###
@@ -101,11 +101,11 @@ module JSS
 
     ### @return [String] the "bar code 1" value
     attr_reader :bar_code_1
-    
+
 
     ### @return [String] the "bar code 2" value
     attr_reader :bar_code_2
-    
+
 
     ### @return [Integer] the id number of the computer to which  this periph is connected
     attr_reader :computer_id
@@ -149,8 +149,6 @@ module JSS
       ### get the field defs for this PeriphType, omitting the leading nil
       @field_defs ||= JSS::PeripheralType.new(:name => @type).fields.compact
 
-      parse_location
-      parse_purchasing
 
     end # initialize
 
@@ -209,7 +207,7 @@ module JSS
         @bar_code_1 = new_value
         @need_to_update = true
     end
-    
+
 
     ###
     ### Set the value of barcode 2
@@ -222,7 +220,7 @@ module JSS
         @bar_code_2 = new_value
         @need_to_update = true
     end
-    
+
 
     ###
     ### Associate this peripheral with a computer.
@@ -241,7 +239,7 @@ module JSS
       end
       @need_to_update = true
     end
-    
+
 
     ###
     ### Disassociate this peripheral from any computer.
@@ -255,7 +253,7 @@ module JSS
       @computer_id = nil
       @need_to_update = true
     end
-    
+
 
     #################################
     ### Private Methods below here
@@ -317,20 +315,20 @@ module JSS
 
       return doc.to_s
     end # rest xml
-    
+
     ### Aliases
     alias barcode_1 bar_code_1
     alias barcode1 bar_code_1
     alias barcode_1= bar_code_1=
     alias barcode1= bar_code_1=
-    
+
     alias barcode_2 bar_code_2
     alias barcode2 bar_code_2
     alias barcode_2= bar_code_2=
     alias barcode2= bar_code_2=
-    
+
     alias assign_to associate
     alias unassign disassociate
-    
+
   end # class Peripheral
 end # module

data/lib/jss/api_object/policy.rb

@@ -76,6 +76,8 @@ module JSS
     include JSS::Scopable
     include JSS::Uploadable
     include JSS::SelfServable
+    include JSS::Categorizable
+
 
     #####################################
     ### Class Methods
@@ -217,9 +219,6 @@ module JSS
     ### the JSS WebApp. They are general settings for this policy.
     ### We'll map it to direct attributes.
 
-    ### @return [String] policy category name
-    attr_reader :category
-
     ### @return [String] how often to run the policy on each computer
     attr_reader :frequency
 
@@ -533,7 +532,6 @@ module JSS
 
       if @in_jss
         gen = @init_data[:general]
-        @category = JSS::APIObject.get_name(gen[:category])
         @frequency = gen[:frequency]
         @target_drive = gen[:target_drive]
         @offline = gen[:offline]
@@ -601,9 +599,6 @@ module JSS
 
         @printers = @init_data[:printers]
 
-        parse_scope
-        parse_self_service
-        @in_self_service = @init_data[:self_service][:use_for_self_service]
 
         ### Not in jss yet
       end
@@ -699,21 +694,6 @@ module JSS
       @need_to_update = true
     end
 
-    ### Change the category of this policy, arg is a category name
-    ###
-    ### @param new_val[String] the name of the new category
-    ###
-    ### @return [void]
-    ###
-    def category=(new_val = JSS::Category::DEFAULT_CATEGORY)
-      return nil if @category == new_val
-      new_val = nil if new_val == ''
-      new_val ||= JSS::Category::DEFAULT_CATEGORY
-      raise JSS::NoSuchItemError, "No category '#{new_val}' in the JSS" unless JSS::Category.all_names(:refresh).include? new_val
-      @category = new_val
-      @need_to_update = true
-    end
-
     ### Change a trigger event
     ###
     ### @param type[Symbol] the type of trigger, one of the keys of {TRIGGER_EVENTS}
@@ -1106,62 +1086,6 @@ module JSS
       @printers.map { |p| p[:name] }
     end
 
-    ###### SelfService
-    ### Is this policy in self service?
-    ###
-    ### @return [Boolean] Is this policy in self service?
-    ###
-    def in_self_service?
-      @in_self_service
-    end
-
-    ### policies in self service aren't 'removable'
-    ###
-    ### @return [FalseClass]
-    ###
-    def user_removable?
-      false
-    end
-    alias user_removable= user_removable?
-
-    ### Add this policy to Self Service
-    ###
-    ### @return [void]
-    def add_to_self_service
-      @need_to_update = (@in_self_service == false)
-      @in_self_service = true
-    end
-
-    ### Remove this policy from Self Service
-    ###
-    ### @return [void]
-    def remove_from_self_service
-      @need_to_update = (@in_self_service == true)
-      @in_self_service = false
-    end
-
-    ### Select or upload an image file to be the self service icon.
-    ### The policy must already exist in the JSS to upload an image.
-    ###
-    ### NOTE: There is no way to verify the validity of an icon id, as they are not
-    ###   available via the API. Caveat Emptor.
-    ###
-    ### NOTE: When setting by id, {#update} or #{save} must be used to save the change.
-    ###
-    ### @param icon [String, Pathname, Integer] the path to the local image file, to upload
-    ###   or the id of a previously uploaded one.
-    ###
-    ### @return [void]
-    ###
-    def assign_icon(icon)
-      if icon.is_a? Integer
-        @self_service_icon = { id: icon }
-        @need_to_update = true
-        return
-      end
-      upload(:icon, icon)
-    end
-
     ###### Actions
 
     ### Try to execute this policy on this machine.
@@ -1186,7 +1110,6 @@ module JSS
     alias command_to_run run_command
     alias delete_path? delete_file?
     alias execute run
-    alias self_service? in_self_service?
 
     ### Private Instance Methods
     #####################################
@@ -1202,7 +1125,8 @@ module JSS
       general.add_element('frequency').text = @frequency
       general.add_element('target_drive').text = @target_drive
       general.add_element('offline').text = @offline
-      general.add_element('category').add_element('name').text = @category if @category
+
+      add_category_to_xml(doc)
 
       JSS.hash_to_rexml_array(@trigger_events).each { |t| general << t }
 
@@ -1226,9 +1150,7 @@ module JSS
         sdeets.each { |d| script << d }
       end
 
-      self_svc = self_service_xml
-      self_svc.add_element('use_for_self_service').text = @in_self_service
-      obj << self_svc
+      add_self_service_xml doc
 
       doc.to_s
     end

data/lib/jss/api_object/purchasable.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.
-### 
+###
 ###
 
 ###
@@ -58,8 +58,6 @@ module JSS
   ###
   ### These items become direct attributes of objects where this module is mixed-in.
   ###
-  ### Classes mixing in this module must call {#parse_purchasing} in their initialization method
-  ### in order to populate the attributes from @init_data.
   ###
   ### If the class also is Creatable or Updatable it must include the value of {#purchasing_xml} in its
   ### rest_xml output.
@@ -231,12 +229,12 @@ module JSS
       @vendor or \
       @warranty_expires
     end
-    
+
     ###
     ### All the purchasing data in a Hash, as it comes from the API.
     ###
     ### The reason it isn't stored this way is to prevent editing of the hash directly.
-    ### 
+    ###
     ### @return [Hash<String>] the location data
     ###
     def purchasing
@@ -255,7 +253,7 @@ module JSS
         :warranty_expires => @warranty_expires,
       }
     end
-    
+
     ###
     ### @api private
     ###
@@ -308,10 +306,10 @@ module JSS
       purch.add_element('warranty_expires_epoch').text = @warranty_expires ? @warranty_expires.to_jss_epoch : nil
       return purch
     end
-    
+
     ### Aliases
     alias leased? is_leased
     alias purchased? is_purchased
-    
+
   end # module Purchasable
 end # module JSS