ruby-jss 0.9.2 → 0.10.0a1

data/lib/jss/api_object/package.rb

@@ -422,7 +422,7 @@ module JSS
       return nil if new_val == @switch_with_package
       new_val = nil if new_val.to_s.empty?
 
-      raise JSS::NoSuchItemError, "No package named '#{new_val}' exists in the JSS" if new_val && (!self.class.all_names.include? new_val)
+      raise JSS::NoSuchItemError, "No package named '#{new_val}' exists in the JSS" if new_val && (!self.class.all_names(api: @api).include? new_val)
 
       new_val ||= DO_NOT_INSTALL
       @switch_with_package = new_val
@@ -460,7 +460,7 @@ module JSS
     def upload_master_file(local_file_path, rw_pw, unmount = true)
       raise JSS::NoSuchItemError, 'Please create this package in the JSS before uploading it.' unless @in_jss
 
-      mdp = JSS::DistributionPoint.master_distribution_point
+      mdp = JSS::DistributionPoint.master_distribution_point api: @api
       destination = mdp.mount(rw_pw, :rw) + "#{DIST_POINT_PKGS_FOLDER}/#{@filename}"
 
       local_path = Pathname.new local_file_path
@@ -520,7 +520,7 @@ module JSS
     ###
     def update_master_filename(old_file_name, new_file_name, rw_pw, unmount = true)
       raise JSS::NoSuchItemError, "#{old_file_name} does not exist in the jss." unless @in_jss
-      mdp = JSS::DistributionPoint.master_distribution_point
+      mdp = JSS::DistributionPoint.master_distribution_point api: @api
       pkgs_dir = mdp.mount(rw_pw, :rw) + DIST_POINT_PKGS_FOLDER.to_s
       old_file = pkgs_dir + old_file_name
       raise JSS::NoSuchItemError, "File not found on the master distribution point at #{DIST_POINT_PKGS_FOLDER}/#{old_file_name}." unless \
@@ -548,7 +548,7 @@ module JSS
     ### @return [Boolean] was the file deleted?
     ###
     def delete_master_file(rw_pw, unmount = true)
-      mdp = JSS::DistributionPoint.master_distribution_point
+      mdp = JSS::DistributionPoint.master_distribution_point api: @api
       file = mdp.mount(rw_pw, :rw) + "#{DIST_POINT_PKGS_FOLDER}/#{@filename}"
       if file.exist?
         file.delete
@@ -631,7 +631,7 @@ module JSS
       #    in >=9.72:  jamf install  -package foo.pkg -path http://mycasper.myorg.edu/CasperShare/Packages/foo.pkg
       #
       append_at_vers = JSS.parse_jss_version('9.72')[:version]
-      our_vers = JSS.parse_jss_version(JSS.api_connection.server.raw_version)[:version]
+      our_vers = JSS.parse_jss_version(@api.server.raw_version)[:version]
       no_filename_in_url = (our_vers < append_at_vers)
 
       # use a provided alternative url for an http download
@@ -642,7 +642,7 @@ module JSS
 
       # use our appropriate dist. point for download
       else
-        mdp = JSS::DistributionPoint.my_distribution_point
+        mdp = JSS::DistributionPoint.my_distribution_point api: @api
 
         ### how do we access our dist. point? with http?
         if mdp.http_downloads_enabled && !(args[:no_http])

data/lib/jss/api_object/peripheral.rb

@@ -129,7 +129,7 @@ module JSS
       if args[:id] == :new
         raise JSS::InvalidDataError, "New Peripherals must have a :type, which must be one of those defined in the JSS." unless args[:type]
         @type = args[:type]
-        raise JSS::InvalidDataError, "No peripheral type '#{@type}' in the JSS" unless JSS::PeripheralType.all_names(:refresh).include? @type
+        raise JSS::InvalidDataError, "No peripheral type '#{@type}' in the JSS" unless JSS::PeripheralType.all_names(:refresh, api: @api).include? @type
         @fields = {}
         @rest_rsrc = 'peripherals/id/-1'
         @site = "None"
@@ -231,11 +231,11 @@ module JSS
     ###
     def associate(computer)
       if computer =~ /^d+$/
-        raise JSS::NoSuchItemError, "No computer in the JSS with id #{computer}" unless JSS::Computer.all_ids.include? computer
+        raise JSS::NoSuchItemError, "No computer in the JSS with id #{computer}" unless JSS::Computer.all_ids(api: @api).include? computer
         @computer_id = computer
       else
-        raise JSS::NoSuchItemError, "No computer in the JSS with name #{computer}" unless JSS::Computer.all_names.include? computer
-        @computer_id = JSS::Computer.map_all_ids_to(:name).invert[computer]
+        raise JSS::NoSuchItemError, "No computer in the JSS with name #{computer}" unless JSS::Computer.all_names(api: @api).include? computer
+        @computer_id = JSS::Computer.map_all_ids_to(:name, api: @api).invert[computer]
       end
       @need_to_update = true
     end
@@ -268,7 +268,7 @@ module JSS
     ###
     def check_field(field, value)
       ### get the field defs for this PeriphType, omitting the leading nil
-      @field_defs ||= JSS::PeripheralType.new(:name => @type).fields.compact
+      @field_defs ||= JSS::PeripheralType.new(:name => @type, api: @api).fields.compact
 
       ### we must have the right number of fields, and they must have the same names
       ### as the definition

data/lib/jss/api_object/policy.rb

@@ -1055,12 +1055,12 @@ module JSS
       opts[:fut] = false if opts[:fut].nil?
       opts[:update_autorun] = false if opts[:update_autorun].nil?
 
-      id = JSS::Package.valid_id identifier
+      id = JSS::Package.valid_id identifier, api: @api
       raise JSS::NoSuchItemError, "No package matches '#{identifier}'" unless id
 
       return nil if @packages.map { |p| p[:id] }.include? id
 
-      name = JSS::Package.map_all_ids_to(:name)[id]
+      name = JSS::Package.map_all_ids_to(:name, api: @api)[id]
 
       position = case opts[:position]
                  when :start then 0
@@ -1163,11 +1163,11 @@ module JSS
       opts[:position] ||= -1
       opts[:priority] ||= :after
 
-      raise JSS::NoSuchItemError, "No script matches '#{identifier}'" unless (id = JSS::Script.valid_id(identifier))
+      raise JSS::NoSuchItemError, "No script matches '#{identifier}'" unless (id = JSS::Script.valid_id(identifier, api: @api))
 
       return nil if @scripts.map { |s| s[:id] }.include? id
 
-      name = JSS::Script.map_all_ids_to(:name)[id]
+      name = JSS::Script.map_all_ids_to(:name, api: @api)[id]
 
       position = case opts[:position]
                  when :start then 0
@@ -1291,7 +1291,7 @@ module JSS
 
       interval = "#{LOG_FLUSH_INTERVAL_INTEGERS[older_than]}+#{LOG_FLUSH_INTERVAL_PERIODS[period]}"
 
-      JSS.api_connection.delete_rsrc "#{LOG_FLUSH_RSRC}/policy/id/#{@id}/interval/#{interval}"
+      @api.delete_rsrc "#{LOG_FLUSH_RSRC}/policy/id/#{@id}/interval/#{interval}"
     end
 
     ###### Aliases

data/lib/jss/api_object/restricted_software.rb

@@ -109,11 +109,11 @@ module JSS
 
     def site=(new_val)
       if new_val.is_a? Integer
-        raise JSS::NoSuchItemError, "No site found with id #{new_val}" unless JSS::Site.all_ids.include? new_val
-        new_val = JSS::Site.map_all_ids_to(:name)[new_val]
+        raise JSS::NoSuchItemError, "No site found with id #{new_val}" unless JSS::Site.all_ids(api: @api).include? new_val
+        new_val = JSS::Site.map_all_ids_to(:name, api: @api)[new_val]
       else
         new_val = new_val.to_s
-        raise JSS::NoSuchItemError, "No site found with name #{new_val}" unless JSS::Site.all_names.include? new_val
+        raise JSS::NoSuchItemError, "No site found with name #{new_val}" unless JSS::Site.all_names(api: @api).include? new_val
       end
       @site = new_val
       @need_to_update = true
@@ -121,7 +121,7 @@ module JSS
 
     def create
       raise JSS::MissingDataError, 'process_name must be set before creating' if @process_name.to_s.empty?
-      raise JSS::AlreadyExistsError, "A #{RSRC_OBJECT_KEY} named #{@name} already exists in the JSS" if self.class.all_names(:refresh).include? @name
+      raise JSS::AlreadyExistsError, "A #{RSRC_OBJECT_KEY} named #{@name} already exists in the JSS" if self.class.all_names(:refresh, api: @api).include? @name
       super
     end
 

data/lib/jss/api_object/scopable/scope.rb

@@ -595,15 +595,15 @@ module JSS
       ###
       def check_name(key, name)
 
-        found_in_jss = SCOPING_CLASSES[key].all_names.include?(name)
+        found_in_jss = SCOPING_CLASSES[key].all_names(api: @api).include?(name)
 
         return true if found_in_jss
 
         return false unless CHECK_LDAP_KEYS.include?(key)
 
         begin
-          return JSS::LDAPServer.user_in_ldap?(name) if LDAP_USER_KEYS.include?(key)
-          return JSS::LDAPServer.group_in_ldap?(name) if LDAP_GROUP_KEYS.include?(key)
+          return JSS::LDAPServer.user_in_ldap?(name, api: @api) if LDAP_USER_KEYS.include?(key)
+          return JSS::LDAPServer.group_in_ldap?(name, api: @api) if LDAP_GROUP_KEYS.include?(key)
 
         # if an ldap server isn't connected, make a note of it and return true
         rescue JSS::InvalidConnectionError

data/lib/jss/api_object/script.rb

@@ -468,7 +468,7 @@ module JSS
 
         # otherwise, get it from the dist. point
         else
-          dist_point = JSS::DistributionPoint.my_distribution_point
+          dist_point = JSS::DistributionPoint.my_distribution_point api: @api
 
           ### how do we access our dist. point?
           if dist_point.http_downloads_enabled

data/lib/jss/api_object/self_servable.rb

@@ -272,9 +272,9 @@ module JSS
     # @return [void]
     #
     def add_self_service_category(new_cat, display_in: true, feature_in: false)
-      new_cat = JSS::Category.map_all_ids_to(:name)[new_cat] if new_cat.is_a? Integer
+      new_cat = JSS::Category.map_all_ids_to(:name, api: @api)[new_cat] if new_cat.is_a? Integer
       feature_in = false if display_in == false
-      raise JSS::NoSuchItemError, "No category '#{new_cat}' in the JSS" unless JSS::Category.all_names(:refresh).include? new_cat
+      raise JSS::NoSuchItemError, "No category '#{new_cat}' in the JSS" unless JSS::Category.all_names(:refresh, api: @api).include? new_cat
 
       raise JSS::InvalidDataError, 'display_in must be true or false' unless display_in.jss_boolean?
 
@@ -482,7 +482,7 @@ module JSS
     #
     def refresh_icon
       return nil unless @in_jss
-      fresh_data = JSS.api_connection.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
+      fresh_data = @api.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
       icon_data = fresh_data[:self_service][:self_service_icon]
       @icon = JSS::Icon.new icon_data
     end # refresh icon

data/lib/jss/api_object/self_servable/icon.rb

@@ -29,7 +29,8 @@ module JSS
     # An Icon in the JSS, used in Self Service.
     #
     # At the moment, icons are not API objects, they are collections of data
-    # stored in the JSS that might be included in some API object's Self Service data.
+    # stored in the JSS that might be included in some API object's
+    # Self Service data.
     #
     # The data available for an icon are:
     #
@@ -38,13 +39,17 @@ module JSS
     # - uri: the uri to download or preview the icon
     # - data: the icon file itself, base-64 encoded.
     #
-    # Icon instances are read-only. To change the icon for an self-servable object,
+    # Icon instances are read-only. To change the icon for a self-servable object,
     # see {SelfServable#icon=}.
     #
     # NOTE: Since icons are not APIObjects, there's no way to see a list of them
     # via the API. The JSS::Icon class methods .all, .all_ids, and .all_names
     # require MySQL database access. See {JSS::DBConnection}.
     #
+    # This also means, if you use multiple API connections, you'll have to
+    # make sure to connect to the correct MySQL server for the
+    # APIConnection you care about.
+    #
     class Icon
 
       #  Class Methods

data/lib/jss/api_object/updatable.rb

@@ -79,7 +79,7 @@ module JSS
       raise JSS::UnsupportedError, "Editing #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows." unless UPDATABLE
       raise JSS::InvalidDataError, "Names can't be empty!" if newname.to_s.empty?
       raise JSS::AlreadyExistsError, "A #{self.class::RSRC_OBJECT_KEY} named '#{newname}' already exsists in the JSS" \
-        if self.class.all_names(:refresh).include? newname
+        if self.class.all_names(:refresh, api: @api).include? newname
       @name = newname
       @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name}" if @rest_rsrc.include? '/name/'
       @need_to_update = true
@@ -93,7 +93,7 @@ module JSS
       return nil unless @need_to_update
       raise JSS::UnsupportedError, "Editing #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows." unless UPDATABLE
       raise JSS::NoSuchItemError, "Not In JSS! Use #create to create this #{self.class::RSRC_OBJECT_KEY} in the JSS before updating it." unless @in_jss
-      JSS.api_connection.put_rsrc @rest_rsrc, rest_xml
+      @api.put_rsrc @rest_rsrc, rest_xml
       @need_to_update = false
       refresh_icon if self_servable?
       @id

data/lib/jss/api_object/uploadable.rb

@@ -130,7 +130,7 @@ module JSS
       file = File.new local_file.to_s, 'rb'
 
       # upload it!
-      JSS.api_connection.cnx[upload_rsrc].post name: file
+      @api.cnx[upload_rsrc].post name: file
     end # def upload file
 
   end # module FileUpload

data/lib/jss/api_object/user.rb

@@ -209,7 +209,7 @@ module JSS
 
     ###
     def ldap_server= (new_val)
-      raise JSS::InvalidDataError, "No LDAP server in the JSS named #{new_val}" unless JSS::LDAPServer.all_names.include? new_val
+      raise JSS::InvalidDataError, "No LDAP server in the JSS named #{new_val}" unless JSS::LDAPServer.all_names(api: @api).include? new_val
       @ldap_server = new_val
       @need_to_update = true
     end
@@ -223,7 +223,7 @@ module JSS
     ###
     def add_site (site)
       return nil if @sites.map{|s| s[:name]}.include? site
-      raise JSS::InvalidDataError, "No site in the JSS named #{site}" unless JSS::Site.all_names.include? site
+      raise JSS::InvalidDataError, "No site in the JSS named #{site}" unless JSS::Site.all_names(api: @api).include? site
       @sites << {:name => site}
       @need_to_update = true
     end

data/lib/jss/composer.rb

@@ -71,22 +71,37 @@ module JSS
   ###
   ### @param opts[Hash] the options for building the .pkg
   ###
-  ### @options opts :pkg_id[String] the full package if for the new pkg. 
+  ### @options opts :pkg_id[String] the full package if for the new pkg.
   ###   e.g. 'com.mycompany.myapp'
   ###
   ### @option opts :bundle_id_prefix[String] the pkg bundle identifier prefix.
-  ###   If no :pkg_id is provided, one is made using this prefix and 
-  ###   the name provided. e.g. 'com.mycompany' 
+  ###   If no :pkg_id is provided, one is made using this prefix and
+  ###   the name provided. e.g. 'com.mycompany'
   ###   Defaults to '{PKG_BUNDLE_ID_PFX}'. See 'man pkgbuild' for more info
   ###
-  ### @option opts :out_dir[String,Pathname] he folder in which the .pkg will be 
+  ### @option opts :out_dir[String,Pathname] he folder in which the .pkg will be
   ###   created. Defaults to {DEFAULT_OUT_DIR}
   ###
-  ### @option opts :preserve_ownership[Boolean] If true, the owner/group of the 
+  ### @option opts :preserve_ownership[Boolean] If true, the owner/group of the
   ###   rootpath are preserved.
-  ###   Default is false: they become the pkgbuild/installer "recommended" 
+  ###   Default is false: they become the pkgbuild/installer "recommended"
   ###   (root/wheel or root/admin)
   ###
+  ### @option opts :signing_identity[String] the name of the signing identity to
+  ###   use for signing the pkg. See `man pkgbuild` for details
+  ###
+  ### @option opts :keychain[String,Pathname] the path to the keychain
+  ###   containing the  the signing identity. See `man pkgbuild` for details
+  ###
+  ### @option opts :certs[String,Array<String>] the Common Name(s) of additional
+  ###   certificates to include when signing the pkg. See `man pkgbuild` for
+  ###   details
+  ###
+  ### @option opts :include_timestamp[Boolean] should a trusted timestamp be
+  ###   included when signing the pkg. See `man pkgbuild` for details.
+  ###   Default depends on the situation, but true is the same as using
+  ###   --timestamp with pkgbuild, and false is --timestamp=none
+  ###
   ### @return [Pathname] the local path to the new .pkg
   ###
   def self.mk_pkg(name, version, root, opts = {})
@@ -101,6 +116,20 @@ module JSS
     pkg_out = "#{opts[:out_dir]}/#{pkg_filename}"
     pkg_ownership = opts[:preserve_ownership] ? "preserve" : "recommended"
 
+    if opts[:signing_identity]
+      signing = "--sign #{Shellwords.escape opts[:signing_identity]}"
+      signing << " --keychain #{Shellwords.escape opts[:keychain].to_s}" if opts[:keychain]
+      signing << ' --timestamp' if opts[:include_timestamp]
+      signing << ' --timestamp=none' if opts[:include_timestamp] == false
+      case opts[:certs]
+      when Array
+        opts[:certs].each { |c| signing << " --cert #{Shellwords.escape c}" }
+      when String
+        signing << " --cert #{Shellwords.escape opts[:certs]}"
+      end # case
+    else
+      signing = ''
+    end # if opts[:signing_identity]
 
     ### first, run 'analyze' to get a 'component plist' in which we can change some settings
     ### for any bundles in the root (bundles like .apps, frameworks, plugins, etc..)
@@ -138,9 +167,9 @@ module JSS
 
     ### now build the pkg
     begin
-      system "#{PKGBUILD} --identifier '#{pkg_id}' --version '#{version}' --ownership #{pkg_ownership} --install-location / --root '#{root}' #{comp_plist_arg} '#{pkg_out}' "
+      it_built = system "#{PKGBUILD} --identifier '#{pkg_id}' --version '#{version}' --ownership #{pkg_ownership} --install-location / --root '#{root}' #{signing} #{comp_plist_arg} '#{pkg_out}' "
 
-      raise RuntimeError, "There was an error building the .pkg" unless $?.exitstatus == 0
+      raise RuntimeError, "There was an error building the .pkg" unless it_built
     ensure
       comp_plist_out.delete if comp_plist_out.exist?
     end
@@ -182,5 +211,3 @@ module JSS
 
  end # module Composer
 end # module JSS
-
-

data/lib/jss/ruby_extensions/string.rb

@@ -1,39 +1,39 @@
-### Copyright 2017 Pixar
+# 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.
-###
-###
+#
+#    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
-  ###
+  # 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 strip.downcase
     when 'true' then true
@@ -41,24 +41,33 @@ class String
     end # case
   end # to bool
 
-  ### Convert a string to a Time object
-  ###
-  ### returns nil if not parsable by JSS::parse_datetime
-  ###
-  ### @return [Time] the time represented by the string.
-  ###
+  # Convert a string to a Time object
+  #
+  # returns nil if not parsable by JSS::parse_datetime
+  #
+  # @return [Time] the time represented by the string.
+  #
   def jss_to_time
     JSS.parse_time self
   rescue
     return nil
   end
 
-  ### Convert a String to a Pathname object
-  ###
-  ### @return [Pathname]
-  ###
+  # Convert a String to a Pathname object
+  #
+  # @return [Pathname]
+  #
   def jss_to_pathname
     Pathname.new self
   end
 
+  # Is this string also a positive integer?
+  # (i.e. it consists only of numberic digits)
+  #
+  # @return [Boolean]
+  #
+  def jss_integer?
+    self =~ /\A[0-9]+\Z/ ? true : false
+  end
+
 end # class