canonix 0.1.2 → 0.1.3

data/README.rdoc

@@ -1,8 +1,16 @@
-= xmlcanonicalizer
+= Canonix
 
 XML Canonicalizer for Ruby >= 1.92
 
-This is taken from XMLCanonicalizer/WSS4R and http://github.com/borisnadion/xml-canonicalizer
+This is taken from XMLCanonicalizer/WSS4R and http://github.com/borisnadion/xml-canonicalizer and https://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: https://github.com/brendon/canonix/issues/2.
 
 == Note on Patches/Pull Requests
  
@@ -12,8 +20,4 @@ This is taken from XMLCanonicalizer/WSS4R and http://github.com/borisnadion/xml-
   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.
-
-== Copyright
-
-Copyright (c) 2010 Andrew Ferk. See LICENSE for details.
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -8,7 +8,7 @@ begin
     gem.summary = %Q{XML Canonicalizer for Ruby >= 1.92}
     gem.description = %Q{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 Canonicaliser as the other project seems to be abandoned.}
+      Ruby XML Canonicaliser as the other project seems to be abandoned.}
     gem.email = "brendon@spike.net.nz"
     gem.homepage = "http://github.com/brendon/canonix"
     gem.authors = ["Brendon Muir"]

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/canonix.gemspec

@@ -5,23 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{canonix}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brendon Muir"]
   s.date = %q{2011-07-03}
   s.description = %q{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 Canonicaliser as the other project seems to be abandoned.}
+      Ruby XML Canonicaliser as the other project seems to be abandoned.}
   s.email = %q{brendon@spike.net.nz}
   s.extra_rdoc_files = [
-    "LICENSE",
     "README.rdoc"
   ]
   s.files = [
     ".document",
     ".rvmrc",
-    "LICENSE",
     "README.rdoc",
     "Rakefile",
     "VERSION",

metadata

@@ -2,7 +2,7 @@
 name: canonix
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Brendon Muir
@@ -27,19 +27,17 @@ dependencies:
 description: |-
   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 Canonicaliser as the other project seems to be abandoned.
+        Ruby XML Canonicaliser as the other project seems to be abandoned.
 email: brendon@spike.net.nz
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.rdoc
 files: 
 - .document
 - .rvmrc
-- LICENSE
 - README.rdoc
 - Rakefile
 - VERSION

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 Andrew Ferk
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.