jss-api 0.5.4

data/lib/jss-api/ruby_extensions/ipaddr.rb

@@ -0,0 +1,91 @@
+### 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.
+### 
+###
+
+############################################
+### A few augmentations to IPAddr handling.
+###
+class IPAddr
+  
+  ### Convert starting and ending IPv4 IP addresses (either Strings or IPAddrs)
+  ### into a single masked IPv4 IPAddr
+  ###
+  ### @param starting[Strings, IPAddr] the starting IP address
+  ###
+  ### @param ending[Strings, IPAddr] the ending IP address
+  ###
+  ### @return [IPAddr] the IP address range represented as a masked IPv4 address
+  ###
+  ### @example
+  ###   IPAddr.jss_masked_v4addr '10.0.0.0', '10.0.0.255' # => #<IPAddr: IPv4:10.0.0.0/255.255.255.0>
+  ###
+  def self.jss_masked_v4addr(starting,ending)
+    IPAddr.new "#{starting}/#{self.jss_cidr_from_ends(starting,ending)}"
+  end #self.jss_masked_v4addr(starting,ending)
+  
+  ### Given starting and ending IPv4 IP addresses (either Strings or IPAddrs)
+  ### return the CIDR notation routing prefix mask
+  ###
+  ### @param starting[Strings, IPAddr] the starting IP address
+  ###
+  ### @param ending[Strings, IPAddr] the ending IP address
+  ###
+  ### @return [FixNum] the CIDR notation routing prefix mask
+  ###
+  ### @example
+  ###   IPAddr.jss_cidr_from_ends '10.0.0.0', '10.0.0.255' # => 24
+  ###
+  def self.jss_cidr_from_ends(starting,ending)
+    
+    starting = IPAddr.new(starting) unless starting.kind_of? IPAddr
+    ending = IPAddr.new(ending) unless ending.kind_of? IPAddr
+    
+    ### how many possible addresses in the range?
+    num_addrs =  ending.to_i - starting.to_i + 1
+    
+    ### convert the number of possible addresses to 
+    ### binary then subtract the number of bits from
+    ### the full length of an IPv4 addr 
+    ### (32 bits) and that gives the CIDR prefix
+    return 32 - num_addrs.to_s(2).length + 1
+    
+  end #self.get_cidr(starting,ending)
+
+  ### Convert a starting address (either String or IPAddr) and a 
+  ### CIDR notation routing prefix mask into the IPv4 address
+  ### of at the end of the range of addresses.
+  ###
+  ### @param starting[Strings, IPAddr] the starting IP address
+  ###
+  ### @param cidr[FixNum] the CIDR mask
+  ###
+  ### @return [IPAddr] the ending IP address of the range.
+  ###
+  ### @example
+  ###   IPAddr.jss_ending_address '10.0.0.0', 24 # => #<IPAddr: IPv4:10.0.0.255>
+  ###
+  def self.jss_ending_address(starting, cidr)
+    IPAddr.new( "#{starting}/#{cidr}").to_range.max
+  end # ending_address
+    
+end # Class IPAddr

data/lib/jss-api/ruby_extensions/pathname.rb

@@ -0,0 +1,77 @@
+### 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.
+### 
+###
+
+############################################
+### Some handy additions to the Pathname class.
+### Why aren't they there already?
+###
+class Pathname
+  
+  ### Is this a real file rather than a symlink?
+  ### @see FileTest.real_file
+  def jss_real_file?
+    FileTest.jss_real_file? self 
+  end # real_file?
+  
+  ### Copy a path to a destination
+  ### @see FileUtils.cp
+  def jss_cp(dest, options = {})
+    FileUtils.cp @path, dest.to_s, options
+  end # cp
+  
+  ### Recursively copy this path to a destination
+  ### @see FileUtils.cp_r
+  def jss_cp_r(dest, options = {})
+    FileUtils.cp_r @path, dest.to_s, options
+  end # cp
+  
+  ### Write some string content to a file.
+  ###
+  ### Simpler than always using an open('w') block 
+  ### *CAUTION* this overwrites files!
+  ###
+  def jss_save(content)
+    self.open('w'){|f| f.write content.to_s}
+  end
+  
+  ### Append some string content to a file.
+  ###
+  ### Simpler than always using an open('a') block
+  ###
+  def jss_append(content)
+    self.open('a'){|f| f.write content.to_s}
+  end
+
+  ### Touching can be good 
+  ###
+  ### @see FileUtils.touch
+  def jss_touch
+    FileUtils.touch @path
+  end
+  
+  ### Pathname should use FileUtils.chown, not File.chown
+  def jss_chown(u,g)
+    FileUtils.chown u, g, @path
+  end
+end # class Pathname

data/lib/jss-api/ruby_extensions/string.rb

@@ -0,0 +1,43 @@
+### 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.
+### 
+###
+
+###
+class String
+  
+  ### Convert the strings "true" and "false" 
+  ### (after stripping whitespace and downcasing)
+  ### to TrueClass and FalseClass respectively
+  ### 
+  ### Return nil if any other string.
+  ###
+  ### @return [Boolean,nil] the boolean value
+  ###
+  def jss_to_bool
+    case self.strip.downcase
+      when "true" then return true
+      when "false" then return false
+      else return nil
+    end # case
+  end # to bool
+end # class

data/lib/jss-api/ruby_extensions/time.rb

@@ -0,0 +1,63 @@
+### 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.
+### 
+###
+
+############################################
+### The JSS API can take incoming timestamp data in three formats:
+### - plain date: YYYY-mm-dd HH:MM:SS, which is assumed to be in the local timezone
+### - UTC date: YYYY-mm-ddTHH:MM:SS.mmm [+-]zzzz, the local time with milliseconds and the timezone offset
+### - Unix epoch with milliseconds, nnnnnnnnnnnnn,  which like all epoch times, is UTC
+###
+### Here we extend Time to return the three formats for use in XML data to pass
+### back to the API. The API xml works with any of the formats, in appropriate elements.
+###
+### Generally this gem uses the epoch format for passing values back to the API, just to help avoid
+### timezone weirdness, but any should work.
+###
+### When reading from the API, all three formats are returned in different xml elements,
+### and the APIObjects in the gem will use the epoch format and the JSS.epoch_to_time method (q.v.) to store
+### the data as a Ruby Time.
+###
+class Time
+
+  ### @return [Integer] the milliseconds of the Time
+  def jss_msec
+    (self.usec/1000.0).round
+  end
+
+  ### @return [Integer] The Time as a unix epoch with milliseconds appended
+  def to_jss_epoch
+    (self.strftime('%s') + self.jss_msec.to_s.ljust(3,'0')).to_i
+  end
+
+  ### @return [String] the Time formatted for a plain JSS XML date element
+  def to_jss_date
+    self.strftime '%Y-%m-%d %H:%M:%S'
+  end
+
+  ### @return [String] the Time formatted for a JSS UTC XML date element
+  def to_jss_utc
+    self.strftime("%Y-%m-%dT%H:%M:%S.#{self.jss_msec}%z")
+  end
+
+end

data/lib/jss-api/server.rb

@@ -0,0 +1,108 @@
+### 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.
+### 
+###
+
+###
+module JSS
+
+  ### A class representing a JSS Server.
+  ###
+  ### The {JSS::APIConnection} instance has a JSS::Server instance in its @server attribute.
+  ### It is created fresh every time {APIConnection#connect} is called.
+  ###
+  ### That's the only time it should be instantiated, and all access should be through
+  ### {JSS::API.server}
+  ###
+  class Server
+
+    #####################################
+    ### Attributes
+    #####################################
+
+    ### @return [String] the organization to which the server is licensed
+    attr_reader :organization
+    
+
+    ### @return [String] the activation code for the server licence
+    attr_reader :activation_code
+
+    ### @return [String] the type of server licence
+    attr_reader :license_type
+
+    ### @return [String] the license product name
+    attr_reader :product
+
+    ###  @return [String] The version of the JSS. See the method JSS.parse_jss_version
+    attr_reader :version
+
+    ###  @return [Integer]
+    attr_reader :major_version
+
+    ###  @return [Integer]
+    attr_reader :minor_version
+
+    ###  @return [Integer]
+    attr_reader :revision_version
+
+    ###  @return [String]
+    attr_reader :raw_version
+
+    #####################################
+    ### Instance Methods
+    #####################################
+
+    ###
+    ### Initialize!
+    ###
+    def initialize
+      begin
+
+        # the jssuser resource is readable by anyone with a JSS acct
+        # regardless of their permissions.
+        # However, it's marked as 'deprecated'. Hopefully jamf will
+        # keep this basic level of info available for basic authentication
+        # and JSS version checking.
+        ju = JSS::API.get_rsrc('jssuser')[:user]
+        @license_type = ju[:license_type]
+        @product = ju[:product]
+        @raw_version = ju[:version]
+        parsed = JSS.parse_jss_version(@raw_version)
+        @major_version = parsed[:major]
+        @minor_version = parsed[:minor]
+        @revision_version = parsed[:revision]
+        @version = parsed[:version]
+
+      rescue RestClient::Request::Unauthorized
+        raise JSS::InvalidConnectionError, "Incorrect JSS username or password for '#{JSS::API.jss_user}'."
+      end
+
+    end
+
+    
+    ##### Aliases
+    alias institution organization
+    alias product_name product
+    
+  end # class server
+
+end # module

data/lib/jss-api/version.rb

@@ -0,0 +1,31 @@
+### 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.
+### 
+###
+
+###
+module JSS
+
+  ### The version of the JSS ruby gem
+  VERSION = "0.5.4"
+
+end # module

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification 
+name: jss-api
+version: !ruby/object:Gem::Version 
+  hash: 3
+  prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 4
+  version: 0.5.4
+platform: ruby
+authors: 
+- Chris Lasell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-10-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: plist
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-mysql
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: net-ldap
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+description: "    The JSS Gem is a framework for interacting with the REST API of the\n    JAMF Software Server (JSS), the core of the Casper Suite from JAMF Software, LLC.\n    JSS API objects are implemented as Ruby classes, and interact with each oher to\n    allow simpler automation of Casper-related tasks. For details see README.md.\"\n"
+email: chrisl@pixar.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE.txt
+- CHANGES.md
+- THANKS.md
+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/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/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/version.rb
+- lib/jss-api.rb
+- README.md
+- LICENSE.txt
+- CHANGES.md
+- THANKS.md
+homepage: http://pixaranimationstudios.github.io/jss-api-gem/index.html
+licenses: 
+- Modified Apache-2.0
+post_install_message: 
+rdoc_options: 
+- --title
+- JSS
+- --line-numbers
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A Ruby interface to the Casper Suite's JSS API
+test_files: []
+
+has_rdoc: true