# RubyGems Release Monitor API (`automly/rubygems-release-monitor-api`) Actor

Monitor RubyGems releases and package metadata from the public RubyGems API.

- **URL**: https://apify.com/automly/rubygems-release-monitor-api.md
- **Developed by:** [Automly](https://apify.com/automly) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## RubyGems Release Monitor API

**RubyGems Release Monitor API** collects clean, structured package release data from the public RubyGems API. Use it to track gem updates, monitor dependency changes, and feed release metadata into analytics, alerts, or AI workflows.

### Why use this RubyGems release monitor?

Ruby libraries change constantly, and version bumps can matter just as much as code changes. This actor gives you a simple way to watch gems without wiring together custom polling and parsing logic.

Typical use cases:
- Track release cadence for critical Ruby dependencies
- Monitor newly published versions in a dependency stack
- Power alerts, dashboards, and changelog workflows
- Enrich engineering data pipelines with package metadata

### Features

- Monitor one or more RubyGems packages in a single run
- Return either a compact latest-release summary or individual recent version records
- Include package metadata, release timestamps, authors, licenses, and dependency counts
- Pay-per-event pricing tied to the records you actually use

### Input

#### Example: quick latest-release check

```json
{
  "gems": "rails, rack, nokogiri",
  "latestOnly": true,
  "maxResults": 5,
  "versionsPerGem": 10
}
````

#### Example: recent version monitoring

```json
{
  "gems": "rails, sidekiq",
  "latestOnly": false,
  "maxResults": 20,
  "versionsPerGem": 5
}
```

#### Input fields

| Field | Type | Description |
|---|---|---|
| `gems` | string | Comma or newline separated RubyGems package names to monitor, such as `rails` or `nokogiri`. |
| `latestOnly` | boolean | When enabled, returns one summary record per gem instead of version records. |
| `maxResults` | integer | Maximum number of dataset records to return across all gems. Values above 100 are clamped. |
| `versionsPerGem` | integer | How many recent versions to include for each gem when `latestOnly` is turned off. Values above 50 are clamped. |

### Output

#### Example record: latest-release summary

```json
{
  "gemName": "rails",
  "version": "8.0.2",
  "latestVersion": "8.0.2",
  "summary": "Ruby on Rails is a web framework",
  "description": "Ruby on Rails is a web framework",
  "homepageUrl": "https://rubyonrails.org/",
  "sourceCodeUrl": "https://github.com/rails/rails",
  "documentationUrl": "https://api.rubyonrails.org/",
  "gemUrl": "https://rubygems.org/gems/rails",
  "authors": "David Heinemeier Hansson",
  "licenses": ["MIT"],
  "createdAt": "2026-05-26T00:00:00.000Z",
  "prerelease": false,
  "platform": "ruby",
  "downloads": 1234,
  "runtimeDependenciesCount": 24,
  "developmentDependenciesCount": 0,
  "recentVersionCount": 0,
  "recordType": "package_summary"
}
```

#### Example record: version detail

```json
{
  "gemName": "rails",
  "version": "8.0.2",
  "latestVersion": "8.0.2",
  "summary": "Ruby on Rails is a web framework",
  "description": "Ruby on Rails is a web framework",
  "homepageUrl": "https://rubyonrails.org/",
  "sourceCodeUrl": "https://github.com/rails/rails",
  "documentationUrl": "https://api.rubyonrails.org/",
  "gemUrl": "https://rubygems.org/gems/rails",
  "authors": "David Heinemeier Hansson",
  "licenses": ["MIT"],
  "createdAt": "2026-05-26T00:00:00.000Z",
  "prerelease": false,
  "platform": "ruby",
  "downloads": 1234,
  "runtimeDependenciesCount": 24,
  "developmentDependenciesCount": 0,
  "recentVersionCount": 1,
  "recordType": "version_record"
}
```

### Limits and caveats

- Package names must point to public RubyGems packages.
- If a package has many releases, use `latestOnly=true` for a cheaper summary run.
- `maxResults` is capped at 100 to keep runs predictable and affordable.
- `versionsPerGem` is capped at 50 so detail runs stay fast.

### Pricing

This actor uses **Pay-Per-Event** pricing.

| Event | Price | Charged when |
|---|---:|---|
| `package-summary-produced` | $0.25 / 1k | A latest-release summary record is produced |
| `version-record-produced` | $0.75 / 1k | An individual version record is produced |

### FAQ

**Do I need a RubyGems account?**\
No. The actor reads public RubyGems metadata.

**What is the difference between summary mode and detail mode?**\
Summary mode returns one record per gem using the latest published version. Detail mode returns recent versions as separate records.

**Can I use this for dependency monitoring?**\
Yes. Re-run the actor on a schedule and compare version changes over time.

**What if a gem does not exist?**\
The actor skips invalid package names and continues with the rest of the list.

# Actor input Schema

## `gems` (type: `string`):

Comma or newline separated RubyGems package names to monitor. Examples: `rails`, `rack`, `nokogiri`.

## `latestOnly` (type: `boolean`):

When enabled, the actor returns one summary record per gem. Turn it off to return individual recent version records.

## `maxResults` (type: `integer`):

Maximum number of dataset records to return across all gems. Values above 100 are clamped.

## `versionsPerGem` (type: `integer`):

How many recent versions to include for each gem when latest release only is turned off. Values above 50 are clamped.

## Actor input object example

```json
{
  "gems": "rails, rack",
  "latestOnly": true,
  "maxResults": 100,
  "versionsPerGem": 10
}
```

# Actor output Schema

## `results` (type: `string`):

All dataset records produced by this run.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "gems": "rails, rack",
    "latestOnly": true,
    "maxResults": 100,
    "versionsPerGem": 10
};

// Run the Actor and wait for it to finish
const run = await client.actor("automly/rubygems-release-monitor-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "gems": "rails, rack",
    "latestOnly": True,
    "maxResults": 100,
    "versionsPerGem": 10,
}

# Run the Actor and wait for it to finish
run = client.actor("automly/rubygems-release-monitor-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "gems": "rails, rack",
  "latestOnly": true,
  "maxResults": 100,
  "versionsPerGem": 10
}' |
apify call automly/rubygems-release-monitor-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=automly/rubygems-release-monitor-api",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "RubyGems Release Monitor API",
        "description": "Monitor RubyGems releases and package metadata from the public RubyGems API.",
        "version": "1.0",
        "x-build-id": "XdayNCDwtazLRQdUs"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/automly~rubygems-release-monitor-api/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-automly-rubygems-release-monitor-api",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/automly~rubygems-release-monitor-api/runs": {
            "post": {
                "operationId": "runs-sync-automly-rubygems-release-monitor-api",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/automly~rubygems-release-monitor-api/run-sync": {
            "post": {
                "operationId": "run-sync-automly-rubygems-release-monitor-api",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "gems"
                ],
                "properties": {
                    "gems": {
                        "title": "RubyGems packages",
                        "type": "string",
                        "description": "Comma or newline separated RubyGems package names to monitor. Examples: `rails`, `rack`, `nokogiri`."
                    },
                    "latestOnly": {
                        "title": "Latest release only",
                        "type": "boolean",
                        "description": "When enabled, the actor returns one summary record per gem. Turn it off to return individual recent version records."
                    },
                    "maxResults": {
                        "title": "Maximum records",
                        "type": "integer",
                        "description": "Maximum number of dataset records to return across all gems. Values above 100 are clamped."
                    },
                    "versionsPerGem": {
                        "title": "Versions per gem",
                        "type": "integer",
                        "description": "How many recent versions to include for each gem when latest release only is turned off. Values above 50 are clamped."
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
