THIS REPOSITORY IS OUTDATED AND SHOULD NO LONGER BE USED! IT WILL BE REMOVED ONCE ALL DEPENDENCIES HAVE BEEN ADJUSTED

Our containerserivce Gem has moved to https://github.com/betterdoc-org/infrastructure-gem-containerservice.

This gem is designed to encapsulate all the common functionality needed within our cointainer services (e.g. authentication and special log handling).

It's very opinionated based on what our team needs.

Add this line to your application's Gemfile:

gem 'betterdoc-containerservice', git: 'https://github.com/betterdoc-org/general-gem-betterdoc-containerservice'

You can also add the railtie manually into your Rails config/application.rb file but the logics should be applied automatically as well.

require "betterdoc/containerservice/railtie"

The following environment variables must to be set in order for any container service depending on this gem to work correctly:

The following environment variables can be set to further customize the functionalities:

The following functionalities are automatically added to your Rails application:

Use the Logging framework (incl. its Railtie) and setzp our common log format.

All controller are enhanced to require a valid JSON Web Token (JWT) on each invocation either as HTTP header Authoriaztion in the format Authorization: Bearer 1234567890ABCEEF or as HTTP parameter _jwt in the format 1234567890ABCDEF.

The following code snippes demonstrate some shortcuts that can be used to render responses:

def some_controller_method
  return render_containerservice_error(404, "Object not found") if object_not_found

  # ...

end

def some_controller_method
  render_containerservice_template(:template_name)
end

Renders the template specified under :template_name.

Only if either the HTTP parameter full_html is set to true for the current request or an environment variable named CONTAINERSERVICE_FULL_HTML is set to true will the layout be applied to the template. Otherwise (the default case) only the plain template will be rendered and returned to the client.

Gem is written as Rails Engine and contains default layout (for development) at app/views/layouts/application.html.erb. This means that container should NOT have its own application layout. If you have one run rm app/views/layouts/application.html.erb to remove it. If you want to override default layout just add app/views/layouts/application.html.erb to your app :)

When the content of the container service is rendered inside a Stack (composed by Stacker) the following helper functionality is available to create a link to another Stack with the same Stacker instance.

Let's take an example:

A Stack is available at http://example.com/stack/abc. This stack aggregates the content from services foo and bar. With the content of foo we want to link to another stack named def:

<div>
  <a href="$ROOT_URL/def">Go to other stack</a>
</div>

To make sure the container service itself doesn't have to know about the actual location of Stacker (the $ROOT_URL) Stacker sends along a series of HTTP headers that tell the container service on which system it is running and which base URL to use.

So all that needs to be done wither within a template is to call the helper function create_stacker_link to create a link:

<div>
    <a href="<%= stacker_link_url('another/stack/location') %>">Go to other location</a>
</div>

This will output a fully qualifies URL incl. base URL and the path.

Parameters can also be passed to the create_stacker_link function:

<div>
    <a href="<%= stacker_link_url('another/stack/location', 'aKey' => 'aValue', 'bKey' => 'bValue') %>">Go to other location</a>
</div>

This will output a fully qualifies URL incl. the parameters passed, e.g.:

http://example.com/another/stack/location?=aValue&b=bValue

The output can also be combined with the standard Rails link_to tag:

<div>
    <%= link_to 'text', stacker_link_url('stack/abc') %>
</div>

When Stacker sends requests to a container service, a header, amongst others, is sent HTTP_X_STACKER_ROOT_URL. A helper method stacker_request? exists in this repository that allows containers to check the flag if the actual request is sent from Stacker.

• Lograge is automatically enabled