ianvaughan/integrate

An Integration Framework for Ruby

Integrate

Integrate is a Ruby Integration Framework for building messaging systems following the Pipes and Filters architectural style.

Using Integrate you can define a workflow to divide a large processing task into a sequence of smaller, independent processing steps that are connected by channels.

Concepts

Messages

A Message is a generic container for data consisting of headers and a payload. Headers hold commonly required information (e.g. id and timestamp), and the payload can be any object. Messages are immutable.

Channels

A Channel represents the "pipe" of a Pipes and Filters architecture. Producers send Messages to a Channel, and Consumers receive Messages from a Channel. A Channel decouples the messaging components.

Endpoints

An Endpoint represents the "filter" of a Pipes and Filters architecture. Its role is to connect application code to the messaging framework and to do so in a non-invasive manner.

Transformers

A Transformer allows loose-coupling of Endpoints. Transformers can be added between Endpoints so that no Endpoint needs to know what is expected by the next in a workflow. A Transformer is responsible for converting a Message's content or structure and returning a new, modified Message.

Filters

A Filter determines whether a Message should be passed to its output channel based upon the value of a Message's headers and/or payload.

Routers

A Router decides which Channel should receive a Message next (if any), based upon the value of a Message's headers and/or payload.

Splitters

A Splitter accepts a Message and then splits it into multiple Messages. A common use case is dividing a "composite" payload object into a group of Messages containing the sub-divided payloads.

Aggregators

An Aggregator is the opposite of a Splitter. It receives multiple Messages and combines them into a single Message.

Service Activators

A Service Activator connects an external service instance to the messaging system.

Channel Adapters

A Channel Adapter connects a Channel to an external system or transport. They may be either inbound or outbound.

Licence

(The MIT License)

Copyright (c) 2012 Global Personals, Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.