Active Call

Active Call provides a standardized way to create service objects.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add active_call

If bundler is not being used to manage dependencies, install the gem by executing:

gem install active_call

Usage

Your child classes should inherit from ActiveCall::Base.

You can add your own service object classes in your gem's lib folder or your project's app/services folder.

Each service object must define only one public method named call.

Logic Flow

Before invoking call.

Validate the request with validates.
Use the before_call hook to set up anything after validation passes.

During call invocation.

A response attribute gets set with the result of the call method.

After invoking call.

Validate the response with validate, on: :response.
Use the after_call hook to set up anything after response validation passes.

Example Service Object

Define a service object with optional validations and callbacks.

require 'active_call'

class YourGemName::SomeResource::CreateService < ActiveCall::Base
  attr_reader :message

  validates :message, presence: true

  validate on: :response do
    errors.add(:message, :invalid, message: 'cannot be baz') if response[:foo] == 'baz'
  end

  before_call :strip_message

  after_call :log_response

  def initialize(message: nil)
    @message = message
  end

  def call
    { foo: message }
  end

  private

  def strip_message
    @message.strip!
  end

  def log_response
    puts "Successfully called #{response}"
  end
end

Using `.call`

You will get an errors object when validation fails.

service = YourGemName::SomeResource::CreateService.call(message: '')
service.success? # => false
service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=blank, options={}>]>
service.errors.full_messages # => ["Message can't be blank"]
service.response # => nil

A response object on a successful call invocation.

service = YourGemName::SomeResource::CreateService.call(message: ' bar ')
service.success? # => true
service.response # => {:foo=>"bar"}

And an errors object if you added errors during the validate, on: :response validation.

service = YourGemName::SomeResource::CreateService.call(message: 'baz')
service.success? # => false
service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=invalid, options={:message=>"cannot be baz"}>]>
service.errors.full_messages # => ["Message cannot be baz"]
service.response # => {:foo=>"baz"}

Using `.call!`

An ActiveCall::ValidationError exception gets raised when validation fails.

begin
  service = YourGemName::SomeResource::CreateService.call!(message: '')
rescue ActiveCall::ValidationError => exception
  exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=blank, options={}>]>
  exception.errors.full_messages # => ["Message can't be blank"]
end

A response object on a successful call invocation.

service = YourGemName::SomeResource::CreateService.call!(message: ' bar ')
service.success? # => true
service.response # => {:foo=>"bar"}

And an ActiveCall::RequestError exception gets raised if you added errors during the validate, on: :response validation.

begin
  service = YourGemName::SomeResource::CreateService.call!(message: 'baz')
rescue ActiveCall::RequestError => exception
  exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=message, type=invalid, options={:message=>"cannot be baz"}>]>
  exception.errors.full_messages # => ["Message cannot be baz"]
  exception.response # => {:foo=>"baz"}
end

Configuration

If you have secrets, use a configuration block.

class YourGemName::BaseService < ActiveCall::Base
  self.abstract_class = true

  config_accessor :api_key, default: ENV['API_KEY'], instance_writer: false
end

Then in your application code you can overwite the configuration defaults.

YourGemName::BaseService.configure do |config|
  config.api_key = Rails.application.credentials.api_key || ENV['API_KEY']
end

And implement a service object like so.

require 'net/http'

class YourGemName::SomeResource::CreateService < YourGemName::BaseService
  def call
    Net::HTTP.get_response(URI("http://example.com/api?#{URI.encode_www_form(api_key: api_key)}"))
  end
end

Gem Creation

To create your own gem for a service.

gem update --system

Build your gem.

bundle gem your_service --test=rspec --linter=rubocop --ci=github --github-username=<your_profile_name> --git --changelog --mit

Then add Active Call as a dependency in your gemspec.

spec.add_dependency 'active_call'

Now start adding your service objects in the lib directory and make sure they inherit from ActiveCall::Base.

Gems Using Active Call

Zoho Sign

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kobusjoubert/active_call.

License

The gem is available as open source under the terms of the MIT License.

active_call

Runtime