Simplify the implementation of services within an API-based software platform.
See Hoodoo Guides for extensive documentation and examples.
Add the gem to your
gem 'hoodoo', '~> 2.0'
Require hoodoo when needed:
- Middleware: The heart of services; Rack-based service applications (think Sinatra, Grape, Rails...) -- Hoodoo::Services::Middleware; but start at Hoodoo::Services::Service and see also Hoodoo::Services::Interface, Hoodoo::Services::Implementation and related classes Hoodoo::Services::Request, Hoodoo::Services::Response, Hoodoo::Services::Session, Hoodoo::Services::Context
- Generic Presenter Layer: Input and output validation and rendering -- Hoodoo::Presenters::Base, Hoodoo::Presenters::BaseDSL
- Unified Error Helpers: Adds standard platform error capability to any API/class -- Hoodoo::ErrorDescriptions, Hoodoo::Errors
- Unified Logger: A single logger for use with platform or local logs -- Hoodoo::Logger
- Platform Sessions: Authentication of sessions, session context -- Hoodoo::Services::Session
- Platform Events: Publishes Platform Events when running on a queue-based infrastructure -- Hoodoo::Events::PlatformEvent
- ActiveRecord Assistance: If using ActiveRecord (optional), provides support methods/mixins for models to help bridge the gap between API resources and persistence -- Hoodoo::ActiveRecord
Master documentation is through RDoc (see below).
Workflow / branches
Development occurs on either
master directly, or temporary
feature branches which are subsequently merged to
master. This model is used because Gem versions, once Hoodoo is stored in a public Gem repository, will allow other software to decide what changes to import or ignore. The Gem version is not usually altered while Hoodoo stays within a private repository.
Run the tests:
bundle exec rake
bundle exec rspec
The Hoodoo public API is documented through source code comments with examples and workflow indications. RDoc turns these into HTML. See earlier for some pointers to classes of interest that will be linked to the relevant class documentation if you read all of this through the RDoc output.
If working on an installed copy of the gem through normal channels, you should be able to issue this command:
...and browse to port 8808 on
localhost to get an index of all gem documentation, including that for Hoodoo. Out of the box from GitHub, RDoc precompiled documentation is available but there is a risk it might be out of date. If working on development of the gem in a GitHub repository clone, you can generate or entirely regenerate RDoc files (re-RDoc) with:
bundle exec rake rerdoc
Some additional higher level hand written documentation may also be present as Markdown data inside the
Please see the
hoodoo.gemspec file for licence details. Those files are authoritative. At the time of writing - though this note might get out of date - Hoodoo is released under the LGPL v3; see: