interactor-contracts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4b6a4b9a1473818e3af68c266630d617bf119a6
+  data.tar.gz: 21a9105f05f823a824545aa231669c7215b6af34
+SHA512:
+  metadata.gz: ab017960b801b150397d026f4754eb231e3128c96e7119f1a3764d3bcc3cdf70cf2640ea630558b4433761f15be64c6a3200a3bcf95f36bc8db3f564be5c8082
+  data.tar.gz: 76c7ba6f0390f18ffebac61dfb14863d9f0920255c930dce9a4dbb3e22f498b9690ae115453a2075d3baf14345a1f6881b3b41072520e6778980fc30d7ec795b

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Change Log
+
+All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning 2.0.0][semver]. Any violations of this scheme are considered to be bugs.
+
+[semver]: http://semver.org/spec/v2.0.0.html
+
+## [0.1.0] - 2017-02-25
+
+### Added
+
+* [#2](https://github.com/michaelherold/interactor-contracts/pull/2): Support for dry-validations ~> 0.10 - [@andrewaguiar](https://github.com/andrewaguiar).
+* [#7](https://github.com/michaelherold/interactor-contracts/pull/7): More ergonomic error handling via `BreachSet#to_hash` - [@michaelherold](https://github.com/michaelherold).
+
+### Fixed
+
+* [#5](https://github.com/michaelherold/interactor-contracts/pull/5): Refactored code base to prepare for the release of v0.1.0 - [@michaelherold](https://github.com/michaelherold).
+
+### Miscellaneous
+
+* [#3](https://github.com/michaelherold/interactor-contracts/pull/3): Updated all dependencies to fix build process - [@michaelherold](https://github.com/michaelherold).
+* [#4](https://github.com/michaelherold/interactor-contracts/pull/4): Added Danger as a collaboration tool - [@michaelherold](https://github.com/michaelherold).
+* [#6](https://github.com/michaelherold/interactor-contracts/pull/6): Updated the README - [@michaelherold](https://github.com/michaelherold).
+
+
+[0.1.0]: https://github.com/michaelherold/interactor-contracts/tree/v0.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+In the spirit of [free software], **everyone** is encouraged to help improve this project. Here are some ways *you* can contribute:
+
+* Use alpha, beta, and pre-release versions.
+* Report bugs.
+* Suggest new features.
+* Write or edit documentation.
+* Write specifications.
+* Write code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace).
+* Refactor code.
+* Fix [issues].
+* Review patches.
+
+[free software]: http://www.fsf.org/licensing/essays/free-sw.html
+[issues]: https://github.com/michaelherold/interactor-contracts/issues
+
+## Submitting an Issue
+
+We use the [GitHub issue tracker][issues] to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted.
+
+When submitting a bug report, please include a [Gist] that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system.
+
+Ideally, a bug report should include a pull request with failing specs.
+
+[Gist]: https://gist.github.com
+
+## Submitting a Pull Request
+
+1. [Fork the repository].
+2. [Create a topic branch].
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your specs or any of the linters fail, return to step 5.
+7. Open `coverage/index.html`. If your changes are not completely covered by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec inch`. If your changes are below a B in documentation, go back to step 8.
+10. Commit and push your changes.
+11. [Submit a pull request].
+
+[Create a topic branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[Fork the repository]: http://learn.github.com/p/branching.html
+[Submit a pull request]: https://help.github.com/articles/creating-a-pull-request/
+
+## Tools to Help You Succeed
+
+After checking out the repository, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+When writing code, you can use the helper application [Guard] to automatically run tests and coverage tools whenever you modify and save a file. This helps to eliminate the tedium of running tests manually and reduces the chance that you will accidentally forget to run the tests. To use Guard, run `bundle exec guard`.
+
+Before committing code, run `bundle exec rake` to check that the code conforms to the style guidelines of the project, that all of the tests are green (if you're writing a feature; if you're only submitting a failing test, then it does not have to pass!), and that the changes are sufficiently documented.
+
+[Guard]: http://guardgem.org
+[rubygems]: https://rubygems.org

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Herold
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,179 @@
+# Interactor::Contracts
+
+[![Build Status](https://travis-ci.org/michaelherold/interactor-contracts.svg)][travis]
+[![Code Climate](https://codeclimate.com/github/michaelherold/interactor-contracts/badges/gpa.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/michaelherold/interactor-contracts.svg?branch=master)][inch]
+
+[codeclimate]: https://codeclimate.com/github/michaelherold/interactor-contracts
+[inch]: http://inch-ci.org/github/michaelherold/interactor-contracts
+[travis]: https://travis-ci.org/michaelherold/interactor-contracts
+
+Interactor::Contracts is an extension to the [interactor] gem that gives you
+the ability to specify the expectations (expected inputs) and assurances
+(expected outputs) of your interactors.
+
+[interactor]: https://github.com/collectiveidea/interactor
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interactor-contracts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interactor-contracts
+
+## Usage
+
+Let's extend the sample `AuthenticateUser` from the Interactor examples with a
+contract that specifies its expectations and assurances.
+
+```ruby
+class AuthenticateUser
+  include Interactor
+  include Interactor::Contracts
+
+  expects do
+    required(:email).filled
+    required(:password).filled
+  end
+
+  assures do
+    required(:user).filled
+    required(:token).filled
+  end
+
+  on_breach do |breaches|
+    context.fail!(breaches)
+  end
+
+  def call
+    if user = User.authenticate(context.email, context.password)
+      context.user = user
+      context.token = user.secret_token
+    else
+      context.fail!(:message => "authenticate_user.failure")
+    end
+  end
+end
+```
+
+The `expects` block defines the expectations: the expected attributes of the
+context prior to the interactor running, along with any predicates that further
+constrain the input.
+
+The `assures` block defines the assurances: the expected attributes of the
+context after the interactor runs and successfully completes, along with any
+predicates the further constrain the output.
+
+Because interactors can have transitive dependencies through the use of
+organizers, any other inputs or outputs are ignored from the perspective of
+the contract and are passed along to the outgoing (successful) context.
+
+Both `expects` and `assures` wrap [dry-validation], so you can use any
+predicates defined in it to describe the expected inputs and outputs of your
+interactor.
+
+To hook into a failed expectation or assurance, you can use the `on_breach`
+method to defined a breach handler. It should take a 1-arity block that expects
+an array of `Breach` objects. These objects have a `property` attribute that
+will give you the key that's in breach of its contract. Breaches also have a
+`messages` attribute that gives the reasons that property is in breach.
+
+By default, when an `on_breach` consequence is not specified, the contract will
+`#fail!` the `Interactor::Context` with the keys that are in breach and arrays
+of messages about what the breaches are.
+
+For example, the above interactor acts as follows:
+
+```ruby
+result = AuthenticateUser.call({})
+#=> #<Interactor::Context email=["email is missing"], password=["password is missing"]>
+
+result.failure?  #=> true
+```
+
+[dry-validation]: https://github.com/dryrb/dry-validation
+
+## 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.
+
+When writing code, you can use the helper application [Guard][guard] to
+automatically run tests and coverage tools whenever you modify and save a file.
+This helps to eliminate the tedium of running tests manually and reduces the
+change that you will accidentally forget to run the tests. To use Guard, run
+`bundle exec guard`.
+
+Before committing code, run `rake` to check that the code conforms to the style
+guidelines of the project, that all of the tests are green (if you're writing a
+feature; if you're only submitting a failing test, then it does not have to
+pass!), and that the changes are sufficiently documented.
+
+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 tags, and push the `.gem` file to [rubygems.org][rubygems].
+
+[guard]: http://guardgem.org
+[rubygems]: https://rubygems.org
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/michaelherold/interactor-contracts.
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][travis] the following Ruby
+versions:
+
+* Ruby 2.1
+* Ruby 2.2
+* Ruby 2.3
+* Ruby 2.4
+* JRuby 9.1
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
+
+If you would like this library to support another Ruby version or
+implementation, you may volunteer to be a maintainer. Being a maintainer
+entails making sure all tests run and pass on that implementation. When
+something breaks on your implementation, you will be responsible for providing
+patches in a timely fashion. If critical issues for a particular implementation
+exist at the time of a major release, support for that Ruby version may be
+dropped.
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pessimistic] with two digits of precision. For example:
+
+    spec.add_dependency "interactor-contracts", "~> 0.1"
+
+[pessimistic]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+[semver]: http://semver.org/spec/v2.0.0.html
+
+## License
+
+The gem is available as open source under the terms of the [MIT License][license].
+
+[license]: http://opensource.org/licenses/MIT.

data/interactor-contracts.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+require File.expand_path("../lib/interactor/contracts/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name    = "interactor-contracts"
+  spec.version = Interactor::Contracts::VERSION
+  spec.authors = ["Michael Herold"]
+  spec.email   = ["michael.j.herold@gmail.com"]
+
+  spec.summary     = "Add contacts to your interactors"
+  spec.description = "Add contacts to your interactors"
+  spec.homepage    = "https://github.com/michaelherold/interactor-contracts"
+  spec.license     = "MIT"
+
+  spec.files = %w(CHANGELOG.md CONTRIBUTING.md LICENSE.md README.md)
+  spec.files += %w(interactor-contracts.gemspec)
+  spec.files += Dir["lib/**/*.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-validation", "~> 0.10"
+  spec.add_dependency "interactor", "~> 3"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+end

data/lib/interactor/contracts/breach.rb

@@ -0,0 +1,60 @@
+module Interactor
+  module Contracts
+    # A wrapper for breached contract terms that encapsulates the failed
+    # property and its messages.
+    class Breach
+      # Represents a breach of a contract with its messages
+      #
+      # @example
+      #   Interactor::Contracts::Breach.new(:name, ["name is missing"])
+      #
+      # @api semipublic
+      # @param [Symbol] property the property violated in the contract
+      # @param [Array<String>] messages the messages describing the breach.
+      def initialize(property, messages)
+        @property = property
+        @messages = messages
+      end
+
+      # The messages describing the breach
+      #
+      # @example
+      #   breach = Interactor::Contracts::Breach.new(:name, ["name is missing"])
+      #   breach.messages  #=> ["name is missing"]
+      #
+      # @api public
+      # @return [Array<String>] the messages describing the breach
+      attr_reader :messages
+
+      # The property violated in the contract
+      #
+      # @example
+      #   breach = Interactor::Contracts::Breach.new(:name, ["name is missing"])
+      #   breach.property  #=> :name
+      #
+      # @api public
+      # @return [Symbol] the property violated in the contract
+      attr_reader :property
+
+      # Allows the Breach to be splatted out as arguments to a block
+      #
+      # @api private
+      # @return [Array<Symbol, Array<String>>]
+      def to_ary
+        [property, messages]
+      end
+
+      # Converts the Breach to an equivalent Hash
+      #
+      # @example
+      #   breach = Interactor::Contracts::Breach.new(:name, ["name is missing"])
+      #   breach.to_h  #=> {:name => ["name is missing"]}
+      #
+      # @api public
+      # @return [Hash]
+      def to_h
+        {property => messages}
+      end
+    end
+  end
+end

data/lib/interactor/contracts/breach_set.rb

@@ -0,0 +1,46 @@
+require "delegate"
+
+module Interactor
+  module Contracts
+    # A simple wrapper around set of breaches of contract constraints
+    class BreachSet < SimpleDelegator
+      # Converts the breach set into a Hash for use with context failing
+      #
+      # @example
+      #   class AuthenticateUser
+      #     include Interactor
+      #     include Interactor::Contracts
+      #
+      #     expects do
+      #       required(:email).filled
+      #       required(:password).filled
+      #     end
+      #
+      #     assures do
+      #       required(:user).filled
+      #       required(:token).filled
+      #     end
+      #
+      #     on_breach do |breaches|
+      #       context.fail!(breaches)
+      #     end
+      #   end
+      #
+      #   result = AuthenticateUser.call({})
+      #   #=> #<Interactor::Context email=["email is missing"],
+      #                             password=["password is missing"]>
+      #
+      #   result.failure?  #=> true
+      #
+      # @api public
+      # @return [Hash] a hash with property keys and message values
+      def to_hash
+        reduce({}) do |result, (property, messages)|
+          result[property] = Array(result[property]) | messages
+          result
+        end
+      end
+      alias_method :to_h, :to_hash
+    end
+  end
+end

data/lib/interactor/contracts/contract.rb

@@ -0,0 +1,116 @@
+require "interactor/contracts/terms"
+
+module Interactor
+  module Contracts
+    # Contains the assurances, expectations, and consequences of an
+    # interactor's contract.
+    class Contract
+      # Instantiates a new Contract with the given contraints
+      #
+      # @example
+      #   Interactor::Contracts::Contract.new
+      #
+      # @api semipublic
+      # @param [Terms] assurances the Contract's assurances
+      # @param [Terms] expectations the Contract's expectations
+      # @param [Array<#call>] consequences the Contract's consequences
+      # rubocop:disable Metrics/LineLength
+      def initialize(assurances: Terms.new, expectations: Terms.new, consequences: [])
+        @assurances = assurances
+        @consequences = consequences
+        @expectations = expectations
+      end
+
+      # The assurances the Contract will fulfill
+      #
+      # @example
+      #   contract = Interactor::Contracts::Contract.new
+      #   contract.assurances  #=> <#Interactor::Contracts::Terms>
+      #
+      # @api semipublic
+      # @return [Terms] the terms for the assurances
+      attr_reader :assurances
+
+      # The expectations for arguments passed into the Interactor
+      #
+      # @example
+      #   contract = Interactor::Contracts::Contract.new
+      #   contract.expectations  #=> <#Interactor::Contracts::Terms>
+      #
+      # @api semipublic
+      # @return [Terms] the terms for the expectations
+      attr_reader :expectations
+
+      # Adds an assurance to the Contract's set of assurances
+      #
+      # @example
+      #   contract = Interactor::Contracts::Contract.new
+      #   contract.add_assurance do
+      #     required(:name).filled
+      #   end
+      #
+      # @api semipublic
+      # @param [Block] term the assurance as a block of arity 0
+      # @return [void]
+      def add_assurance(&term)
+        assurances.add(&term)
+      end
+
+      # Adds a consequence to the Contract's set of consequences
+      #
+      # @example
+      #   contract = Interactor::Contracts::Contract.new
+      #   contract.add_expectation do |breaches|
+      #     context[:message] = breaches.first.messages.first
+      #   end
+      #
+      # @api semipublic
+      # @param [#call] consequence the consequence as a callable with arity 1
+      # @return [void]
+      def add_consequence(consequence)
+        @consequences << consequence
+      end
+
+      # Adds an expectation to the Contract's set of expectations
+      #
+      # @example
+      #   contract = Interactor::Contracts::Contract.new
+      #   contract.add_expectation do
+      #     required(:name).filled
+      #   end
+      #
+      # @api semipublic
+      # @param [Block] term the expectation as a block of arity 0
+      # @return [void]
+      def add_expectation(&term)
+        expectations.add(&term)
+      end
+
+      # The consequences for the Contract
+      #
+      # @example
+      #   contract = Interactor::Contracts::Contract.new
+      #   contract.consequences  #=> [<#Proc>]
+      #
+      # @api semipublic
+      # @return [Array<#call>] the consequences for the Contract
+      def consequences
+        if @consequences.empty?
+          Array(default_consequence)
+        else
+          @consequences
+        end
+      end
+
+      private
+
+      # The default consequence of a breached contract
+      #
+      # @api private
+      # @return [#call] the default consequence
+      def default_consequence
+        ->(breaches) { context.fail!(breaches) }
+      end
+    end
+  end
+end

data/lib/interactor/contracts/dsl.rb

@@ -0,0 +1,150 @@
+require "interactor/contracts/contract"
+
+module Interactor
+  module Contracts
+    # Defines the class-level DSL that enables Interactor contracts.
+    module DSL
+      # Defines the assurances of an Interactor and creates an after hook
+      #
+      # @example
+      #   class CreatePerson
+      #     include Interactor
+      #     include Interactor::Contracts
+      #
+      #     assures do
+      #       required(:person).filled
+      #     end
+      #
+      #     def call
+      #       context.person = Person.new
+      #     end
+      #   end
+      #
+      # @api public
+      # @param [Block] block the block defining the assurances
+      # @return [void]
+      def assures(&block)
+        contract.add_assurance(&block)
+        define_assurances_hook
+      end
+
+      # The Contract to enforce on calls to the Interactor
+      #
+      # @example
+      #   class CreatePerson
+      #     include Interactor
+      #     include Interactor::Contracts
+      #
+      #     assures do
+      #       required(:person).filled
+      #     end
+      #
+      #     contracts  #=> <#Interactor::Contracts::Contract>
+      #   end
+      #
+      # @api semipublic
+      # @return [Contract]
+      def contract
+        @contract ||= Contract.new
+      end
+
+      # Defines the expectations of an Interactor and creates a before hook
+      #
+      # @example
+      #   class CreatePerson
+      #     include Interactor
+      #     include Interactor::Contracts
+      #
+      #     expects do
+      #       required(:name).filled
+      #     end
+      #
+      #     def call
+      #       context.person = Person.create!(:name => context.name)
+      #     end
+      #   end
+      #
+      #   CreatePerson.call(:first_name => "Billy").success?  #=> false
+      #   CreatePerson.call(:name => "Billy").success?        #=> true
+      #
+      # @api public
+      # @param [Block] block the block defining the expectations
+      # @return [void]
+      def expects(&block)
+        contract.add_expectation(&block)
+        define_expectations_hook
+      end
+
+      # Defines a consequence that is called when a contract is breached
+      #
+      # @example
+      #   class CreatePerson
+      #     include Interactor
+      #     include Interactor::Contracts
+      #
+      #     expects do
+      #       required(:name).filled
+      #     end
+      #
+      #     on_breach do |breaches|
+      #       context.fail!(:message => "invalid_#{breaches.first.property}")
+      #     end
+      #
+      #     def call
+      #       context.person = Person.create!(:name => context.name)
+      #     end
+      #   end
+      #
+      #   CreatePerson.call(:first_name => "Billy").message  #=> "invalid_name"
+      #
+      # @api public
+      # @param [Block] block the consequence as a block of arity 1.
+      # @return [void]
+      def on_breach(&block)
+        contract.add_consequence(block)
+      end
+
+      private
+
+      # Flags whether the assurances hook has been defined
+      #
+      # @api private
+      # @return [TrueClass, FalseClass] true if the hook is defined
+      attr_reader :defined_assurances_hook
+      alias_method :defined_assurances_hook?, :defined_assurances_hook
+
+      # Flags whether the expectations hook has been defined
+      #
+      # @api private
+      # @return [TrueClass, FalseClass] true if the hook is defined
+      attr_reader :defined_expectations_hook
+      alias_method :defined_expectations_hook?, :defined_expectations_hook
+
+      # Defines an after hook that validates the Interactor's output
+      #
+      # @api private
+      # @raise [Interactor::Failure] if the input fails to meet its contract.
+      # @return [void]
+      def define_assurances_hook
+        return if defined_assurances_hook?
+
+        after { enforce_contracts(contract.assurances) }
+
+        @defined_assurances_hook = true
+      end
+
+      # Defines a before hook that validates the Interactor's input
+      #
+      # @api private
+      # @raise [Interactor::Failure] if the input fails to meet its contract.
+      # @return [void]
+      def define_expectations_hook
+        return if defined_expectations_hook?
+
+        before { enforce_contracts(contract.expectations) }
+
+        @defined_expectations_hook = true
+      end
+    end
+  end
+end

data/lib/interactor/contracts/errors.rb

@@ -0,0 +1,10 @@
+module Interactor
+  module Contracts
+    # Base error class used for all errors within the gem.
+    ContractsError = Class.new(StandardError)
+
+    # Raised when trying to include Interactor::Contracts into a class that is
+    # not an Interactor.
+    NotAnInteractor = Class.new(ContractsError)
+  end
+end

data/lib/interactor/contracts/outcome.rb

@@ -0,0 +1,80 @@
+require "forwardable"
+require "interactor/contracts/breach"
+require "interactor/contracts/breach_set"
+
+module Interactor
+  module Contracts
+    # The outcome of a Terms enforcement.
+    class Outcome
+      extend Forwardable
+
+      # Instantiantes a new Outcome based on the results of a Terms enforcement
+      #
+      # @api private
+      # @param [Dry::Validation::Result] result
+      def initialize(result)
+        @result = result
+      end
+
+      # @!method success?
+      #   Checks whether the the terms enforcement was a success
+      #
+      #   @example
+      #     terms = Interactor::Contract::Terms.new
+      #     terms.add do
+      #       required(:name).filled
+      #     end
+      #
+      #     outcome = terms.call(:name => "Bilbo Baggins")
+      #     outcome.success?  #=> true
+      #
+      #   @api semipublic
+      #   @return [Boolean]
+      def_delegator :@result, :success?
+
+      # The list of breaches of the Terms
+      #
+      # @example
+      #   terms = Interactor::Contract::Terms.new
+      #   terms.add do
+      #     required(:name).filled
+      #   end
+      #
+      #   outcome = terms.call(:name => "Bilbo Baggins")
+      #   outcome.breaches  #=> []
+      #
+      # @api semipublic
+      # @return [Array<Breach>] the breaches of the Terms' constraints
+      def breaches
+        BreachSet.new(result.messages(:full => true).map do |property, messages|
+          Breach.new(property, messages)
+        end)
+      end
+
+      # Checks whether the the Terms enforcement was a failure
+      #
+      # @example
+      #   terms = Interactor::Contract::Terms.new
+      #   terms.add do
+      #     required(:name).filled
+      #   end
+      #
+      #   outcome = terms.call(:name => "Bilbo Baggins")
+      #   outcome.failure?  #=> false.
+      #
+      # @api semipublic
+      # @return [Boolean]
+      def failure?
+        !success?
+      end
+
+      private
+
+      # The result of a Terms enforcement
+      #
+      # @api private
+      # @return [Dry::Validation::Result]
+      attr_reader :result
+    end
+  end
+end

data/lib/interactor/contracts/terms.rb

@@ -0,0 +1,51 @@
+require "dry-validation"
+require "interactor/contracts/outcome"
+
+module Interactor
+  module Contracts
+    # The terms of a contract, either for assurances or expectations
+    class Terms
+      # Instantiates a new set of terms
+      #
+      # @example
+      #   terms = Interactor::Contracts::Terms.new
+      #
+      # @api public
+      # @param [Dry::Validation::Schema] terms the terms to start with
+      def initialize(terms = Class.new(Dry::Validation::Schema))
+        @terms = terms
+      end
+
+      # Add a new set of terms to the list of terms
+      #
+      # @example
+      #   terms = Interactor::Contracts::Terms.new
+      #   terms.add do
+      #     required(:name).filled
+      #   end
+      #
+      # @api public
+      # @param [Block] term the term to add to the terms
+      # @return [void]
+      def add(&term)
+        @terms = Dry::Validation.Schema(@terms, {:build => false}, &term)
+      end
+
+      # Validates the terms against a given context
+      #
+      # @example
+      #   terms = Interactor::Contracts::Terms.new
+      #   terms.add do
+      #     required(:name).filled
+      #   end
+      #   terms.call(:name => "Bilbo Baggins")
+      #
+      # @api public
+      # @param [#to_h] context the context to validate the terms against
+      # @return [Outcome]
+      def call(context)
+        Outcome.new(@terms.new.call(context.to_h))
+      end
+    end
+  end
+end

data/lib/interactor/contracts/version.rb

@@ -0,0 +1,5 @@
+module Interactor
+  module Contracts
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/interactor/contracts.rb

@@ -0,0 +1,47 @@
+require "dry-validation"
+require "interactor"
+require "interactor/contracts/dsl"
+require "interactor/contracts/errors"
+
+module Interactor
+  # Create a contract for your interactor that specifies what it expects as
+  # inputs.
+  module Contracts
+    # Called when the module is included into another class or module
+    #
+    # @api private
+    # @param [Class, Module] descendant the including class or module
+    # @return [void]
+    def self.included(descendant)
+      unless descendant.include?(Interactor)
+        fail NotAnInteractor, "#{descendant} does not include `Interactor'"
+      end
+      descendant.extend(DSL)
+    end
+
+    private
+
+    # The Contract to enforce on calls to the Interactor
+    #
+    # @api private
+    # @return [Contract]
+    def contract
+      self.class.contract
+    end
+
+    # Checks for a breach of contract and applies consequences for a breach
+    #
+    # @api private
+    # @param [#call] contracts a callable object
+    # @return [void]
+    def enforce_contracts(contracts)
+      outcome = contracts.call(context)
+
+      unless outcome.success?
+        contract.consequences.each do |handler|
+          instance_exec(outcome.breaches, &handler)
+        end
+      end
+    end
+  end
+end

data/lib/interactor-contracts.rb

@@ -0,0 +1,2 @@
+# rubocop:disable Style/FileName
+require "interactor/contracts"

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: interactor-contracts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Herold
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: interactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: Add contacts to your interactors
+email:
+- michael.j.herold@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- interactor-contracts.gemspec
+- lib/interactor-contracts.rb
+- lib/interactor/contracts.rb
+- lib/interactor/contracts/breach.rb
+- lib/interactor/contracts/breach_set.rb
+- lib/interactor/contracts/contract.rb
+- lib/interactor/contracts/dsl.rb
+- lib/interactor/contracts/errors.rb
+- lib/interactor/contracts/outcome.rb
+- lib/interactor/contracts/terms.rb
+- lib/interactor/contracts/version.rb
+homepage: https://github.com/michaelherold/interactor-contracts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Add contacts to your interactors
+test_files: []
+has_rdoc: