ruby-jss 1.2.3 → 1.2.4a1

data/lib/jamf/api/json_objects/prestage_sync_status.rb

@@ -0,0 +1,63 @@
+# Copyright 2019 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 Module
+module Jamf
+
+  # Classes
+  #####################################
+
+  # A building defined in the JSS
+  class PrestageSyncStatus < Jamf::JSONObject
+
+    extend Jamf::Immutable
+
+    OBJECT_MODEL = {
+
+      # @!attribute syncState [r]
+      #   @return [String]
+      syncState: {
+        class: :string
+      },
+
+      # @!attribute prestageId [r]
+      #   @return [Integer]
+      prestageId: {
+        class: :integer
+      },
+
+      # @!attribute timestamp [r]
+      #   @return [Jamf::Timestamp]
+      timestamp: {
+        class: Jamf::Timestamp
+      },
+
+    }.freeze
+
+    parse_object_model
+
+  end # class
+
+end # module

data/lib/jamf/api/json_objects/purchasing_data.rb

@@ -0,0 +1,125 @@
+# Copyright 2019 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 module
+module Jamf
+
+  # A 'location' for a managed object in Jamf Pro
+  class PurchasingData < Jamf::JSONObject
+
+    # TODO: setters or an uncreated device?
+
+    OBJECT_MODEL = {
+
+      # @!attribute isPurchased
+      #   @param [String]
+      #   @return [String]
+      isPurchased: {
+        class: :boolean
+      },
+
+      # @!attribute isLeased
+      #   @param [String]
+      #   @return [String]
+      isLeased: {
+        class: :boolean
+      },
+
+      # @!attribute poNumber
+      #   @param [String]
+      #   @return [String]
+      poNumber: {
+        class: :string
+      },
+
+      # @!attribute appleCareId
+      #   @param [String]
+      #   @return [String]
+      appleCareId: {
+        class: :string
+      },
+
+      # @!attribute vendor
+      #   @param [String]
+      #   @return [String]
+      vendor: {
+        class: :string
+      },
+
+      # @!attribute purchasePrice
+      #   @param [String]
+      #   @return [String]
+      purchasePrice: {
+        class: :string
+      },
+
+      # @!attribute purchasingAccount
+      #   @param [String]
+      #   @return [String]
+      purchasingAccount: {
+        class: :string
+      },
+
+      # @!attribute poDate
+      #   @param [String]
+      #   @return [String]
+      poDate: {
+        class: Jamf::Timestamp
+      },
+
+      # @!attribute warrantyExpiresDate
+      #   @param [String]
+      #   @return [String]
+      warrantyExpiresDate: {
+        class: Jamf::Timestamp
+      },
+
+      # @!attribute leaseExpiresDate
+      #   @param [String]
+      #   @return [String]
+      leaseExpiresDate: {
+        class: Jamf::Timestamp
+      },
+
+      # @!attribute lifeExpectancy
+      #   @param [String]
+      #   @return [String]
+      lifeExpectancy: {
+        class: :integer
+      },
+
+      # @!attribute purchasingContact
+      #   @param [String]
+      #   @return [String]
+      purchasingContact: {
+        class: :string
+      }
+    }.freeze
+
+    parse_object_model
+
+  end # class location
+
+end # module

data/lib/jamf/api/mixins/abstract.rb

@@ -0,0 +1,58 @@
+# Copyright 2019 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 Jamf
+
+  # This mixin should be extended in abstract class definitions
+  # it will raise an error if those classes are instantiated.
+  # It also maintains an array of classes that extend themselves this way
+  # and are abstract.
+  module Abstract
+
+    # when a class is extended by this module, it
+    # gets added to the array of known abstract classes
+    def self.extended(by_class)
+      abstract_classes << by_class
+    end
+
+    # Classes will be added to this array as they are exteded by Abstract
+    def self.abstract_classes
+      @abstract_classes ||= []
+    end
+
+    def self.abstract?
+      abstract_classes.include? self
+    end
+
+    # when any extended class or subclass of an extended class is instntiated
+    # check that it isn't in the abstract list.
+    def new(*args, &block)
+      raise Jamf::UnsupportedError, "Unsupported: #{self} is an abstract class, cannot be instantiated." if Jamf::Abstract.abstract_classes.include? self
+
+      super
+    end
+
+  end # module Abstract
+
+end # Jamf

data/lib/jamf/api/mixins/bulk_deletable.rb

@@ -0,0 +1,39 @@
+# Copyright 2019 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 Jamf
+
+  # This mixin overrides JSONObject.mutable? to return false,
+  # meaning that no setters are ever defined, and if the
+  # object is a Jamf::Resource, #save will raise an error
+  #
+  module Immutable
+
+    def mutable?
+      false
+    end
+
+  end # Lockable
+
+end # Jamf

data/lib/jamf/api/mixins/change_log.rb

@@ -0,0 +1,136 @@
+# Copyright 2019 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 Jamf
+
+  # a mix-in module for Jamf::Resource subclasses.
+  #
+  # Many Jamf resources maintain an 'object history', available in the WebUI via
+  # the 'History' button at the bottom of a page. Ad-hoc history entries can
+  # be added containing textual notes, which is useful for objects that don't
+  # have a real 'notes' or 'description' field, like policies.
+  #
+  # In the Jamf Pro API, this history is usually available at a resource path
+  # ending with '/history'
+  #
+  # Due to the many kinds of history available in Jamf,  like management
+  # history, application usage history, and so on, ruby-jss uses the term
+  # 'change log' to refer to a Jamf resource's 'object history', and access
+  # to the change log is provided by this module.
+  #
+  # The change log can be available in different places:
+  #
+  # - instances of a CollectionResources (e.g. individual policies)
+  #   - mix-in this module by including it, to get instance methods
+  # - CollectionResources as a whole (e.g. Inventory Preload Records)
+  #   - mix-in this module by extending it, to get class methods
+  # - SingletonResources (e.g. Client Checkin Settings )
+  #   - mix-in this module by including AND extending, to get both
+  #
+  # This module will add two methods:
+  #
+  #   1) #change_log,  will fetch and cache an Array of readonly
+  #     Jamf::ChangeLogEntry instances. passing any truthy parameter will
+  #     cause it to re-fetch the Array from the server.
+  #
+  #   2) #add_history_note(note), which takes a string and adds it to the
+  #     object's change history as a note and re-fetches & caches the history.
+  #
+  module ChangeLog
+
+    # The change and note history for this resource.
+    #
+    # The history is cached internally and only re-fetched when
+    # a truthy parameter is given.
+    #
+    # @param refresh[Boolean] re-fetch and re-cache the history
+    #
+    # @return [Array<Jamf::ChangeHistoryEntry>] The change and note history for
+    #   this resource
+    #
+    def change_log(refresh = false, cnx: Jamf.cnx)
+      # this should only be true for instances of CollectionResources
+      cnx = @cnx if @cnx
+
+      @change_log = nil if refresh
+      @change_log ||= cnx.get(change_log_rsrc)[:results].map! do |l|
+        #
+        # TODO: Report bug in jamf data, sometimes there's no details in the JSON
+        # so add an empty string if needed. DO it for note too, just in case
+        l[:details] ||= Jamf::BLANK
+        l[:note] ||= Jamf::BLANK
+
+        Jamf::ChangeLogEntry.new l
+      end # map!
+    end
+
+    # Add a note to this resource's change log.
+    #
+    # If the change history has been cached already, it is
+    # recached after adding the note.
+    #
+    # @param note[String] The note to add. It cannot be empty.
+    #
+    # @return [void]
+    #
+    def add_change_log_note(note, cnx: Jamf.cnx)
+      # this should only be true for instances of CollectionResources
+      cnx = @cnx if @cnx
+
+      note = Jamf::Validate.non_empty_string note
+      note_to_send = { note: note }
+      cnx.post change_log_rsrc, note_to_send
+      # flush the cached data, force reload when next accessed, to get new note
+      @change_log = nil
+    end
+
+    # Private methods
+    ###########################
+    private
+
+    # TODO: Implement paging
+    def change_log_rsrc
+      @change_log_rsrc ||= "#{rsrc_path}/history"
+    end
+
+    # def change_log_rsrc(page: nil, size: nil)
+    #   params = ''
+    #   params << '?' if page || size
+    #   if page
+    #
+    #   end
+    #
+    #   if size
+    #
+    #   end
+    #   params << '?' if page || size
+    #   params << '?' if page || size
+    #
+    #   @change_log_rsrc ||= "#{rsrc_path}/history"
+    # end
+
+  end # module ChangeHistory
+
+end # module

data/lib/jamf/api/mixins/extendable.rb

@@ -0,0 +1,75 @@
+# Copyright 2019 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 Jamf
+
+  #
+  module Extendable
+
+    # The Array of extensionAttributes converted to a Hash of
+    # 'Name' => value
+    def ext_attrs
+      extensionAttributes.map { |ea| [ea.name, ea.value] }.to_h.freeze
+    end
+
+    def ext_attr_names
+      extensionAttributes.map(&:name).freeze
+    end
+
+    def set_ext_attr(ea_name, new_val)
+      raise Jamf::NoSuchItemError, "No ext attr named '#{ea_name}'" unless ext_attr_names.include? ea_name
+      eattr = extensionAttributes.select { |ea| ea.name == ea_name }.first
+      eattr.send :new_value=, new_val
+    end
+
+    def ext_attrs_to_update
+      extensionAttributes.select(&:unsaved_changes?)
+    end
+
+    def ext_attrs_unsaved_changes
+      ext_attrs_to_update.map do |ea|
+        [ea.name,
+         {
+           old: ea.unsaved_changes[:value][:old],
+           new: ea.unsaved_changes[:value][:new]
+         }]
+      end.to_h
+    end
+
+    def ext_attrs_unsaved_changes?
+      !ext_attrs_to_update.empty?
+    end
+
+    def ext_attrs_clear_unsaved_changes
+      ext_attrs_to_update.each(&:clear_unsaved_changes)
+    end
+
+    def ext_attrs_to_jamf
+      ext_attrs_to_update.map(&:to_jamf)
+    end
+
+  end # extendable
+
+end # module