ask-notion 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3611433429efcbb9f1fcab1a41682930622328e4932e38dafe5109c4d701683b
-  data.tar.gz: fd5fa7ec897d263b50d9e9304a4901b7d484d3f5e1af3ef61b8abbd74948de32
+  metadata.gz: 47d6854ce6682921d9539ee76011a7d107f3e3c26f56aadb16591ba2cd6a4dd4
+  data.tar.gz: 458565c92e6a87a3435f4ba092592987feeec1f16398d26c4e1f756d64ce8f55
 SHA512:
-  metadata.gz: 01f49ed7c061ef6a8ad78c5f0da9bdfc375a867c83e47dc88d3004ec776fbeffcb63edbdda96d4576fd9de7f969104c9e1cf62a5a24659f0e190a1e50f0b7b77
-  data.tar.gz: eb7e2dc56e723eb3960871c2db7855cd997f8a90b824f300e4e826629286024eeaaca3c276ef45cb7e3505cb16201f43bf48ffd3926e89d83dc1ec3d8876b7f4
+  metadata.gz: d6e2a8f315130af92740b830bff885a5324d1c30913218054e2c60c45e3adb4cae6d859347c39c69d2b7fba5a4dab2ce7da6468f51dcfd62d7bfdaffe204b16a
+  data.tar.gz: b3506a0ef4d249be2496b6442881ef3b9b638dce906f1bd3760547aa91b2a05ff3db51c18d5c3eb08a1bbc81d6cb4589fbf28d778bb7a3e65c133105990f8cac

data/README.md

@@ -1,11 +1,11 @@
 # ask-notion
 
-Notion service context for the ask-rb ecosystem.
+[![Gem Version](https://badge.fury.io/rb/ask-notion.svg)](https://badge.fury.io/rb/ask-notion)
 
-Provides:
-- `Ask::Notion.client` — authenticated Notion API client
-- `Ask::Notion::DESCRIPTION` — context metadata for the system prompt
-- `Ask::Notion::Errors` — structured error knowledge for AI agents
+Notion service context for AI agents in the ask-rb ecosystem. It provides an
+authenticated Notion API client built on notion-ruby-client, metadata
+constants for system prompts, and a structured error guide for common Notion
+API issues.
 
 ## Installation
 
@@ -13,43 +13,40 @@ Provides:
 gem "ask-notion"
 ```
 
-## Usage
+## Quick Start
 
 ```ruby
 require "ask-notion"
 
-# Returns an authenticated Notion::Client
 client = Ask::Notion.client
 
 # Query a database
-results = client.database_query(database_id: "your-database-id")
+results = client.database_query(database_id: "DB_ID")
 
 # Get a page
-page = client.page_retrieve(page_id: "your-page-id")
+page = client.page_retrieve(page_id: "PAGE_ID")
 
 # Create a page in a database
 client.page_create(
-  parent: { database_id: "your-database-id" },
-  properties: {
-    "Name" => { title: [{ text: { content: "New Task" } }] },
-    "Status" => { status: { name: "In Progress" } }
-  }
+  parent: { database_id: "DB_ID" },
+  properties: { "Name" => { title: [{ text: { content: "New Page" } }] } }
 )
 
 # Search across Notion
-results = client.search(query: "project notes")
-```
+client.search(query: "project")
 
-## Auth Setup
+# List blocks in a page and list workspace users
+client.block_children_list(block_id: "BLOCK_ID")
+client.user_list
+```
 
-This gem uses `Ask::Auth` to resolve the `:notion_token` credential.
+## Authentication
 
-1. Go to https://www.notion.so/my-integrations
-2. Create a new integration and copy the Internal Integration Secret
-3. Set the token in your environment:
+`Ask::Notion.client` resolves a token via `Ask::Auth.resolve(:notion_token)`.
+Set it in your environment:
 
 ```bash
-export NOTION_TOKEN="ntn_your_integration_token"
+export NOTION_TOKEN=ntn_your_integration_token
 ```
 
 Or add it to `~/.ask/credentials.yml`:
@@ -58,10 +55,33 @@ Or add it to `~/.ask/credentials.yml`:
 notion_token: ntn_your_integration_token
 ```
 
+Credentials can also come from Rails credentials, a database, or an OAuth
+provider, depending on your `ask-auth` configuration. Create an integration at
+[notion.so/my-integrations](https://www.notion.so/my-integrations) and copy
+the Internal Integration Secret.
+
+## Key entry points
+
+- `Ask::Notion.client` - an authenticated `Notion::Client`. It is wrapped in a
+  proxy that converts `Notion::Api::Errors::Unauthorized` into
+  `Ask::Auth::InvalidCredential` and retries rate limits and transient
+  failures with exponential backoff.
+- `Ask::Notion::Errors` - structured error knowledge for agents: guidance by
+  exception class, HTTP status code descriptions, and rate limit info.
+- `Ask::Notion::DESCRIPTION`, `DOCS_URL`, `AUTH_NAME`, `GEM_NAME`,
+  `GEM_VERSION`, 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: Notion](https://ask-rb.github.io/ask-docs/services/notion) covers
+ask-notion in depth, including the client, error guide, and constants.
+API reference: https://ask-rb.github.io/ask-docs/reference/api.
+
 ## Development
 
-```bash
-bin/setup
+```
+bundle install
 bundle exec rake test
 ```
 

data/lib/ask/notion/context.rb

@@ -11,8 +11,9 @@ module Ask
     # URL for the Notion API reference.
     API_REF_URL = "https://developers.notion.com/reference"
 
-    # URL for the Notion OpenAPI specification.
-    OPENAPI_URL = "https://developers.notion.com/.well-known/openapi.json"
+    # Notion no longer serves an OpenAPI spec at a stable URL.
+    # The API reference is at API_REF_URL instead.
+    # OPENAPI_URL was removed because the spec is no longer available.
 
     # Credential name used with Ask::Auth.resolve.
     AUTH_NAME = :notion_token

data/lib/ask/notion/version.rb

@@ -2,6 +2,6 @@
 
 module Ask
   module Notion
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-notion
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 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: notion-ruby-client
   requirement: !ruby/object:Gem::Requirement
@@ -118,7 +118,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: Notion service context for the ask-rb ecosystem
 test_files: []