Skip to content

Commit

Permalink
Update readme, gemspec.
Browse files Browse the repository at this point in the history
  • Loading branch information
toothrot committed Nov 11, 2009
1 parent 5f2752c commit b378d33
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
15 changes: 11 additions & 4 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= inquisition
= Inquisition

== Introduction

Expand All @@ -9,14 +9,21 @@ It keeps your strings heresy-free.

Inquisition offers you three methods on Object:

cleanse_attr *attributes
cleanse_attr_reader *attributes
cleanse_attr_writer *attributes
cleanse_attr *attributes, options
cleanse_attr_reader *attributes, options
cleanse_attr_writer *attributes, options

These methods will wrap your getters and/or setters for an attribute through a
HTML5 Sanitizer. This should help to protect against most kinds of cross site
scripting attacks.

For example:

cleanse_attr :name, :allow => {:name => /(<strong>)/}

The above example will clean all values written to or read from the name
attribute, but will not remove strong tags.

== Installation

sudo gem install thumblemonks-inquisition
Expand Down
8 changes: 4 additions & 4 deletions inquisition.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Gem::Specification.new do |s|
s.name = %q{inquisition}
s.version = "0.2"
s.version = "0.3"

s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["toothrot"]
s.date = %q{2009-07-06}
s.date = %q{2009-11-11}
s.email = %q{[email protected]}
s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
s.files = ["VERSION.yml", "README.rdoc", "lib/inquisition.rb", "lib/html5lib_sanitize.rb", "test/inquisition_test.rb", "test/performance.rb", "test/models.rb", "test/test_helper.rb", "Rakefile", "LICENSE"]
Expand All @@ -15,12 +15,12 @@ Gem::Specification.new do |s|
s.post_install_message = %q{Choosy heretics choose Thumble Monks.}
s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
s.require_paths = ["lib"]
s.rubygems_version = %q{1.3.1}
s.rubygems_version = %q{1.3.5}
s.summary = %q{Inquisition is a fancy way to protect your ActiveRecord attributes from XSS}

if s.respond_to? :specification_version then
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
s.specification_version = 2
s.specification_version = 3

if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
s.add_runtime_dependency(%q{html5}, [">= 0.10.0"])
Expand Down

0 comments on commit b378d33

Please sign in to comment.