ruby-jss 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51cf70afc810fbee9ccdecf58e5dca6692d9a26b
-  data.tar.gz: d669472cf36975bdc4e4c4ce65392a7c1802f416
+  metadata.gz: 6681d7531f34a10d2ba31f13428c9391446a15ec
+  data.tar.gz: 80fae35e805326660e8cf0372ba14fd3bb3652f5
 SHA512:
-  metadata.gz: e4d5d398bff3f5c0a0bf92b02689cd5b03d2f9c9bbc1d961eea43790524962ba3348fd034c9c974ddd4be32a2afffed23fbdce2dd9549f0cfae0ec8da429b5ad
-  data.tar.gz: 50b93457bd8a8b5a2226d9374ced5baacfeaba6e9ab37d7e04836cbc3b0e95d829cff1a34ed701cdfe27497f6a1c80131effe2ce794e06fe3cdc35ffe03c905c
+  metadata.gz: fd89d7e838147899adcbed3042d795a632e182428567bb675965fa3850eb3956a30b4c8e975b453f77ac52e5ba97ada2cbdb950ac3ae1b409b8414ca898a30de
+  data.tar.gz: f755fabd0f11caddb9d20291842f774d141aa51c935d7e9cb0bacf5a0db58a1270aa7195546d8211c20f8d00786cc5f2e52265ca4d730210aaf439a387500018

data/data/ruby-jss.conf.example

@@ -0,0 +1,181 @@
+#####################
+#
+#     ruby-jss configuration.
+#
+# This file should be stored at /etc/ruby-jss.conf
+# on all machines that use ruby-jss
+#
+# A personal copy can also be stored in your home folder as
+# ~/.ruby-jss.conf  and the settings there will override those
+# from the system-wide file in /etc.
+#
+# When the JSS module is loaded, the conf files are read into
+# an instance of JSS::Configuration, and stored in the constant JSS::CONFIG
+#
+# The values loaded are used by default for making API and database connections.
+# However, they can be overridden per-connection by specifying values when
+# calling the #connect methods.
+#
+# The file format is one attribute per line, thus:
+#
+#     attr_name: value
+#
+# Lines that don't start with a known attribute name followed by a colon
+# are ignored. If an attribute is defined more than once, the last one wins.
+#
+# Known attributes are listed and defined in the ruby-jss.conf.default file
+# in the rubygem folder's data folder
+# (e.g. /Library/Ruby/Gems/2.0.0/gems/ruby-jss-0.6.3/data/ruby-jss.conf.default )
+#
+# The conf file may be edited with any text editor, however developers should
+# look at the manipulation methods in the JSS::Configuration class.
+#
+
+### - api_server_name
+###   The hostname of the server for JSS REST API connections.
+###
+###   *** REQUIRED ***
+###
+###   NOTE, this is the (fully-qualified) hostname, e.g.
+###   'casper.myorg.org'. Don't use a URL.
+###
+###   If you leave this blank:
+###   d3 will not work, nor any other code that expects a
+###   configured hostname
+###
+api_server_name:
+
+### - api_server_port
+###   The port for connecting to the JSS REST API
+###
+###   If you leave this blank:
+###   Defaults to 8443
+###
+api_server_port:
+
+### - api_ssl_version
+###   The SSL version to use for the API connection
+###
+###   If you leave this blank:
+###   Defaults to 'TLSv1'
+###
+api_ssl_version:
+
+### - api_verify_cert
+###   Should the API connections require a verifiable/trusted certificate?
+###   If you are using a self-signed cert. for your JSS, and have not
+###   deployed it as a trusted cert on all your clients, you should
+###   set this to 'false', and be aware of the risks.
+###
+###   If you leave this blank:
+###   Defaults to true
+###
+api_verify_cert:
+
+### - api_username
+###   The username to use when making an API connection.
+###
+###   *** REQUIRED ***
+###
+###   Note that the passwords are not storeable here!!
+###     see https://github.com/PixarAnimationStudios/ruby-jss/blob/master/README.md#passwords
+###
+###   If you leave this blank:
+###   d3 may break, as well as any other code that
+###   expects a configured api user name
+###
+api_username:
+
+### - api_timeout_open
+###   The timeout (in seconds) for connecting to the API
+###
+###   If you leave this blank:
+###   Defaults to 60
+###
+api_timeout_open:
+
+### - api_timeout
+###   The response timeout (in seconds) for API requests
+###
+###   If you leave this blank:
+###   Defaults to 60
+###
+api_timeout:
+
+### - db_server_name
+###   The hostname of the server for JSS MySQL connections.
+###
+###
+###   *** REQUIRED for d3 ***
+###
+###   Note: if you aren't accessing the database directly,
+###   you don't need this.  However, if you're using d3
+###   you will need this.
+###
+###   NOTE, this is the (fully-qualified) hostname, e.g.
+###   'casper.myorg.org'. Don't provide a URL.
+###
+###   If you leave this blank:
+###   d3 will break, and any other code that expects a
+###   configured database server name
+###
+db_server_name:
+
+### - db_server_port
+###   The port for MySQL connections
+###
+###   If you leave this blank:
+###   Defaults defaults to 3306
+###
+db_server_port:
+
+### - db_server_socket
+###   The MySQL socket path, if needed for local connections
+###
+###   If you leave this blank:
+###   Defaults to '/var/mysql/mysql.sock'
+###
+db_server_socket:
+
+### - db_username
+###   The username for MySQL connections
+###
+###   If you leave this blank:
+###   d3 might break, as well as any other code that expiects
+###   a configured db user name
+###
+db_username:
+
+### - db_name
+###
+###
+###   The name of the MySQL database that holds JSS data
+###
+###   If you leave this blank:
+###   Defaults to 'jamfsoftware'
+###
+db_name:
+
+### - db_connect_timeout
+###   The timeout (in seconds) for connecting to the database
+###
+###   If you leave this blank:
+###   Defaults to 60
+###
+db_connect_timeout:
+
+### - db_read_timeout
+###   The timeout (in seconds) for reading results from the database
+###
+###   If you leave this blank:
+###   Defaults to 60
+###
+db_read_timeout:
+
+### - db_write_timeout
+###   The timeout (in seconds) for writing to the database
+###
+###   If you leave this blank:
+###   Defaults to 60
+###
+db_write_timeout:

data/lib/jss.rb

@@ -27,6 +27,13 @@
 ###
 module JSS
 
+  ### The minimum Ruby version that works with this gem
+  MINIMUM_RUBY_VERSION = "2.0.0"
+
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new(MINIMUM_RUBY_VERSION)
+    raise "Can't use the JSS module, ruby itself must be version #{MINIMUM_RUBY_VERSION} or greater."
+  end
+
   #####################################
   ### Required Libraries, etc
   #####################################
@@ -61,6 +68,8 @@ module JSS
   ### in the deprecated 'jssuser' resource
   MINIMUM_SERVER_VERSION = "9.4"
 
+
+
   ### The current local UTC offset as a fraction of a day  (Time.now.utc_offset is the offset in seconds,
   ### 60*60*24 is the seconds in a day)
   TIME_ZONE_OFFSET =  Rational(Time.now.utc_offset, 60*60*24)

data/lib/jss/api_object/distribution_point.rb

@@ -483,7 +483,7 @@ module JSS
     ###
     def unmount
       return nil unless mounted?
-      if system "umount '#{@mountpoint}'"
+      if system "/sbin/umount '#{@mountpoint}'"
         @mountpoint.rmdir if @mountpoint.directory? and (not @mountpoint.mountpoint?)
         @mounted = false
       else

data/lib/jss/api_object/osx_configuration_profile.rb

@@ -1,31 +1,30 @@
 ### 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
   #####################################
@@ -34,103 +33,103 @@ module JSS
   ### Module Methods
   #####################################
 
-
+  
   #####################################
   ### Classes
   #####################################
 
-  ###
+  ### 
   ### An OS X Configuration Profile in the JSS.
   ###
   ### Note that the profile payloads and the profile UUID cannot be edited or updated with this via this class.
   ### Use the web UI.
   ###
   ### @see JSS::APIObject
-  ###
+  ### 
   class OSXConfigurationProfile < JSS::APIObject
-
+    
     #####################################
     ### Mix-Ins
     #####################################
     include JSS::Updatable
     include JSS::Scopable
     include JSS::SelfServable
-
+    
     #####################################
     ### Class Methods
     #####################################
-
+         
     #####################################
     ### Class Constants
     #####################################
-
+    
     ### The base for REST resources of this class
     RSRC_BASE = "osxconfigurationprofiles"
-
+    
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :os_x_configuration_profiles
-
+    
     ### The hash key used for the JSON object output.
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :os_x_configuration_profile
-
+    
     ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
     VALID_DATA_KEYS = [:distribution_method, :scope, :redeploy_on_update]
-
+    
     ### Our scopes deal with computers
     SCOPE_TARGET_KEY = :computers
-
+    
     ### Our SelfService happens on OSX
     SELF_SERVICE_TARGET = :osx
-
+    
     ### Our SelfService deploys profiles
     SELF_SERVICE_PAYLOAD = :profile
-
+    
     ### The possible values for the :distribution_method
     DISTRIBUTION_METHODS = ["Install Automatically", "Make Available in Self Service"]
-
+    
     SELF_SERVICE_DIST_METHOD = "Make Available in Self Service"
-
+    
     ### The possible values for :level
     LEVELS = ["user", "computer"]
-
-
+    
+    
     #####################################
     ### Attributes
     #####################################
-
+    
     ### @return [String] the description of this profile
     attr_reader :description
-
+    
     ### @return [String] the distribution_method of this profile
     attr_reader :distribution_method
-
+    
     ### @return [Boolean] can the user remove this profile
     attr_reader :user_removable
-
+    
     ### @return [String] the level (user/computer) of this profile
     attr_reader :level
-
+    
     ### @return [String] the uuid of this profile. NOT Updatable
     attr_reader :uuid
-
+    
     ### @return [Boolean] Should this profile be redeployed when an inventory update happens?
     attr_reader :redeploy_on_update
-
+    
     ### @return [String] the plist containing the payloads for this profile. NOT Updatable
     attr_reader :payloads
-
+    
     #####################################
-    ### Constructor
+    ### Constructor 
     #####################################
-
+    
     ###
     ### See JSS::APIObject#initialize
     ###
     def initialize (args = {})
-
+      
       super
-
+      
       @description = @main_subset[:description]
       @distribution_method = @main_subset[:distribution_method]
       @user_removable = @main_subset[:user_removable]
@@ -138,10 +137,10 @@ 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
 
     #####################################
@@ -158,8 +157,8 @@ module JSS
       @description = new_val.strip!
       @need_to_update = true
     end
-
-
+    
+    
     ###
     ### @param new_val[String] how should this be distributed to clients?
     ###
@@ -171,7 +170,7 @@ module JSS
       @distribution_method = new_val
       @need_to_update = true
     end
-
+    
     ###
     ### @param new_val[Boolean] should the user be able to remove this?
     ###
@@ -184,7 +183,7 @@ module JSS
       @user_removable = new_val
       @need_to_update = true
     end
-
+    
     ###
     ### @param new_val[String] the new level for this profile (user/computer)
     ###
@@ -196,53 +195,53 @@ module JSS
       @level = new_val
       @need_to_update = true
     end
-
-
+    
+    
     ###
     ### @return [Boolean] is this profile available in Self Service?
     ###
     def in_self_service?
       @distribution_method == SELF_SERVICE_DIST_METHOD
     end
-
-
+    
+    
     ###
     ### @return [Boolean] is this profile removable by the user?
     ###
     def user_removable?
       @user_removable
     end
-
-
-    ###
+    
+    
+    ### 
     ### @return [Hash] The payload plist parsed into a Ruby hash
     ###
     def parsed_payloads
       Plist.parse_xml @payloads
     end
-
+    
     ###
     ### @return [Array<Hash>] the individual payloads from the payload Plist
     ###
     def payload_content
       parsed_payloads['PayloadContent']
     end
-
+    
     ###
     ### @return [Array<String>] the PayloadType of each payload (e.g. com.apple.caldav.account)
     ###
     def payload_types
       payload_content.map{|p| p['PayloadType'] }
     end
-
+    
     #####################################
     ### Private Instance Methods
     #####################################
     private
-
+    
     def rest_xml
       doc = REXML::Document.new
-
+      
       obj = doc.add_element RSRC_OBJECT_KEY.to_s
       gen = obj.add_element('general')
       gen.add_element('description').text = @description
@@ -250,13 +249,13 @@ module JSS
       gen.add_element('user_removable').text = @user_removable
       gen.add_element('level').text = @level
       gen.add_element('redeploy_on_update').text = @redeploy_on_update
-
+      
       obj << @scope.scope_xml
       obj << self_service_xml
-
+      
       return doc.to_s
     end
-
+    
   end # class OSXConfigurationProfile
-
+  
 end # module

data/lib/jss/api_object/package.rb

@@ -572,7 +572,7 @@ module JSS
       mdp.unmount if unmount
     end # upload
 
-    ###
+
     ### Delete the filename from the master distribution point, if it exists.
     ###
     ### If you'll be uploading several files you can specify unmount as false, and do it manually when all
@@ -587,7 +587,7 @@ module JSS
     ###
     def delete_master_file (rw_pw, unmount = true)
       mdp = JSS::DistributionPoint.master_distribution_point
-      file = mdp.mount(rw_pw, :rw) +"#{DIST_POINT_PKGS_FOLDER}/#{@filename}"
+      file = mdp.mount(rw_pw, :rw) + "#{DIST_POINT_PKGS_FOLDER}/#{@filename}"
       if file.exist?
         file.delete
         did_it = true
@@ -599,6 +599,21 @@ module JSS
     end # delete master file
 
 
+    ### Delete this package from the JSS, optionally
+    ### deleting the master dist point file also.
+    ###
+    ### @param delete_file[Boolean] should the master dist point file be deleted?
+    ###
+    ### @param rw_pw[String] the password for the read/write account on the master Distribution Point
+    ###   or :prompt, or :stdin# where # is the line of stdin containing the password. See {JSS::DistributionPoint#mount}
+    ###
+    ### @param unmount[Boolean] whether or not ot unount the distribution point when finished.
+    ###
+    def delete  (delete_file: false, rw_pw: nil, unmount: true)
+      super()
+      delete_master_file(rw_pw,  unmount) if delete_file
+    end
+
     ### Install this package via the jamf binary 'install' command from the
     ### distribution point for this machine.
     ### See {JSS::DistributionPoint.my_distribution_point}

data/lib/jss/api_object/self_servable.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.
-###
+### 
 ###
 
 ###
@@ -41,19 +41,19 @@ module JSS
   ###
   ### The JSS objects that have Self Service data return it in a :self_service subset,
   ### which all have similar data, a hash with at least these keys:
-  ### - :self_service_description
-  ### - :self_service_icon
+  ### - :self_service_description 
+  ### - :self_service_icon 
   ###
   ### Most also have:
   ### - :feature_on_main_page
   ### - :self_service_categories
   ###
-  ### iOS Profiles in self service have this key:
-  ### - :security
+  ### iOS Profiles in self service have this key: 
+  ### - :security 
   ###
   ### Additionally, items that apper in OS X SlfSvc have these keys:
   ### - :install_button_text
-  ### - :force_users_to_view_description
+  ### - :force_users_to_view_description 
   ###
   ### See the attribute definitions for details of these values and structures.
   ###
@@ -71,14 +71,14 @@ module JSS
   ### - Define the constant SELF_SERVICE_PAYLOAD which contains one of :policy, :profile, or :app
   ### - Call {#parse_self_service} in the subclass's constructor after calling super
   ### - Include the result of {#self_service_xml} in their #rest_xml output
-  ### - Define the method #in_self_service? which returns a Boolean indicating that the item is
+  ### - Define the method #in_self_service? which returns a Boolean indicating that the item is 
   ###   available in self service. Different API objects indicate this in different ways.
   ### - Define the method #user_removable? which returns Boolean indicating that the item (a profile)
   ###   can be removed by the user in SSvc. OS X profiles store this in the :user_removable key of the
   ###   :general subset as a boolean, whereas iOS profiles stor it in :security as one of 3 strings
   ###
   ###
-  ### Notes:
+  ### Notes: 
   ### - Self service icons cannot be modified via this code. Use the Web UI.
   ### - There an API bug in handling categories, and all but the last one are ommitted. Until this is fixed, categories
   ###   cannot be saved via this code since that would cause data-loss when more than one category is applied.
@@ -90,19 +90,19 @@ module JSS
     #####################################
 
     SELF_SERVABLE = true
-
+    
     IOS_PROFILE_REMOVAL_OPTIONS = ["Always", "With Authorization", "Never"]
-
+    
     #####################################
     ###  Variables
     #####################################
-
-
+    
+    
     #####################################
     ###  Attribtues
     #####################################
 
-
+    
     ### @return [String] The verbage that appears in SelfSvc for this item
     attr_reader :self_service_description
 
@@ -127,7 +127,7 @@ module JSS
     ### - :display_in => [Boolean] should the item be displayed in this category in SSvc? (OSX SSvc only)
     ### - :feature_in => [Boolean] should the item be featured in this category in SSVC? (OSX SSvc only)
     ###
-    ### NOTE: as of Casper 9.61 there's a bug in the JSON output from the API, and only the last
+    ### NOTE: as of Casper 9.61 there's a bug in the JSON output from the API, and only the last 
     ### category is returned, if more than one are set.
     ###
     attr_reader :self_service_categories
@@ -145,7 +145,7 @@ module JSS
 
     ### @return [String] The text label on the install button in SSvc (OSX SSvc only)
     attr_reader :self_service_install_button_text
-
+    
     ### @return [Boolean] Should an extra window appear before the user can install the item? (OSX SSvc only)
     attr_reader :self_service_force_users_to_view_description
 
@@ -165,32 +165,32 @@ module JSS
     def parse_self_service
       @init_data[:self_service] ||= {}
       ss_data = @init_data[:self_service]
-
+      
       @self_service_description = ss_data[:self_service_description]
       @self_service_icon = ss_data[:self_service_icon]
-
+      
       @self_service_feature_on_main_page = ss_data[:feature_on_main_page]
-
+      
       # TEMPORARY - until JAMF fixes the category data in JSON
       @self_service_categories = [
         ss_data[:self_service_categories][:category]
       ]
-
+      
       # make this an empty hash if needed
       @self_service_security = ss_data[:security] || {}
-
-      # if this is an osx profile, set @self_service_security[:removal_disallowed] to "Always" or "Never"
+      
+      # if this is an osx profile, set @self_service_security[:removal_disallowed] to "Always" or "Never" 
       # to indicate the boolean :user_removable
       if @init_data[:general].keys.include? :user_removable
         @self_service_security[:removal_disallowed] = @init_data[:general][:user_removable] ? "Always" : "Never"
       end
-
+      
       @self_service_install_button_text = ss_data[:install_button_text]
       @self_service_force_users_to_view_description = ss_data[:force_users_to_view_description]
 
     end
 
-
+    
     ###
     ###
     ### Setters
@@ -218,9 +218,9 @@ module JSS
       @self_service_install_button_text = new_val.strip
       @need_to_update = true
     end
-
+    
     ###
-    ### @param new_val[Boolean] should this appear on the main SelfSvc page?
+    ### @param new_val[Boolean] should this appear on the main SelfSvc page? 
     ###
     ### @return [void]
     ###
@@ -230,9 +230,9 @@ module JSS
       @self_service_feature_on_main_page = new_val
       @need_to_update = true
     end
-
+    
     ###
-    ### @param new_val[Boolean] should this appear on the main SelfSvc page?
+    ### @param new_val[Boolean] should this appear on the main SelfSvc page? 
     ###
     ### @return [void]
     ###
@@ -243,7 +243,7 @@ module JSS
       @self_service_force_users_to_view_description = new_val
       @need_to_update = true
     end
-
+    
     ###
     ### Add or change one of the categories for this item in SSvc.
     ###
@@ -260,21 +260,21 @@ module JSS
       raise JSS::NoSuchItemError, "No category '#{new_cat}' in the JSS" unless JSS::Category.all_names(:refresh).include? new_cat
       raise JSS::InvalidDataError, "display_in must be true or false" unless JSS::TRUE_FALSE.include? display_in
       raise JSS::InvalidDataError, "feature_in must be true or false" unless JSS::TRUE_FALSE.include? feature_in
-
+      
       new_data = {:name => new_cat, :display_in => display_in, :feature_in => feature_in }
-
+      
       # see if this category is already among our categories.
       idx = @self_service_categories.index{|c| c[new_cat]}
-
-      if idx
+      
+      if idx 
         @self_service_categories[idx] = new_data
       else
         @self_service_categories << new_data
       end
-
+      
       @need_to_update = true
     end
-
+    
     ###
     ### Remove a category from those for this item in SSvc
     ###
@@ -296,18 +296,17 @@ module JSS
     ### @return [void]
     ###
     def profile_can_be_removed (new_val)
-
-      new_val = "Always" if new_val === true
+      
+      new_val = "Always" if new_val === true 
       new_val = "Never" if new_val === false
-
+      
       return nil if new_val == @self_service_security[:removal_disallowed]
       raise JSS::InvalidDataError, "" unless IOS_PROFILE_REMOVAL_OPTIONS.include? new_val
-
+      
       @self_service_security[:removal_disallowed] = new_val
     end
-
-
-
+    
+    
     ###
     ### @api private
     ###
@@ -318,16 +317,16 @@ module JSS
     ### @return [REXML::Element]
     ###
     def self_service_xml
-
+      
       ssvc = REXML::Element.new('self_service')
-
+      
       return ssvc unless self.in_self_service?
-
+      
       ssvc.add_element('self_service_description').text = @self_service_description
       ssvc.add_element('feature_on_main_page').text = @self_service_feature_on_main_page
-
+      
       ### TEMPORARY - re-enable this when the category bug is fixed.
-
+      
 #       cats = ssvc.add_element('self_service_categories')
 #       @self_service_categories.each do |cat|
 #         catelem = cats.add_element('category')
@@ -335,22 +334,22 @@ module JSS
 #         catelem.add_element('display_in').text = cat[:display_in] if cat.keys.include? :display_in
 #         catelem.add_element('feature_in').text = cat[:feature_in] if cat.keys.include? :feature_in
 #       end
-
+      
       unless @self_service_security.empty?
         sec = ssvc.add_element('security')
         sec.add_element('removal_disallowed').text = @self_service_security[:removal_disallowed] if @self_service_security[:removal_disallowed]
         sec.add_element('password').text = @self_service_security[:password] if @self_service_security[:password]
       end
-
+      
       ssvc.add_element('install_button_text').text = @self_service_install_button_text if @self_service_install_button_text
       ssvc.add_element('force_users_to_view_description').text = @self_service_force_users_to_view_description unless @self_service_force_users_to_view_description.nil?
 
       return ssvc
     end
-
+    
     ### aliases
     alias change_self_service_category add_self_service_category
-
+    
   end # module SelfServable
 
 end # module JSS

data/lib/jss/configuration.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.
-### 
+###
 ###
 
 ###
@@ -98,14 +98,17 @@ module JSS
     ### Class Constants
     #####################################
 
-    ### The filename for storing the prefs, globally or user-level
-    CONF_FILE = "jss_gem.conf"
+    ### The filename for storing the config, globally or user-level.
+    ### The first matching file is used - the array provides
+    ### backward compatibility with earlier versions.
+    ### Saving will always happen to the first filename
+    CONF_FILES = [ "ruby-jss.conf", "jss_gem.conf"]
 
     ### The Pathname to the machine-wide preferences plist
-    GLOBAL_CONF = Pathname.new "/etc/#{CONF_FILE}"
+    GLOBAL_CONFS =  CONF_FILES.map{|cf| Pathname.new "/etc/#{cf}"}
 
     ### The Pathname to the user-specific preferences plist
-    USER_CONF = ENV["HOME"] ? Pathname.new("~/.#{CONF_FILE}").expand_path : nil
+    USER_CONFS =  CONF_FILES.map{|cf| ENV["HOME"] ? Pathname.new("~/.#{cf}").expand_path : nil }.compact
 
     ### The attribute keys we maintain, and the type they should be stored as
     CONF_KEYS = {
@@ -175,7 +178,12 @@ module JSS
     ### @return [void]
     ###
     def read_global
-      read GLOBAL_CONF if GLOBAL_CONF.file? and GLOBAL_CONF.readable?
+      GLOBAL_CONFS.each { |gcf|
+        if gcf.file? and gcf.readable?
+          read gcf
+          return
+        end
+      }
     end
 
     ###
@@ -184,8 +192,12 @@ module JSS
     ### @return [void]
     ###
     def read_user
-      return unless USER_CONF
-      read USER_CONF if USER_CONF.file? and USER_CONF.readable?
+      USER_CONFS.each { |ucf|
+        if ucf.file? and ucf.readable?
+          read ucf
+          return
+        end
+      }
     end
 
 
@@ -217,37 +229,37 @@ module JSS
     ###
     def save(file)
       path = case file
-        when :global then GLOBAL_CONF
-        when :user then USER_CONF
+        when :global then GLOBAL_CONFS.first
+        when :user then USER_CONFS.first
         else Pathname.new(file)
       end
-      
+
       raise JSS::MissingDataError, "No HOME environment variable, can't write to user conf file." if path.nil?
-      
+
       # file already exists? read it in and update the values.
       if path.readable?
         data = path.read
-        
+
         # go thru the known attributes/keys
-        CONF_KEYS.keys.sort.each do |k| 
-          
+        CONF_KEYS.keys.sort.each do |k|
+
           # if the key exists, update it.
-          if data =~ /^#{k}:/ 
-            data.sub!(/^#{k}:.*$/, "#{k}: #{self.send k}") 
-          
+          if data =~ /^#{k}:/
+            data.sub!(/^#{k}:.*$/, "#{k}: #{self.send k}")
+
           # if not, add it to the end unless it's nil
           else
             data += "\n#{k}: #{self.send k}" unless self.send(k).nil?
-          end # if data =~ /^#{k}:/ 
-        end #each do |k| 
-        
+          end # if data =~ /^#{k}:/
+        end #each do |k|
+
       else # not readable, make a new file
         data = ""
-        CONF_KEYS.keys.sort.each do |k| 
-          data << "#{k}: #{self.send k}\n" unless self.send(k).nil? 
+        CONF_KEYS.keys.sort.each do |k|
+          data << "#{k}: #{self.send k}\n" unless self.send(k).nil?
         end
       end # if path readable
-      
+
       # make sure we end with a newline, the save it.
       data << "\n" unless data.end_with?("\n")
       path.jss_save data

data/lib/jss/db_connection.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.
-### 
+###
 ###
 
 ###
@@ -78,16 +78,19 @@ module JSS
     ### The name of the JSS database on the mysql server
     DEFAULT_DB_NAME = "jamfsoftware"
 
-    ### give the connection a 120 second timeout, for really slow
+    ### give the connection a 60 second timeout, for really slow
     ### net connections (like... from airplanes)
-    DFT_TIMEOUT = 120
+    DFT_TIMEOUT = 60
 
     ###
     DFT_SOCKET = '/var/mysql/mysql.sock'
-    
+
     ### the default MySQL port
     DFT_PORT = 3306
-    
+
+    ### The default encoding in the tables - JAMF wisely uses UTF-8
+    DFT_CHARSET = "utf8"
+
     ### the strftime format for reading/writing dates in the db
     SQL_DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
 
@@ -147,7 +150,7 @@ module JSS
       # 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[:port] ||= JSS::CONFIG.db_server_port
       args[:socket] ||= JSS::CONFIG.db_server_socket
@@ -169,6 +172,7 @@ module JSS
       args[:port] ||= Mysql::MYSQL_TCP_PORT
       args[:socket] ||= DFT_SOCKET
       args[:db_name] ||= DEFAULT_DB_NAME
+      args[:charset] ||= DFT_CHARSET
 
       begin
         @mysql.close if connected?
@@ -205,7 +209,7 @@ module JSS
       @mysql.options Mysql::OPT_CONNECT_TIMEOUT, @connect_timeout
       @mysql.options Mysql::OPT_READ_TIMEOUT, @read_timeout
       @mysql.options Mysql::OPT_WRITE_TIMEOUT, @write_timeout
-
+      @mysql.charset = args[:charset]
       @mysql.connect @server, @user , @pw , @mysql_name, @port, @socket
 
       @connected = true
@@ -224,7 +228,7 @@ module JSS
     ### it'll have to be re-connected before using again
     ###
     def disconnect
-      @mysql.close if connected?
+      @mysql.close if @mysql.protocol
       @server = nil
       @port = nil
       @socket = nil
@@ -235,7 +239,7 @@ module JSS
       @connected = false
       nil
     end # disconnect
-    
+
     ### Test that a given hostname is a MySQL server
     ###
     ### @param server[String] The hostname to test
@@ -245,13 +249,13 @@ module JSS
     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
@@ -259,8 +263,8 @@ module JSS
       end
       return false
     end
-    
-    ### The server to which we are connected, or will 
+
+    ### The server to which we are connected, or will
     ### try connecting to if none is specified with the
     ### call to #connect
     ###
@@ -275,8 +279,8 @@ module JSS
       srvr ||= JSS::Client.jss_server
       return srvr
     end
-    
-    
+
+
     #### Aliases
 
     alias connected? connected

data/lib/jss/utility.rb

@@ -118,7 +118,7 @@ module JSS
   ### This method tests a given OS, against a requirement list
   ### to see if the requirement is met.
   ###
-  ### @param requirement[String] The os requirement list, a comma-seprated string
+  ### @param requirement[String,Array] The os requirement list, a comma-seprated string
   ###   or array of strings of allows OSes. e.g. 10.7, 10.8.5 or 10.9.x
   ###
   ### @param processor[String] the os to check, defaults to
@@ -128,8 +128,10 @@ module JSS
   ###   given?
   ###
   def self.os_ok? (requirement, os_to_check = nil)
-    return true if requirement.to_s.empty? or requirement.to_s =~ /none/i
+    return true if requirement.to_s =~ /none/i
+    return true if requirement.to_s == 'n'
     requirement = JSS.to_s_and_a(requirement)[:arrayform]
+    return true if requirement.empty?
 
     os_to_check ||= `/usr/bin/sw_vers -productVersion`.chomp
 

data/lib/jss/version.rb

@@ -26,6 +26,6 @@
 module JSS
 
   ### The version of the JSS ruby gem
-  VERSION = "0.6.3"
+  VERSION = '0.6.4'
 
 end # module

data/lib/ruby-jss.rb

@@ -0,0 +1,2 @@
+# for those who require the gem name
+require 'jss'

metadata

@@ -1,71 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Chris Lasell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: ruby-mysql
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.9.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.9.12
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.2
 - !ruby/object:Gem::Dependency
   name: net-ldap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 description: |2
       The ruby-jss gem provides the JSS module, a framework for interacting with the REST API
       of the JAMF Software Server (JSS), the core of the Casper Suite, an enterprise/education
@@ -90,6 +102,7 @@ files:
 - THANKS.md
 - bin/cgrouper
 - bin/subnet-update
+- data/ruby-jss.conf.example
 - lib/jss-api.rb
 - lib/jss.rb
 - lib/jss/api_connection.rb
@@ -154,6 +167,7 @@ files:
 - lib/jss/server.rb
 - lib/jss/utility.rb
 - lib/jss/version.rb
+- lib/ruby-jss.rb
 homepage: http://pixaranimationstudios.github.io/ruby-jss/
 licenses:
 - Apache-2.0 WITH Modifications