ruby-jss 0.7.0 → 0.8.1

data/lib/jss/db_connection.rb

@@ -141,6 +141,12 @@ module JSS
     ### @return [true] the connection was successfully made.
     ###
     def connect(args = {})
+      begin
+        disconnect if @connected
+      rescue Mysql::ClientError::ServerGoneError
+        @connected = false
+      end
+
       # server might come frome several places
       # if not given in the args, use #hostname to figure out
       # which
@@ -161,11 +167,7 @@ module JSS
       args[:read_timeout] ||= args[:timeout] ? args[:timeout] : DFT_TIMEOUT
       args[:write_timeout] ||= args[:timeout] ? args[:timeout] : DFT_TIMEOUT
 
-      begin
-        @mysql.close if connected?
-      rescue Mysql::ClientError::ServerGoneError
-        @connected = false
-      end
+
 
       @port = args[:port]
       @socket = args[:socket]

data/lib/jss/exceptions.rb

@@ -1,96 +1,104 @@
 ### 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
-  
+
   #####################################
   ### Exceptions
   #####################################
-  
-  ### 
-  ### MissingDataError - raise this error when we 
+
+  ###
+  ### MissingDataError - raise this error when we
   ### are missing args, or other simliar stuff.
-  ### 
+  ###
   class MissingDataError < RuntimeError; end
-  
-  ### 
-  ### InvalidDataError - raise this error when 
+
+  ###
+  ### InvalidDataError - raise this error when
   ### a data item isn't what we expected.
-  ### 
+  ###
   class InvalidDataError < RuntimeError; end
-  
-  ### 
-  ### InvalidConnectionError - raise this error when we 
+
+  ###
+  ### InvalidConnectionError - raise this error when we
   ### don't have a usable connection to a network service, or
   ### don't have proper authentication/authorization.
-  ### 
+  ###
   class InvalidConnectionError < RuntimeError; end
-  
-  ### 
-  ### NoSuchItemError - raise this error when 
+
+  ###
+  ### NoSuchItemError - raise this error when
   ### a desired item doesn't exist.
-  ### 
+  ###
   class NoSuchItemError < RuntimeError; end
-  
-  ### 
-  ### AlreadyExistsError - raise this error when 
+
+  ###
+  ### AlreadyExistsError - raise this error when
   ### trying to create something that already exists.
-  ### 
+  ###
   class AlreadyExistsError < RuntimeError; end
-  
-  ### 
-  ### FileServiceError - raise this error when 
+
+  ###
+  ### FileServiceError - raise this error when
   ### there's a problem accessing file service on a
   ### distribution point.
-  ### 
+  ###
   class FileServiceError < RuntimeError; end
-  
+
   ###
-  ### UnmanagedError - raise this when we 
-  ### try to do something managerial to 
+  ### UnmanagedError - raise this when we
+  ### try to do something managerial to
   ### an unmanaged object
   ###
   class UnmanagedError <  RuntimeError; end
-  
+
   ###
-  ### UnsupportedError - raise this when we 
+  ### UnsupportedError - raise this when we
   ### try to do something not yet supported
   ###
   class UnsupportedError <  RuntimeError; end
-  
+
   ###
-  ### TimeoutError - raise this when we 
+  ### TimeoutError - raise this when we
   ### try to do and it times out
   ###
   class TimeoutError <  RuntimeError; end
-  
+
   ###
-  ### AuthenticationError - raise this when 
+  ### AuthenticationError - raise this when
   ### a name/pw are wrong
   ###
   class AuthenticationError <  RuntimeError; end
-  
-end # module JSS
+
+  ###
+  ### ConflictError - raise this when
+  ### attempts to PUT or PUSH to the API
+  ### result in a 409 Conflict http error.
+  ### See JSS::APIConnect.instance.raise_conflict_error
+  ###
+  class ConflictError <  RuntimeError; end
+
+end  # module JSS

data/lib/jss/ruby_extensions.rb

@@ -1,29 +1,29 @@
 ### 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.
-### 
+###
 ###
 
-### All monkey-patched convenience methods are either prefixed with "jss_"  or 
+### All monkey-patched convenience methods are either prefixed with "jss_"  or
 ### if they are type coercions, "to_jss_"
 ###
 
@@ -31,6 +31,7 @@
 require "jss/ruby_extensions/filetest.rb"
 require "jss/ruby_extensions/hash.rb"
 require "jss/ruby_extensions/ipaddr.rb"
+require "jss/ruby_extensions/object.rb"
 require "jss/ruby_extensions/pathname.rb"
 require "jss/ruby_extensions/time.rb"
 require "jss/ruby_extensions/string.rb"

data/lib/jss/ruby_extensions/object.rb

@@ -0,0 +1,19 @@
+# Extensions to Ruby Objects for use within the JSS module
+class Object
+
+  # is an object an explict true or false?
+  #
+  # TODO: globally replace
+  #      `JSS::TRUE_FALSE.include? xxx`
+  #   with
+  #      `xxx.jss_boolean?`
+  #
+  #
+  # @return [Boolean]
+  #
+  def jss_boolean?
+    [true, false].include? self
+  end
+  alias jss_bool? jss_boolean?
+
+end

data/lib/jss/utility.rb

@@ -376,62 +376,104 @@ module JSS
     xml_list
   end
 
-  ### Parse a JSS Version number into something comparable
+  ### Parse a JSS Version number into something comparable.
   ###
-  ### Unfortunately, the JSS version numbering is inconsistant and improper at the moment.
-  ### Version 9.32 should be version 9.3.2, so that it
-  ### will be recognizable as being less than 9.4
+  ### With Jamf Pro 9.99, "Semantic Versioning" is used, see http://semver.org/
   ###
-  ### To work around this until JAMF standardizes version numbering,
-  ### we will assume any digits before the first dot is the major version
-  ### and the first digit after the first dot is the minor version
-  ### and anything else, including other dots, is the revision
+  ### 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
   ###
-  ### If that revision starts with a dot, it is removed.
-  ### so 9.32 becomes  major-9, minor-3, rev-2
-  ### and 9.32.3764 becomes major-9, minor-3, rev-2.3764
-  ### and 9.3.2.3764 becomes major-9, minor-3, rev-2.3764
+  ### 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 method of parsing will break if the minor revision
-  ### ever gets above 9.
+  ### 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
   ###
-  ### Returns a hash with these keys:
+  ### This method returns a Hash with these keys:
   ### * :major => the major version, Integer
   ### * :minor => the minor version, Integor
-  ### * :revision => the revision, String
-  ### * :version => a Gem::Version object built from the above keys, which is easily compared to others.
+  ### * :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)
-    spl = version.split('.')
-
-    case spl.count
-      when 1
-        major = spl[0].to_i
-        minor = 0
-        revision = '0'
-      when 2
-        major = spl[0].to_i
-        minor = spl[1][0,1].to_i
-        revision = spl[1][1..-1]
-        revision = '0' if revision.empty?
-      else
-        major = spl[0].to_i
-        minor = spl[1][0,1].to_i
-        revision = spl[1..-1].join('.')[1..-1]
-        revision = revision[1..-1] if revision.start_with? '.'
+    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/
+
+    # since ruby-jss requires 9.4 and up, this check works fine.
+    if major == '9' && !second_part.start_with?('99')
+      parse_jss_version_oldstyle version
+    else
+      parse_jss_version_newstyle version
     end
+  end
 
-    ###revision = revision[1..-1] if revision.start_with? '.'
-    { :major => major,
-      :minor => minor,
-      :revision => revision,
-      :version => Gem::Version.new("#{major}.#{minor}.#{revision}")
+  # (see parse_jss_version)
+  def self.parse_jss_version_newstyle(version)
+    release, build = version.split '-'
+    major, minor, revision = release.split '.'
+    {
+      major: major.to_i,
+      minor:  minor.to_i,
+      revision:  revision.to_i,
+      maint:  revision.to_i,
+      patch:  revision.to_i,
+      build:  build,
+      version: Gem::Version.new(version)
     }
-  end
+  end # parse_jss_version_oldstyle
+
+
+  # (see parse_jss_version)
+  def self.parse_jss_version_oldstyle(version)
+    version =~ /^(\d+?)\.(.*)$/
+    major = Regexp.last_match[1]
+    second_part = Regexp.last_match[2].to_s
+
+    minor = second_part[0]
+    revision = second_part[1..-1]
+
+    # if there's a non-digit anywhere in any part, it and everything after
+    # is the build.
+    if revision.to_s =~ /^(\d*)(\D.*)$/
+      revision = Regexp.last_match[1]
+      build = Regexp.last_match[2]
+      # but remove a leading dot
+      build = build[1..-1] if build.start_with? '.'
+    end
+    minor ||= ''
+    revision ||= ''
+
+    version_string = major.to_s
+    unless minor.empty?
+      version_string << ".#{minor}"
+      version_string << ".#{revision}" unless revision.empty?
+    end
+    {
+      major: major.to_i,
+      minor:  minor.to_i,
+      revision:  revision.to_i,
+      maint:  revision.to_i,
+      patch:  revision.to_i,
+      build:  build.to_s,
+      version:  Gem::Version.new(version_string)
+    }
+  end # parse_jss_version_oldstyle
 
   ### @return [Boolean] is this code running as root?
   ###

data/lib/jss/version.rb

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

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Chris Lasell
+- Aurica Hayes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -78,17 +79,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: immutable-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 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
-      tool for managing Apple devices, from JAMF Software LLC.
+      of the Jamf Software Server (JSS), the core of Jamf Pro, an enterprise/education
+      tool for managing Apple devices, from Jamf Software LLC.
       JSS API objects are implemented as Ruby classes, and interact with each oher to
-      allow simpler automation of Casper-related tasks. For details see the README file."
+      allow simpler automation of Jamf-related tasks. For details see the README file."
 email: ruby-jss@pixar.com
 executables:
 - cgrouper
 - netseg-update
-- jss-webhook-server
+- jamfHelperBackgrounder
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -102,7 +123,7 @@ files:
 - README.md
 - THANKS.md
 - bin/cgrouper
-- bin/jss-webhook-server
+- bin/jamfHelperBackgrounder
 - bin/netseg-update
 - data/ruby-jss.conf.example
 - lib/jss-api.rb
@@ -115,6 +136,7 @@ files:
 - lib/jss/api_object/advanced_search/advanced_mobile_device_search.rb
 - lib/jss/api_object/advanced_search/advanced_user_search.rb
 - lib/jss/api_object/building.rb
+- lib/jss/api_object/categorizable.rb
 - lib/jss/api_object/category.rb
 - lib/jss/api_object/computer.rb
 - lib/jss/api_object/computer_invitation.rb
@@ -124,6 +146,7 @@ files:
 - lib/jss/api_object/criteriable/criterion.rb
 - lib/jss/api_object/department.rb
 - lib/jss/api_object/distribution_point.rb
+- lib/jss/api_object/ebook.rb
 - lib/jss/api_object/extendable.rb
 - lib/jss/api_object/extension_attribute.rb
 - lib/jss/api_object/extension_attribute/computer_extension_attribute.rb
@@ -135,8 +158,11 @@ files:
 - lib/jss/api_object/group/user_group.rb
 - lib/jss/api_object/ldap_server.rb
 - lib/jss/api_object/locatable.rb
+- lib/jss/api_object/mac_application.rb
 - lib/jss/api_object/matchable.rb
 - lib/jss/api_object/mobile_device.rb
+- lib/jss/api_object/mobile_device_application.rb
+- lib/jss/api_object/mobile_device_configuration_profile.rb
 - lib/jss/api_object/netboot_server.rb
 - lib/jss/api_object/network_segment.rb
 - lib/jss/api_object/osx_configuration_profile.rb
@@ -151,11 +177,13 @@ files:
 - lib/jss/api_object/scopable/scope.rb
 - lib/jss/api_object/script.rb
 - lib/jss/api_object/self_servable.rb
+- lib/jss/api_object/self_servable/icon.rb
 - lib/jss/api_object/site.rb
 - lib/jss/api_object/software_update_server.rb
 - lib/jss/api_object/updatable.rb
 - lib/jss/api_object/uploadable.rb
 - lib/jss/api_object/user.rb
+- lib/jss/api_object/vppable.rb
 - lib/jss/api_object/webhook.rb
 - lib/jss/client.rb
 - lib/jss/compatibility.rb
@@ -167,72 +195,13 @@ files:
 - lib/jss/ruby_extensions/filetest.rb
 - lib/jss/ruby_extensions/hash.rb
 - lib/jss/ruby_extensions/ipaddr.rb
+- lib/jss/ruby_extensions/object.rb
 - lib/jss/ruby_extensions/pathname.rb
 - lib/jss/ruby_extensions/string.rb
 - lib/jss/ruby_extensions/time.rb
 - lib/jss/server.rb
 - lib/jss/utility.rb
 - lib/jss/version.rb
-- lib/jss/webhooks.rb
-- lib/jss/webhooks/README.md
-- lib/jss/webhooks/configuration.rb
-- lib/jss/webhooks/data/sample_handlers/RestAPIOperation-executable
-- lib/jss/webhooks/data/sample_handlers/RestAPIOperation.rb
-- lib/jss/webhooks/data/sample_jsons/ComputerAdded.json
-- lib/jss/webhooks/data/sample_jsons/ComputerCheckIn.json
-- lib/jss/webhooks/data/sample_jsons/ComputerInventoryCompleted.json
-- lib/jss/webhooks/data/sample_jsons/ComputerPolicyFinished.json
-- lib/jss/webhooks/data/sample_jsons/ComputerPushCapabilityChanged.json
-- lib/jss/webhooks/data/sample_jsons/JSSShutdown.json
-- lib/jss/webhooks/data/sample_jsons/JSSStartup.json
-- lib/jss/webhooks/data/sample_jsons/MobileDeviceCheckIn.json
-- lib/jss/webhooks/data/sample_jsons/MobileDeviceCommandCompleted.json
-- lib/jss/webhooks/data/sample_jsons/MobileDeviceEnrolled.json
-- lib/jss/webhooks/data/sample_jsons/MobileDevicePushSent.json
-- lib/jss/webhooks/data/sample_jsons/MobileDeviceUnEnrolled.json
-- lib/jss/webhooks/data/sample_jsons/PatchSoftwareTitleUpdated.json
-- lib/jss/webhooks/data/sample_jsons/PushSent.json
-- lib/jss/webhooks/data/sample_jsons/RestAPIOperation.json
-- lib/jss/webhooks/data/sample_jsons/SCEPChallenge.json
-- lib/jss/webhooks/data/sample_jsons/SmartGroupComputerMembershipChange.json
-- lib/jss/webhooks/data/sample_jsons/SmartGroupMobileDeviceMembershipChange.json
-- lib/jss/webhooks/event.rb
-- lib/jss/webhooks/event/computer_added.rb
-- lib/jss/webhooks/event/computer_check_in.rb
-- lib/jss/webhooks/event/computer_inventory_completed.rb
-- lib/jss/webhooks/event/computer_policy_finished.rb
-- lib/jss/webhooks/event/computer_push_capability_changed.rb
-- lib/jss/webhooks/event/handlers.rb
-- lib/jss/webhooks/event/jss_shutdown.rb
-- lib/jss/webhooks/event/jss_startup.rb
-- lib/jss/webhooks/event/mobile_device_check_in.rb
-- lib/jss/webhooks/event/mobile_device_command_completed.rb
-- lib/jss/webhooks/event/mobile_device_enrolled.rb
-- lib/jss/webhooks/event/mobile_device_push_sent.rb
-- lib/jss/webhooks/event/mobile_device_unenrolled.rb
-- lib/jss/webhooks/event/patch_software_title_updated.rb
-- lib/jss/webhooks/event/push_sent.rb
-- lib/jss/webhooks/event/rest_api_operation.rb
-- lib/jss/webhooks/event/scep_challenge.rb
-- lib/jss/webhooks/event/smart_group_computer_membership_change.rb
-- lib/jss/webhooks/event/smart_group_mobile_device_membership_change.rb
-- lib/jss/webhooks/event/webhook.rb
-- lib/jss/webhooks/event_objects.rb
-- lib/jss/webhooks/event_objects/computer.rb
-- lib/jss/webhooks/event_objects/jss.rb
-- lib/jss/webhooks/event_objects/mobile_device.rb
-- lib/jss/webhooks/event_objects/patch_software_title_update.rb
-- lib/jss/webhooks/event_objects/push.rb
-- lib/jss/webhooks/event_objects/rest_api_operation.rb
-- lib/jss/webhooks/event_objects/scep_challenge.rb
-- lib/jss/webhooks/event_objects/smart_group.rb
-- lib/jss/webhooks/server_app.rb
-- lib/jss/webhooks/server_app/routes.rb
-- lib/jss/webhooks/server_app/routes/handle_webhook_event.rb
-- lib/jss/webhooks/server_app/routes/home.rb
-- lib/jss/webhooks/server_app/self_signed_cert.rb
-- lib/jss/webhooks/server_app/server.rb
-- lib/jss/webhooks/version.rb
 - lib/ruby-jss.rb
 homepage: http://pixaranimationstudios.github.io/ruby-jss/
 licenses:
@@ -262,5 +231,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: A Ruby interface to the Casper Suite's JSS API
+summary: A Ruby interface to the Jamf Pro REST API
 test_files: []