ask-honeybadger 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18083370cefeff9d036b53bf1a6ac15ad030817b33f82b823a0967eb530bb811
-  data.tar.gz: 3353dc3b808a6263ea64f18f0822b26aea7820f736a471db470388ebc551c288
+  metadata.gz: 7bf6c5d3a01d7ad34fd5a976a9f927c69264da6a08f59cbfeed18301910be668
+  data.tar.gz: b36b5150b323c82d0907869536ceb04ef138d0cd511ba7262a7b7f7143b154ec
 SHA512:
-  metadata.gz: ebc3912e26fcd986856a11715436f0528239843310cd37d1ee5849297a4de16d44b4e2d5859dffbc9829bf11279d96f1793f49943f98425f439f81404409592d
-  data.tar.gz: f3f4ee0ff4c3833c452d1d579eec626b64f49d5a56816f047059b1da82859f19db1a17a53f0bbc9e405b003fa1bb3a2fd12f6f875bf48f5e5d5e2e563bbb24e9
+  metadata.gz: 7c95ac0e3b959955cc81d1322fda99600faa191036866ad3dce431b232def9562da806864c01404b69bb871b2388be58ce0291f8ae17216a9ac68c2ae1091da3
+  data.tar.gz: cbed75aa023d85409605cb4a1035364ec11dbeec88de2ccb26c3ba8d481e16b939cda3cf9f4dc5446fa25c9bceee28611bc8382f92d21fc8c5b85c6dd70d27a6

data/README.md

@@ -1,8 +1,11 @@
 # ask-honeybadger
 
-Honeybadger — error tracking via the Honeybadger API
+[![Gem Version](https://badge.fury.io/rb/ask-honeybadger.svg)](https://badge.fury.io/rb/ask-honeybadger)
 
-Part of the [ask-rb](https://github.com/ask-rb) ecosystem.
+Honeybadger service context for AI agents in the ask-rb ecosystem. It provides
+an authenticated HTTP client for the Honeybadger Data API, metadata constants
+for system prompts, and a structured error guide for common Honeybadger API
+issues.
 
 ## Installation
 
@@ -10,27 +13,32 @@ Part of the [ask-rb](https://github.com/ask-rb) ecosystem.
 gem "ask-honeybadger"
 ```
 
-## Usage
+## Quick Start
 
 ```ruby
 require "ask-honeybadger"
 
-# Get an authenticated client:
-client = Ask::Honeybadger.client
+# List all projects
+Ask::Honeybadger.projects
 
-# List faults for a project:
-faults = client.get("/v2/projects/PROJECT_ID/faults")
+# Recent faults for a project
+faults = Ask::Honeybadger.recent_faults(project_id: "PROJECT_ID", limit: 10)
 
-# Or use the convenience helpers:
-Ask::Honeybadger.recent_faults(project_id: "PROJECT_ID", limit: 10)
+# Summary counts for a project
 Ask::Honeybadger.fault_summary(project_id: "PROJECT_ID")
+
+# A single fault
 Ask::Honeybadger.fault(project_id: "PROJECT_ID", fault_id: 42)
-Ask::Honeybadger.projects
+
+# Or use the raw client (base URL: https://app.honeybadger.io/v2)
+client = Ask::Honeybadger.client
+client.get("/v2/projects/PROJECT_ID/faults")
 ```
 
 ## Authentication
 
-Set your Honeybadger API token in the environment:
+`Ask::Honeybadger.client` resolves a token via
+`Ask::Auth.resolve(:honeybadger_token)`. Set it in your environment:
 
 ```bash
 export HONEYBADGER_TOKEN=your_token_here
@@ -42,11 +50,36 @@ Or add it to `~/.ask/credentials.yml`:
 honeybadger_token: your_token_here
 ```
 
-Get your token at https://app.honeybadger.io/users/edit
+Credentials can also come from Rails credentials, a database, or an OAuth
+provider, depending on your `ask-auth` configuration. The token is sent as
+HTTP Basic auth with the token as the username and a blank password. Get your
+token at [app.honeybadger.io/users/edit](https://app.honeybadger.io/users/edit).
+
+## Key entry points
+
+- `Ask::Honeybadger.client` - an authenticated Faraday client with base URL
+  `https://app.honeybadger.io/v2`. It is wrapped in a proxy that converts
+  auth failures into `Ask::Auth::InvalidCredential`.
+- `Ask::Honeybadger.recent_faults(project_id:, limit: 25, **params)` - fetch
+  recent faults with optional query params (`q`, `order`, `environment`).
+- `Ask::Honeybadger.fault_summary(project_id:)`, `fault(project_id:, fault_id:)`,
+  and `projects` - other convenience helpers.
+- `Ask::Honeybadger::Errors` - structured error knowledge for agents:
+  guidance by exception class, HTTP status descriptions, and rate limit info.
+- `Ask::Honeybadger::DESCRIPTION`, `DOCS_URL`, `AUTH_NAME`, `GEM_NAME`, and
+  `QUICK_START` - metadata constants for system prompts.
+
+## Full documentation
+
+The full ask-rb documentation lives at https://ask-rb.github.io/ask-docs.
+[Services: Honeybadger](https://ask-rb.github.io/ask-docs/services/honeybadger)
+covers ask-honeybadger in depth, including the client, error guide, and
+constants. API reference: https://ask-rb.github.io/ask-docs/reference/api.
 
 ## Development
 
-```bash
+```
+bundle install
 bundle exec rake test
 ```
 

data/lib/ask/honeybadger/version.rb

@@ -2,6 +2,6 @@
 
 module Ask
   module Honeybadger
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-honeybadger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kaka Ruto
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Honeybadger — error tracking via the Honeybadger API
 test_files: []