Project

canonix

0.02
No commit activity in last 3 years
No release in over 3 years
This is based on andrewferk's rewrite for Ruby 1.9 compatibility, but applies relevance's fix to ensure proper canonicalisation. It is intended that this be the new official Ruby XML Canonicaliser as the other project seems to be abandoned.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

 Project Readme

Canonix¶ ↑

XML Canonicalizer for Ruby >= 1.9.2

This is taken from XMLCanonicalizer/WSS4R and github.com/borisnadion/xml-canonicalizer and github.com/andrewferk/xmlcanonicalizer.

This gem is intended to replace andrewferk’s xmlcanonicalizer which appears to have been abandoned.

History¶ ↑

The main reason why this gem was created was to provide a working XML Canonicaliser for the ruby-saml project. The original gem had a bug in it that prevented it from correctly processing namespaced XML documents. A patch was provided by relevance and has been applied to canonix.

I personally have little understanding of the inner workings of this code, and will happily accept pull requests to fix any issues that you may come across (with tests please). I am also not aware of which XML Canonicalisation algorithm is implemented by this gem, and a discussion on this matter can be found here: github.com/brendon/canonix/issues/2.

Note on Patches/Pull Requests¶ ↑

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

  • Send me a pull request. Bonus points for topic branches.