README.md

VulnDB HQ Ruby Gem

This gem provides a Ruby wrapper to the VulnDB HQ API (http://vulndbhq.com).

Installation

Add this line to your application's Gemfile:

gem 'vulndbhq'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vulndbhq

Configuration

To provide your access credentials:

require 'vulndbhq'

client = VulnDBHQ::client
client.host = 'https://you.vulndbhq.com'
client.user = '[email protected]'
client.password = 'password'

Or provide configuration in line:

client = VulnDBHQ::Client.new(host: 'https://your.vulndbhq.com', user: '[email protected]', password: 'password')

Usage examples

Return the all PrivatePage:

client.private_pages

Return private pages containing XSS

client.private_pages(q: 'XSS')

Get a PrivatePage by id:

private_page = client.private_page(1)

puts private_page.name
puts private_page.content

Return all the PublicPages:

client.public_pages

See the VulnDB HQ API docs for the full list of available methods.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Copyright

Copyright (c) 2012 Daniel Martin, Security Roots Ltd. See LICENSE for details.

Acknowledgements

This gem uses the Faraday gem for the HTTP layer and is inspired by the Twitter gem architecture.