#
# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# This file is part of Ronin.
#
# Ronin is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ronin is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
#

require 'ronin/model'

require 'dm-timestamps'

module Ronin
  #
  # Represents a open port at a specified IP address.
  #
  class OpenPort

    include Model
    include DataMapper::Timestamps

    # The primary key of the open port
    property :id, Serial

    # The IP Address that was scanned
    belongs_to :ip_address, :model => 'IPAddress'

    # The port
    belongs_to :port

    # The service detected on the port
    belongs_to :service, :required => false

    # any credentials used by the service running on the port
    has 0..n, :service_credentials

    # When the open-port was last scanned
    property :last_scanned_at, Time

    # Define the created_at timestamp
    timestamps :created_at

    #
    # The IP Address of the open port.
    #
    # @return [String]
    #   The IP Address.
    #
    # @since 1.0.0
    #
    # @api public
    #
    def address
      self.ip_address.address
    end

    #
    # The port number.
    #
    # @return [Integer]
    #   The port number.
    #
    # @since 1.0.0
    #
    # @api public
    #
    def number
      self.port.number
    end

    #
    # Converts the open port to an integer.
    #
    # @return [Integer]
    #   The port number.
    #
    # @since 1.0.0
    #
    # @api public
    #
    def to_i
      self.port.to_i
    end

    #
    # Converts the open port to a string.
    #
    # @return [String]
    #   The information of the open port.
    #
    # @since 1.0.0
    #
    # @api public
    #
    def to_s
      if self.service
        "#{self.port} (#{self.service})"
      else
        self.port.to_s
      end
    end

  end
end