ask-github 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f0e1e42270acf35d49dbe2b9ddacde65159b7aacc9812ec6936e663c32063e9
-  data.tar.gz: 95ab525daa2236b18f8eacf1bcf6ff1d9159a3616a2c2b0337575a57c29d7be0
+  metadata.gz: 6ae01ffdb62eea1500c1e9544915704dbcc34d18f27124a82f3a3ee59c93e92b
+  data.tar.gz: 03a155f16c3e4409ea7383b7b071f0c55d7bd729ec553c70d8e92020e9b72d8f
 SHA512:
-  metadata.gz: 93d4c3b6bcc51abdb61b6d2a088cf14184ccd8e6eb53a8bd7bf833611fb13cb6b5fb234568f4843aec0216feedffc7e9e6ffc1966552ce9d2c41c0be4d25ec31
-  data.tar.gz: e157ba7fe7bc3565eaca177cf26e5d46cbf96fee8fac978c2313c1efce784d703e2c2b8a4f78359826992e0387e127c6a623ee44bd1b157570a93a27678df45f
+  metadata.gz: d40f074e53dd7d58e15dce513200921f23ac344fd2f1b505efb36a9d871b407993920dcfe39cf6ee925b7b67465aba444c24a156722bc2226614cd7e241df817
+  data.tar.gz: 03210c203eff7072f09d372ec8cf536cdf06ea013eb5f479728b35d08a23f1b96bff56a884eeee8a5d244a4409db41553955732479b2026262f09bc5605915c1

data/README.md

@@ -1,8 +1,12 @@
 # ask-github
 
-GitHub service context for AI agents in the ask-rb ecosystem.
+[![Gem Version](https://badge.fury.io/rb/ask-github.svg)](https://badge.fury.io/rb/ask-github)
 
-Provides an authenticated Octokit client, metadata constants for system prompts, and a structured error guide for common GitHub API issues.
+GitHub service context for AI agents in the ask-rb ecosystem. It provides an
+authenticated Octokit client for the GitHub REST API, metadata constants for
+system prompts, and a structured error guide for common GitHub API issues.
+
+## Installation
 
 ```ruby
 gem "ask-github"
@@ -10,8 +14,6 @@ gem "ask-github"
 
 ## Quick Start
 
-### Get an authenticated client
-
 ```ruby
 require "ask-github"
 
@@ -23,47 +25,42 @@ client.contents("owner/repo", path: "Gemfile")
 client.search_issues("query")
 ```
 
-The client is an `Octokit::Client` wrapped in a proxy that converts `Octokit::Unauthorized` into `Ask::Auth::InvalidCredential` with actionable error messages.
-
-### Authentication
-
-The client resolves a GitHub token via `Ask::Auth.resolve(:github_token)`. Tokens can be provided through any configured auth provider:
-
-1. **Environment variable:** `GITHUB_TOKEN`
-2. **Credentials file:** `~/.ask/credentials.yml`
-3. **Rails credentials:** `Rails.application.credentials.github_token`
-4. **OAuth / Database:** Custom providers
+## Authentication
 
-Generate a token at [github.com/settings/tokens](https://github.com/settings/tokens) with the `repo` and `read:org` scopes.
+`Ask::GitHub.client` resolves a token via `Ask::Auth.resolve(:github_token)`.
+Set it in your environment:
 
-## Context Constants
+```bash
+export GITHUB_TOKEN=your_token_here
+```
 
-Use these constants to build system prompts for AI agents:
+Or add it to `~/.ask/credentials.yml`:
 
-| Constant | Value |
-|---|---|
-| `Ask::GitHub::DESCRIPTION` | "GitHub — code hosting, issues, pull requests, actions, packages" |
-| `Ask::GitHub::DOCS_URL` | https://docs.github.com/en/rest |
-| `Ask::GitHub::OPENAPI_URL` | https://api.github.com/openapi.json |
-| `Ask::GitHub::AUTH_NAME` | `:github_token` |
-| `Ask::GitHub::GEM_NAME` | `"octokit"` |
-| `Ask::GitHub::GEM_VERSION` | `"~> 9.0"` |
-| `Ask::GitHub::QUICK_START` | Copy-paste Ruby code snippet |
+```yaml
+github_token: your_token_here
+```
 
-## Error Guide
+Credentials can also come from Rails credentials, a database, or an OAuth
+provider, depending on your `ask-auth` configuration. Generate a token at
+[github.com/settings/tokens](https://github.com/settings/tokens) with the
+`repo` and `read:org` scopes.
 
-`Ask::GitHub::Errors` provides structured knowledge for agents:
+## Key entry points
 
-```ruby
-Ask::GitHub::Errors.for("Octokit::NotFound")
-# => { message: "...", action: "..." }
+- `Ask::GitHub.client` - an authenticated `Octokit::Client` (auto-paginating,
+  `per_page: 100`, retry middleware). It is wrapped in a proxy that converts
+  `Octokit::Unauthorized` into `Ask::Auth::InvalidCredential`.
+- `Ask::GitHub::Errors` - structured error knowledge for agents: guidance by
+  exception class, HTTP status code descriptions, and rate limit info.
+- `Ask::GitHub::DESCRIPTION`, `DOCS_URL`, `AUTH_NAME`, `GEM_NAME`,
+  `GEM_VERSION`, and `QUICK_START` - metadata constants for system prompts.
 
-Ask::GitHub::Errors.status_code_description(404)
-# => "Not Found — Resource does not exist or is private."
+## Full documentation
 
-Ask::GitHub::Errors::RATE_LIMIT[:authenticated]
-# => "5,000 requests per hour"
-```
+The full ask-rb documentation lives at https://ask-rb.github.io/ask-docs.
+[Services: GitHub](https://ask-rb.github.io/ask-docs/services/github) covers
+ask-github in depth, including the client, error guide, and constants.
+API reference: https://ask-rb.github.io/ask-docs/reference/api.
 
 ## Development
 

data/lib/ask/github/version.rb

@@ -2,6 +2,6 @@
 
 module Ask
   module GitHub
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-github
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Kaka Ruto
@@ -15,14 +15,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: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -160,7 +160,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: GitHub service context for the ask-rb ecosystem
 test_files: []