ruby-jss 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6681d7531f34a10d2ba31f13428c9391446a15ec
-  data.tar.gz: 80fae35e805326660e8cf0372ba14fd3bb3652f5
+  metadata.gz: edccb1a8e4436aae8603aecc748d5cd817115144
+  data.tar.gz: 7f169bdfa8623ee12699e241872ddee9259d19b9
 SHA512:
-  metadata.gz: fd89d7e838147899adcbed3042d795a632e182428567bb675965fa3850eb3956a30b4c8e975b453f77ac52e5ba97ada2cbdb950ac3ae1b409b8414ca898a30de
-  data.tar.gz: f755fabd0f11caddb9d20291842f774d141aa51c935d7e9cb0bacf5a0db58a1270aa7195546d8211c20f8d00786cc5f2e52265ca4d730210aaf439a387500018
+  metadata.gz: a25d238371cdfd1157b3e11320002ac10f6da9b90acf4b10cadfba5f54cc932d0b3d4525d22f3e471f318b778ed0c45afc987a560bb08afd3a86b0eec66bb19a
+  data.tar.gz: 48f2c4bc65aad055eb5e84eb3ef2a195706d4253cdb7b4a0ba3675d76fea364921ef7fb79002e78aea358138a4dd3b19056a4b1f425b4589cb3b5a3e2b929f3b

data/lib/jss.rb

@@ -159,6 +159,7 @@ module JSS
 
   ### APIObject Classes without SubClasses
 
+  class Account < JSS::APIObject ; end
   class Building < JSS::APIObject ; end
   class Category < JSS::APIObject ; end
   class Computer < JSS::APIObject ; end
@@ -168,11 +169,13 @@ module JSS
   class MobileDevice < JSS::APIObject ; end
   class NetBootServer < JSS::APIObject ; end
   class NetworkSegment < JSS::APIObject ; end
+  class OSXConfigurationProfile < JSS::APIObject ; end
   class Package < JSS::APIObject ; end
   class PeripheralType < JSS::APIObject ; end
   class Peripheral < JSS::APIObject ; end
   class Policy < JSS::APIObject ; end
   class RemovableMacAddress < JSS::APIObject ; end
+  class RestrictedSoftware < JSS::APIObject ; end
   class Script < JSS::APIObject ; end
   class Site < JSS::APIObject ; end
   class SoftwareUpdateServer < JSS::APIObject ; end

data/lib/jss/api_object.rb

@@ -1,25 +1,25 @@
 ### Copyright 2016 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.
-### 
+###
 ###
 
 ###
@@ -235,11 +235,11 @@ module JSS
       self.all(refresh).each{|i| h[i[:id]] = i[other_key]}
       h
     end
-    
-    
+
+
     ### Return an Array of JSS::APIObject subclass instances
     ### e.g when called on JSS::Package, return all JSS::Package
-    ### objects in the JSS. 
+    ### objects in the JSS.
     ###
     ### NOTE: This may be slow as it has to look up each object individually!
     ### use it wisely.
@@ -251,11 +251,11 @@ module JSS
       objects_key = "#{self::RSRC_LIST_KEY}_objects".to_sym
       @@all_items[objects_key] = nil if refresh
       return @@all_items[objects_key] if @@all_items[objects_key]
-      @@all_items[objects_key] = self.all(refresh = false).map{|o| self.new :id => o[:id]}      
+      @@all_items[objects_key] = self.all(refresh = false).map{|o| self.new :id => o[:id]}
     end
-    
-    
-    
+
+
+
     ###
     ### Convert an Array of Hashes of API object data to a
     ### REXML element.
@@ -439,7 +439,7 @@ module JSS
         @name = args[:name]
         @init_data = {:name => args[:name]}
         @in_jss = false
-        @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{URI.escape @name}"
+        @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name}"
         @need_to_update = true
         return
 
@@ -488,13 +488,13 @@ module JSS
       # many things have  a :site
       if @main_subset[:site]
         @site = JSS::APIObject.get_name( @main_subset[:site])
-      end 
-      
+      end
+
       # many things have a :category
       if @main_subset[:category]
-        @category = JSS::APIObject.get_name( @main_subset[:category]) 
+        @category = JSS::APIObject.get_name( @main_subset[:category])
       end
-      
+
       # set empty strings to nil
       @init_data.jss_nillify! '', :recurse
 
@@ -540,7 +540,7 @@ module JSS
     def delete
       return nil unless @in_jss
       JSS::API.delete_rsrc @rest_rsrc
-      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{URI.escape @name}"
+      @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name}"
       @id = nil
       @in_jss = false
       @need_to_update = false
@@ -565,11 +565,11 @@ module JSS
       return doc.to_s
     end
 
-    
+
     ### Aliases
-    
+
     alias in_jss? in_jss
-    
+
   end # class APIObject
 
 
@@ -584,6 +584,7 @@ require "jss/api_object/matchable"
 require "jss/api_object/purchasable"
 require "jss/api_object/updatable"
 require "jss/api_object/extendable"
+require "jss/api_object/self_servable"
 
 ### Mix-in Sub Modules with Classes
 require "jss/api_object/criteriable"
@@ -595,22 +596,25 @@ require "jss/api_object/extension_attribute"
 require "jss/api_object/group"
 
 ### APIObject SubClasses without SubClasses
+require "jss/api_object/account"
 require "jss/api_object/building"
 require "jss/api_object/category"
 require "jss/api_object/computer"
+require "jss/api_object/computer_invitation"
 require "jss/api_object/department"
 require "jss/api_object/distribution_point"
 require "jss/api_object/ldap_server"
 require "jss/api_object/mobile_device"
 require "jss/api_object/netboot_server"
 require "jss/api_object/network_segment"
+require "jss/api_object/osx_configuration_profile"
 require "jss/api_object/package"
 require "jss/api_object/peripheral_type"
 require "jss/api_object/peripheral"
 require "jss/api_object/policy"
 require "jss/api_object/removable_macaddr"
+require "jss/api_object/restricted_software"
 require "jss/api_object/script"
 require "jss/api_object/site"
 require "jss/api_object/software_update_server"
 require "jss/api_object/user"
-

data/lib/jss/api_object/account.rb

@@ -0,0 +1,160 @@
+### Copyright 2016 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.
+###
+###
+
+###
+module JSS
+
+  #####################################
+  ### Module Variables
+  #####################################
+
+  #####################################
+  ### Module Methods
+  #####################################
+
+  #####################################
+  ### Classes
+  #####################################
+
+  ###
+  ### A User in the JSS.
+  ###
+  ### @see JSS::APIObject
+  ###
+  class Account < JSS::APIObject
+
+    ### Note: This class is not fully extended and since the resource
+    ### is different than the rest, methods like JSS::Account.all do not work
+
+    #####################################
+    ### Mix-Ins
+    #####################################
+
+    #####################################
+    ### Class Methods
+    #####################################
+
+    ### @return [Array<Hash>] all JSS account users
+    def self.all_users(refresh = false)
+      self.all(refresh)[:users]
+    end
+
+    ### @return [Array<Hash>] all JSS account user ids
+    def self.all_user_ids(refresh = false)
+      self.all(refresh)[:users].map{|i| i[:id]}
+    end
+
+    ### @return [Array<Hash>] all JSS account user names
+    def self.all_user_names(refresh = false)
+      self.all(refresh)[:users].map{|i| i[:name]}
+    end
+
+    ### @return [Array<Hash>] all JSS account groups
+    def self.all_groups(refresh = false)
+      self.all(refresh)[:groups]
+    end
+
+    ### @return [Array<Hash>] all JSS account group ids
+    def self.all_group_ids(refresh = false)
+      self.all(refresh)[:groups].map{|i| i[:id]}
+    end
+
+    ### @return [Array<Hash>] all JSS account group names
+    def self.all_group_names(refresh = false)
+      self.all(refresh)[:groups].map{|i| i[:name]}
+    end
+
+    #####################################
+    ### Class Constants
+    #####################################
+
+    ### The base for REST resources of this class
+    RSRC_BASE = "accounts"
+
+    ### the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :accounts
+
+    ### The hash key used for the JSON object output.
+    ### It's also used in various error messages
+    RSRC_OBJECT_KEY = :account
+
+    #####################################
+    ### Attributes
+    #####################################
+
+    ### @return [String] The user's full name
+    attr_reader :full_name
+
+    ### @return [String] The user's email address
+    attr_reader :email
+
+    ### @return [String] The user's access level
+    attr_reader :access_level
+
+    ### @return [String] The user's privilege set
+    attr_reader :privilege_set
+
+    ### @return [Hash]
+    ###
+    ### Info about the privileges assigned to the user
+    ###
+    ### Note: these arrays may be empty, they always exist
+    ###
+    ### The Hash keys are:
+    ### * :jss_objects => An array of jss_object privileges
+    ### * :jss_settings => An array of jss_settings privileges
+    ### * :jss_actions => An array of jss_actions privileges
+    ### * :recon => An array of Casper Recon privileges
+    ### * :casper_admin => An array of Casper Admin privileges
+    ### * :casper_remote => An array of Casper Remote privileges
+    ### * :casper_imaging => An array of Casper Imaging privileges
+    attr_reader :privileges
+
+    #####################################
+    ### Constructor
+    #####################################
+
+    ###
+    ### See JSS::APIObject#initialize
+    ###
+    def initialize (args = {})
+      super args, [:userid, :username, :groupid, :groupname]
+
+      # check to see if a user has been specified, haven't built groups yet
+      is_user = [:userid, :username].any? { |key| args.keys.include? key }
+
+      if is_user
+        @user_name = @init_data[:name]
+        @full_name = @init_data[:full_name]
+        @email = @init_data[:email]
+        @access_level = @init_data[:access_level]
+        @privilege_set = @init_data[:privilege_set]
+        @privileges = @init_data[:privileges]
+      end
+
+    end # initialize
+
+  end # class accounts
+
+end # module

data/lib/jss/api_object/computer.rb

@@ -1,25 +1,25 @@
 ### Copyright 2016 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.
-### 
+###
 ###
 
 ###
@@ -319,7 +319,7 @@ module JSS
 
     ### @return [String] the barcodes
     attr_reader :barcode_1, :barcode_2
-    
+
 
     ### @return [String] The name of the distribution point for this computer
     attr_reader :distribution_point
@@ -359,7 +359,7 @@ module JSS
 
     ### @return [String] the serial number
     attr_reader :serial_number
-    
+
 
     ### @return [Hash] the :name and :id of the site for this machine
     attr_reader :site
@@ -593,16 +593,34 @@ module JSS
     def local_accounts
       @groups_accounts[:local_accounts]
     end
-    
 
+
+    ### @return [Boolean] is FileVault2 enabled?
     ###
+    def filevault2_enabled?
+      boot_drive[:partition][:filevault2_status] != "Not Encrypted"
+    end
+
+    ### @return [Array<Hash>] The local_accounts Array that have Legacy FV enabled
+    ###
+    def filevault1_accounts
+      return [] if filevault2_enabled?
+      local_accounts.select{ |a| a[:filevault_enabled] }
+    end
+
     ### @return [Array<Hash>]  each storage device
     ###
     def drives
       @hardware[:storage]
     end
 
+    ### @return [Hash, nil] The hardware[:storage] hash of the boot drive
     ###
+    def boot_drive
+      drives.each{ |d| return d if d[:partition][:type] == "boot" }
+      return nil
+    end
+
     ### @return [Array<Hash>]  each printer on this computer
     ###   Keys are :name, :uri, :type, :location
     ###
@@ -755,8 +773,8 @@ module JSS
       @purchasing = nil
       @software = nil
     end #delete
-    
-    
+
+
 # Not Functional until I get more docs from JAMF
 #
 #     ###
@@ -786,7 +804,7 @@ module JSS
 #     alias erase erase_device
 #     alias wipe erase_device
 
-    
+
     ### aliases
     alias alt_macaddress alt_mac_address
     alias bar_code_1 barcode_1

data/lib/jss/api_object/computer_invitation.rb

@@ -0,0 +1,206 @@
+### Copyright 2016 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.
+###
+###
+
+###
+module JSS
+
+  #####################################
+  ### Module Constants
+  #####################################
+
+  #####################################
+  ### Module Variables
+  #####################################
+
+  #####################################
+  ### Module Methods
+  #####################################
+
+  ###
+  ### This class represents a Computer Invitation in the JSS.
+  ###
+  ### ===Adding Computer Invitations to the JSS
+  ###
+  ### This class is meant only to generate and hold the response of creating
+  ### an invitation.
+  ###
+  ### @see APIObject
+  ### @see Creatable
+  ###
+
+  class ComputerInvitation < JSS::APIObject
+
+    #####################################
+    ### MixIns
+    #####################################
+
+    include JSS::Creatable
+
+    #####################################
+    ### Class Variables
+    #####################################
+
+    #####################################
+    ### Class Methods
+    #####################################
+
+    #####################################
+    ### Class Constants
+    #####################################
+
+    ### The base for REST resources of this class
+    RSRC_BASE = "computerinvitations"
+
+    ### the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :computer_invitations
+
+    ### The hash key used for the JSON object output.
+    ### It's also used in various error messages
+    RSRC_OBJECT_KEY = :computer_invitation
+
+    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [:invitation]
+
+    #####################################
+    ### Attributes
+    #####################################
+
+    ### The values returned in the General, Location, and Purchasing subsets are stored as direct attributes
+    ### Location and Purchasing are defined in the Locatable and Purchasable mixin modules.
+    ### Here's General, in alphabetical order
+
+    ### @return [String] the invitation name
+    attr_reader :name
+
+    ### @return [String] the invitation type
+    ###
+    ### Valid values are: URL and EMAIL. Will default to DEFAULT.
+    attr_accessor :invitation_type
+
+    ### @return [String] whether or not to create the account if required
+    ###
+    ### "true" or "false" are valid values.
+    attr_accessor :create_account_if_does_not_exist
+
+    ### @return [String]
+    ###
+    ### Time since epoch that the invitation will expire at.
+    ###
+    ### Note: defaults to "Unlimited", so only set if it should expire.
+    attr_accessor :expiration_date_epoch
+
+    ### @return [String]
+    ###
+    ### The username of the ssh user to be created.
+    ###
+    ### REQUIRED for valid setup.
+    attr_accessor :ssh_username
+
+    ### @return [String]
+    ###
+    ### The whether or not to hide the ssh user.
+    attr_accessor :hide_account
+
+    ### @return [String]
+    ###
+    ### The invitation_status.
+    attr_accessor :invitation_status
+
+    ### @return [String]
+    ###
+    ### Whether the invitation can be used multiple times (boolean).
+    attr_accessor :multiple_uses_allowed
+
+    #####################################
+    ### Public Instance Methods
+    #####################################
+
+    ###
+    ### @see APIObject#initialize
+    ###
+    def initialize(args = {
+      id: :new,
+      name: "some_new_name",
+      ssh_username: "casper_remote",
+      hide_account: "true" } )
+
+      super args, []
+
+      @name = @init_data[:invitation]
+      @invitation_type = @init_data[:invitation_type]
+      @create_account_if_does_not_exist = @init_data[:create_account_if_does_not_exist]
+      @expiration_date_epoch = @init_data[:expiration_date_epoch] || args[:expiration_date_epoch]
+      @ssh_username = @init_data[:ssh_username] || args[:ssh_username]
+      @hide_account = @init_data[:hide_account] || args[:hide_account]
+      @invitation_status = @init_data[:invitation_status] || args[:invitation_status]
+      @multiple_uses_allowed = @init_data[:multiple_uses_allowed] || args[:multiple_uses_allowed]
+    end
+
+    #####################################
+    ### Public Class Methods
+    #####################################
+
+    ###
+    ### Needed to support creation of new Computer Invitations to set their name.
+    ###
+    ### @return [JSS::ComputerInvitation]
+    ###
+    def create
+      new_invitation_id = super
+
+      jss_me = ComputerInvitation.new(id: new_invitation_id, name: 'set_by_request')
+      @name = jss_me.name
+      @invitation_type = jss_me.invitation_type
+      @create_account_if_does_not_exist = jss_me.create_account_if_does_not_exist
+      @expiration_date_epoch = jss_me.expiration_date_epoch
+      @ssh_username = jss_me.ssh_username
+      @hide_account = jss_me.hide_account
+      @invitation_status = jss_me.invitation_status
+      @multiple_uses_allowed = jss_me.multiple_uses_allowed
+    end
+
+    #####################################
+    ### Private Instance Methods
+    #####################################
+    private
+
+    ###
+    ### Sets invitation expiration 4 hours after request.
+    ###
+    def rest_xml
+      doc = REXML::Document.new APIConnection::XML_HEADER
+      obj = doc.add_element RSRC_OBJECT_KEY.to_s
+      obj.add_element('invitation_type').text = invitation_type
+      obj.add_element('create_account_if_does_not_exist').text = create_account_if_does_not_exist
+      if expiration_date_epoch
+        obj.add_element('expiration_date_epoch').text = expiration_date_epoch
+      end
+      obj.add_element('ssh_username').text = ssh_username
+      obj.add_element('hide_account').text = hide_account
+      obj.add_element('invitation_status').text = invitation_status
+      obj.add_element('multiple_uses_allowed').text = multiple_uses_allowed
+      return doc.to_s
+    end
+  end
+end