request_migrations 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2224934d0be51149ebf90a756ae9cfd9172ee83310609c9cfc94c49c4c75166
-  data.tar.gz: 3de2f808de4c02d7de89ec9baae0b5d68cadab94d8118e13688a941de791d3cf
+  metadata.gz: 9a4bcd66e61c3fbda8dd1a2d68c84953bd44cfb2b1c9fed79e90a0965cb1853d
+  data.tar.gz: b772558c45d89f41d9c0eceab0b118e141fd93f31d40e037b810b669f2dfc997
 SHA512:
-  metadata.gz: 944f3e23fe55b3d9eb56cdf0491871bfecea72a5c9a57b15f8827152b7cf5a21ab0e0ac6c1f254a9afabe4fc980562b864e96a2868ec864a314d41876e1af987
-  data.tar.gz: e3fa22992ac3aadcd34ce860310f6a496f4aa7f54179090863bcf993582e2c757fa07677862973b817edc2d209b289284e19ec040249c62011ad20ceb41ee0c6
+  metadata.gz: d6727a31da8a3bbf69d013af4c68a873ff7c1c09a17f407906f27469df8c822aa070207e9ab6fa39299e3ef2960c8184efa954f9417c6678c3f242808add7cfa
+  data.tar.gz: 7086a2c8604219bef3d9b7040897f0faa30cb2ff19d800ea1ab9011db3dad2d11b25d8e77b2e98b09175b90e2ad93180664278c60ea5af9d47fbe4c52c6b8388

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.1.2
+
+- Remove deprecated `ActiveSupport::Configurable`.
+
+## 1.1.1
+
+- Fix minimum required Ruby version from v3.0 to v3.1.
+
+## 1.1.0
+
+- Add `request_migrations/testing` for unit testing migrations.
+
 ## 1.0.1
 
 - Fix application order of `request` migrations.

data/README.md

@@ -1,5 +1,6 @@
 # request_migrations
 
+[![CI](https://github.com/keygen-sh/request_migrations/actions/workflows/test.yml/badge.svg)](https://github.com/keygen-sh/request_migrations/actions)
 [![Gem Version](https://badge.fury.io/rb/request_migrations.svg)](https://badge.fury.io/rb/request_migrations)
 
 **Make breaking API changes without breaking things!** Use `request_migrations` to craft
@@ -13,9 +14,32 @@ to serve millions of API requests per day.
 
 Sponsored by:
 
-[![Keygen logo](https://user-images.githubusercontent.com/6979737/175406169-bd8bf064-7343-4bd1-94b7-a773ecec07b8.png)](https://keygen.sh)
-
-_A software licensing and distribution API built for developers._
+<a href="https://keygen.sh?ref=request_migrations">
+  <div>
+    <img src="https://keygen.sh/images/logo-pill.png" width="200" alt="Keygen">
+  </div>
+</a>
+
+_A fair source software licensing and distribution API._
+
+Links:
+
+- [Installing request_migrations](#installation)
+- [Supported Ruby versions](#supported-rubies)
+- [RubyDoc](#documentation)
+- [Usage](#usage)
+  - [Response migrations](#response-migrations)
+  - [Request migrations](#request-migrations)
+  - [Data migrations](#data-migrations)
+  - [Routing constraints](#routing-constraints)
+  - [Configuration](#configuration)
+  - [Version formats](#version-formats)
+- [Testing](#testing)
+- [Tips and tricks](#tips-and-tricks)
+- [Examples](#examples)
+- [Credits](#credits)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
@@ -39,8 +63,9 @@ $ gem install request_migrations
 
 ## Supported Rubies
 
-`request_migrations` supports Ruby 3. We encourage you to upgrade if you're on an older
-version. Ruby 3 provides a lot of great features, like better pattern matching.
+**`request_migrations` supports Ruby 3.1 and above.** We encourage you to upgrade if you're on an older
+version. Ruby 3 provides a lot of great features, like better pattern matching and a new shorthand
+hash syntax.
 
 ## Documentation
 
@@ -124,8 +149,8 @@ end
 
 As you can see, with pattern matching, it makes creating migrations for certain
 resources simple. Here, we've defined a migration that only runs for the `users#show`
-and `me#show` resources, and only when the response is successfuly. In addition,
-the data is only migrated when the response body contains a user.
+resource, and only when the response is successful. In addition, the data is
+only migrated when the response body contains a user.
 
 Next, we'll need to configure `request_migrations` via an initializer under
 `initializers/request_migrations.rb`:
@@ -198,6 +223,8 @@ The gem makes no assumption on a response's content type or what the migration
 will do. You could, for example, migrate the response body, or mutate the
 headers, or even change the response's status code.
 
+The `response` method can be used multiple times per-migration.
+
 ### Request migrations
 
 Request migrations define a change on a request. For example, modifying a request's
@@ -225,6 +252,8 @@ headers. It's up to you, all it does is provide the request.
 
 Request migrations should [avoid using the `migrate` method](#avoid-migrate-for-request-migrations).
 
+The `request` method can be used multiple times.
+
 ### Data migrations
 
 In our first scenario, where we combined our user's name attributes, we defined
@@ -292,10 +321,15 @@ end
 
 This will apply the block defined in `migrate` onto our data. With that,
 we've successfully applied a migration to both our API responses, as well
-as to the webhook events we send. In this case, if our `event` matches the
-our user shape, e.g. `type: 'user'`, then the migration will be applied.
+as to the webhook events we send. In this case, if our event data matches
+our expected data shape, e.g. `type: 'user'`, then the migration will
+be applied.
 
-In addition to data migrations, this allows for easier testing.
+In addition to data migrations, this allows for easier [testing](#testing).
+
+The `migrate` method can be used multiple times per-migration to e.g. 
+match and migrate on different shapes of data. For a JSON:API app,
+for example, you could migrate on `data: [*]` and `includes: [*]`.
 
 ### Routing constraints
 
@@ -406,9 +440,11 @@ end
 ```
 
 To avoid polluting the global configuration, you can use `RequestMigrations::Testing`
-within your application's `spec/rails_helper.rb` (or similar).
+within your application's `spec/rails_helper.rb`, or a similar spec helper:
 
 ```ruby
+require 'request_migrations/testing'
+
 Rspec.configure do |config|
   config.before :each do
     RequestMigrations::Testing.setup!
@@ -420,6 +456,9 @@ Rspec.configure do |config|
 end
 ```
 
+This will setup a new test configuration, and then restore the previous global configuration
+after each spec.
+
 ## Tips and tricks
 
 Over the years, we're learned a thing or two about versioning an API. We'll share tips here.
@@ -502,7 +541,7 @@ end
 And for a response containing a collection of users:
 
 ```ruby
-class CombineNamesForUserMigration < RequestMigrations::Migration
+class CombineNamesForUsersMigration < RequestMigrations::Migration
   description %(transforms a collection of users' first and last names to a combined name attribute)
 
   migrate if: -> data { data in [*, { type: 'user' }, *] do |data|
@@ -603,7 +642,7 @@ end
 
 Avoid using routing version constraints that remove functionality. They can be a headache
 during upgrades. Consider only making _additive_ changes. Instead, consider removing or
-hiding the documenation for old or deprecated endpoints, to limit any new usage.
+hiding the documentation for old or deprecated endpoints, to limit any new usage.
 
 ```ruby
 Rails.application.routes.draw do
@@ -680,6 +719,13 @@ to get the data we need in order to complete the migration.
 
 Have a tip of your own? Open a pull request!
 
+## Examples
+
+Below are some real-world examples of request migrations:
+
+- Migrations: https://github.com/keygen-sh/keygen-api/tree/master/app/migrations
+- Tests: https://github.com/keygen-sh/keygen-api/tree/master/spec/migrations
+
 ## Is it any good?
 
 Yes.

data/SECURITY.md

@@ -1,7 +1,8 @@
 # Security Policy
 
-## Reporting a Vulnerability
+## Reporting a vulnerability
 
 If you find a vulnerability in `request_migrations`, please contact Keygen via
-[email](mailto:security@keygen.sh). You will be given public credit for your
-disclosure.
+[email](mailto:security@keygen.sh).
+
+You will be given public credit for your disclosure.

data/lib/request_migrations/configuration.rb

@@ -2,37 +2,40 @@
 
 module RequestMigrations
   class Configuration
-    include ActiveSupport::Configurable
-
     ##
     # logger defines the logger used by request_migrations.
     #
     # @return [Logger] the logger.
-    config_accessor(:logger) { Logger.new("/dev/null") }
+    class_attribute :logger
+    self.logger = Logger.new("/dev/null")
 
     ##
     # request_version_resolver defines how request_migrations should resolve the
     # current version of a request.
     #
     # @return [Proc] the request version resolver.
-    config_accessor(:request_version_resolver) { -> req { self.current_version } }
+    class_attribute :request_version_resolver
+    self.request_version_resolver = -> req { self.current_version }
 
     ##
     # version_format defines the version format.
     #
     # @return [Symbol] format
-    config_accessor(:version_format) { :semver }
+    class_attribute :version_format
+    self.version_format = :semver
 
     ##
     # current_version defines the latest version.
     #
     # @return [String, Integer, Float, nil] the current version.
-    config_accessor(:current_version) { nil }
+    class_attribute :current_version
+    self.current_version = nil
 
     ##
     # versions defines past versions and their migrations.
     #
     # @return [Hash<String, Array<Symbol, String, Class>>] past versions.
-    config_accessor(:versions) { {} }
+    class_attribute :versions
+    self.versions = {}
   end
 end

data/lib/request_migrations/gem.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RequestMigrations
-  VERSION = "1.1.0"
+  VERSION = "1.1.2"
 end

data/lib/request_migrations/testing.rb

@@ -9,10 +9,7 @@ module RequestMigrations
     def self.setup!
       @@config = RequestMigrations.config
 
-      RequestMigrations.reset!
-      RequestMigrations.configure do |config|
-        @@config.config.each { |(k, v)| config.config[k] = v }
-      end
+      RequestMigrations.config = @@config.dup
     end
 
     ##

data/lib/request_migrations.rb

@@ -46,13 +46,10 @@ module RequestMigrations
   ##
   # @private
   def self.config=(cfg)
-    @config = cfg
-  end
+    raise ArgumentError, 'invalid config provided' unless
+      cfg.is_a?(Configuration)
 
-  ##
-  # @private
-  def self.reset!
-    @config = RequestMigrations::Configuration.new
+    @config = cfg
   end
 
   ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request_migrations
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Zeke Gabrielse
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2025-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,7 +80,7 @@ homepage: https://github.com/keygen-sh/request_migrations
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -88,15 +88,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.5.11
+signing_key: 
 specification_version: 4
 summary: Write request and response migrations for your Ruby on Rails API.
 test_files: []