Contents

# SecurityGuard

This gem is a collection of useful tools for auditing data and performing security checks.

## Installation

Add this line to your application's Gemfile:

    gem 'security_guard'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install security_guard

## Usage

### Executable

There is an `sguard` command if you intend to use security_guard as a command line tool. Please refer to the help option for its usage.

    sguard -h

### Tips

You can pass in setters during initialisation, for example:

```ruby
country_ips = SecurityGuard::CountryIps.new
country_ips.countries = ['Australia', 'United Kingdom']
country_ips.ips = ['4.4.4.4', '8.8.8.8', '203.206.0.1']

# the above is equivalent to:

country_ips = SecurityGuard::CountryIps.new(
  :countries => ['Australia', 'United Kingdom']
  :ips       => ['4.4.4.4', '8.8.8.8', '203.206.0.1']
)
```

### Country IPs

Returns a list of the IPs from given country and IP dictionaries. Useful for auditing IPs from higher risk nations.

```ruby
country_ips = SecurityGuard::CountryIps.new
country_ips.countries = ['Australia', 'United Kingdom']
country_ips.ips = ['4.4.4.4', '8.8.8.8', '203.206.0.1']
country_ips.result # => ['203.206.0.1']
```

You may also pass country and IP data as a line-delimited file by appending `_from_file` at the end of the attributes:

```ruby
country_ips.countries_from_file = '/path/to/the/file'
country_ips.ips_from_file = '/path/to/the/file'
```

## Changelog

### v0.0.3 [2012-01-20]

- Added Concerns::Initializable

### v0.0.2 [2012-01-19]

- Added IP address sanity check
- Coloured test output
- Added changelog

### v0.0.1 [2012-01-18]

- First release, implemented SecurityGuard::CountryIps and `bin/sguard`

## Contributing

1. Fork it
2. Make sure you add documentation to README.md
3. Make sure you test all your code
4. Do your magic!
5. Create a new Pull Request

## Author

- [Fred Wu](http://fredwu.me/)

Brought to you by [SitePoint](http://www.sitepoint.com/).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
security_guard-0.0.3	README.md