### 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 JSS

  # Module Variables
  #####################################

  # Module Methods
  #####################################

  # Classes
  #####################################

  # An iBeacon in the JSS.
  # @see JSS::APIObject
  #
  class IBeacon < JSS::APIObject

    # Mix-Ins
    #####################################
    include JSS::Creatable
    include JSS::Updatable

    # Class Methods
    #####################################

    # Class Constants
    #####################################

    # The base for REST resources of this class
    RSRC_BASE = 'ibeacons'.freeze

    # the hash key used for the JSON list output of all objects in the JSS
    RSRC_LIST_KEY = :ibeacons

    # The hash key used for the JSON object output.
    # It's also used in various error messages
    RSRC_OBJECT_KEY = :ibeacon

    # the object type for this object in
    # the object history table.
    # See {APIObject#add_object_history_entry}
    OBJECT_HISTORY_OBJECT_TYPE = 360

    # The major & minor values, if used, must be in this range
    MAJOR_MINOR_RANGE = 0..65_535.freeze

    # If not used, this is the value for the major and minor
    MAJOR_MINOR_UNUSED = -1

    # Attributes
    #####################################

    ### @return [String] the top-level region identifier, a valid UUID
    attr_reader :uuid

    ### @return [IPAddr] the mid-level region identifier,
    # an integer within MAJOR_MINOR_RANGE or MAJOR_MINOR_UNUSED
    attr_reader :major

    ### @return [IPAddr] the low-level region identifier,
    # an integer within MAJOR_MINOR_RANGE or MAJOR_MINOR_UNUSED
    attr_reader :minor

    # Constructor
    # @see JSS::APIObject.initialize
    #####################################
    def initialize(args = {})
      super args

      @uuid = @init_data[:uuid]
      @major = @init_data[:major]
      @minor = @init_data[:minor]

      # defaults
      @major ||= MAJOR_MINOR_UNUSED
      @minor ||= MAJOR_MINOR_UNUSED
    end # init


    # Public Instance Methods
    #####################################

    # set the uuid
    #
    # @param newval[String] the new uuid
    #
    # @return [void]
    #
    def uuid=(newval)
      JSS::Validate.uuid newval
      @uuid = newval
      @need_to_update = true
    end

    # Set the major value to for this iBeacon region.
    # Use nil or -1 to not use the major value
    #
    # @param newval[String] the new value
    #
    # @return [void]
    #
    def major=(newval)
      if newval.nil? || newval == MAJOR_MINOR_UNUSED
        newval ||= MAJOR_MINOR_UNUSED
      else
        JSS::Validate.ibeacon_major_minor newval
      end
      @major = newval
      @need_to_update = true
    end

    # Set the minoe value to for this iBeacon region.
    # Use nil or -1 to not use the major value
    #
    # @param newval[String] the new value
    #
    # @return [void]
    #
    def minor=(newval)
      if newval.nil? || newval == MAJOR_MINOR_UNUSED
        newval ||= MAJOR_MINOR_UNUSED
      else
        JSS::Validate.ibeacon_major_minor newval
      end

      @minor = newval
      @need_to_update = true
    end

    # @return is the major identifier being used in this region?
    def using_major?
      @major == MAJOR_MINOR_UNUSED
    end

    # @return is the minor identifier being used in this region?
    def using_minor?
      @minor == MAJOR_MINOR_UNUSED
    end

    # @see Creatable.create
    def create
      raise JSS::MissingDataError, 'uuid may not be empty' if @uuid.to_s.empty?

      super
    end

    # @see Updatable.update
    def update
      raise JSS::MissingDataError, 'uuid may not be empty' if @uuid.to_s.empty?

      super
    end

    # private instance methods
    ######################
    private

    # the xml formated data for adding or updating this in the JSS
    #
    def rest_xml
      doc = REXML::Document.new APIConnection::XML_HEADER
      ns = doc.add_element RSRC_OBJECT_KEY.to_s
      ns.add_element('name').text = @name
      ns.add_element('uuid').text = @uuid
      ns.add_element('major').text = @major.to_s
      ns.add_element('minor').text = @minor.to_s
      doc.to_s
    end # rest_xml


  end # class ibeacon

end # module