jss-api 0.6.1 → 0.6.2

data/lib/jss-api.rb

@@ -1,191 +1 @@
-### 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.
-### 
-###
-
-###
-### JSS, A Ruby module for interacting with the JAMF Software Server via it's REST API.
-###
-module JSS
-
-  #####################################
-  ### Required Libraries, etc
-  #####################################
-
-  ###################
-  ### Standard Libraries
-  require 'date'
-  require 'singleton'
-  require 'pathname'
-  require 'fileutils'
-  require 'uri'
-  require "ipaddr"
-  require "rexml/document"
-  require "base64"
-  require "shellwords"
-  require "digest"
-  require 'yaml'
-
-  ###################
-  ### Gems
-  require 'rest-client'
-  require 'json'
-  require 'plist'
-
-
-
-  #####################################
-  ### Constants
-  #####################################
-
-  ### The minimum JSS version that works with this gem, as returned by the API
-  ### 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)
-
-  ### These are handy for testing values without making new arrays, strings, etc every time.
-  TRUE_FALSE = [true, false]
-
-  ### When parsing a date/time data into a Time object, these will return nil
-  NIL_DATES = [0, nil, '', '0']
-
-  ### The contents of anything piped to stdin, split into lines. See {JSS.stdin}
-  STDIN_LINES = $stdin.tty? ? [] : $stdin.read.lines.map{|line| line.chomp("\n") }
-
-
-  #####################################
-  ### Module Variables
-  #####################################
-
-  #####################################
-  ### Module Methods
-  #####################################
-
-
-  ###
-  ### Define classes and submodules here so that they don't
-  ### generate errors when referenced during the loading of
-  ### the library.
-  ###
-
-  #####################################
-  ### Sub Modules
-  #####################################
-
-  module Composer ; end
-
-  ### Mix-in Sub Modules
-
-  module Creatable ; end
-  module FileUpload ; end
-  module Locatable ; end
-  module Matchable ; end
-  module Purchasable ; end
-  module Updatable ; end
-  module Extendable ; end
-
-  ### Mix-in Sub Modules with Classes
-
-  module Criteriable ; end
-  class Criteriable::Criteria ; end
-  class Criteriable::Criterion ; end
-
-  module Scopable ; end
-  class Scopable::Scope ; end
-
-  #####################################
-  ### Classes
-  #####################################
-
-  class APIObject ; end
-  class APIConnection ; end
-  class Client ; end
-  class DBConnection ; end
-  class Server ; end
-  class Preferences ; end
-
-  #####################################
-  ### SubClasses
-  #####################################
-
-  ### APIObject Classes with SubClasses
-
-  class AdvancedSearch < JSS::APIObject ; end
-  class AdvancedComputerSearch < JSS::AdvancedSearch ; end
-  class AdvancedMobileDeviceSearch < JSS::AdvancedSearch ; end
-  class AdvancedUserSearch <  JSS::AdvancedSearch ; end
-
-
-  class ExtensionAttribute < JSS::APIObject ; end
-  class ComputerExtensionAttribute < JSS::ExtensionAttribute ; end
-  class MobileDeviceExtensionAttribute < JSS::ExtensionAttribute ; end
-  class UserExtensionAttribute < JSS::ExtensionAttribute ; end
-
-  class Group < JSS::APIObject ; end
-  class ComputerGroup < JSS::Group ; end
-  class MobileDeviceGroup < JSS::Group ; end
-  class UserGroup < JSS::Group ; end
-
-  ### APIObject Classes without SubClasses
-
-  class Building < JSS::APIObject ; end
-  class Category < JSS::APIObject ; end
-  class Computer < JSS::APIObject ; end
-  class Department < JSS::APIObject ; end
-  class DistributionPoint < JSS::APIObject ; end
-  class LDAPServer < JSS::APIObject ; end
-  class MobileDevice < JSS::APIObject ; end
-  class NetBootServer < JSS::APIObject ; end
-  class NetworkSegment < JSS::APIObject ; end
-  class Package < JSS::APIObject ; end
-  class PeripheralType < JSS::APIObject ; end
-  class Peripheral < JSS::APIObject ; end
-  class Policy < JSS::APIObject ; end
-  class RemovableMacAddress < JSS::APIObject ; end
-  class Script < JSS::APIObject ; end
-  class Site < JSS::APIObject ; end
-  class SoftwareUpdateServer < JSS::APIObject ; end
-  class User < JSS::APIObject ; end
-
-
-end # module JSS
-
-
-##################
-### Load the rest of the module
-# $:.unshift File.dirname(__FILE__)
-
-require "jss-api/utility"
-require "jss-api/composer"
-require "jss-api/compatibility"
-require "jss-api/ruby_extensions"
-require "jss-api/exceptions"
-require "jss-api/api_connection"
-require "jss-api/api_object"
-require "jss-api/server"
-require "jss-api/client"
-require "jss-api/configuration"
-require "jss-api/db_connection"
-require "jss-api/version"
+require 'jss'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jss-api
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: plist
+  name: ruby-jss
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,152 +26,23 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-mysql
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-- !ruby/object:Gem::Dependency
-  name: net-ldap
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.2
 description: |2
-      The jss-api 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.
-      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."
-email: jss-api-gem@pixar.com
-executables:
-- cgrouper
-- subnet-update
+      This is the last version of the gem named jss-api. It exists merely as a pointer to the new
+      gem 'ruby-jss' which provdes the same module going forward.
+      Requiring 'jss-api' will merely require 'jss'. However, please update your code to require 'jss'
+      directly, as this wrapper will eventually go away.
+email: ruby-jss@pixar.com
+executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
-- LICENSE.txt
-- CHANGES.md
-- THANKS.md
+extra_rdoc_files: []
 files:
-- lib/jss-api/api_connection.rb
-- lib/jss-api/api_object/advanced_search/advanced_computer_search.rb
-- lib/jss-api/api_object/advanced_search/advanced_mobile_device_search.rb
-- lib/jss-api/api_object/advanced_search/advanced_user_search.rb
-- lib/jss-api/api_object/advanced_search.rb
-- lib/jss-api/api_object/building.rb
-- lib/jss-api/api_object/category.rb
-- lib/jss-api/api_object/computer.rb
-- lib/jss-api/api_object/creatable.rb
-- lib/jss-api/api_object/criteriable/criteria.rb
-- lib/jss-api/api_object/criteriable/criterion.rb
-- lib/jss-api/api_object/criteriable.rb
-- lib/jss-api/api_object/department.rb
-- lib/jss-api/api_object/distribution_point.rb
-- lib/jss-api/api_object/extendable.rb
-- lib/jss-api/api_object/extension_attribute/computer_extension_attribute.rb
-- lib/jss-api/api_object/extension_attribute/mobile_device_extension_attribute.rb
-- lib/jss-api/api_object/extension_attribute/user_extension_attribute.rb
-- lib/jss-api/api_object/extension_attribute.rb
-- lib/jss-api/api_object/group/computer_group.rb
-- lib/jss-api/api_object/group/mobile_device_group.rb
-- lib/jss-api/api_object/group/user_group.rb
-- lib/jss-api/api_object/group.rb
-- lib/jss-api/api_object/ldap_server.rb
-- lib/jss-api/api_object/locatable.rb
-- lib/jss-api/api_object/matchable.rb
-- lib/jss-api/api_object/mobile_device.rb
-- lib/jss-api/api_object/netboot_server.rb
-- lib/jss-api/api_object/network_segment.rb
-- lib/jss-api/api_object/osx_configuration_profile.rb
-- lib/jss-api/api_object/package.rb
-- lib/jss-api/api_object/peripheral.rb
-- lib/jss-api/api_object/peripheral_type.rb
-- lib/jss-api/api_object/policy.rb
-- lib/jss-api/api_object/purchasable.rb
-- lib/jss-api/api_object/removable_macaddr.rb
-- lib/jss-api/api_object/scopable/scope.rb
-- lib/jss-api/api_object/scopable.rb
-- lib/jss-api/api_object/script.rb
-- lib/jss-api/api_object/self_servable.rb
-- lib/jss-api/api_object/site.rb
-- lib/jss-api/api_object/software_update_server.rb
-- lib/jss-api/api_object/updatable.rb
-- lib/jss-api/api_object/uploadable.rb
-- lib/jss-api/api_object/user.rb
-- lib/jss-api/api_object.rb
-- lib/jss-api/client.rb
-- lib/jss-api/compatibility.rb
-- lib/jss-api/composer.rb
-- lib/jss-api/configuration.rb
-- lib/jss-api/db_connection.rb
-- lib/jss-api/exceptions.rb
-- lib/jss-api/ruby_extensions/filetest.rb
-- lib/jss-api/ruby_extensions/hash.rb
-- lib/jss-api/ruby_extensions/ipaddr.rb
-- lib/jss-api/ruby_extensions/pathname.rb
-- lib/jss-api/ruby_extensions/string.rb
-- lib/jss-api/ruby_extensions/time.rb
-- lib/jss-api/ruby_extensions.rb
-- lib/jss-api/server.rb
-- lib/jss-api/utility.rb
-- lib/jss-api/version.rb
 - lib/jss-api.rb
-- .yardopts
-- README.md
-- LICENSE.txt
-- CHANGES.md
-- THANKS.md
-- bin/cgrouper
-- bin/subnet-update
-homepage: http://pixaranimationstudios.github.io/jss-api-gem/
+homepage: http://pixaranimationstudios.github.io/ruby-jss/
 licenses:
 - Modified Apache-2.0
 post_install_message: 
-rdoc_options:
-- --title
-- JSS
-- --line-numbers
-- --main
-- README.md
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -179,7 +50,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -191,6 +62,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: A Ruby interface to the Casper Suite's JSS API
+summary: A backward-compatibility wrapper for the ruby-jss gem (formerly jss-api)
 test_files: []
-has_rdoc: true

data/.yardopts

@@ -1,7 +0,0 @@
---title "The JSS API Ruby Gem - access to the Casper Suite API"
---readme README.md
---embed-mixins
--
-LICENSE.txt
-CHANGES.md
-THANKS.md

data/CHANGES.md

@@ -1,88 +0,0 @@
-# Change History
-
-## v0.6.1 2016-03-01
-
-#### additions & features
-
-- JSS::Package#install now takes :alt_download_url argument.Can be used to specify a custom URL from which to download a pkg/dmg for installation with 'jamf install'. This allows the use of cloud distribution points.
-- JSS::DistributionPoint: Added reachability methods, improved assessment of mount-success. #reachable_for_download? and #reachable_for_upload? will now return a boolean indicating if the DistPoint is reachable.
-
-## v0.6.0 2016-01-06
-
-This version of the jss-api gem incorporates changes needed for the upcoming release of d3 (a.k.a. depot3), 
-a package/patch management system for Casper, which was the reason for the jss-api gem to begin with.
-
-As such, while the JSS module will continue to be a separate git repo, specific commits of it will be 
-submodules of the depot3 git repo, starting with this one, or one shortly hereafter.
-
-
-#### bugfixes & cleanup
-
-- new path to the jamf binary was corrected
-- fixed the logic in using the :use_ssl arg to JSS::APIConnection::connect
-- Composer module no longer adds redundant .pkg extensions
-- JSS::DistributionPoint, bug fix when initializing with :id=>:master
-- JSS::DistributionPoint: #mount now defaults to read-only unless :rw is passed
-- String: added #jss_to_time to convertion strings to Time objects using JSS::parse_time
-- JSS::Package: better handling of API values like "None" and "No category assigned"
-- JSS::Package: added #type to return :pkg or :dmg
-- JSS::Package: Changes to #install, including return value! See NOTES below.
-- lots of code cleanup
-
-#### additions & features
-
-- JSS::APIConnection and JSS::DBConnection determines server hostname via several means if not yet connected
-- JSS::APIConnection and JSS::DBConnection can test validitiy of a server
-- JSS::DBConnection now has a DEFAULT_PORT constant
-
-
-NOTES:
-
-Important: Package#install now returns a boolean indicating success of installation.
-The previous return value (the Process::Status of the 'jamf install' proceess) usually returned 0 exitstatus even if the pkg install failed.
-Now the actual install command is examined, and if its exitstatus is zero, Package#install returns true, else false.
-
-Also: As of casper 9.72, the argument requirements havechanged for 'jamf install' with http downloads. This is now handled correctly
-
-
-## v0.5.8 2015-09-22
-
-#### bugfixes & cleanup
-
-- location.rb: location value setters are now properly converted to strings
-- api_connection.rb: #connect now takes :use_ssl option (defaults to true) 
-- api_connection.rb: #connect will accept arbitrary ports when :use_ssl is true
-
-#### additions & features
-
-- client.rb: looks for the new ElCap+ location for the jamf binary, falls back to old location if not found.
-- Locatable#clear_location public instance method added
-- TimeoutError and AuthenticationError have been added to exceptions
-- Policy objects now have a #run method - attempts to execute the policy locally.
-
-## v0.5.7 2015-05-26
-
-#### bugfixes & cleanup
-
-- JSS.to_s_and_a now properly converts nils to "" and []
-- DBConnection.connect gracefully handle reconnecting if the old connection went away
-- DBConnection.connect, and APIConnection.connect: include server name when prompting for password
-- Configuration: handle lack of ENV['HOME'] when trying to expand ~ to locate user-level config file.
-- MobileDevice#unmanage_device: send_mdm_command is a class method, not an instance method
-- APIObject: auto-set @site and @category if applicable
-- Package: os_requirements default to empty array if unset in JSS
-- Package#required_processor: remove buggy line of ancient, deprecated code
-- Package#upload_master_file: move autoupdate to appropriate location
-
-## v0.5.6 2014-11-04
-
-- now requires Ruby >= 1.9.3 and rest-client >= 1.7.0. Needed for Casper >= 9.61's lack of support for SSLv3.
-- APIConnection now accepts :ssl_version option in the argument hash. Defaults to 'TLSv1'
-- Configuration now supports the api_ssl_version key, used for the :ssl_version option of the APIConnection.
-- the example programs have been moved to the bin directory, and are now included in the gem installation.
-- many documentation updates as we adjust to being live
-- minor bugfixes
-
-## v0.5.0 2014-10-23 
-
-- first opensource release