Contents

# Hackerone::Client

A limited client library for interacting with HackerOne. Currently only supports a few operations:

```ruby 
client = HackerOne::Client::Api.new("github")

# GET`/reports` returns all reports in the "new" state for a given program
client.reports

# GET `/report/{id}` returns report data for a given report
client.report(id)

# POST '/report/{id}/state_change change the state of a report
# `state` can be one of  new, triaged, needs-more-info, resolved, not-applicable, informative, duplicate, spam
client.state_change(id, state)

# POST '/report/{id}/add_report_reference add a "reference" e.g. internal issue number
client.add_report_reference(id, reference)

# Triage an issue (add a reference and set state to :triaged)
client.triage(id, reference)
```

## Usage

### Credential management

You'll need to generate an API token at https://hackerone.com/<program>/api.

* Click "Create API token"
* Name the token
* Click "Create"
* Copy down the value

Set the `HACKERONE_TOKEN` and `HACKERONE_TOKEN_NAME` environment variables.

### Program name

In order to retrieve all reports for a given program, you need to supply a default program:

```ruby
HackerOne::Client.program = "github"
```

### Risk classification

Configure the low/med/high/crit ranges for easier classification based on payouts:

```ruby
HackerOne::Client.low_range = 1..999
HackerOne::Client.medium_range = 1000...2500
HackerOne::Client.high_range = 2500...5000
HackerOne::Client.critical_range = 5000...100_000_000
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/oreoshake/hackerone-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
hackerone-client-0.3.2	README.md
hackerone-client-0.3.1	README.md
hackerone-client-0.3.0	README.md
hackerone-client-0.2.3	README.md
hackerone-client-0.2.2	README.md
hackerone-client-0.2.1	README.md