One of the concepts we've had great success with in the Tuts+ team is service objects. We've used service objects to reduce coupling in our systems, make them more testable, and make important business logic more obvious to all the developers on the team.
So when we decided to codify some of the concepts we've used in our Rails development into a Ruby gem (called Aldous), service objects were top of the list.
What I'd like to do today is give a quick rundown of service objects as we've implemented them in Aldous. Hopefully this will tell you most of the things you need to know in order to use Aldous service objects in your own projects.

A service object is basically a method that is wrapped in an object. Sometimes a service object can contain several methods, but the simplest version is just a class with one method, e.g.:
class DoSomething
def perform
# do stuff
end
endWe're all used to using nouns to name our objects, but sometimes it can be hard to find a good noun to represent a concept, whereas talking about it in terms of an action (or verb) is simple and natural. A service object is what we get when we 'go with the flow' and just turn the verb into an object.
Of course, given the above definition we can turn any action/method into a service object if we so desire. The following...
class Customer
def createPurchase(order)
# do stuff
end
end... could be turned into:
class CreateCustomerPurchase
def initialize(customer, order)
end
def perform
# do stuff
end
endWe could write several other posts about the effect service objects might have on the design of your system, the various trade-offs you'll be making, etc. For now let's just be aware of them as a concept and consider them just another tool we have in our arsenal.
As Rails apps get bigger, our models tend to become quite large, and so we look for ways to push some functionality out of them into 'helper' objects. But this is often easier said than done. Rails doesn't have a concept, in the model layer, which is more granular than a model. So you end up having to make a lot of judgement calls:
lib folder?You now need to communicate what you've done to the other developers on your team and to any new people who join later. And, of course, faced with a similar situation, other developers might make different judgement calls, leading to inconsistencies creeping in.
Service objects give us a concept which is more granular than a model. We can have a consistent location for all our services and you only ever move one method into a service. You name this class after the action/method that it will represent. We can extract functionality into more granular objects without too many judgement calls, which keeps the whole team on the same page, allowing us to get on with the business of building a great application.
Using service objects reduces coupling between your Rails models, and the resultant services are highly reusable due to their small size/light footprint.
Service objects are also highly testable, as they usually won't require as much test boilerplate as more heavyweight objects, and you only worry about testing the one method that the object contains.
Both the service objects and their tests are easy to read/understand as they are highly cohesive (also a side-effect of their small size). You can also discard and rewrite both service objects and their tests almost at will, as the cost of doing so is relatively low and it is very easy to maintain their interface.
Service objects definitely have a lot going for them, especially when you introduce them into your Rails apps.

Given that service objects are so simple, why do we even need a gem? Why not just create POROs, and then you don't need to worry about another dependency?
You could definitely do that, and in fact we did this for quite a while in Tuts+, but through extensive usage we ended up developing a few patterns for services that made our lives just that little bit easier, and this is exactly what we've pushed into Aldous. These patterns are light and don't involve a lot of magic. They make our lives a tiny bit easier, but we retain all the control if we need it.
First things first, where should your services live? We tend to put them in app/services, so you need the following in your app/config/application.rb:
config.autoload_paths += %W(
#{config.root}/app/services
)
config.eager_load_paths += %W(
#{config.root}/app/services
)As I've mentioned above, we tend to name service objects after actions/verbs (e.g. CreateUser, RefundPurchase), but we also tend to append 'service' to all the class names (e.g. CreateUserService, RefundPurchaseService). This way no matter which context you're in (looking at the files on the file system, looking at a service class anywhere in the codebase) you always know you're dealing with a service object.
This is not enforced by the gem in any way, but worth taking into account as a lesson learned.
When we say immutable, we mean that after the object is initialized, its internal state will no longer change. This is really great since it makes it much simpler to reason about the state of each object as well as the system as a whole.
In order for the above to be true, the service object method can't change the state of the object, so any data must be returned as an output of the method. This is difficult to enforce directly, since an object will always have access to its own internal state. With Aldous we try to enforce it via convention and education, and the next two sections will show you how.
An Aldous service object must always return one of two types of objects:
Aldous::Service::Result::SuccessAldous::Service::Result::FailureHere is an example:
class CreateUserService < Aldous::Service
def perform
user = User.new(user_data_hash)
if user.save
Result::Success.new
else
Result::Failure.new
end
end
endBecause we inherit from Aldous::Service, we can construct our return objects as Result::Success. Using those objects as return values allows us to do things like:
hash = {}
result = CreateUserService.perform(hash)
if result.success?
# do success stuff
else #result.failure?
# do failure stuff
endWe could, in theory, just return true or false and get the same behaviour as we have above, but if we did that we couldn't carry any extra data with our return value, and we often want to carry data.
The success or failure of an operation/service is only part of the story. Often we will have created some object which we want to return, or produced some errors of which we want to notify the calling code. This is why returning objects, as we've shown above, is useful. These objects are not just used to indicate success or failure, they are also data transfer objects.
Aldous allows you to override a method on the base service class, to specify a set of default values that objects returned from the service would contain, e.g.:
class CreateUserService < Aldous::Service
attr_reader :user_data_hash
def initialize(user_data_hash)
@user_data_hash = user_data_hash
end
def default_result_data
{user: nil}
end
def perform
user = User.new(user_data_hash)
if user.save
Result::Success.new(user: user)
else
Result::Failure.new
end
end
endThe hash keys contained in default_result_data will automatically become methods on the Result::Success and Result::Failure objects returned by the service. And if you supply a different value for one of the keys in that method, it will override the default. So in the case of the above class:
hash = {}
result = CreateUserService.perform(hash)
if result.success?
result.user # will be an instance of User
result.blah # would raise an error
else #result.failure?
result.user # will be nil
result.blah # would raise an error
endIn effect the hash keys in the default_result_data method are a contract for the users of the service object. We guarantee that you would be able to call any key in that hash as a method on any result object that comes out of the service.

When we talk about error-free APIs we mean methods that never raise errors, but always return a value to indicate success or failure. I've written about error-free APIs before. Aldous services are error-free depending on how you call them. In the example above:
result = CreateUserService.perform(hash)
This will never raise an error. Internally Aldous wraps your perform method in a rescue block and if your code raises an error it will return a Result::Failure with the default_result_data as data.
This is quite liberating, because you no longer have to think about what can go wrong with the code you've written. You're only interested in the success or failure of your service, and any error will result in a failure.
This is great for most situations. But sometimes, you want an error generated. The best example of this is when you're using a service object in a background worker and an error would cause the background worker to retry. This is why an Aldous service also magically gets a perform! method and allows you to override another method from the base class. Here is our example again:
class CreateUserService < Aldous::Service
attr_reader :user_data_hash
def initialize(user_data_hash)
@user_data_hash = user_data_hash
end
def raisable_error
MyApplication::Errors::UserError
end
def default_result_data
{user: nil}
end
def perform
user = User.new(user_data_hash)
if user.save
Result::Success.new(user: user)
else
Result::Failure.new
end
end
endAs you can see, we've now overridden the raisable_error method. We sometimes want an error to be produced, but we also don't want it to be any type of error. Otherwise our calling code would have to become aware of every possible error that the service can produce, or be forced to catch one of the base error types. This is why when you use the perform! method, Aldous will still catch all the errors for you, but will then re-raise the raisable_error you've specified and set the original error as the cause. You could now have this:
hash = {}
begin
service = CreateUserService.build(hash)
result = service.perform!
rescue service.raisable_error => e
# error stuff
endYou may have noticed the factory method usage:
CreateUserService.build(hash) CreateUserService.perform(hash)
You should always be using these, and never construct service objects directly. The factory methods are what allow us to cleanly hook in the nice features like automatic rescue and adding the default_result_data.
However, when it comes to tests, you don't want to have to worry about how Aldous augments the functionality of your service objects. So, when testing, simply construct the objects directly using the constructor and then test your functionality. You'll get specs for the logic you wrote and trust that Aldous will do what it's supposed to do (Aldous has tests of its own for this) when it comes to production.
Hopefully this has given you an idea of how service objects (and especially Aldous service objects) can be a nice tool in your arsenal when working with Ruby/Rails. Give Aldous a try and let us know what you think. Also feel free to have a look at the Aldous code. We didn't just write it to be useful, but also to be readable and easy to understand/modify.
Create Modern Vue Apps Using Create-Vue and Vite
/
5Pros and Cons of Using WordPress
/
-4How to Fix the “There Has Been a Critical Error in Your Website” Error in WordPress
/
1How To Fix The “There Has Been A Critical Error in Your Website” Error in WordPress
How to Create a Privacy Policy Page in WordPress
/
8WordPress Website Maintenance Guide For Beginners
/
6How Long Does It Take to Learn JavaScript?
/
-1How Long Does it Take to Learn JavaScript
/
1The Best Way to Deep Copy an Object in JavaScript
/
-2
4
-5Adding and Removing Elements From Arrays in JavaScript
/
-2Create a JavaScript AJAX Post Request: With and Without jQuery
/
75 Real-Life Uses for the JavaScript reduce() Method
/
-9How to Enable or Disable a Button With [removed] jQuery vs. Vanilla
/
3How to Enable or Disable a Button With [removed] jQuery vs Vanilla
/
-4Confirm Yes or No With JavaScript
/
-1How to Change the URL in [removed] Redirecting
/
-315+ Best WordPress Twitter Widgets
/
-227 Best Tab and Accordion Widget Plugins for WordPress (Free & Premium)
/
1021 Best Tab and Accordion Widget Plugins for WordPress (Free & Premium)
/
-1130 HTML Best Practices for Beginners
/
-831 Best WordPress Calendar Plugins and Widgets (With 5 Free Plugins)
/
525 Ridiculously Impressive HTML5 Canvas Experiments
/
-8
1How to Implement Email Verification for New Members
/
3How to Create a Simple Web-Based Chat Application
/
530 Popular WordPress User Interface Elements
/
-5Top 18 Best Practices for Writing Super Readable Code
/
2Best Affiliate WooCommerce Plugins Compared
/
-1018 Best WordPress Star Rating Plugins
/
1410+ Best WordPress Twitter Widgets
/
320+ Best WordPress Booking and Reservation Plugins
/
5Working With Tables in React: Part Two
/
-4Best CSS Animations and Effects on CodeCanyon
/
-1630 CSS Best Practices for Beginners
/
4How to Create a Custom WordPress Plugin From Scratch
/
510 Best Responsive HTML5 Sliders for Images and Text… and 3 Free Options
/
-416 Best Tab and Accordion Widget Plugins for WordPress
/
-418 Best WordPress Membership Plugins and 5 Free Plugins
/
325 Best WooCommerce Plugins for Products, Pricing, Payments and More
/
310 Best WordPress Twitter Widgets
1 /
1512 Best Contact Form PHP Scripts for 2020
/
-220 Popular WordPress User Interface Elements
/
-210 Best WordPress Star Rating Plugins
/
-312 Best CSS Animations on CodeCanyon
/
112 Best WordPress Booking and Reservation Plugins
/
220 Best WordPress Calendar Plugins and Widgets
/
-212 Elegant CSS Pricing Tables for Your Latest Web Project
/
724 Best WordPress Form Plugins for 2020
/
-214 Best PHP Event Calendar and Booking Scripts
/
-1Create a Blog for Each Category or Department in Your WooCommerce Store
8 Best WordPress Booking and Reservation Plugins
/
-18Best Exit Popups for WordPress Compared
/
19Best Exit Popups for WordPress Compared
/
-611 Best Tab & Accordion WordPress Widgets & Plugins
/
-1012 Best Tab & Accordion WordPress Widgets & Plugins
1New Course: Practical React Fundamentals
/
3Short Course: Better Angular App Architecture With Modules
/
2Preview Our New Course on Angular Material
/
5Object-Oriented PHP With Classes and Objects
/
3Best Practices for ARIA Implementation
/
-2Accessible Apps: Barriers to Access and Getting Started With Accessibility
/
-3Dramatically Speed Up Your React Front-End App Using Lazy Loading
/
1915 Best Modern JavaScript Admin Templates for React, Angular, and Vue.js
/
-1415 Best Modern JavaScript Admin Templates for React, Angular and Vue.js
/
219 Best JavaScript Admin Templates for React, Angular, and Vue.js
/
4New Course: Build an App With JavaScript and the MEAN Stack
/
10Hands-on With ARIA: Accessibility Recipes for Web Apps
/
810 Best WordPress Facebook Widgets
13 /
-5Hands-on With ARIA: Accessibility for eCommerce
/
6New eBooks Available for Subscribers
/
-5Hands-on With ARIA: Homepage Elements and Standard Navigation
/
10
-9Site Accessibility: Getting Started With ARIA
/
2How Secure Are Your JavaScript Open-Source Dependencies?
/
-2New Course: Secure Your WordPress Site With SSL
/
-3Testing Components in React Using Jest and Enzyme
/
-8Testing Components in React Using Jest: The Basics
/
-415 Best PHP Event Calendar and Booking Scripts
/
-1Create Interactive Gradient Animations Using Granim.js
/
10How to Build Complex, Large-Scale Vue.js Apps With Vuex
1 /
1Examples of Dependency Injection in PHP With Symfony Components
/
-4Set Up Routing in PHP Applications Using the Symfony Routing Component
1 /
11A Beginner’s Guide to Regular Expressions in JavaScript
/
12Introduction to Popmotion: Custom Animation Scrubber
/
-4Introduction to Popmotion: Pointers and Physics
/
-10New Course: Connect to a Database With Laravel’s Eloquent ORM
/
-5How to Create a Custom Settings Panel in WooCommerce
/
-12Building the DOM faster: speculative parsing, async, defer and preload
1 /
120 Useful PHP Scripts Available on CodeCanyon
3 /
49How to Find and Fix Poor Page Load Times With Raygun
/
2Introduction to the Stimulus Framework
/
-14Single-Page React Applications With the React-Router and React-Transition-Group Modules
612 Best Contact Form PHP Scripts
1 /
-4Getting Started With the Mojs Animation Library: The ShapeSwirl and Stagger Modules
/
2Getting Started With the Mojs Animation Library: The Shape Module
/
-4Getting Started With the Mojs Animation Library: The HTML Module
/
3Project Management Considerations for Your WordPress Project
/
-98 Things That Make Jest the Best React Testing Framework
/
3Creating an Image Editor Using CamanJS: Layers, Blend Modes, and Events
/
-3New Short Course: Code a Front-End App With GraphQL and React
Creating an Image Editor Using CamanJS: Applying Basic Filters
/
-14Creating an Image Editor Using CamanJS: Creating Custom Filters and Blend Modes
/
1Challenge: Create a To-Do List in React
1Deploy PHP Web Applications Using Laravel Forge
/
-1Getting Started With the Mojs Animation Library: The Burst Module
/
6
-9A Gentle Introduction to Higher-Order Components in React: Best Practices
/
-4Challenge: Build a React Component
/
-4A Gentle Introduction to HOC in React: Learn by Example
/
5A Gentle Introduction to Higher-Order Components in React
/
-6Creating Pretty Popup Messages Using SweetAlert2
/
5Creating Stylish and Responsive Progress Bars Using ProgressBar.js
/
1718 Best Contact Form PHP Scripts for 2022
/
-3How to Make a Real-Time Sports Application Using Node.js
/
1Creating a Blogging App Using Angular & MongoDB: Delete Post
/
-17Set Up an OAuth2 Server Using Passport in Laravel
/
1Creating a Blogging App Using Angular & MongoDB: Edit Post
/
-2Creating a Blogging App Using Angular & MongoDB: Add Post
/
-1Creating a Blogging App Using Angular & MongoDB: Show Post
/
8Creating a Blogging App Using Angular & MongoDB: Home
/
10
2Creating a Blogging App Using Angular & MongoDB: Login
/
13Creating Your First Angular App: Implement Routing
/
13Persisted WordPress Admin Notices: Part 4
/
-4Creating Your First Angular App: Components, Part 2
/
3Persisted WordPress Admin Notices: Part 3
/
3How Laravel Broadcasting Works
/
1
9Persisted WordPress Admin Notices: Part 2
/
-3Create Your First Angular App: Storing and Accessing Data
/
2Persisted WordPress Admin Notices: Part 1
/
-3Error and Performance Monitoring for Web & Mobile Apps Using Raygun
/
6Using Luxon for Date and Time in JavaScript
7 /
-5How to Create an Audio Oscillator With the Web Audio API
/
-6How to Cache Using Redis in Django Applications
/
220 Essential WordPress Utilities to Manage Your Site
/
-5Introduction to API Calls With React and Axios
/
18Beginner’s Guide to Angular 4: HTTP
/
11Rapid Web Deployment for Laravel With GitHub, Linode, and RunCloud.io
/
8Beginners Guide to Angular 4: Routing
/
-9Beginner’s Guide to Angular 4: Components
/
1Creating a Drop-Down Menu for Mobile Pages
/
2Introduction to Forms in Angular 4: Writing Custom Form Validators
/
510 Best WordPress Booking & Reservation Plugins
/
3Getting Started With Redux: Connecting Redux With React
/
15Getting Started With Redux: Learn by Example
/
15Getting Started With Redux: Why Redux?
/
9Understanding Recursion With JavaScript
/
-2How to Auto Update WordPress Salts
/
-8How to Download Files in Python
/
-4
-22Eloquent Mutators and Accessors in Laravel
1 /
17
-11
1210 Best HTML5 Sliders for Images and Text
/
5Site Authentication in Node.js: User Signup
/
-4Creating a Task Manager App Using Ionic: Part 2
/
2Creating a Task Manager App Using Ionic: Part 1
/
1
3Introduction to Forms in Angular 4: Template-Driven Forms
/
-124 Essential WordPress Utilities to Manage Your Site
/
-125 Essential WordPress Utilities to Manage Your Site
/
-12Get Rid of Bugs Quickly Using BugReplay
1 /
-13Manipulating HTML5 Canvas Using Konva: Part 1, Getting Started
/
710 Must-See Easy Digital Downloads Extensions for Your WordPress Site
22 Best WordPress Booking and Reservation Plugins
/
-5Understanding ExpressJS Routing
/
-515 Best WordPress Star Rating Plugins
/
12Inheritance and Extending Objects With JavaScript
/
-7Introduction to the CSS Grid Layout With Examples
1 /
2
8Performant Animations Using KUTE.js: Part 5, Easing Functions and Attributes
/
-8Performant Animations Using KUTE.js: Part 4, Animating Text
/
-12Performant Animations Using KUTE.js: Part 3, Animating SVG
/
-8New Course: Code a Quiz App With Vue.js
/
-1Performant Animations Using KUTE.js: Part 2, Animating CSS Properties
/
3
9Performant Animations Using KUTE.js: Part 1, Getting Started
/
410 Best Responsive HTML5 Sliders for Images and Text (Plus 3 Free Options)
/
-3Single-Page Applications With ngRoute and ngAnimate in AngularJS
/
-12Deferring Tasks in Laravel Using Queues
/
-5
4Site Authentication in Node.js: User Signup and Login
/
10Working With Tables in React, Part Two
/
-16Working With Tables in React, Part One
/
6How to Set Up a Scalable, E-Commerce-Ready WordPress Site Using ClusterCS
/
-2New Course on WordPress Conditional Tags
/
4
-11Building With Vue.js 2 and Firebase
6 /
10
-6
1Best Unique Bootstrap JavaScript Plugins
/
-10
-5Essential JavaScript Libraries and Frameworks You Should Know About
/
7
2Vue.js Crash Course: Create a Simple Blog Using Vue.js
/
-13Build a React App With a Laravel RESTful Back End: Part 1, Laravel 5.5 API
/
5API Authentication With Node.js
/
-4Beginner’s Guide to Angular: HTTP
/
7Beginner’s Guide to Angular: Routing
/
-4Beginners Guide to Angular: Routing
/
-6Beginner’s Guide to Angular: Services
/
5Beginner’s Guide to Angular: Components
/
-1How to Create a Custom Authentication Guard in Laravel
/
7Learn Computer Science With [removed] Part 3, Loops
/
-2Build Web Applications Using Node.js
/
3Learn Computer Science With [removed] Part 4, Functions
/
3Learn Computer Science With [removed] Part 2, Conditionals
/
12Learn Computer Science With [removed] Part 1, The Basics
/
-5Create Interactive Charts Using Plotly.js, Part 5: Pie and Gauge Charts
/
-8Create Interactive Charts Using Plotly.js, Part 4: Bubble and Dot Charts
/
18Create Interactive Charts Using Plotly.js, Part 3: Bar Charts
/
-14Awesome JavaScript Libraries and Frameworks You Should Know About
/
-4Create Interactive Charts Using Plotly.js, Part 2: Line Charts
/
-8Bulk Import a CSV File Into MongoDB Using Mongoose With Node.js
/
-4Build a To-Do API With Node, Express, and MongoDB
/
-6Getting Started With End-to-End Testing in Angular Using Protractor
/
10TypeScript for Beginners, Part 4: Classes
/
-10Object-Oriented Programming With JavaScript
/
610 Best Affiliate WooCommerce Plugins Compared
/
9Stateful vs. Stateless Functional Components in React
/
11Make Your JavaScript Code Robust With Flow
/
-6Build a To-Do API With Node and Restify
/
6Testing Components in Angular Using Jasmine: Part 2, Services
/
1Testing Components in Angular Using Jasmine: Part 1
/
-2Creating a Blogging App Using React, Part 6: Tags
/
-11React Crash Course for Beginners, Part 3
/
2React Crash Course for Beginners, Part 2
/
12React Crash Course for Beginners, Part 1
/
2Set Up a React Environment, Part 4
1 /
8Set Up a React Environment, Part 3
/
-12New Course: Get Started With Phoenix
/
-11Set Up a React Environment, Part 2
/
2Command Line Basics and Useful Tricks With the Terminal
/
3How to Create a Real-Time Feed Using Phoenix and React
/
-8Build a React App With a Laravel Back End: Part 2, React
/
2Build a React App With a Laravel RESTful Back End: Part 1, Laravel 9 API
/
-7Creating a Blogging App Using React, Part 5: Profile Page
/
-5Pagination in CodeIgniter: The Complete Guide
/
22JavaScript-Based Animations Using Anime.js, Part 4: Callbacks, Easings, and SVG
/
-1JavaScript-Based Animations Using Anime.js, Part 3: Values, Timeline, and Playback
Learn to Code With [removed] Part 1, The Basics
/
510 Elegant CSS Pricing Tables for Your Latest Web Project
/
-6Getting Started With the Flux Architecture in React
/
-2Getting Started With Matter.js: The Composites and Composite Modules
/
4Getting Started With Matter.js: The Engine and World Modules
/
1510 More Popular HTML5 Projects for You to Use and Study
/
-24Understand the Basics of Laravel Middleware
/
-6Iterating Fast With Django & Heroku
/
8Creating a Blogging App Using React, Part 4: Update & Delete Posts
/
3Creating a jQuery Plugin for Long Shadow Design
/
-9How to Register & Use Laravel Service Providers
2 /
-13Unit Testing in React: Shallow vs. Static Testing
/
5Creating a Blogging App Using React, Part 3: Add & Display Post
/
15Creating a Blogging App Using React, Part 2: User Sign-Up
20 /
-5Creating a Blogging App Using React, Part 1: User Sign-In
/
109 More Popular HTML5 Projects for You to Use and Study
/
18Creating a Grocery List Manager Using Angular, Part 2: Managing Items
/
99 Elegant CSS Pricing Tables for Your Latest Web Project
/
1Dynamic Page Templates in WordPress, Part 3
/
-2Angular vs. React: 7 Key Features Compared
/
6Creating a Grocery List Manager Using Angular, Part 1: Add & Display Items
/
2New eBooks Available for Subscribers in June 2017
/
7Create Interactive Charts Using Plotly.js, Part 1: Getting Started
/
11The 5 Best IDEs for WordPress Development (And Why)
/
233 Popular WordPress User Interface Elements
/
2New Course: How to Hack Your Own App
/
-10How to Install Yii on Windows or a Mac
/
5What Is a JavaScript Operator?
/
-5How to Register and Use Laravel Service Providers
/
9
waly Good blog post. I absolutely love this…