MicroService Signed Request Middleware
Rack::MicroService::SignedRequest
provides support for handling MicroService
signed requests in Rack compatible applications.
Installation
Add this line to your application's Gemfile:
gem 'rack-micro_service-signed_request', :require => 'rack-micro_service-signed_request'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rack-micro_service-signed_request
Configuration
Rack
In the config.ru
use Rack::MicroService::SignedRequest
# Your app might support multiple MicroService instances
# This block allows you to determine what secret to use based on the Authorization header
secret do |auth_header_params|
"this_should_be_the_app_secret_for_authentication_header_params"
end
end
Rails
In config/application.rb
module ExampleApp
class Application < Rails::Application
config.middleware.use "Rack::MicroService::SignedRequest" do
# Your app might support multiple MicroService instances
# This block allows you to determine what secret to use based on the Authorization header
secret do |auth_header_params|
"this_should_be_the_app_secret_for_authentication_header_params"
end
end
end
end
Usage
request.env['micro_service.client_id']
will be populated with add-ons client_id
request.env['micro_service.errors.signed_request']
will be populated if there was an error authenticating the signed request
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rack-micro_service-signed_request.
License
The gem is available as open source under the terms of the MIT License.