Merge branch 'release/v5.1.0'

Author: bolshakov

.github/workflows/ci.yml

@@ -51,7 +51,7 @@ jobs:
         env:
           STOPLIGHT_REDIS_URL: "redis://127.0.0.1:6379/0"
           STOPLIGHT_DATA_STORE: ${{ matrix.data_store }}
-          CUCUMBER_PUBLISH_TOKEN: ${{ secrets.CUCUMBER_PUBLISH_TOKEN }}
+          CUCUMBER_PUBLISH_ENABLED: true
 
   spec:
     name: Specs on Ruby ${{ matrix.ruby }} with Redis ${{ matrix.redis }} 💚

.gitignore

@@ -4,7 +4,18 @@
 /doc/
 /pkg/
 /tmp/
+tmp/
 /vendor/
 /.idea
 profile_results
 /docker/Gemfile.lock
+*.log
+
+# OS or Editor folders
+.DS_Store
+.cache
+.project
+.settings
+.tmproj
+.idea
+Thumbs.db

Gemfile

@@ -13,6 +13,7 @@ group :admin do
 end
 
 group :development do
+  gem "ammeter"
   gem "benchmark-ips", "~> 2.14"
   gem "concurrent-ruby-ext"
   gem "connection_pool"

Gemfile.lock

@@ -1,57 +1,97 @@
 PATH
   remote: .
   specs:
-    stoplight (5.0.2)
+    stoplight (5.1.0)
       zeitwerk
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (8.0.2)
+      actionview (= 8.0.2)
+      activesupport (= 8.0.2)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.0.2)
+      activesupport (= 8.0.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ammeter (1.1.7)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
     ast (2.4.3)
     base64 (0.2.0)
+    benchmark (0.4.1)
     benchmark-ips (2.14.0)
-    bigdecimal (3.1.9)
+    bigdecimal (3.2.2)
     builder (3.3.0)
     concurrent-ruby (1.3.5)
     concurrent-ruby-ext (1.3.5)
       concurrent-ruby (= 1.3.5)
     connection_pool (2.5.3)
-    cucumber (9.2.1)
+    crass (1.0.6)
+    cucumber (10.0.0)
+      base64 (~> 0.2)
       builder (~> 3.2)
       cucumber-ci-environment (> 9, < 11)
-      cucumber-core (> 13, < 14)
-      cucumber-cucumber-expressions (~> 17.0)
-      cucumber-gherkin (> 24, < 28)
+      cucumber-core (> 15, < 17)
+      cucumber-cucumber-expressions (> 17, < 19)
       cucumber-html-formatter (> 20.3, < 22)
-      cucumber-messages (> 19, < 25)
       diff-lcs (~> 1.5)
+      logger (~> 1.6)
       mini_mime (~> 1.1)
       multi_test (~> 1.1)
-      sys-uname (~> 1.2)
+      sys-uname (~> 1.3)
     cucumber-ci-environment (10.0.1)
-    cucumber-core (13.0.3)
-      cucumber-gherkin (>= 27, < 28)
-      cucumber-messages (>= 20, < 23)
+    cucumber-core (15.1.0)
+      cucumber-gherkin (> 27, < 31)
+      cucumber-messages (> 26, < 29)
       cucumber-tag-expressions (> 5, < 7)
-    cucumber-cucumber-expressions (17.1.0)
+    cucumber-cucumber-expressions (18.0.1)
       bigdecimal
-    cucumber-gherkin (27.0.0)
-      cucumber-messages (>= 19.1.4, < 23)
-    cucumber-html-formatter (21.9.0)
+    cucumber-gherkin (30.0.4)
+      cucumber-messages (> 25, < 28)
+    cucumber-html-formatter (21.10.1)
       cucumber-messages (> 19, < 28)
-    cucumber-messages (22.0.0)
+    cucumber-messages (27.2.0)
     cucumber-tag-expressions (6.1.2)
     database_cleaner-core (2.0.1)
     database_cleaner-redis (2.0.0)
       database_cleaner-core (~> 2.0.0)
       redis
     date (3.4.1)
-    debug (1.10.0)
+    debug (1.11.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.6.2)
     docile (1.4.0)
+    drb (2.2.3)
+    erb (5.0.1)
+    erubi (1.13.1)
     ffi (1.17.2)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
     io-console (0.8.0)
     irb (1.15.2)
       pp (>= 0.6.0)
@@ -61,12 +101,20 @@ GEM
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
     mini_mime (1.1.5)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
     multi_json (1.15.0)
     multi_test (1.1.0)
     mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.7.4)
+    nokogiri (1.18.8)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.8.0)
       ast (~> 2.4.1)
@@ -75,7 +123,7 @@ GEM
       prettyprint
     prettyprint (0.2.0)
     prism (1.4.0)
-    psych (5.2.3)
+    psych (5.2.6)
       date
       stringio
     puma (6.6.0)
@@ -91,10 +139,28 @@ GEM
       rack (>= 3.0.0)
     rack-test (2.2.0)
       rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.3.0)
     rantly (2.0.0)
-    rdoc (6.13.1)
+    rdoc (6.14.1)
+      erb
       psych (>= 4.0.0)
     redis (5.4.0)
       redis-client (>= 0.22.0)
@@ -115,6 +181,14 @@ GEM
     rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
+    rspec-rails (8.0.0)
+      actionpack (>= 7.2)
+      activesupport (>= 7.2)
+      railties (>= 7.2)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
     rspec-support (3.13.4)
     rubocop (1.75.6)
       json (~> 2.3)
@@ -138,6 +212,7 @@ GEM
       base64
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -170,20 +245,26 @@ GEM
     standard-performance (1.8.0)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.25.0)
-    stringio (3.1.6)
+    stringio (3.1.7)
     sys-uname (1.3.1)
       ffi (~> 1.1)
+    thor (1.3.2)
     tilt (2.6.0)
     timecop (0.9.10)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
+    uri (1.0.3)
+    useragent (0.16.11)
     zeitwerk (2.7.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  ammeter
   benchmark-ips (~> 2.14)
   concurrent-ruby-ext
   connection_pool

README.md

@@ -128,18 +128,23 @@ receives `nil`. In both cases, the return value of the fallback becomes the retu
 
 Stoplight goes with a built-in Admin Panel that can track all active Lights and manually lock them in the desired state (`Green` or `Red`). Locking lights in certain states might be helpful in scenarios like E2E testing.
 
-To add Admin Panel to your Rails project, add this configuration to your `config/routes.rb` file.
+To add Admin Panel protected by basic authentication to your Rails project, add this configuration to your `config/routes.rb` file.
 
 ```ruby
 Rails.application.routes.draw do
   # ...
 
+  Stoplight::Admin.use(Rack::Auth::Basic) do |username, password|
+    username == ENV["STOPLIGHT_ADMIN_USERNAME"] && password == ENV["STOPLIGHT_ADMIN_PASSWORD"]
+  end
   mount Stoplight::Admin => '/stoplights'
 
   # ...
 end
 ```
 
+Then set up `STOPLIGHT_ADMIN_USERNAME` and `STOPLIGHT_ADMIN_PASSWORD` env variables to access your Admin panel.
+
 **IMPORTANT:** Stoplight Admin Panel requires you to have `sinatra` and `sinatra-contrib` gems installed. You can either add them to your Gemfile:
 
 ```ruby
@@ -158,13 +163,13 @@ gem install sinatra-contrib
 It is possible to run the Admin Panel separately from your application using the `stoplight-admin:<release-version>` docker image.
 
 ```shell
-docker run --net=host stoplight-admin:v5
+docker run --net=host bolshakov/stoplight-admin
 ```
 
 **IMPORTANT:** Standalone Admin Panel should use the same Redis your application uses. To achieve this, set the `REDIS_URL` ENV variable via `-e REDIS_URL=<url-to-your-redis-servier>.` E.g.:
 
 ```shell
-docker run -e REDIS_URL=redis://localhost:6378  --net=host stoplight-admin:v5
+docker run -e REDIS_URL=redis://localhost:6378  --net=host bolshakov/stoplight-admin
 ```
 
 
@@ -384,6 +389,12 @@ Stoplight.configure do |config|
 end
 ```
 
+You can generate initializer with Redis, Admin Panel route and add needed gems to your Gemfile:
+
+```sh
+rails generate stoplight:install --with-admin-panel
+```
+
 ## Testing
 
 Tips for working with Stoplight in test environments:
@@ -416,6 +427,12 @@ Stoplight supports the latest three minor versions of Ruby, which currently are:
 the minimum supported Ruby version is not considered a breaking change. We support the current stable Redis 
 version (`7.4.x`) and the latest release of the previous major version (`6.2.x`)
 
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Run tests with `bundle exec rspec` and check 
+code style with `bundle exec standardrb`. We follow a git flow branching strategy - see our [Git Flow wiki page] for 
+details on branch naming, releases, and contribution workflow.
+
 ## Credits
 
 Stoplight was originally created by [camdez][] and [tfausak][]. It is currently maintained by [bolshakov][] and
@@ -444,3 +461,4 @@ Fowler’s [CircuitBreaker][] article.
 [complete list of contributors]: https://github.com/bolshakov/stoplight/graphs/contributors
 [CircuitBreaker]: http://martinfowler.com/bliki/CircuitBreaker.html
 [Redis]: https://redis.io/
+[Git Flow wiki page]: https://github.com/bolshakov/stoplight/wiki/Git-Flow

SECURITY.md

@@ -6,8 +6,8 @@ You can expect to receive security fixes for the latest minor version only.
 
 | Version | Supported          |
 |---------| ------------------ |
-| 4.1.x   | :white_check_mark: |
-| < 4.1   | :x:                |
+| 5.1.x   | :white_check_mark: |
+| < 5.1   | :x:                |
 
 ## Reporting a Vulnerability
 

lib/generators/stoplight/install/USAGE

@@ -0,0 +1,16 @@
+Description:
+  Generates stoplight initializer to setup Stoplight Redis configuration
+    and optionally sets up Admin panel
+  
+Examples:
+  rails generate stoplight:install
+
+    This will generate "config/initializers/stoplight.rb" initializer with basic config
+    Then you should adjust Redis config there.
+
+  rails generate stoplight:install --with-admin-panel
+
+    This generated all needed requirements to set up Stoplight Admin Panel:
+    * It generates initializer "config/initializers/stoplight.rb" with Redis configuration
+    * It injects your "config/routes.rb" with route with basic authentication to Stoplight Admin panel
+    * It injects your Gemfile with needed dependencies ('redis', 'sinatra' and 'sinatra-contrib')