Skip to content

tknzk/saml_idp_metadata

Repository files navigation

SAML IdP Metadata Parser

CircleCI Build Status

Parser for SAML IdP metadata

Installation

Add this line to your application's Gemfile:

gem 'saml_idp_metadata'

And then execute:

$ bundle

Or install it yourself as:

$ gem install saml_idp_metadata

Usage

Basic one:

# validate_xmlsn

xml = File.read('./idp_metadata.xml')

SamlIdpMetadata::Parser.call(xml: xml).validate_xmlns
# ensure_params?
xml = File.read('./idp_metadata.xml')

SamlIdpMetadata::Parser.call(xml: xml).ensure_params?
# build_params
xml = File.read('./idp_metadata.xml')

SamlIdpMetadata::Parser.call(xml: xml).build_params

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tknzk/saml_idp_metadata. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the SamlIdpMetadata project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.