request_migrations 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2224934d0be51149ebf90a756ae9cfd9172ee83310609c9cfc94c49c4c75166
-  data.tar.gz: 3de2f808de4c02d7de89ec9baae0b5d68cadab94d8118e13688a941de791d3cf
+  metadata.gz: '091e4436fcd439967859301cc299fccaf6081f5da326ed79813e7cbce3f4d86c'
+  data.tar.gz: 4be2f76ade4958a48794ee62e6184c964f747f6c59a44a12ef20dcbbcc8c32a0
 SHA512:
-  metadata.gz: 944f3e23fe55b3d9eb56cdf0491871bfecea72a5c9a57b15f8827152b7cf5a21ab0e0ac6c1f254a9afabe4fc980562b864e96a2868ec864a314d41876e1af987
-  data.tar.gz: e3fa22992ac3aadcd34ce860310f6a496f4aa7f54179090863bcf993582e2c757fa07677862973b817edc2d209b289284e19ec040249c62011ad20ceb41ee0c6
+  metadata.gz: e2a22c88034bd0a67f34849909d85686267a4fd2a62dfbcfcb963766f678397d141a628608b63e0549581fbd9e02184a938619a269c81e44bd1a094d2febe702
+  data.tar.gz: d92878fd3a359c744c4cc9354325a5fea7d89ca81e9c3aa2718bd033a8b7ed8f7840f8bce0ada3f170dfb8f3a1ea9f1362cff8b08effafee53ffc0b5b59911c4

data/README.md

@@ -17,6 +17,24 @@ Sponsored by:
 
 _A software licensing and distribution API built for developers._
 
+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)
+- [Credits](#credits)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Installation
 
 Add this line to your application's `Gemfile`:
@@ -39,8 +57,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 +143,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`:
@@ -292,10 +311,11 @@ 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).
 
 ### Routing constraints
 
@@ -406,9 +426,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 +442,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.

data/lib/request_migrations/gem.rb

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

data/lib/request_migrations.rb

@@ -46,13 +46,16 @@ module RequestMigrations
   ##
   # @private
   def self.config=(cfg)
+    raise ArgumentError, 'invalid config provided' unless
+      cfg.is_a?(Configuration)
+
     @config = cfg
   end
 
   ##
   # @private
   def self.reset!
-    @config = RequestMigrations::Configuration.new
+    @config = Configuration.new
   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.1
 platform: ruby
 authors:
 - Zeke Gabrielse
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -88,7 +88,7 @@ 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:
   - - ">="