Giddyup nerd! Wrangle your SOA.
Saddle makes writing service clients as easy as giving high fives.
It's a full-featured, generic consumer layer for you to build API client implementations with.
Ok, I love high fives, but what does Saddle do for me?
Saddle is a framework that makes it exceptionally easy to write HTTP API clients. It abstracts away a lot of the repetitive work and lets you focus on your business logic. It also provides a simple middleware interface that makes it easy to extend functionality.
Saddle enables you to create beautifully stable and functionaly API clients, in the fewest lines of code possible.
- Specifying default connection settings for your client makes usage simple
- Automatic call tree construction, based upon module/class namespace
- Easily integrate with logging systems (currently supports statsd & Airbrake)
- Support simple testing of your client
- Post urlencoded or JSON (handles multipart file posts as well)
- Auto-parse JSON responses
- Strictly enforce request timeouts (client-wide or endpoint specific timeouts)
- Automatic retries with exponential backoff
- Turns 4xx and 5xx responses into exceptions
- If desired, silently return default values upon exception
- For the sake of cleanliness, pick a namespace that everything related to your client should live in. For this example, we'll use SaddleExample
- Inherit your client class, SaddleExample::Client, from Saddle::Client
- Create an endpoints directory at the same level as your client class file
Create endpoint classes in the endpoints directory that inherit from Saddle::TraversalEndpoint and are under the SaddleExample::Endpoints namespace module
- Give these endpoints methods that call get or post to perform the actual request
Their module/class namespace determines how they are accessed in the client's call tree. For example, the get_all() in SaddleExample::Endpoints::Fish::Guppy would be accessed by:
If you need REST style endpoints like client.fish('guppy').catch() then check out Saddle::ResourceEndpoint and how it's used in saddle-example
Initialize an instance of your client. ex:
saddle_example_client = SaddleExample::Client.create
- xml posting/parsing
Saddle is released under the MIT License.