Interaction

Provides a convention for modelling user interactions as use case classes. A use case class represents and is named after something a user does with your application SignUp, RequestResetPasswordEmail etc.

Attributes are whitelisted and coerced into an expected type using Virtus. An attribute will either be the specified type or nil.

Take a look at the code itself for full details of the API provided.

A simple example

class SignUp
  include Interaction
  include ActiveModel::Validations
  include Interaction::ValidationHelpers

  # Virtus
  attribute :email, String
  attribute :password, String

  # ActiveModel validations
  validates :email, :password, presence: true

  attr_reader :user

  def perform
    validate!
    create_user
    deliver_welcome_email
  end

  private

  def create_user
    @user = User.create(attributes)
    failure! unless @user.persisted?
  end

  def deliver_welcome_email
    # ...
  end
end

sign_up = SignUp.perform(username: 'john', password: 'j0hn')
sign_up.success?
# => true
sign_up.user
# => #<User id:...>

stevehodgkiss/interaction

Interaction

A simple example