ruby-jss 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4328e0cc23db07a92bfa3136ea036a84b614eb38
-  data.tar.gz: 9ec5ef3a805471764d22061b7a15e809eb966e27
+  metadata.gz: ba0289a3600d2d044211e9b13ee210fb6c10b7a2
+  data.tar.gz: 647f502e548e3f86345ce9992e20ec26fbe1a273
 SHA512:
-  metadata.gz: c3f80986485ec6620fc9f2b9ee45b6ce3bc68390a8db443abd1ad26362222602f09638b34600e6e378ebd2c61f771d8ba109a185013d0f9361763f18ab0fbb68
-  data.tar.gz: 1b8ebb3ffafc7562a3f9c4ad08cc8b562b1596d9c523ce69f57820016ee8d393e3b8009d27e5fdf7e9491fee2a739652e7accf56cc27713f5da4d76c277284b6
+  metadata.gz: dfebb20f13d49cd7677bc9e5fbb47ab668d5a98640cfdd3a4e97852c2cd22189c563cad9759972c5932e047ab31fdeb3cad9dce84c80c67f7e9c7e33f1f8d0f8
+  data.tar.gz: fb8761e60f48733df1f6047a4b1b324a1ece25d6c7dad6693b2a162cdd08d981921df20efb475716996f887b43f10b4c17c5029146387ca528199da9c3583950

data/CHANGES.md

@@ -1,5 +1,11 @@
 # Change History
 
+## v0.8.1 2017-06-07
+
+- Fix: Some objects failed to locate their 'main subset' (the chunk of API data that contains the object name and id) correctly.
+- Fix: Some versions of Gem::Version don't like dashes (which are part of SemVers).
+
+
 ## v0.8.1 2017-06-05
 
 - Improvement: Support for the new semantic versioning of Jamf products starting with Jamf Pro 9.99

data/lib/jss/api_object.rb

@@ -721,11 +721,12 @@ module JSS
     # @return [Hash] The part of the @init_data containg the :id and :name
     #
     def find_main_subset
+      return @init_data if @init_data[:id] && @init_data[:name]
+      return @init_data[:general] if @init_data[:general] && @init_data[:general][:id] && @init_data[:general][:name]
       @init_data.each do |key, value|
         next unless value.is_a? Hash
         return value if value.keys.include?(:id) && value.keys.include?(:name)
       end
-      @init_data
     end
 
     # parse category data during initialization

data/lib/jss/utility.rb

@@ -1,134 +1,132 @@
-### 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.
-###
-###
-
-###
+# 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.
+#
+#
+
+#
 module JSS
 
-  ### A collection of useful utility methods. Mostly for
-  ### converting values between formats, parsing data, and
-  ### user interaction.
-
-  ### Converts an OS Version into an Array of higher OS versions.
-  ###
-  ### It's unlikely that this library will still be in use as-is by the release of OS X 10.19.15.
-  ### Hopefully well before then JAMF will implement a "minimum OS" in the JSS itself.
-  ###
-  ### @param min_os [String] the mimimum OS version to expand, e.g. ">=10.6.7"  or "10.6.7"
-  ###
-  ### @return [Array] Nearly all potential OS versions from the minimum to 10.19.x.
-  ###
-  ### @example
-  ###   JSS.expand_min_os ">=10.6.7" # => returns this array
-  ###    # ["10.6.7",
-  ###    #  "10.6.8",
-  ###    #  "10.6.9",
-  ###    #  "10.6.10",
-  ###    #  "10.6.11",
-  ###    #  "10.6.12",
-  ###    #  "10.6.13",
-  ###    #  "10.6.14",
-  ###    #  "10.6.15",
-  ###    #  "10.7.x",
-  ###    #  "10.8.x",
-  ###    #  "10.9.x",
-  ###    #  "10.10.x",
-  ###    #  "10.11.x",
-  ###    #  "10.12.x",
-  ###    #  "10.13.x",
-  ###    #  "10.14.x",
-  ###    #  "10.15.x",
-  ###    #  "10.16.x",
-  ###    #  "10.17.x",
-  ###    #  "10.18.x",
-  ###    #  "10.19.x"]
-  ###
-  ###
-  def self.expand_min_os (min_os)
-
-    min_os = min_os.delete ">="
-
-    ### split the version into major, minor and maintenance release numbers
-    (maj,min,maint) = min_os.split(".")
-    maint = "x" if maint.nil? or maint == "0"
-
-    ### if the maint release number is an "x" just start the list of OK OS's with it
-    if maint == "x"
-      ok_oses = [maj + "." + min.to_s + ".x"]
-
-    ### otherwise, start with it and explicitly add all maint releases up to 15
-    ### (and hope apple doesn't do more than 15 maint releases for an OS)
+  # A collection of useful utility methods. Mostly for
+  # converting values between formats, parsing data, and
+  # user interaction.
+
+  # Converts an OS Version into an Array of higher OS versions.
+  #
+  # It's unlikely that this library will still be in use as-is by the release of OS X 10.19.15.
+  # Hopefully well before then JAMF will implement a "minimum OS" in the JSS itself.
+  #
+  # @param min_os [String] the mimimum OS version to expand, e.g. ">=10.6.7"  or "10.6.7"
+  #
+  # @return [Array] Nearly all potential OS versions from the minimum to 10.19.x.
+  #
+  # @example
+  #   JSS.expand_min_os ">=10.6.7" # => returns this array
+  #    # ["10.6.7",
+  #    #  "10.6.8",
+  #    #  "10.6.9",
+  #    #  "10.6.10",
+  #    #  "10.6.11",
+  #    #  "10.6.12",
+  #    #  "10.6.13",
+  #    #  "10.6.14",
+  #    #  "10.6.15",
+  #    #  "10.7.x",
+  #    #  "10.8.x",
+  #    #  "10.9.x",
+  #    #  "10.10.x",
+  #    #  "10.11.x",
+  #    #  "10.12.x",
+  #    #  "10.13.x",
+  #    #  "10.14.x",
+  #    #  "10.15.x",
+  #    #  "10.16.x",
+  #    #  "10.17.x",
+  #    #  "10.18.x",
+  #    #  "10.19.x"]
+  #
+  #
+  def self.expand_min_os(min_os)
+    min_os = min_os.delete '>='
+
+    # split the version into major, minor and maintenance release numbers
+    (maj, min, maint) = min_os.split('.')
+    maint = 'x' if maint.nil? || maint == '0'
+
+    # if the maint release number is an "x" just start the list of OK OS's with it
+    if maint == 'x'
+      ok_oses = [maj + '.' + min.to_s + '.x']
+
+    # otherwise, start with it and explicitly add all maint releases up to 15
+    # (and hope apple doesn't do more than 15 maint releases for an OS)
     else
       ok_oses = []
       (maint.to_i..15).each do |m|
-        ok_oses <<  maj + "." + min +"." + m.to_s
+        ok_oses << maj + '.' + min + '.' + m.to_s
       end # each m
     end
 
-    ### now account for all OS X versions starting with 10.
-    ### up to at least 10.19.x
+    # now account for all OS X versions starting with 10.
+    # up to at least 10.19.x
     ((min.to_i + 1)..19).each do |v|
-      ok_oses <<  maj + "." + v.to_s + ".x"
+      ok_oses << maj + '.' + v.to_s + '.x'
     end # each v
-    return ok_oses
+    ok_oses
   end
 
-  ### Scripts and packages can have processor limitations.
-  ### This method tests a given processor, against a requirement
-  ### to see if the requirement is met.
-  ###
-  ### @param requirement[String] The processor requirement.
-  ###   either 'ppc', 'x86', or some variation on "none", nil, or empty
-  ###
-  ### @param processor[String] the processor to check, defaults to
-  ###  the processor of the current machine. Any flavor of intel
+  # Scripts and packages can have processor limitations.
+  # This method tests a given processor, against a requirement
+  # to see if the requirement is met.
+  #
+  # @param requirement[String] The processor requirement.
+  #   either 'ppc', 'x86', or some variation on "none", nil, or empty
+  #
+  # @param processor[String] the processor to check, defaults to
+  #  the processor of the current machine. Any flavor of intel
   ##   is (i486, i386, x86-64, etc) is treated as "x86"
-  ###
-  ### @return [Boolean] can this pkg be installed with the processor
-  ###   given?
-  ###
-  def self.processor_ok? (requirement, processor = nil)
-
-    return true if requirement.to_s.empty? or requirement =~ /none/i
+  #
+  # @return [Boolean] can this pkg be installed with the processor
+  #   given?
+  #
+  def self.processor_ok?(requirement, processor = nil)
+    return true if requirement.to_s.empty? || requirement =~ /none/i
     processor ||= `/usr/bin/uname -p`
-    return requirement == (processor.to_s.include?("86") ? "x86" : "ppc")
+    requirement == (processor.to_s.include?('86') ? 'x86' : 'ppc')
   end
 
-  ### Scripts and packages can have OS limitations.
-  ### This method tests a given OS, against a requirement list
-  ### to see if the requirement is met.
-  ###
-  ### @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
-  ###  the os of the current machine.
-  ###
-  ### @return [Boolean] can this pkg be installed with the processor
-  ###   given?
-  ###
-  def self.os_ok? (requirement, os_to_check = nil)
+  # Scripts and packages can have OS limitations.
+  # This method tests a given OS, against a requirement list
+  # to see if the requirement is met.
+  #
+  # @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
+  #  the os of the current machine.
+  #
+  # @return [Boolean] can this pkg be installed with the processor
+  #   given?
+  #
+  def self.os_ok?(requirement, os_to_check = nil)
     return true if requirement.to_s =~ /none/i
     return true if requirement.to_s == 'n'
     requirement = JSS.to_s_and_a(requirement)[:arrayform]
@@ -143,164 +141,158 @@ module JSS
     #   "10.8.x" /^10\.8\.?\d*$/
     req_regexps = requirement.map do |r|
       if r.end_with?('.x')
-        /^#{r.chomp('.x').gsub('.','\.')}\.?\d*$/
+        /^#{r.chomp('.x').gsub('.', '\.')}\.?\d*$/
 
       elsif r =~ /^\d+\.\d+$/
-        /^#{r.gsub('.','\.')}(.0)?$/
+        /^#{r.gsub('.', '\.')}(.0)?$/
 
       else
-        /^#{r.gsub('.','\.')}$/
+        /^#{r.gsub('.', '\.')}$/
       end
     end
 
-    req_regexps.each{|re| return true if os_to_check =~ re  }
-    return false
+    req_regexps.each { |re| return true if os_to_check =~ re }
+    false
   end
 
-
-  ### Given a list of data as a comma-separated string, or an Array of strings,
-  ### return a Hash with both versions.
-  ###
-  ### Some parts of the JSS require lists as comma-separated strings, while
-  ### often those data are easier work with as arrays. This method is a handy way
-  ### to get either form when given either form.
-  ###
-  ### @param somedata [String, Array] the data to parse, of either class,
-  ###
-  ### @return [Hash{:stringform => String, :arrayform => Array}] the data as both comma-separated String and Array
-  ###
-  ### @example
-  ###   JSS.to_s_and_a "foo, bar, baz" # Hash => {:stringform => "foo, bar, baz", :arrayform => ["foo", "bar", "baz"]}
-  ###
-  ###   JSS.to_s_and_a ["foo", "bar", "baz"] # Hash => {:stringform => "foo, bar, baz", :arrayform => ["foo", "bar", "baz"]}
-  ###
-  def self.to_s_and_a (somedata)
+  # Given a list of data as a comma-separated string, or an Array of strings,
+  # return a Hash with both versions.
+  #
+  # Some parts of the JSS require lists as comma-separated strings, while
+  # often those data are easier work with as arrays. This method is a handy way
+  # to get either form when given either form.
+  #
+  # @param somedata [String, Array] the data to parse, of either class,
+  #
+  # @return [Hash{:stringform => String, :arrayform => Array}] the data as both comma-separated String and Array
+  #
+  # @example
+  #   JSS.to_s_and_a "foo, bar, baz" # Hash => {:stringform => "foo, bar, baz", :arrayform => ["foo", "bar", "baz"]}
+  #
+  #   JSS.to_s_and_a ["foo", "bar", "baz"] # Hash => {:stringform => "foo, bar, baz", :arrayform => ["foo", "bar", "baz"]}
+  #
+  def self.to_s_and_a(somedata)
     case somedata
-      when nil
-        valstr = ""
-        valarr = []
-      when String
-        valstr = somedata
-        valarr = somedata.split(/,\s*/)
-      when Array
-        valstr = somedata.join ", "
-        valarr = somedata
-      else
-        raise JSS::InvalidDataError, "Input must be a comma-separated String or an Array of Strings"
+    when nil
+      valstr = ''
+      valarr = []
+    when String
+      valstr = somedata
+      valarr = somedata.split(/,\s*/)
+    when Array
+      valstr = somedata.join ', '
+      valarr = somedata
+    else
+      raise JSS::InvalidDataError, 'Input must be a comma-separated String or an Array of Strings'
     end # case
-    return {:stringform => valstr, :arrayform => valarr}
+    { stringform: valstr, arrayform: valarr }
   end # to_s_and_a
 
-  ### Parse a plist into a Ruby data structure.
-  ### This enhances Plist::parse_xml taking file paths, as well as XML Strings
-  ### and reading the files regardless of binary/XML format.
-  ###
-  ### @param plist[Pathname, String] the plist XML, or the path to a plist file
-  ###
-  ### @return [Object] the parsed plist as a ruby hash,array, etc.
-  ###
-  def self.parse_plist (plist)
-
+  # Parse a plist into a Ruby data structure.
+  # This enhances Plist::parse_xml taking file paths, as well as XML Strings
+  # and reading the files regardless of binary/XML format.
+  #
+  # @param plist[Pathname, String] the plist XML, or the path to a plist file
+  #
+  # @return [Object] the parsed plist as a ruby hash,array, etc.
+  #
+  def self.parse_plist(plist)
     # did we get a string of xml, or a string pathname?
     case plist
     when String
-      if plist.include? "</plist>"
-        return Plist.parse_xml plist
-      else
-        plist = Pathname.new plist
-      end
+      return Plist.parse_xml plist if plist.include? '</plist>'
+      plist = Pathname.new plist
     when Pathname
       true
     else
-      raise ArgumentError, "Argument must be a path (as a Pathname or String) or a String of XML"
+      raise ArgumentError, 'Argument must be a path (as a Pathname or String) or a String of XML'
     end # case plist
 
     # if we're here, its a Pathname
     raise JSS::MissingDataError, "No such file: #{plist}" unless plist.file?
 
-    return Plist.parse_xml `/usr/libexec/PlistBuddy -x -c print #{Shellwords.escape(plist.to_s)}`
-
+    Plist.parse_xml `/usr/libexec/PlistBuddy -x -c print #{Shellwords.escape(plist.to_s)}`
   end # parse_plist
 
-
-  ### Converts anything that responds to #to_s to a Time, or nil
-  ###
-  ### Return nil if the item is nil, 0 or an empty String.
-  ###
-  ### Otherwise the item converted to a string, and parsed with DateTime.parse.
-  ### It is then examined to see if it has a UTC offset. If not, the local offset
-  ### is applied, then the DateTime is converted to a Time.
-  ###
-  ### @param a_datetime [#to_s] The thing to convert to a time.
-  ###
-  ### @return [Time, nil] nil is returned if a_datetime is nil, 0 or an empty String.
-  ###
+  # Converts anything that responds to #to_s to a Time, or nil
+  #
+  # Return nil if the item is nil, 0 or an empty String.
+  #
+  # Otherwise the item converted to a string, and parsed with DateTime.parse.
+  # It is then examined to see if it has a UTC offset. If not, the local offset
+  # is applied, then the DateTime is converted to a Time.
+  #
+  # @param a_datetime [#to_s] The thing to convert to a time.
+  #
+  # @return [Time, nil] nil is returned if a_datetime is nil, 0 or an empty String.
+  #
   def self.parse_time(a_datetime)
     return nil if NIL_DATES.include? a_datetime
 
     the_dt = DateTime.parse(a_datetime.to_s)
 
-    ### The microseconds in DateTimes are stored as a fraction of a day.
-    ### Convert them to an integer of microseconds
+    # The microseconds in DateTimes are stored as a fraction of a day.
+    # Convert them to an integer of microseconds
     usec = (the_dt.sec_fraction * 60 * 60 * 24 * (10**6)).to_i
 
-    ### if the UTC offset of the datetime is zero, make a new one with the correct local offset
-    ### (which might also be zero if we happen to be in GMT)
-    if the_dt.offset == 0
-      the_dt =  DateTime.new(the_dt.year, the_dt.month, the_dt.day, the_dt.hour, the_dt.min, the_dt.sec, JSS::TIME_ZONE_OFFSET)
+    # if the UTC offset of the datetime is zero, make a new one with the correct local offset
+    # (which might also be zero if we happen to be in GMT)
+    if the_dt.offset.zero?
+      the_dt = DateTime.new(the_dt.year, the_dt.month, the_dt.day, the_dt.hour, the_dt.min, the_dt.sec, JSS::TIME_ZONE_OFFSET)
     end
     # now convert it to a Time and return it
     Time.at the_dt.strftime('%s').to_i, usec
+  end # parse_time
+
+  # Deprecated - to be eventually removed in favor of
+  # the more-appropriately named JSS::parse_time
+  #
+  # @see JSS::parse_time
+  #
+  def self.parse_datetime(a_datetime)
+    parse_time(a_datetime)
+  end
 
-  end #parse_time
-
-  ### Deprecated - to be eventually removed in favor of
-  ### the more-appropriately named JSS::parse_time
-  ###
-  ### @see JSS::parse_time
-  ###
-  def self.parse_datetime(a_datetime) ; self.parse_time(a_datetime) ; end
-
-  ### Converts JSS epoch (unix epoch + milliseconds) to a Ruby Time object
-  ###
-  ### @param epoch[String, Integer, nil]
-  ###
-  ### @return [Time, nil] nil is returned if epoch is nil, 0 or an empty String.
-  ###
+  # Converts JSS epoch (unix epoch + milliseconds) to a Ruby Time object
+  #
+  # @param epoch[String, Integer, nil]
+  #
+  # @return [Time, nil] nil is returned if epoch is nil, 0 or an empty String.
+  #
   def self.epoch_to_time(epoch)
     return nil if NIL_DATES.include? epoch
     Time.at(epoch.to_i / 1000.0)
-  end #parse_date
-
-  ### Given a string of xml element text, escape any characters that would make XML unhappy.
-  ###   * & => &amp;
-  ###   * " => &quot;
-  ###   * < => &lt;
-  ###   * > => &gt;
-  ###   * ' => &apos;
-  ###
-  ### @param string [String] the string to make xml-compliant.
-  ###
-  ### @return [String] the xml-compliant string
-  ###
+  end # parse_date
+
+  # Given a string of xml element text, escape any characters that would make XML unhappy.
+  #   * & => &amp;
+  #   * " => &quot;
+  #   * < => &lt;
+  #   * > => &gt;
+  #   * ' => &apos;
+  #
+  # @param string [String] the string to make xml-compliant.
+  #
+  # @return [String] the xml-compliant string
+  #
   def self.escape_xml(string)
     string.gsub(/&/, '&amp;').gsub(/\"/, '&quot;').gsub(/>/, '&gt;').gsub(/</, '&lt;').gsub(/'/, '&apos;')
   end
 
-  ### Given an element name and an array of content, generate an Array of
-  ### REXML::Element objects with that name, and matching content.
-  ### The array of REXML elements would render thus:
-  ###     <foo>bar</foo>
-  ###     <foo>morefoo</foo>
-  ###
-  ### @param element [#to_s] an element_name like :foo
-  ###
-  ### @param list [Array<#to_s>] an Array of element content such as ["bar", :morefoo]
-  ###
-  ### @return [Array<REXML::Element>]
-  ###
-  def self.array_to_rexml_array(element,list)
-    raise JSS::InvalidDataError, "Arg. must be an Array." unless list.kind_of? Array
+  # Given an element name and an array of content, generate an Array of
+  # REXML::Element objects with that name, and matching content.
+  # The array of REXML elements would render thus:
+  #     <foo>bar</foo>
+  #     <foo>morefoo</foo>
+  #
+  # @param element [#to_s] an element_name like :foo
+  #
+  # @param list [Array<#to_s>] an Array of element content such as ["bar", :morefoo]
+  #
+  # @return [Array<REXML::Element>]
+  #
+  def self.array_to_rexml_array(element, list)
+    raise JSS::InvalidDataError, 'Arg. must be an Array.' unless list.is_a? Array
     element = element.to_s
     list.map do |v|
       e = REXML::Element.new(element)
@@ -309,26 +301,26 @@ module JSS
     end
   end
 
-  ### Given a simple Hash, convert it to an array of REXML Elements such that each
-  ### key becomes an element, and its value becomes the text content of
-  ### that element
-  ###
-  ### @example
-  ###   my_hash = {:foo => "bar", :baz => :morefoo}
-  ###   xml = JSS.hash_to_rexml_array(my_hash)
-  ###   xml.each{|x| puts x }
-  ###
-  ###   <foo>bar</foo>
-  ###   <baz>morefoo</baz>
-  ###
-  ### @param hash [Hash{#to_s => #to_s}] the Hash to convert
-  ###
-  ### @return [Array<REXML::Element>] the Array of REXML elements.
-  ###
+  # Given a simple Hash, convert it to an array of REXML Elements such that each
+  # key becomes an element, and its value becomes the text content of
+  # that element
+  #
+  # @example
+  #   my_hash = {:foo => "bar", :baz => :morefoo}
+  #   xml = JSS.hash_to_rexml_array(my_hash)
+  #   xml.each{|x| puts x }
+  #
+  #   <foo>bar</foo>
+  #   <baz>morefoo</baz>
+  #
+  # @param hash [Hash{#to_s => #to_s}] the Hash to convert
+  #
+  # @return [Array<REXML::Element>] the Array of REXML elements.
+  #
   def self.hash_to_rexml_array(hash)
-    raise InvalidDataError, "Arg. must be a Hash." unless hash.kind_of? Hash
+    raise InvalidDataError, 'Arg. must be a Hash.' unless hash.is_a? Hash
     ary = []
-    hash.each_pair do |k,v|
+    hash.each_pair do |k, v|
       el = REXML::Element.new k.to_s
       el.text = v
       ary << el
@@ -336,39 +328,39 @@ module JSS
     ary
   end
 
-  ### Given an Array of Hashes with :id and/or :name keys, return
-  ### a single REXML element with a sub-element for each item,
-  ### each of which contains a :name or :id element.
-  ###
-  ### @param list_element [#to_s] the name of the XML element that contains the list.
-  ### e.g. :computers
-  ###
-  ### @param item_element [#to_s] the name of each XML element in the list,
-  ### e.g. :computer
-  ###
-  ### @param item_list [Array<Hash>] an Array of Hashes each with a :name or :id key.
-  ###
-  ### @param content [Symbol] which hash key should be used as the content of if list item? Defaults to :name
-  ###
-  ### @return [REXML::Element] the item list as REXML
-  ###
-  ### @example
-  ###   comps = [{:id=>2,:name=>'kimchi'},{:id=>5,:name=>'mantis'}]
-  ###   xml = JSS.item_list_to_rexml_list(:computers, :computer , comps, :name)
-  ###   puts xml
-  ###   # output manually formatted for clarity. No newlines in the real xml string
-  ###   <computers>
-  ###     <computer>
-  ###       <name>kimchi</name>
-  ###     </computer>
-  ###     <computer>
-  ###       <name>mantis</name>
-  ###     </computer>
-  ###   </computers>
-  ###
-  ###   # if content is :id, then, eg. <name>kimchi</name> would be <id>2</id>
-  ###
-  def self.item_list_to_rexml_list(list_element, item_element , item_list, content = :name)
+  # Given an Array of Hashes with :id and/or :name keys, return
+  # a single REXML element with a sub-element for each item,
+  # each of which contains a :name or :id element.
+  #
+  # @param list_element [#to_s] the name of the XML element that contains the list.
+  # e.g. :computers
+  #
+  # @param item_element [#to_s] the name of each XML element in the list,
+  # e.g. :computer
+  #
+  # @param item_list [Array<Hash>] an Array of Hashes each with a :name or :id key.
+  #
+  # @param content [Symbol] which hash key should be used as the content of if list item? Defaults to :name
+  #
+  # @return [REXML::Element] the item list as REXML
+  #
+  # @example
+  #   comps = [{:id=>2,:name=>'kimchi'},{:id=>5,:name=>'mantis'}]
+  #   xml = JSS.item_list_to_rexml_list(:computers, :computer , comps, :name)
+  #   puts xml
+  #   # output manually formatted for clarity. No newlines in the real xml string
+  #   <computers>
+  #     <computer>
+  #       <name>kimchi</name>
+  #     </computer>
+  #     <computer>
+  #       <name>mantis</name>
+  #     </computer>
+  #   </computers>
+  #
+  #   # if content is :id, then, eg. <name>kimchi</name> would be <id>2</id>
+  #
+  def self.item_list_to_rexml_list(list_element, item_element, item_list, content = :name)
     xml_list = REXML::Element.new  list_element.to_s
     item_list.each do |i|
       xml_list.add_element(item_element.to_s).add_element(content.to_s).text = i[content]
@@ -376,41 +368,41 @@ module JSS
     xml_list
   end
 
-  ### Parse a JSS Version number into something comparable.
-  ###
-  ### With Jamf Pro 9.99, "Semantic Versioning" is used, see http://semver.org/
-  ###
-  ### For versions less than 9.99 parsing is like this:
-  ###   - Digits before the first dot are the Major Version
-  ###   - The first digit after the first dot is the Minor Version
-  ###   - Any other digits after the first dot but before a non-digit
-  ###     are the Revision
-  ###   - Anything after a second dot is the build identifier
-  ###   - Any non-digit anywhere means that it and everything after it
-  ###     are the build identifier
-  ###
-  ### So 9.32 becomes major-9, minor-3, rev-2, build-''
-  ### and 9.32.3764 becomes major-9, minor-3, rev-2, build-3764
-  ### and 9.32a3764 becomes major-9, minor-3, rev-2, build-a3764
-  ### and 9.32a1234.t234 becomes major-9, minor-3, rev-2, build-a1234.t234
-  ###
-  ### This old style method of parsing will break if digits between the first
-  ### dot and the second (or the end) ever gets above 99, since '100' will
-  ### become minor-1, rev-0
-  ###
-  ### This method returns a Hash with these keys:
-  ### * :major => the major version, Integer
-  ### * :minor => the minor version, Integor
-  ### * :maint => the revision, Integer
-  ###   (this is also available with the keys :patch and :revision)
-  ### * :build => the revision, String
-  ### * :version => a Gem::Version object built from :major, :minor, :revision
-  ###   which can be easily compared with other Gem::Version objects.
-  ###
-  ### @param version[String] a JSS version number from the API
-  ###
-  ### @return [Hash{Symbol => String, Gem::Version}] the parsed version data.
-  ###
+  # Parse a JSS Version number into something comparable.
+  #
+  # With Jamf Pro 9.99, "Semantic Versioning" is used, see http://semver.org/
+  #
+  # For versions less than 9.99 parsing is like this:
+  #   - Digits before the first dot are the Major Version
+  #   - The first digit after the first dot is the Minor Version
+  #   - Any other digits after the first dot but before a non-digit
+  #     are the Revision
+  #   - Anything after a second dot is the build identifier
+  #   - Any non-digit anywhere means that it and everything after it
+  #     are the build identifier
+  #
+  # So 9.32 becomes major-9, minor-3, rev-2, build-''
+  # and 9.32.3764 becomes major-9, minor-3, rev-2, build-3764
+  # and 9.32a3764 becomes major-9, minor-3, rev-2, build-a3764
+  # and 9.32a1234.t234 becomes major-9, minor-3, rev-2, build-a1234.t234
+  #
+  # This old style method of parsing will break if digits between the first
+  # dot and the second (or the end) ever gets above 99, since '100' will
+  # become minor-1, rev-0
+  #
+  # This method returns a Hash with these keys:
+  # * :major => the major version, Integer
+  # * :minor => the minor version, Integor
+  # * :maint => the revision, Integer
+  #   (this is also available with the keys :patch and :revision)
+  # * :build => the revision, String
+  # * :version => a Gem::Version object built from :major, :minor, :revision
+  #   which can be easily compared with other Gem::Version objects.
+  #
+  # @param version[String] a JSS version number from the API
+  #
+  # @return [Hash{Symbol => String, Gem::Version}] the parsed version data.
+  #
   def self.parse_jss_version(version)
     major, second_part, *_rest = version.split('.')
     raise JSS::InvalidDataError, 'JSS Versions must start with "x.x" where x is one or more digits' unless major =~ /\d$/ && second_part =~ /^\d/
@@ -434,11 +426,11 @@ module JSS
       maint:  revision.to_i,
       patch:  revision.to_i,
       build:  build,
-      version: Gem::Version.new(version)
+      # version: Gem::Version.new(version)
+      version: Gem::Version.new("#{major}.#{minor}.#{revision}#{build}")
     }
   end # parse_jss_version_oldstyle
 
-
   # (see parse_jss_version)
   def self.parse_jss_version_oldstyle(version)
     version =~ /^(\d+?)\.(.*)$/
@@ -475,49 +467,47 @@ module JSS
     }
   end # parse_jss_version_oldstyle
 
-  ### @return [Boolean] is this code running as root?
-  ###
+  # @return [Boolean] is this code running as root?
+  #
   def self.superuser?
-    Process.euid == 0
+    Process.euid.zero?
   end
 
-  ### Retrive one or all lines from whatever was piped to standard input.
-  ###
-  ### Standard input is read completely the first time this method is called
-  ### and the lines are stored as an Array in the module var @@stdin_lines
-  ###
-  ### @param line[Integer] which line of stdin is being retrieved.
-  ###  The default is zero (0) which returns all of stdin as a single string.
-  ###
-  ### @return [String, nil] the requested ling of stdin, or nil if it doesn't exist.
-  ###
+  # Retrive one or all lines from whatever was piped to standard input.
+  #
+  # Standard input is read completely the first time this method is called
+  # and the lines are stored as an Array in the module var @stdin_lines
+  #
+  # @param line[Integer] which line of stdin is being retrieved.
+  #  The default is zero (0) which returns all of stdin as a single string.
+  #
+  # @return [String, nil] the requested ling of stdin, or nil if it doesn't exist.
+  #
   def self.stdin(line = 0)
-    @@stdin_lines ||= ($stdin.tty? ? [] : $stdin.read.lines.map{|line| line.chomp("\n") })
+    @stdin_lines ||= ($stdin.tty? ? [] : $stdin.read.lines.map { |l| l.chomp("\n") })
 
-    return @@stdin_lines.join("\n") if line <= 0
+    return @stdin_lines.join("\n") if line <= 0
     idx = line - 1
-    return @@stdin_lines[idx]
+    @stdin_lines[idx]
   end
 
-  ### Prompt for a password in a terminal.
-  ###
-  ### @param message [String] the prompt message to display
-  ###
-  ### @return [String] the text typed by the user
-  ###
+  # Prompt for a password in a terminal.
+  #
+  # @param message [String] the prompt message to display
+  #
+  # @return [String] the text typed by the user
+  #
   def self.prompt_for_password(message)
-
     begin
       $stdin.reopen '/dev/tty' unless $stdin.tty?
       $stderr.print "#{message} "
-      system "/bin/stty -echo"
+      system '/bin/stty -echo'
       pw = $stdin.gets.chomp("\n")
       puts
     ensure
-      system "/bin/stty echo"
+      system '/bin/stty echo'
     end # begin
-    return pw
+    pw
   end
 
-
 end # module

data/lib/jss/version.rb

@@ -27,6 +27,6 @@
 module JSS
 
   ### The version of the JSS ruby gem
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.8.2'.freeze
 
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist