Skip to content
This repository has been archived by the owner on Dec 31, 2020. It is now read-only.
/ bugcrowd Public archive

(Unofficial) Ruby wrapper for the Bugcrowd HTTP API

License

Notifications You must be signed in to change notification settings

mattreduce/bugcrowd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bugcrowd

(Unofficial) Ruby wrapper for the Bugcrowd HTTP API.

Installation

Add this line to your application's Gemfile:

gem 'bugcrowd'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bugcrowd

Usage

Locally or in production, expose your Bugcrowd API credentials via environment variables:

export BUGCROWD_USER=yourusername
export BUGCROWD_PASSWORD=yourpass

Then use the client in either of two ways:

Bugcrowd.list_bounties

client = Bugcrowd::Client.new(username: 'yourusername', password: 'yourpass')
client.list_bounties

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

License

The gem is available as open source under the terms of the MIT License.