jss-api 0.5.7 → 0.5.8

data/CHANGES.md

@@ -1,6 +1,20 @@
 # Change History
 
+v0.5.8 2015-09-22
+
+bugfixes & cleanup
+- location.rb: location value setters are now properly converted to strings
+- api_connection.rb: #connect now takes :use_ssl option (defaults to true) 
+- api_connection.rb: #connect will accept arbitrary ports when :use_ssl is true
+
+additions & features
+- client.rb: looks for the new ElCap+ location for the jamf binary, falls back to old location if not found.
+- Locatable#clear_location public instance method added
+- TimeoutError and AuthenticationError have been added to exceptions
+- Policy objects now have a #run method - attempts to execute the policy locally.
+
 v0.5.7 2015-05-26
+
 bugfixes & cleanup
 - JSS.to_s_and_a now properly converts nils to "" and []
 - DBConnection.connect gracefully handle reconnecting if the old connection went away
@@ -13,6 +27,7 @@ bugfixes & cleanup
 - Package#upload_master_file: move autoupdate to appropriate location
 
 v0.5.6 2014-11-04
+
 - now requires Ruby >= 1.9.3 and rest-client >= 1.7.0. Needed for Casper >= 9.61's lack of support for SSLv3.
 - APIConnection now accepts :ssl_version option in the argument hash. Defaults to 'TLSv1'
 - Configuration now supports the api_ssl_version key, used for the :ssl_version option of the APIConnection.
@@ -21,4 +36,5 @@ v0.5.6 2014-11-04
 - minor bugfixes
 
 v0.5.0 2014-10-23 
+
 - first opensource release

data/README.md

@@ -371,7 +371,7 @@ If you're using Ruby 1.8.7 (Casper 9.4 - 9.6 only), install the following gems m
 
 ## LICENSE
 
-Copyright 2014 Pixar
+Copyright 2015 Pixar
 
 Licensed under the Apache License, Version 2.0 (the "Apache License")
 with the following modification; you may not use this file except in

data/lib/jss-api/api_object.rb

@@ -121,7 +121,6 @@ module JSS
     ### Class Variables
     #####################################
 
-    ###
     ### This Hash holds the most recent API query for a list of all items in any subclass,
     ### keyed by the subclass's RSRC_LIST_KEY. See the self.all class method.
     ###
@@ -236,7 +235,27 @@ 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. 
+    ###
+    ### NOTE: This may be slow as it has to look up each object individually!
+    ### use it wisely.
+    ###
+    ### @param refresh[Boolean] should the data  re-queried from the API?
+    ###
+    ### @return [Hash{Integer => Object}] the objects requested
+    def self.all_objects(refresh = false)
+      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]}      
+    end
+    
+    
+    
     ###
     ### Convert an Array of Hashes of API object data to a
     ### REXML element.

data/lib/jss-api/api_object/locatable.rb

@@ -159,8 +159,8 @@ module JSS
     ###
     def building= (new_val)
       return nil if @building == new_val
-      new_val.strip!
-      raise JSS::NoSuchItemError, "No building named #{new_val} exists in the JSS" unless JSS::Building.all_names.include? 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
       @building = new_val
       @need_to_update = true
     end
@@ -168,8 +168,8 @@ module JSS
     ###
     def department= (new_val)
       return nil if @department == new_val
-      new_val.strip!
-      raise JSS::NoSuchItemError, "No department named #{new_val} exists in the JSS" unless JSS::Department.all_names.include? 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
       @department = new_val
       @need_to_update = true
     end
@@ -177,8 +177,8 @@ module JSS
     ###
     def email_address= (new_val)
       return nil if @email_address == new_val
-      new_val.strip!
-      raise JSS::InvalidDataError, "Invalid Email Address" unless new_val =~ /^[^\s@]+@[^\s@]+$/
+      new_val = new_val.to_s.strip
+      raise JSS::InvalidDataError, "Invalid Email Address" unless new_val.empty? or  new_val =~ /^[^\s@]+@[^\s@]+$/
       @email_address = new_val
       @need_to_update = true
     end
@@ -186,7 +186,7 @@ module JSS
     ###
     def position= (new_val)
       return nil if @position == new_val
-      new_val.strip!
+      new_val = new_val.to_s.strip
       @position = new_val
       @need_to_update = true
     end
@@ -194,7 +194,7 @@ module JSS
     ###
     def phone= (new_val)
       return nil if @phone == new_val
-      new_val.strip!
+      new_val = new_val.to_s.strip
       @phone = new_val
       @need_to_update = true
     end
@@ -202,7 +202,7 @@ module JSS
     ###
     def real_name= (new_val)
       return nil if @real_name == new_val
-      new_val.strip!
+      new_val = new_val.to_s.strip
       @real_name = new_val
       @need_to_update = true
     end
@@ -210,7 +210,7 @@ module JSS
     ###
     def room= (new_val)
       return nil if @room == new_val
-      new_val.strip!
+      new_val = new_val.to_s.strip
       @room = new_val
       @need_to_update = true
     end
@@ -218,7 +218,7 @@ module JSS
     ###
     def username= (new_val)
       return nil if @username == new_val
-      new_val.strip!
+      new_val = new_val.to_s.strip
       @username = new_val
       @need_to_update = true
     end
@@ -237,6 +237,24 @@ module JSS
       @room
     end
 
+    ###
+    ### Clear all location data
+    ###
+    ### @return [void]
+    ###
+    def clear_location
+      @username = ''
+      @real_name = ''
+      @email_address = ''
+      @position = ''
+      @phone = ''
+      @department  = ''
+      @building = ''
+      @room = ''
+      @need_to_update = true
+    end
+    
+    
     ### aliases
     alias user username
     

data/lib/jss-api/api_object/policy.rb

@@ -843,12 +843,28 @@ module JSS
     ### @return [Boolean] is this policy available in SelfService?
     def self_service?; @self_service[:use_for_self_service] ; end
     
+    ### Try to execute this policy on this machine.
+    ###
+    ### @param show_output[Boolean] should the stdout and stderr of the 
+    ###  'jamf policy' command be sent to stdout in realtime?
+    ###
+    ### @return [Boolean, nil] The success of the 'jamf policy' command, or nil
+    ###   if the policy couldn't be executed (out of scope, policy disabled, etc)
+    ###
+    def run (show_output = false)
+      return nil unless enabled?
+      output = JSS::Client.run_jamf("policy", "-id #{id}", show_output)
+      return nil if output.include? 'No policies were found for the ID'
+      return $?.exitstatus == 0 ? true : false
+    end
+    
     ### Aliases
     alias enabled? enabled
     alias pkgs packages
     alias command_to_run run_command
     alias delete_path? delete_file?
-
+    alias execute run
+    
     #####################################
     ### Private Instance Methods
     #####################################

data/lib/jss-api/client.rb

@@ -54,7 +54,10 @@ module JSS
     #####################################
 
     ### The Pathname to the jamf binary executable
-    JAMF_BINARY = Pathname.new "/usr/sbin/jamf"
+    ### As of El Capitan (OS X 10.11) the location has moved.
+    ORIG_JAMF_BINARY = Pathname.new "/usr/sbin/jamf"
+    ELCAP_JAMF_BINARY = Pathname.new "/usr/local/sbin/jamf"
+    JAMF_BINARY = ELCAP_JAMF_BINARY.executable? ? ELCAP_JAMF_BINARY : ORIG_JAMF_BINARY
 
     ### The Pathname to the jamfHelper executable
     JAMF_HELPER = Pathname.new "/Library/Application Support/JAMF/bin/jamfHelper.app/Contents/MacOS/jamfHelper"

data/lib/jss-api/exceptions.rb

@@ -80,4 +80,16 @@ module JSS
   ###
   class UnsupportedError <  RuntimeError; end
   
+  ###
+  ### TimeoutError - raise this when we 
+  ### try to do and it times out
+  ###
+  class TimeoutError <  RuntimeError; end
+  
+  ###
+  ### AuthenticationError - raise this when 
+  ### a name/pw are wrong
+  ###
+  class AuthenticationError <  RuntimeError; end
+  
 end # module JSS

data/lib/jss-api/server.rb

@@ -93,7 +93,7 @@ module JSS
         @version = parsed[:version]
 
       rescue RestClient::Request::Unauthorized
-        raise JSS::InvalidConnectionError, "Incorrect JSS username or password for '#{JSS::API.jss_user}'."
+        raise JSS::AuthenticationError, "Incorrect JSS username or password for '#{JSS::API.jss_user}@#{JSS::API.server_host}'."
       end
 
     end

data/lib/jss-api/version.rb

@@ -26,6 +26,6 @@
 module JSS
 
   ### The version of the JSS ruby gem
-  VERSION = "0.5.7"
+  VERSION = "0.5.8"
 
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jss-api
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist