ruby-jss 0.10.0a3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7727d3ed2d2b1be1f06c518739e40ca271fdc2a2
-  data.tar.gz: 3f2b112e349629a2832e3de91fc8b5ac7425d02a
+  metadata.gz: 769cbc0fa921b444480b1c3b588664c3c3937aa7
+  data.tar.gz: 4a4d8ab91135e180d49e52e2be783019cb42e978
 SHA512:
-  metadata.gz: 8d4dfa7278b3ec4542c2f4004648e52730d4a9791754b4b91401e68b51c07682c61c53b58e114061cd46cdc9cb008260e37b056d732017ee31089118d9d6f0f5
-  data.tar.gz: 636c0dc8dfe3c41d75a2d11239cd4be4d92682d09958baf3f89e1c5038fcd401c605efd27c8b1e171f210453901470b0d139d50931b2c4c25cb9d949e6e85cf9
+  metadata.gz: '069697c8db875ece53b7490a7ec095d695d2852dd1c6d20acc4a6d4a0acdcc4a59f7e978b8408f03796b52f9713991c2345f716aef964bf08bcfea364b384887'
+  data.tar.gz: 7de60430c90c5ce3f7f92afdb75307e1a8798d22ba75868dd6702970d829c81143943da96fc759612cf9d477e0fc6535e77bb793865ffe22b94efdf6f95d9ffc

data/CHANGES.md

@@ -1,10 +1,6 @@
 # Change History
 
-## v0.10.0a2 2017-08-17 (pre release)
-
-- Fix: require 'English', rather than require 'english'. Thanks to HIMANSHU-ELIGIBLE @ github for catching & fixing this one.
-
-## v0.10.0a1 2017-08-15 (pre release)
+## v0.10.0 2017-10-09
 
 - Improvement: Working with multiple APIConnections is now far more flexible!
 
@@ -16,6 +12,17 @@
   The default/active connection continues to work as always, so your existing code will be fine.
   See the [documentation for the JSS::APIConnection class](http://www.rubydoc.info/gems/ruby-jss/JSS/APIConnection) for details.
 - Fix: Specifying port 443, as well as 8443, when connecting an APIConnection will default to using SSL. To force such a connection to NOT use SSL, provide the parameter `use_ssl: false`
+- Fix: require 'English', rather than require 'english'. Thanks to HIMANSHU-ELIGIBLE @ github for catching & fixing this one.
+- Fix: Popup extension attributes can always take a blank value.
+- Fix: UserGroup members have a 'username' value, not 'name'
+- Add: Two case-insentive string methods added to Array:
+  - Array#jss_ci_include_string? Takes a string, returns true if the Array contains the string without regard to case.
+        E.g. `['ThrAsHer'].jss_ci_include_string? 'thrasher' # => true`
+  - Array#jss_ci_fetch_string Takes a string and fetches it from the array, regardless of case. Nil if not found.
+        E.g. `['thrasher'].jss_ci_fetch_string 'ThrAsHer'  # => 'thrasher'`
+- Fix: APIConnection.map_all_ids wasn't honoring :refresh
+- Improvement: Extendable module: only push changed EAs when `update` is called.
+- Add: Computer objects now have a `last_enrolled` attribute
 
 ## v0.9.3 2017-08-08
 

data/lib/jss.rb

@@ -77,6 +77,9 @@ module JSS
   ### When parsing a date/time data into a Time object, these will return nil
   NIL_DATES = [0, nil, '', '0'].freeze
 
+  ### Empty strings are used in various places
+  BLANK = ''.freeze
+
   ### Module Variables
   #####################################
 

data/lib/jss/api_connection.rb

@@ -658,7 +658,7 @@ module JSS
     def map_all_ids(class_name, refresh = false, to: nil)
       raise "'to:' value must be provided for mapping ids." unless to
       the_class = JSS.api_object_class(class_name)
-      the_class.map_all_ids_to to,  api: self
+      the_class.map_all_ids_to to, refresh, api: self
     end
 
     # Call the 'valid_id' method on a JSS::APIObject subclass

data/lib/jss/api_object.rb

@@ -444,7 +444,7 @@ module JSS
       # pass to .new
       if arg.is_a? Hash
         raise ArgumentError, 'Use .make to create new JSS objects' if arg[:id] == :new
-        api = arg[:api] if arg[:api]
+        arg[:api] ||= api
         return new arg
       end
 
@@ -452,7 +452,7 @@ module JSS
       # and if it's result includes the desired value,
       # the pass they key and arg to .new
       lookup_key_list_methods.each do |key, method_name|
-        return new ({ key => arg, :api => api }) if method_name && send(method_name).include?(arg)
+        return new(key => arg, :api => api) if method_name && send(method_name).include?(arg)
       end # each key
 
       # if we're here, we couldn't find a matching object
@@ -610,10 +610,10 @@ module JSS
     #
     def save
       if @in_jss
-        raise JSS::UnsupportedError, 'Updating this object in the JSS is currently not supported' unless updatable?
+        raise JSS::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
         update
       else
-        raise JSS::UnsupportedError, 'Creating this object in the JSS is currently not supported' unless creatable?
+        raise JSS::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
         create
       end
     end

data/lib/jss/api_object/advanced_search/advanced_mobile_device_search.rb

@@ -53,8 +53,7 @@ module JSS
     RSRC_BASE = 'advancedmobiledevicesearches'.freeze
 
     # the hash key used for the JSON list output of all objects in the JSS
-    # NOTE - THIS IS A BUG, it should be advanced_mobile_device_searches
-    RSRC_LIST_KEY = :advanced_computer_searches
+    RSRC_LIST_KEY = :advanced_mobile_device_searches
 
     # The hash key used for the JSON object output.
     # It's also used in various error messages

data/lib/jss/api_object/computer.rb

@@ -540,6 +540,9 @@ module JSS
     # @return [Time] the last contact time
     attr_reader :last_contact_time
 
+    # @return [Time] the last time this machine was enrolled
+    attr_reader :last_enrolled
+
     # @return [String] the primary macaddress
     attr_reader :mac_address
 
@@ -743,6 +746,7 @@ module JSS
       @barcode_2 = @init_data[:general][:barcode_2]
       @distribution_point = @init_data[:general][:distribution_point]
       @initial_entry_date = JSS.epoch_to_time @init_data[:general][:initial_entry_date_epoch]
+      @last_enrolled = JSS.epoch_to_time @init_data[:general][:last_enrolled_date_epoch]
       @ip_address = @init_data[:general][:ip_address]
       @jamf_version = @init_data[:general][:jamf_version]
       @last_contact_time = JSS.epoch_to_time @init_data[:general][:last_contact_time_epoch]

data/lib/jss/api_object/criteriable/criteria.rb

@@ -94,7 +94,7 @@ module JSS
       ### @return [void]
       ###
       def criteria= (new_criteria)
-        unless new_criteria.is_a?(Array) && new_criteria.reject{ |c| c.is_a? JSS::Criteriable::Criterion }.empty?
+        unless new_criteria.is_a?(Array) && new_criteria.reject{ |c| c.is_a?(JSS::Criteriable::Criterion) }.empty?
           raise JSS::InvalidDataError, "Argument must be an Array of JSS::Criteriable::Criterion instances."
         end
         new_criteria.each{ |nc| criterion_ok? nc }

data/lib/jss/api_object/extendable.rb

@@ -139,6 +139,11 @@ module JSS
         @ext_attrs[ea[:name]] = ea[:value]
 
       end # each do ea
+
+      # remember changes as they happen so
+      # we only send changes back to the server.
+      @changed_eas = []
+
     end
 
     ###
@@ -159,6 +164,9 @@ module JSS
     ###
     def set_ext_attr(name, value)
 
+      # if we don't currently have any need to update(cuz we have recently), reset the list of changes to push
+      @changed_eas = [] unless @need_to_update
+
       # this will raise an exception if the name doesn't exist
       ea_def = self.class::EXT_ATTRIB_CLASS.new :name => name
 
@@ -184,8 +192,9 @@ module JSS
         ea[:value] = value if ea[:name] == name
       end
       @ext_attrs[name] = value
-
+      @changed_eas << name
       @need_to_update = true
+
     end
 
     ###
@@ -195,10 +204,10 @@ module JSS
     ###  included in the rest_xml of objects that mix-in this module.
     ###
     def ext_attr_xml
-
+      @changed_eas ||= []
       eaxml = REXML::Element.new('extension_attributes')
-
       @extension_attributes.each do |ea|
+        next unless @changed_eas.include? ea[:name]
         ea_el = eaxml.add_element('extension_attribute')
         ea_el.add_element('name').text = ea[:name]
 

data/lib/jss/api_object/extension_attribute.rb

@@ -99,6 +99,9 @@ module JSS
     ### These input types can be modified, the others cannot.
     EDITABLE_INPUT_TYPES = ["Text Field", "Pop-up Menu"]
 
+    ### Popup choices can, for now, take empty strings
+    BLANK = ''.freeze
+
     ### Where can it be displayed in the WebApp?
     ### subclasses can add to this list
     WEB_DISPLAY_CHOICES = [
@@ -162,6 +165,8 @@ module JSS
       if @init_data[:input_type]
         @input_type = @init_data[:input_type][:type] || DEFAULT_INPUT_TYPE
         @popup_choices = @init_data[:input_type][:popup_choices]
+        # popups can always contain blank
+        @popup_choices << JSS::BLANK if @popup_choices
       else
         @input_type = DEFAULT_INPUT_TYPE
       end
@@ -391,7 +396,7 @@ module JSS
 
       begin
         search_class = self.class::TARGET_CLASS::SEARCH_CLASS
-        acs = search_class.new id: :new, name: tmp_advsrch, api: @api
+        acs = search_class.make name: tmp_advsrch, api: @api
         acs.display_fields = self.class::TARGET_CLASS == JSS::User ?  [@name, USERNAME_FIELD] : [@name, USERNAME_FIELD, LAST_RECON_FIELD]
 
         # search for 'Username like "" ' because all searchable object classes have a "Username" value
@@ -416,7 +421,7 @@ module JSS
 
       ensure
         if defined? acs
-          acs.delete
+          acs.delete if acs
         else
           search_class.fetch(:name => tmp_advsrch, api: @api).delete if search_class.all_names(:refresh, api: @api).include? tmp_advsrch
         end

data/lib/jss/api_object/group.rb

@@ -279,7 +279,7 @@ module JSS
     def remove_member(m)
       raise InvalidDataError, "Smart group members can't be changed." if @is_smart
 
-      if @members.reject!{ |mm|  [mm[:id], mm[:name]].include? m  }
+      if @members.reject!{ |mm|  [mm[:id], mm[:name], mm[:username]].include? m  }
         @need_to_update = true
       else
         raise JSS::NoSuchItemError, "No member matches '#{m}'"

data/lib/jss/ruby_extensions.rb

@@ -27,7 +27,6 @@
 ### if they are type coercions, "to_jss_"
 ###
 
-###
 require "jss/ruby_extensions/filetest.rb"
 require "jss/ruby_extensions/hash.rb"
 require "jss/ruby_extensions/ipaddr.rb"
@@ -35,3 +34,4 @@ require "jss/ruby_extensions/object.rb"
 require "jss/ruby_extensions/pathname.rb"
 require "jss/ruby_extensions/time.rb"
 require "jss/ruby_extensions/string.rb"
+require "jss/ruby_extensions/array.rb"

data/lib/jss/ruby_extensions/array.rb

@@ -0,0 +1,52 @@
+# 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.
+#
+#
+
+#
+class Array
+
+  # A case-insensitive version of #include? for Arrays of Strings.
+  #
+  # @param somestring [String] the String to search for
+  #
+  # @return [Boolean] Does the Array contain the String, ignoring case?
+  #
+  def jss_ci_include_string?(somestring)
+    any? { |s| s.to_s.casecmp(somestring).zero? }
+  end
+
+  # Fetch a string from an Array of Strings case-insensitively,
+  # e.g. my_array.jss_ci_fetch_string('ThRashEer') will return 'thrasher'
+  # or nil if no match
+  #
+  # @param somestring [String] the String to search for
+  #
+  # @return [String, nil] The matching string as it exists in the Array, nil if it doesn't exist
+  #
+  def jss_ci_fetch_string(somestring)
+    idx = index { |s| s.to_s.casecmp(somestring).zero? }
+    idx ? self[idx] : nil
+  end
+
+end # class

data/lib/jss/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 0.10.0a3
+  version: 0.10.0
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2017-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -172,6 +172,7 @@ files:
 - lib/jss/db_connection.rb
 - lib/jss/exceptions.rb
 - lib/jss/ruby_extensions.rb
+- lib/jss/ruby_extensions/array.rb
 - lib/jss/ruby_extensions/filetest.rb
 - lib/jss/ruby_extensions/hash.rb
 - lib/jss/ruby_extensions/ipaddr.rb
@@ -204,9 +205,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8