jss-api 0.5.8 → 0.6.1

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/api_object/scopable/scope.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/client.rb

@@ -1,25 +1,25 @@
-### Copyright 2014 Pixar
-###  
+### 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.
-### 
+###
 ###
 
 ###
@@ -56,7 +56,7 @@ module JSS
     ### The Pathname to the jamf binary executable
     ### 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"
+    ELCAP_JAMF_BINARY = Pathname.new "/usr/local/jamf/bin/jamf"
     JAMF_BINARY = ELCAP_JAMF_BINARY.executable? ? ELCAP_JAMF_BINARY : ORIG_JAMF_BINARY
 
     ### The Pathname to the jamfHelper executable
@@ -109,7 +109,7 @@ module JSS
     #####################################
     ### Class Methods
     #####################################
-    
+
     ###
     ### Get the current IP address as a String.
     ###
@@ -126,7 +126,7 @@ module JSS
       ### turn off reverse DNS resolution temporarily
       ### @note the 'socket' library has already been required by 'rest-client'
       orig, Socket.do_not_reverse_lookup = Socket.do_not_reverse_lookup, true
-  
+
       UDPSocket.open do |s|
         s.connect '192.168.0.0', 1
         s.addr.last
@@ -243,16 +243,15 @@ module JSS
     ### @return [Hash] the HardwareDataType data from the system_profiler command
     ###
     def self.hardware_data
-       Plist.parse_xml(`system_profiler SPHardwareDataType -xml`)[0]["_items"][0]
+      raw = `/usr/sbin/system_profiler SPHardwareDataType -xml 2>/dev/null`
+      Plist.parse_xml(raw)[0]["_items"][0]
     end
 
 
-
+    ### Run an arbitrary jamf binary command.
     ###
     ### @note Most jamf commands require superuser/root privileges.
     ###
-    ### Run an arbitrary jamf binary command.
-    ###
     ### @param command[String,Symbol] the jamf binary command to run
     ###   The command is the single jamf command that comes after the/usr/bin/jamf.
     ###
@@ -260,7 +259,7 @@ module JSS
     ###   This is to be passed to Kernel.` (backtick), after being combined with the
     ###   jamf binary and the jamf command
     ###
-    ### @param show_output[Boolean] Should the stdout & stderr of the jamf binary be sent to
+    ### @param verbose[Boolean] Should the stdout & stderr of the jamf binary be sent to
     ###  the current stdout in realtime, as well as returned as a string?
     ###
     ### @return [String] the stdout & stderr of the jamf binary.
@@ -276,8 +275,7 @@ module JSS
     ### The details of the Process::Status for the jamf binary process can be captured from $?
     ### immediately after calling. (See Process::Status)
     ###
-    ###
-    def self.run_jamf(command, args = nil, show_output  = false)
+    def self.run_jamf(command, args = nil, verbose  = false)
       raise JSS::UnmanagedError, "The jamf binary is not installed on this computer." unless self.installed?
       raise JSS::UnsupportedError, "You must have root privileges to run that jamf binary command" unless ROOTLESS_JAMF_COMMANDS.include? command.to_sym or JSS.superuser?
 
@@ -292,16 +290,19 @@ module JSS
           raise JSS::InvalidDataError, "args must be a String or Array of Strings"
       end # case
 
+      cmd += " -verbose" if verbose and (not cmd.include? " -verbose")
+      puts "Running: #{cmd}" if verbose
+
       output = []
       IO.popen("#{cmd} 2>&1") do |proc|
         while line = proc.gets
           output << line
-          puts line if show_output
+          puts line if verbose
         end
       end
-
-      return output.join('')
-
+      install_out = output.join('')
+      install_out.force_encoding("UTF-8") if install_out.respond_to? :force_encoding
+      return install_out
     end # run_jamf
 
 

data/lib/jss-api/compatibility.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/composer.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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
@@ -86,7 +86,7 @@ module JSS
     opts[:out_dir] ||= DEFAULT_OUT_DIR
     opts[:bundle_id_prefix] ||= PKG_BUNDLE_ID_PFX
 
-    pkg_filename = "#{name}.pkg"
+    pkg_filename = name.end_with?(".pkg") ? name : name+".pkg" 
     pkg_id = opts[:bundle_id_prefix] + "." + name
     pkg_out = "#{opts[:out_dir]}/#{pkg_filename}"
     pkg_ownership = opts[:preserve_ownership] ? "preserve" : "recommended"

data/lib/jss-api/configuration.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/db_connection.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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
@@ -84,7 +84,10 @@ module JSS
 
     ###
     DFT_SOCKET = '/var/mysql/mysql.sock'
-
+    
+    ### the default MySQL port
+    DFT_PORT = 3306
+    
     ### the strftime format for reading/writing dates in the db
     SQL_DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
 
@@ -140,8 +143,12 @@ module JSS
     ###
     def connect(args = {})
 
+      # server might come frome several places
+      # if not given in the args, use #hostname to figure out
+      # which
+      @server = args[:server] ?  args[:server] : hostname
+      
       # settings from config if they aren't in the args
-      args[:server] ||= JSS::CONFIG.db_server_name
       args[:port] ||= JSS::CONFIG.db_server_port
       args[:socket] ||= JSS::CONFIG.db_server_socket
       args[:db_name] ||= JSS::CONFIG.db_name
@@ -169,7 +176,6 @@ module JSS
         @connected = false
       end
 
-      @server = args[:server]
       @port = args[:port]
       @socket = args[:socket]
       @mysql_name = args[:db_name]
@@ -178,14 +184,13 @@ module JSS
       @read_timeout = args[:read_timeout]
       @write_timeout = args[:write_timeout]
 
-      # make sure we have a user
-      raise JSS::MissingDataError, "No JSS user specified, or listed in configuration." unless args[:user]
-
-      # passwd from prompt, stdin, or args?
+      # make sure we have a user, pw, server
+      raise JSS::MissingDataError, "No MySQL user specified, or listed in configuration." unless args[:user]
       raise JSS::MissingDataError, "Missing :pw (or :prompt/:stdin) for user '#{@user}'" unless args[:pw]
+      raise JSS::MissingDataError, "No MySQL Server hostname specified, or listed in configuration." unless @server
 
       @pw = if args[:pw] == :prompt
-        JSS.prompt_for_password "Enter the password for the MySQL user #{@user}@#{args[:server]}:"
+        JSS.prompt_for_password "Enter the password for the MySQL user #{@user}@#{@server}:"
       elsif  args[:pw].is_a?(Symbol) and args[:pw].to_s.start_with?('stdin')
         args[:pw].to_s =~ /^stdin(\d+)$/
         line = $1
@@ -195,8 +200,6 @@ module JSS
         args[:pw]
       end
 
-
-
       @mysql = Mysql.init
 
       @mysql.options Mysql::OPT_CONNECT_TIMEOUT, @connect_timeout
@@ -222,10 +225,58 @@ module JSS
     ###
     def disconnect
       @mysql.close if connected?
+      @server = nil
+      @port = nil
+      @socket = nil
+      @user = nil
+      @connection_timeout = DFT_TIMEOUT
+      @read_timeout = DFT_TIMEOUT
+      @write_timeout = DFT_TIMEOUT
       @connected = false
       nil
     end # disconnect
-
+    
+    ### Test that a given hostname is a MySQL server
+    ###
+    ### @param server[String] The hostname to test
+    ###
+    ### @return [Boolean] does the server host a MySQL server?
+    ###
+    def valid_server? (server, port = DFT_PORT)
+      mysql = Mysql.init
+      mysql.options Mysql::OPT_CONNECT_TIMEOUT, 5
+      
+      begin
+        # this connection should get an access denied error if there is
+        # a mysql server there. I'm assuming no one will use this username
+        # and pw for anything real
+        mysql.connect server, "notArealUser", "definatelyNotA#{$$}password", "not_a_db", port
+        
+      rescue Mysql::ServerError::AccessDeniedError
+        return true
+      rescue
+        return false
+      end
+      return false
+    end
+    
+    ### The server to which we are connected, or will 
+    ### try connecting to if none is specified with the
+    ### call to #connect
+    ###
+    ### @return [String] the hostname of the server
+    ###
+    def hostname
+      # return it if already set
+      return @server if @server
+      # otherwise, from the config
+      srvr = JSS::CONFIG.db_server_name
+      # otherwise, assume its on the JSS server to which this client talks
+      srvr ||= JSS::Client.jss_server
+      return srvr
+    end
+    
+    
     #### Aliases
 
     alias connected? connected

data/lib/jss-api/exceptions.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/ruby_extensions.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/ruby_extensions/filetest.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/ruby_extensions/hash.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/ruby_extensions/ipaddr.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/ruby_extensions/pathname.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/ruby_extensions/string.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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
@@ -40,4 +40,20 @@ class String
       else return nil
     end # case
   end # to bool
+  
+  ### Convert a string to a Time object
+  ###
+  ### returns nil if not parsable by JSS::parse_datetime
+  ###
+  ### @return [Time] the time represented by the string.
+  ###
+  def jss_to_time
+    begin
+      JSS.parse_time self
+    rescue
+      return nil
+    end
+  end
+
+  
 end # class

data/lib/jss-api/ruby_extensions/time.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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

data/lib/jss-api/server.rb

@@ -1,4 +1,4 @@
-### Copyright 2014 Pixar
+### 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