jss-api 0.5.4

data/CHANGES.md

@@ -0,0 +1,4 @@
+# Change History
+
+v0.5.0 2014-10-23 
+- first opensource release

data/LICENSE.txt

@@ -0,0 +1,174 @@
+
+                               Modified Apache 2.0 License
+
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   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.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/README.md

@@ -0,0 +1,368 @@
+# The JSS API Ruby Gem - access to the Casper Suite from Ruby
+
+## DESCRIPTION
+
+jss-api is a Ruby Gem providing access to the REST API of the JAMF Software Server (JSS) - the core of the Casper Suite
+from JAMF Software, LLC. It defines the JSS module, which abstracts API resources as Ruby objects, and provides methods for interacting with those
+resources. It also provides some features that aren't a part of the API itself, but come with other Casper-related 
+tools, such as uploading .pkg and .dmg {JSS::Package} data to the master distribution point, and the installation 
+of {JSS::Package} objects on client machines. (See BEYOND THE API) 
+
+The gem is not a complete implementation of the Casper API. Only some API objects are modeled, some only minimally. Of
+those, some are read-only, some partially writable, some fully read-write (all implemented objects can be deleted)
+See OBJECTS IMPLEMENTED for a list. 
+
+We've implemented the things we need in our environment, and as our needs grow, we'll add more. 
+Hopefully others will find it useful, and add more to it as well
+
+
+## SYNOPSIS
+
+```ruby
+# you may need to require 'rubygems' first if you're using Ruby 1.8
+require 'jss-api'   
+
+JSS::API.connect :user => jss_user, :pw => jss_user_pw, :server => jss_server_hostname
+
+JSS::Package.all # returns an array of data about all JSS::Package objects in the JSS
+JSS::Package.all_names # returns an array of names of all JSS::Package objects in the JSS
+
+# Get a static computer group
+mg = JSS::ComputerGroup.new :name => "Macs of interest"
+
+# Add a computer to the group
+mg.add_member "pricklepants"
+
+# save my changes
+mg.update
+
+# Create a new network segment to store in the JSS
+ns = JSS::NetworkSegment.new :id => :new, :name => 'Private Class C', :starting_address => '192.168.0.0', :ending_address => '192.168.0.255'
+
+# Associate this network segment with a specific building, which must exist in the JSS, and be listed in JSS::Building.all_names
+ns.building = "Main Office" 
+
+# Associate this network segment with a specific software update server, which must exist in the JSS, 
+# and be listed in JSS::SoftwareUpdateServer.all_names
+ns.swu_server = "Main SWU Server" 
+
+# Store the new network segment in the JSS
+ns.create 
+```
+
+## USAGE
+
+### Connecting to the API
+
+Before you can work with JSS Objects via the API, you have to connect to it. 
+
+The constant {JSS::API} contains the connection to the API (a singleton instance of {JSS::APIConnection}). When the JSS Module is first loaded, it isn't 
+connected.  To remedy that, use JSS::API.connect, passing it values for :user, :pw, and :server:
+
+```ruby
+JSS::API.connect :user => jss_user, :pw => jss_user_pw, :server => jss_server_hostname
+```
+
+Make sure the user has privileges in the JSS to do things with API Objects. 
+
+The {JSS::API#connect} method also accepts the symbols :stdin and :prompt as values for :pw, which will cause it to read the
+password from stdin, or prompt for it in the shell. See the JSS::APIConnection class for more connection options and details about its methods. 
+
+Also see {JSS::Configuration}, and the CONFIGURATION section below, for how to store
+server connection parameters in a simple config file.
+
+### Working with JSS Objects (a.k.a REST Resources)
+
+All API Object classes are subclasses of JSS::APIObject and share methods for listing, retrieving, and deleting from the JSS. All supported objects can be listed, retrieved and deleted, but only some can be updated or created. Those classes do so by mixing in the JSS::Creatable and/or JSS::Updateable modules. See below for the level of implementation of each class. 
+
+--------
+
+#### Listing Objects
+
+To get an Array of every object in the JSS of some Class, call that Class's .all method:
+
+```ruby
+JSS::Computer.all # => [{:name=>"cephei", :id=>62},{:name=>"peterparker", :id=>218}, {:name=>"rowdy", :id=>901}, ...]
+```
+
+The Array will contain a Hash for each item, with at least a :name and an :id.  Some classes provide more data for each item.
+To get just the names or just the ids in an Array, use the .all\_names or .all\_ids Class method
+
+```ruby
+JSS::Computer.all_names # =>  ["cephei", "peterparker", "rowdy", ...]
+JSS::Computer.all_ids # =>  [62, 218, 901, ...]
+```    
+
+Some Classes provide other ways to list objects, depending on the data available, e.g. JSS::MobileDevice.all\_udids
+
+--------
+
+#### Retrieving Objects
+
+To retrieve a single object call the object's constructor (.new) and provide either :name or :id or :data.
+
+* :name or :id will be looked up via the API
+
+```ruby
+a_dept = JSS::Department.new :name => "Payroll" # =>  #<JSS::Department:0x10b4c0818...
+```
+
+* :data must be the parsed JSON output of a separate API query (a hash with symbolized keys)
+
+```ruby
+dept_data = JSS::API.get_rsrc("departments/name/Payroll")[:department] # => {:name=>"Payroll", :id=>42}
+a_dept = JSS::Department.new :data => dept_data  # =>  #<JSS::Department:0x10b4a83f8...
+```
+
+Some subclasses can use more than just the :id and :name keys for lookups, e.g. computers can be looked up with :udid, :serial_number, or :mac_address.
+
+--------
+
+#### Creating Objects
+
+Some Objects can be created anew in the JSS. To make a new object, first instantiate one using :id => :new, and provide a unique :name.
+
+```ruby
+new_pkg = JSS::Package.new :id => :new, :name => "transmogrifier-2.3-1.pkg"
+```
+
+Then set the attributes of the new object as needed
+
+```ruby
+new_pkg.reboot_required = false
+new_pkg.category = "CoolTools"
+# etc..
+```
+
+Then use the #create method to create it in the JSS.
+
+```ruby
+new_pkg.create # => 453 # the id number of the object just created
+```
+
+*NOTE* some subclasses require more data than just a :name when instantiating with :id => :new.
+
+--------
+
+#### Updating Objects
+
+Some objects can be modified in the JSS.
+
+```ruby
+existing_script = JSS::Script.new :id => 321
+existing_script.name = "transmogrifier-2.3-1.post-install"
+```
+
+After changing any attributes, use the #update method (also aliased to #save) to push the changes to the JSS.
+
+```ruby
+existing_script.update # or existing_script.save  => true # the update was successful
+```
+
+--------
+
+#### Deleting Objects
+
+To delete an object, just call its #delete method
+
+```ruby
+existing_script = JSS::Script.new :id => 321
+existing_script.delete # => true # the delete was successful
+```
+
+
+See JSS::APIObject, the parent class of all API resources, for general information about creating, reading, updating/saving, and deleting resources.
+
+See the individual subclasses for any details specific to them.
+
+
+
+## OBJECTS IMPLEMENTED
+
+See each Class's documentation for details.
+
+### Creatable and Updatable
+
+* {JSS::AdvancedComputerSearch}
+* {JSS::AdvancedMobileDeviceSearch}
+* {JSS::AdvancedUserSearch}
+* {JSS::Building}
+* {JSS::Category}
+* {JSS::ComputerExtensionAttribute}
+* {JSS::ComputerGroup}
+* {JSS::Department}
+* {JSS::MobileDeviceExtensionAttribute}
+* {JSS::MobileDeviceGroup}
+* {JSS::NetworkSegment}
+* {JSS::Package}
+* {JSS::Peripheral}
+* {JSS::PeripheralType}
+* {JSS::RemovableMacAddress}
+* {JSS::Script}
+* {JSS::User}
+* {JSS::UserExtensionAttribute}
+* {JSS::UserGroup}
+
+### Updatable but not Creatable
+
+* {JSS::Computer} - limited to modifying
+  * name
+  * barcodes
+  * asset tag
+  * ip address
+  * location data
+  * purchasing data
+  * editable extension attributes
+* {JSS::MobileDevice} - limited to modifying
+  * asset tag
+  * location data
+  * purchasing data
+  * editable extension attributes
+* {JSS::Policy} - limited  to modifying
+  * scope (see {JSS::Scopable::Scope})
+  * name
+  * enabled
+  * category
+  * triggers
+  * file & process actions
+  
+**NOTE** Even in the API and the WebApp, Computer and Mobile Device data gathered by an Inventory Upate (a.k.a. 'recon') is not editable.
+
+### Read-Only
+
+These must be created and edited via the JSS WebApp
+
+* {JSS::DistributionPoint}
+* {JSS::LDAPServer}
+* {JSS::NetBootServer}
+* {JSS::SoftwareUpdateServer}
+
+### Deletable
+
+All supported API Objects can be deleted
+
+
+Other useful classes:
+
+* {JSS::Server} - An encapsulation of some info about the server, such as the JSS version and license. An instance is available as an attribute of the {JSS::APIConnection} singleton.
+* {JSS::Client} - An object representing the local machine as a Casper-managed client, and JAMF-related info and methods
+
+## CONFIGURATION
+
+The {JSS::Configuration} singleton class is used to read, write, and use site-specific defaults for using the JSS Gem. When the JSS module is loaded, the single instance of {JSS::Configuration} is created and stored in the constant {JSS::CONFIG}. At that time the system-wide file /etc/jss_gem.conf is examined if it exists, and the items in it are loaded into the attributes of {JSS::CONFIG}. The user-specific file ~/.jss_gem.conf then is examined if it exists, and any items defined there will override those values from the system-wide file.
+
+The values defined in those files are used as defaults throughout the Gem. Currently, those values are only related to establishing the API connection. For example, if a server name is defined, then a :server does not have to be specified when calling {JSS::API#connect}.
+
+While the {JSS::Configuration} clss provides methods for changing the values, saving the files, and re-reading them, or reading an arbitrary file, the files are text files with a simple format, and can be created by any means desired. 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.
+
+Lines starting with a # are comments and will be preserved when using #save.
+
+The currently known attributes are:
+
+* api_server_name [String] the hostname of the JSS API server
+* api_server_port [Integer] the port number for the API connection
+* api_verify_cert [Boolean] 'true' or 'false' - if SSL is used, should the SSL certificate be verified (usually false for a self-signed cert)
+* api_username [String] the JSS username for connecting to the API
+* api_timeout_open [Integer] the number of seconds for the open-connection timeout
+* api_timeout [Integer] the number of seconds for the response timeout
+
+To put a standard server & username on all client machines, and auto-accept the JSS's self-signed https certificate, create the file /etc/jss_gem.conf containing three lines like this:
+
+```
+api_server_name: casper.myschool.edu
+api_username: readonly-api-user
+api_verify_cert: false
+```
+
+and then any calls to {JSS::API.connect} will assume that server and username, and won't complain about the self-signed certificate.
+
+Note that the config files don't store passwords. You'll have to use your own methods for acquiring the password for the JSS::API.connect call. The {JSS::API#connect} method also accepts the symbols :stdin and :prompt, which will cause it to read the password from stdin, or prompt for it in 
+the shell.
+
+
+## BEYOND THE API
+
+While the Casper API provides access to object data in the JSS, this gem tries to use that data to provide more than just information exchange. Here are some examples of how we use the API data to provide functionality found in various Casper tools:
+
+* Client Machine Access
+  * The {JSS::Client} module provides the ability to run jamf binary commands, and access the local cache of package receipts 
+* Package Installation 
+  * {JSS::Package} objects can be installed on the local machine, from the appropriate distribution point
+* Script Execution
+  * {JSS::Script} objects can be executed locally on demand
+* Package Creation
+  * The {JSS::Composer} module provides creation of very simple .pkg and .dmg packages
+  * {JSS::Package} objects can upload their .pkg or .dmg files to the master distribution point ({JSS::Script} objects can also if you store them there.)
+* Reporting/AdvancedSearch exporting
+  * {JSS::AdvancedSearch} subclasses can export their results to csv, tab, and xml files.
+* LDAP Access
+  * {JSS::LDAPServer} objects can query the LDAP servers for user, group, and membership data.
+* MDM Commands
+  * {JSS::MobileDevice}s (and eventually {JSS::Computer}s) can be sent MDM commands
+* Extension Attributes
+  * {JSS::ExtensionAttribute} work with {JSS::AdvancedSearch} subclasses to provide extra reporting about Ext. Attrib. values.
+
+## REQUIREMENTS
+
+the JSS gem was written for:
+
+* Mac OS X 10.8 and higher
+* Casper Suite version 9.4 or higher
+* Ruby 1.8.7 and 2.0.0 (the two versions that come with OS X 10.9).
+
+It also requires these gems, which will be installed automatically if you install JSS with `gem install jss`
+
+* rest-client >=1.6.7 http://rubygems.org/gems/rest-client
+* json or json\_pure >= 1.6.5 http://rubygems.org/gems/json or http://rubygems.org/gems/json_pure
+  * (only in ruby 1.8.7.  Ruby 2.0.0 has json in its standard library)
+* ruby-mysql >= 2.9.12 http://rubygems.org/gems/ruby-mysql
+  * (only for a few things that still require direct SQL access to the JSS database)
+* plist =3.1.0 http://rubygems.org/gems/plist
+  * for the {JSS::Composer} module and {JSS::Client} class
+* net-ldap >= 0.3.1 http://rubygems.org/gems/net-ldap
+  * for accessing the LDAP servers defined in the JSS, to check for user and group info.
+
+## INSTALL
+
+NOTE: You may need to install XCode, and it's CLI tools, in order to install the required gems.
+
+In general, you can install the JSS Gem with this command: 
+
+`gem install jss-api`
+
+If you're using Ruby 1.8.7, install the following gems manually first, since the JSS gem will try to install newer, incompatible versions if they aren't pre-installed.
+
+`gem install json -v 1.6.5`
+
+`gem install mime-types -v 1.25.1`
+
+`gem install rest-client -v 1.6.8`
+
+## LICENSE
+
+Copyright 2014 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.