balrog 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5139f44e15d64bc7e7138716bd2f94078345981281415b3ac40bf4408c8181b0
-  data.tar.gz: 014f03129ad8f39feac850621f6a581138419b6933341e09a3feae2273736b0d
+  metadata.gz: b518904751f63b68eab38cc945dfebe1cf013124be9b16abf684fbfe24450550
+  data.tar.gz: '0179daeb802833fdf7cb6771584f604fcba47bbdb4fe8177003ea70c1ec3aa4d'
 SHA512:
-  metadata.gz: 7cfe1ba81b99825b54f41d0116c819d968bfcac4f5a85940676e4b583dee45fb80598e06deb8126c127e2879c7ff55713eb99aac484dc4ab1b8b84a4583b7c90
-  data.tar.gz: 8ba157eb6b60d32e272f09b508883fa5a0637810e5142e9dc5368cb1bd676bacc6952d559841c4b5f57e19965ebfff5f12ea1591cdc39633c939f2b0531d5871
+  metadata.gz: c85e1122e208eba94aa7dd98940b38a1274a5e048922d4f15b9cf7699daabb2f7d905efcdc1f5e711192270e554229a5c324cbfcf78e6decc6ab7c40b9588708
+  data.tar.gz: 5f0ad78e961fed3cc084af8f6a12c20fb8f5118967aa8de08491519fd33ca55fa481fa168b3df5a505279cbeed3de008e79c9a636ae7f0606f5e74ce048c2982

data/.circleci/config.yml

@@ -4,6 +4,7 @@ jobs:
   build:
     docker:
       - image: circleci/ruby:2.6.2-node-browsers
+      - image: circleci/redis:5.0.4
 
     working_directory: ~/repo/spec/dummy-rails-app
 

data/.gitignore

@@ -11,3 +11,5 @@
 .rspec_status
 
 .DS_Store
+
+**/dump.rdb

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# 1.0.0
+
+- added `Balrog::RoutesMiddleware` module, which can be used to protect mounted Rack applications.
+- dropped support for Rails < 5.
+
+# 0.2.0
+
+- added `balrog_logout_button` view helper method.
+
+# 0.1.0
+
+- initial release.

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    balrog (0.2.0)
+    balrog (1.0.0)
       bcrypt (~> 3.0)
-      rails (>= 4.2)
+      rails (>= 5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,7 +5,7 @@
 [![Gem Version](https://badge.fury.io/rb/balrog.svg)](https://badge.fury.io/rb/balrog)
 [![CircleCI](https://circleci.com/gh/pixielabs/balrog.svg?style=svg)](https://circleci.com/gh/pixielabs/balrog)
 
-Balrog is a lightweight authorization library for Ruby on Rails written by
+Balrog is a lightweight authorization library for Ruby on Rails >= 5 written by
 [Pixie Labs](https://pixielabs.io) that can protect your routes with a single
 username & password combination.
 
@@ -28,7 +28,7 @@ gem 'balrog'
 
 Run the installer to generate an initializer:
 
-```
+```shell
 $ bundle exec rails generate balrog:install
 Enter New Password:
 Confirm New Password:
@@ -59,6 +59,29 @@ class AdminController < ApplicationController
 end
 ```
 
+## Restricting access to mounted Rack applications within config/routes.rb
+
+Use the `.use` [method](https://www.rubydoc.info/gems/rack/Rack%2FBuilder:use) to add Balrog to the 'stack'. 
+
+For example with Sidekiq::Web...
+
+```ruby
+# Then we tell SideKiq to use Balrog::RoutesMiddleware
+Sidekiq::Web.use Balrog::RoutesMiddleware
+
+mount Sidekiq::Web => '/sidekiq'
+```
+
+N.B. If you are mounting Sidekiq Web, you need to [disable Sidekiq Web's session in config/initializers/sidekiq.rb](https://github.com/mperham/sidekiq/issues/3377#issuecomment-381254940).
+
+```ruby
+require 'sidekiq/web'
+
+# In order to force sidekiq to use the rails app's session,
+# we need to disable the Sidekiq's session.
+Sidekiq::Web.disable(:sessions)
+```
+
 ## Logout button
 
 To add a logout button, you can call the `balrog_logout_button` view helper

data/app/views/balrog/gate.html.erb

@@ -23,4 +23,4 @@
 
 </body>
 
-</html>
+</html>

data/balrog.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "bcrypt", "~> 3.0"
-  spec.add_dependency "rails", ">=4.2"
+  spec.add_dependency "rails", ">=5"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/balrog.rb

@@ -3,6 +3,7 @@ require 'rails'
 module Balrog 
   require_relative 'balrog/version'
   require_relative 'balrog/middleware'
+  require_relative 'balrog/routes_middleware'
   require_relative 'balrog/engine'
   require_relative 'balrog/rake_tasks'
   require_relative 'balrog/generators'

data/lib/balrog/routes_middleware.rb

@@ -0,0 +1,27 @@
+# Public: Balrog routes middleware that redirects the user to a security
+# gate unless the session includes { 'balrog' => 'authenticated' }.
+# 
+# In order to protect SideKiq Web you would do something like this: 
+#
+# require 'sidekiq/web'
+#
+# Sidekiq::Web.disable(:sessions)
+# Sidekiq::Web.use Balrog::RoutesMiddleware
+#
+# mount Sidekiq::Web => '/sidekiq'
+
+class Balrog::RoutesMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    unless env['rack.session']['balrog'] == 'authenticated'
+      html = ApplicationController.renderer.render 'balrog/gate', layout: nil
+      return [200, {"Content-Type" => "text/html"}, [html]]  
+    end
+    @app.call(env)
+  end 
+
+end
+

data/lib/balrog/version.rb

@@ -1,3 +1,3 @@
 module Balrog
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: balrog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Pixie Labs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +92,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -112,6 +113,7 @@ files:
 - lib/balrog/middleware.rb
 - lib/balrog/password_hasher.rb
 - lib/balrog/rake_tasks.rb
+- lib/balrog/routes_middleware.rb
 - lib/balrog/tasks/generate_hash.rake
 - lib/balrog/version.rb
 - lib/balrog/view_helpers.rb