Contents

# frozen_string_literal: true

require 'saml/kit/namespaces'

module Saml
  module Kit
    module XmlParseable
      NAMESPACES = {
        NameFormat: ::Saml::Kit::Namespaces::ATTR_SPLAT,
        ds: ::Xml::Kit::Namespaces::XMLDSIG,
        md: ::Saml::Kit::Namespaces::METADATA,
        saml: ::Saml::Kit::Namespaces::ASSERTION,
        samlp: ::Saml::Kit::Namespaces::PROTOCOL,
        xmlenc: ::Xml::Kit::Namespaces::XMLENC,
      }.freeze

      # Returns the SAML document returned as a Hash.
      def to_h
        @to_h ||= Hash.from_xml(to_s) || {}
      end

      # Returns the XML document as a String.
      #
      # @param pretty [Boolean] true to return a human friendly version
      # of the XML.
      def to_xml(pretty: nil)
        pretty ? to_nokogiri.to_xml(indent: 2) : to_s
      end

      # Returns the SAML document as an XHTML string.
      # This is useful for rendering in a web page.
      def to_xhtml
        Nokogiri::XML(to_xml, &:noblanks).to_xhtml
      end

      def present?
        to_s.present?
      end

      # @!visibility private
      def to_nokogiri
        @to_nokogiri ||= Nokogiri::XML(to_s)
      end

      # @!visibility private
      def at_xpath(xpath)
        return unless present?
        to_nokogiri.at_xpath(xpath, NAMESPACES)
      end

      # @!visibility private
      def search(xpath)
        to_nokogiri.search(xpath, NAMESPACES)
      end

      # Returns the XML document as a [String].
      def to_s
        content
      end
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version	Path
saml-kit-1.0.24	lib/saml/kit/concerns/xml_parseable.rb
saml-kit-1.0.23	lib/saml/kit/concerns/xml_parseable.rb
saml-kit-1.0.22	lib/saml/kit/concerns/xml_parseable.rb
saml-kit-1.0.21	lib/saml/kit/concerns/xml_parseable.rb
saml-kit-1.0.20	lib/saml/kit/concerns/xml_parseable.rb
saml-kit-1.0.19	lib/saml/kit/concerns/xml_parseable.rb
saml-kit-1.0.18	lib/saml/kit/concerns/xml_parseable.rb
saml-kit-1.0.17	lib/saml/kit/concerns/xml_parseable.rb
saml-kit-1.0.16	lib/saml/kit/concerns/xml_parseable.rb