murraysum / honeybadger-api Goto Github PK

View Code? Open in Web Editor NEW

11.0 3.0 8.0 125 KB

Ruby Library for the HoneyBadger Read API

License: MIT License

Ruby 100.00%

honeybadger honeybadger-read-api exceptions monitoring

honeybadger-api's Introduction

Honeybadger Read API

A Ruby Library for the Honeybadger Read API for easily pulling your data out of Honeybadger.

Installation

Add this line to your application's Gemfile:

gem "honeybadger-api"

And then execute:

$ bundle

Or install it yourself as:

$ gem install honeybadger-api

Usage

Introduction

Firstly require the library:

require "honeybadger-api"

Then configure your personal API access token. Your personal API access token can be found on your personal profile page:

Honeybadger::Api.configure do |c|
  c.access_token = "xxxxxxxxxxxxxxxxxxxx"
end

After you have setup your API access token you can now make requests.

Projects

# Find a project
Honeybadger::Api::Project.find(project_id)

# Find all the projects
Honeybadger::Api::Project.all

# Retrieve a paginator for projects
paginator = Honeybadger::Api::Project.paginate

There are several methods that you should be aware of when using the paginator.

# Get a paginator for a resource
paginator = Honeybadger::Api::Project.paginate


# Retrieve a paginator for projects starting at a page
paginator = Honeybadger::Api::Project.paginate(:page => 5)

# Whether there are any more previous or next pages
paginator.previous?
=> true
paginator.next?
=> true

# Retrieve the previous or next pages
paginator.previous
paginator.next

# Retrieve the current page number
paginator.current_page

# Return all previously requested pages as a Hash
paginator.pages
=> {
  1 => [
    #<Honeybadger::Api::Project @id=1, @name="Example">,
    #<Honeybadger::Api::Project @id=2, @name="Acme">
  ],
  2 => [
    #<Honeybadger::Api::Project @id=3, @name="Website">
  ]
}

# Return all previously requested pages as a collection
paginator.collection
=> [
  #<Honeybadger::Api::Project @id=1, @name="Example">,
  #<Honeybadger::Api::Project @id=2, @name="Acme">,
  #<Honeybadger::Api::Project @id=3, @name="Website">
]

Deploys

# Find a deploy
Honeybadger::Api::Deploy.find(project_id, deploy_id)

# Find all the deploys
Honeybadger::Api::Deploy.all(project_id)

# Retrieve a paginator for deploys
Honeybadger::Api::Deploy.paginate(project_id)

Faults

# Find a fault
Honeybadger::Api::Fault.find(project_id, fault_id)

# Find all the faults
Honeybadger::Api::Fault.all(project_id)

# Retrieve a paginator for faults
Honeybadger::Api::Fault.paginate(project_id)

Notices

# Find all the notices
Honeybadger::Api::Notice.all(project_id, fault_id)

# Retrieve a paginator for notices
Honeybadger::Api::Notice.paginate(project_id, fault_id)

Comments

# Find a comment
Honeybadger::Api::Comment.find(project_id, fault_id, comment_id)

# Find all the comments
Honeybadger::Api::Comment.all(project_id, fault_id)

# Retrieve a paginator for comments
Honeybadger::Api::Comment.paginate(project_id, fault_id)

Teams

# Find a team
Honeybadger::Api::Team.find(team_id)

# Find all the teams
Honeybadger::Api::Team.all

# Retrieve a paginator for teams
Honeybadger::Api::Team.paginate

Team Members

# Find a team member
Honeybadger::Api::TeamMember.find(team_id, team_member_id)

# Find all the team members
Honeybadger::Api::TeamMember.all(team_id)

# Retrieve a paginator for team members
Honeybadger::Api::TeamMember.paginate(team_id)

Team Invitations

# Find a team invitation
Honeybadger::Api::TeamInvitation.find(team_id, team_invitation_id)

# Find all the team invitations
Honeybadger::Api::TeamInvitation.all(team_id)

# Retrieve a paginator for team invitations
Honeybadger::Api::TeamInvitation.paginate(team_id)

Sites

# Find a site
Honeybadger::Api::Site.find(project_id, site_id)

# Find all the sites
Honeybadger::Api::Site.all(project_id)

# Retrieve a paginator for sites
Honeybadger::Api::Site.paginate(project_id)

Outages

# Find all the outages
Honeybadger::Api::Outage.all(project_id, site_id)

# Retrieve a paginator for outages
Honeybadger::Api::Outage.paginate(project_id, site_id)

Uptime Checks

# Find all the uptime checks
Honeybadger::Api::UptimeCheck.all(project_id, site_id)

# Retrieve a paginator for uptime checks
Honeybadger::Api::UptimeCheck.paginate(project_id, site_id)

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

honeybadger-api's People

Contributors

Stargazers

Watchers

Forkers

amelikh2 ajish wlojtek andystabler advancedenergyeconomy cuvant peterwilson kewlar

honeybadger-api's Issues

Unintialized constant `OpenSSL` in client

Under Ruby 2.1.8 the gem raises an unintialized constant exception:

NameError: uninitialized constant Honeybadger::Api::Client::OpenSSL
from /Users/murray/.gem/ruby/2.1.8/gems/honeybadger-api-1.0.0/lib/honeybadger-api/client.rb:26:in `request'

Within Honeybadger::Api::Client there is a missing require "openssl":

https://github.com/murraysum/honeybadger-api/blob/master/lib/honeybadger-api/client.rb#L26

Migrate specs to use expect syntax

Notice resource in 2.0.0

After updating to 2.0.0 version i've encountered problem with notice resource. After calling paginate method on Notice i'm receiving error

2.3.1 :001 > Honeybadger::Api::Notice.paginate(XXXX, XXXX)
NoMethodError: undefined method `[]' for nil:NilClass
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/deploy.rb:14:in `initialize'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/notice.rb:22:in `new'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/notice.rb:22:in `initialize'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/notice.rb:42:in `new'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/notice.rb:42:in `block in handler'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/paginator.rb:22:in `block in initialize'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/paginator.rb:21:in `map'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/paginator.rb:21:in `initialize'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/request.rb:40:in `new'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/request.rb:40:in `paginate'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/request.rb:36:in `paginate'
    from gems/honeybadger-api-2.0.0/lib/honeybadger-api/notice.rb:37:in `paginate'
    from (irb):1

From what i see, Notice resource is now using Deploy resource. Why Deploy is
obligatory now ?

EDIT 1
I think empty deploy key in response is causing that problem

Add support for the site uptime check endpoints

http://docs.honeybadger.io/guides/api.html#site-uptime-check-list

Add URL parameter filtering and ordering

Since the gem was written several of the Read API endpoints now support URL parameter filters and ordering:

Fault
Notice
Deploy
Metrics

See Read API docs for details.

Support for these filters and ordering parameters should be in the gem

Add support for the metrics endpoint

http://docs.honeybadger.io/guides/api.html#metrics

Add missing github_project attribute to Project

There is a missing github_project attribute coming from the API response but not on the Project class

Failing specs due to changes in rspec

RSpec has changed the color_enabled configuration option.
RSpec has also replaced be_true with be_truthy and be_false with be_falsey.

Add support for the site list endpoints

http://docs.honeybadger.io/guides/api.html#site-list-site-details

Add support for the site outage endpoints

http://docs.honeybadger.io/guides/api.html#site-outage-list

Client does not verify ssl certs due to use of OpenSSL::SSL::VERIFY_NONE

Issue

Within https://github.com/murraysum/honeybadger-api/blob/master/lib/honeybadger-api/client.rb#L27 we do not verify ssl certs. Instead we use OpenSSL::SSL::VERIFY_NONE which defeats the point of SSL. 😨

We should be using the OpenSSL::SSL::VERIFY_PEER mode.

Expected Behaviour

SSL certs are verified

Actual Behaviour

SSL certs are not verified

Error when trying to access next paginator page

Hey,

I'm using latest version and since today, I have a problem with paginator.
Pulling notices like this:
notices = Honeybadger::Api::Notice.paginate(project_id, fault_id, { created_after: created_after })
There is a NoMethodError: undefined method '<' for nil:NilClass when trying to access next page with notices.next?

Add ability to see Rate Limits

http://docs.honeybadger.io/guides/api.html#rate-limiting