Contents

#
# Copyright (c) 2006-2021 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 <https://www.gnu.org/licenses/>.
#

require 'ronin/model'

require 'uri/query_params'

module Ronin
  #
  # Represents a query param that belongs to a {URL}.
  #
  class URLQueryParam

    include Model

    # The primary-key of the URL query param
    property :id, Serial

    # The name of the URL query param
    belongs_to :name, :model => 'URLQueryParamName'

    # The value of the URL query param
    property :value, Text

    # The URL
    belongs_to :url, :model => 'URL'

    #
    # Converts the URL query param to a String.
    #
    # @return [String]
    #   The dumped URL query param.
    #
    # @since 1.0.0
    #
    # @api public
    #
    def to_s
      URI::QueryParams.dump(self.name.to_s => self.value)
    end

    #
    # Inspects the URL query param.
    #
    # @return [String]
    #   The inspected URL query param.
    #
    # @since 1.0.0
    #
    # @api public
    #
    def inspect
      "#<#{self.class}: #{self}>"
    end

  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ronin-1.5.1	lib/ronin/url_query_param.rb