diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ca470e..34b3c8e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [0.2.0] - Unreleased +## [0.2.1] - 2026-08-05 + +### Deprecated + +- Documented the Reve public API shutdown and the gem's deprecated, unmaintained status +- Added a RubyGems post-install warning with the API sunset date and repository README link + +## [0.2.0] - 2026-07-17 ### Added diff --git a/README.md b/README.md index fca4761..1901dce 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,12 @@ Ruby client for the [Reve image generation API](https://api.reve.com/console/doc [![Gem Version](https://badge.fury.io/rb/reve_ai.svg)](https://badge.fury.io/rb/reve_ai) [![ci](https://github.com/dpaluy/reve_ai/actions/workflows/ci.yml/badge.svg)](https://github.com/dpaluy/reve_ai/actions/workflows/ci.yml) +## API sunset notice + +> **Reve's public API sunsets Friday, August 14, 2026.** Existing approved API users retain access through the sunset window; all other users can no longer access it, and new API onboarding is closed. Unused paid credits begin full-refund processing Monday, August 17, 2026. + +This gem is deprecated and will be unmaintained after the API shutdown. No further feature development or maintenance is planned. + ## Installation ``` @@ -459,15 +465,13 @@ bundle exec rake test bundle exec rubocop ``` -## Release +## Release -```sh -bundle exec rake release -``` +This gem is deprecated, and no further feature releases are planned. ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/dpaluy/reve_ai. +This project is deprecated and will be unmaintained after the API shutdown. Contributions for new features or ongoing maintenance are no longer being accepted. ## License diff --git a/lib/reve_ai/version.rb b/lib/reve_ai/version.rb index b248878..720c801 100644 --- a/lib/reve_ai/version.rb +++ b/lib/reve_ai/version.rb @@ -2,5 +2,5 @@ module ReveAI # @return [String] Current gem version - VERSION = "0.2.0" + VERSION = "0.2.1" end diff --git a/reve_ai.gemspec b/reve_ai.gemspec index 10452dd..3a8b113 100644 --- a/reve_ai.gemspec +++ b/reve_ai.gemspec @@ -8,9 +8,10 @@ Gem::Specification.new do |spec| spec.authors = ["dpaluy"] spec.email = ["dpaluy@users.noreply.github.com"] - spec.summary = "Ruby client for the Reve image generation API." - spec.description = "ReveAI provides a lightweight Faraday-based wrapper for the Reve image generation API " \ - "(create, edit, remix images)." + spec.summary = "Deprecated Ruby client for Reve's sunset image generation API." + spec.description = "ReveAI was a lightweight Faraday-based wrapper for the Reve image generation API " \ + "(create, edit, remix images). The upstream public API sunsets on August 14, 2026; " \ + "this gem is deprecated and will be unmaintained after the shutdown." spec.homepage = "https://github.com/dpaluy/reve_ai" spec.license = "MIT" spec.required_ruby_version = ">= 3.0.0" @@ -21,6 +22,15 @@ Gem::Specification.new do |spec| spec.metadata["source_code_uri"] = "https://github.com/dpaluy/reve_ai" spec.metadata["changelog_uri"] = "https://github.com/dpaluy/reve_ai/blob/master/CHANGELOG.md" spec.metadata["bug_tracker_uri"] = "https://github.com/dpaluy/reve_ai/issues" + spec.metadata["deprecated"] = "true" + + spec.post_install_message = <<~MESSAGE + WARNING: The upstream Reve public API sunsets Friday, August 14, 2026. + This gem is deprecated and will be unmaintained after the shutdown. + Existing approved API users retain access through the sunset window; all other users can no longer access it, and new API onboarding is closed. + Unused paid credits begin full-refund processing Monday, August 17, 2026. + See the repository README for details: https://github.com/dpaluy/reve_ai#api-sunset-notice + MESSAGE # Specify which files should be added to the gem when it is released. # The `git ls-files -z` loads the files in the RubyGem that have been added into git. diff --git a/test/reve_ai/gemspec_test.rb b/test/reve_ai/gemspec_test.rb index 0cc264e..7d1bf34 100644 --- a/test/reve_ai/gemspec_test.rb +++ b/test/reve_ai/gemspec_test.rb @@ -3,6 +3,21 @@ require_relative "../test_helper" class GemspecTest < Minitest::Test + def test_version_and_deprecation_metadata_are_discoverable + assert_equal Gem::Version.new("0.2.1"), gemspec.version + assert_includes gemspec.summary.downcase, "deprecated" + assert_includes gemspec.description.downcase, "unmaintained" + assert_equal "true", gemspec.metadata["deprecated"] + end + + def test_post_install_message_warns_about_api_sunset + message = gemspec.post_install_message + + assert_includes message, "August 14, 2026" + assert_includes message, "deprecated" + assert_includes message, "https://github.com/dpaluy/reve_ai#api-sunset-notice" + end + def test_base64_is_a_runtime_dependency dependency = gemspec.runtime_dependencies.find { |candidate| candidate.name == "base64" }