Patterns

A collection of reusable Ruby objects for Rails applications.

• Service object module (to be used as a mixin)
• ApiRequest class to wrap HTTP requests (matches interface of Unirest)
• Notifier class (for reporting to bug tracking services, matches interface of Rollbar)

Inspiration

• https://github.com/Selleo/pattern
• https://github.com/Selleo/business_process
• http://multithreaded.stitchfix.com/blog/2015/06/02/anatomy-of-service-objects-in-rails/
• https://medium.com/selleo/essential-rubyonrails-patterns-part-1-service-objects-1af9f9573ca1
• http://unirest.io/ruby.html

Installation

Add this line to your application's Gemfile:

gem "patterns", :git => "https://github.com/davev/patterns.git"

And then execute:

$ bundle

Or install it yourself as:

$ git clone https://github.com/davev/patterns.git
$ cd patterns && gem build patterns.gemspec
$ gem install patterns-0.1.0.gem

Usage

Service Mixin

1. set up a service object class and include the Service mixin. the return value of the call method will be accessible through the result attribute. see source for advanced usage.

  class GreetWorld
    include Patterns::Service

    def initialize(msg)
      @msg = msg
    end

    def call
      return @msg
    end
  end

2. invoke service class (mixin provides nice syntax for invocation)

  res = GreetWorld.call("hello")

3. mixin provides common interface for retrieving result, status, and error.

  res.result
  # => "hello"

  res.success?
  # => true

  res.error
  # => nil

  # if an error occurred while executing service code:
  res.error
  # => "the stack overflowed"

ApiRequest Class

ApiRequest api matches the Unirest interface. see source for advanced usage.

  response = Patterns::ApiRequest.get(
    endpoint_url,
    params: {
      client_id: @client.id
    }
  )

  response.body if response.success?

Notifier Class

Notifier api matches the Rollbar interface. Assumes the pertinent ENV vars are set with credentials for the notifier service being used, e.g. Rollbar.

  begin
    # do stuff
  rescue => e
    Notifier.error(e, e.message, client_id: @client.id)
  end

Development

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

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/davev/patterns. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in the Patterns project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.