wisper_interactor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a60a0ad078fc3f8f258b3c2a483093db2d74220
+  data.tar.gz: fd5dc44eb7f936c7eda789098a89c980c0a39de1
+SHA512:
+  metadata.gz: 490c9908be91ec557671fc5d65e411003d89b2450f07432035e95b1dd58ef11290e8df2e62383513af7ac566cdb0ecd51f13f96442c15246118621c48fd249d2
+  data.tar.gz: 6aed3834b14c5c07ffb4d9bf7493717d116cc7a733a59c5f891538cc2633d564c87fc39ccfd19096a3d0c7d41deae6d313ad111476e0535a5f0f33e83b05b69a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wisper_interactor.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matthew Solt
+
+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,122 @@
+# WisperInteractor
+
+[![Gem Version](https://img.shields.io/gem/v/wisper_interactor.svg?style=flat)](https://rubygems.org/gems/wisper_interactor)
+[![Build Status](https://secure.travis-ci.org/activefx/wisper_interactor.png)](http://travis-ci.org/activefx/wisper_interactor)
+[![Code Climate](https://codeclimate.com/github/activefx/wisper_interactor/badges/gpa.svg)](https://codeclimate.com/github/activefx/wisper_interactor)
+[![Dependency Status](https://gemnasium.com/activefx/wisper_interactor.png)](https://gemnasium.com/activefx/wisper_interactor)
+[![Test Coverage](https://codeclimate.com/github/activefx/wisper_interactor/badges/coverage.svg)](https://codeclimate.com/github/activefx/wisper_interactor)
+
+WisperInteractor extends [Interactor](https://github.com/collectiveidea/interactor) with PubSub capabilities using [Wisper](https://github.com/krisleech/wisper). Instead of including the Interactor module, your interactor classes should inherit from WisperInteractor::Base. All Interactor methods are available such as the before, after, and around hooks, the rollback method, and the interactor class is still intialized or called with the context options. 
+
+As an interactor is designed to encapsulate your application's business logic and keep it out of your controllers, it makes sense to combine that functionality with Wisper's PubSub capabilities, further decoupling business logic from application code and external concerns. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wisper_interactor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wisper_interactor
+
+## Usage
+
+````ruby 
+class NewsletterSignup < WisperInteractor::Base 
+
+  # Subscribe a class that listens to Wisper events. For example, 
+  # if your NewletterSignup interactor is going to publish a 
+  # :signup_successful event, your AddMailchimpSubscriber listener
+  # should have a #signup_successful and possibly also a #signup_failed
+  # method to handle to the corresponding events. See the Wisper 
+  # documentation for futher information.  
+  # 
+  # .subscribe can be called multiple times in a WisperInteractor, and
+  # can also accept options that are passed to the Wisper publisher. 
+  # 
+  subscribe AddMailchimpSubscriber
+  subscribe NewsletterAnalyticsService, async: true
+
+  # Runs after all other Interactor hooks when the interactor executes 
+  # successfully. It is recommended that you broadcast a success 
+  # message here that Wisper listeners can subscribe to in the future.
+  # 
+  on_success do
+    broadcast(:newsletter_signup_succeeded, context.params)
+  end
+
+  # Runs in the event of any failure of the interactor. Keep in mind that
+  # the interactor before hook, as well as the first portion of an 
+  # around hook will have run in the event of a failure. It is recommended
+  # that you broadcast a failure message here that Wisper listeners can 
+  # subscribe to in the future.
+  # 
+  on_failure do
+    broadcast(:newsletter_signup_failed, context.params)
+  end
+
+  # This is where you should place the core business logic of your 
+  # interactor. This is evaulated in the context of the instance, 
+  # and will have access to any instance methods you have defined 
+  # as well as the interactor context method. You should use this
+  # for your logic instead of #call as specified in the Interactor
+  # documentation. 
+  # 
+  # If this block executes successfully, the on_success callback is
+  # called, and if it fails or raises an error, the on_failure 
+  # callback is executed. 
+  # 
+  perform do
+    if form.validate(context.params)
+      form.save
+    else
+      context.fail!(message: "Failed to create model.")
+    end
+  end
+
+  # Example instance method
+  # 
+  def form
+    context.form ||= NewsletterSignupForm.new
+  end
+
+  # As interactors can be chained together using an Interactor::Organizer, 
+  # you may for example want to include logic to unsubscribe a user from 
+  # your newsletter should a future interactor fail. This is of course 
+  # completely optional. 
+  # 
+  def rollback
+    # logic for undoing interactor action 
+  end
+end
+
+# Example execution of the NewsletterSignup interactor
+# 
+NewsletterSignup.call(params: { email: 'info@example.com'})
+````
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/wisper_interactor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wisper_interactor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wisper_interactor.rb

@@ -0,0 +1,5 @@
+require "wisper_interactor/version"
+require "wisper_interactor/base"
+
+module WisperInteractor
+end

data/lib/wisper_interactor/base.rb

@@ -0,0 +1,93 @@
+require 'interactor'
+require 'wisper'
+
+module WisperInteractor
+  class Base
+    include Interactor
+    include Wisper::Publisher
+
+    def self.on_success(&blk)
+      self.on_success_callback = blk
+    end
+
+    def self.on_failure(&blk)
+      self.on_failure_callback = blk
+    end
+
+    def self.perform(&blk)
+      self.instructions = blk
+    end
+
+    def self.on_success_callback=(value)
+      @on_success_callback = value
+    end
+
+    def self.on_success_callback
+      @on_success_callback
+    end
+
+    def self.on_failure_callback=(value)
+      @on_failure_callback = value
+    end
+
+    def self.on_failure_callback
+      @on_failure_callback
+    end
+
+    def self.instructions=(value)
+      @instructions = value
+    end
+
+    def self.instructions
+      @instructions
+    end
+
+    def self.subscribers
+      @subscribers ||= []
+    end
+
+    def self.subscribe(subscriber, **options)
+      self.subscribers << [ subscriber, options ]
+    end
+
+    # Override Interactor#run!
+    #
+    def run!
+      subscribe_listeners
+      perform_instructions
+    end
+
+    def call
+      execute :instructions
+    end
+
+    private
+
+    def subscribe_listeners
+      self.class.subscribers.each do |subscriber|
+        self.subscribe(*subscriber)
+      end
+    end
+
+    def perform_instructions
+      begin
+        with_hooks do
+          call
+          context.called!(self)
+        end
+        execute :on_success_callback
+      rescue
+        execute :on_failure_callback
+        context.rollback!
+        raise
+      end
+    end
+
+    def execute(key)
+      if blk = self.class.send(key)
+        instance_exec &blk
+      end
+    end
+
+  end
+end

data/lib/wisper_interactor/version.rb

@@ -0,0 +1,3 @@
+module WisperInteractor
+  VERSION = '0.1.0'
+end

data/wisper_interactor.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper_interactor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wisper_interactor"
+  spec.version       = WisperInteractor::VERSION
+  spec.authors       = ["Matt Solt"]
+  spec.email         = ["mattsolt@gmail.com"]
+
+  spec.summary       = %q{Extend Interactor (https://github.com/collectiveidea/interactor) with PubSub capabilities using Wisper (https://github.com/krisleech/wisper).}
+  spec.description   = %q{Extend Interactor (https://github.com/collectiveidea/interactor) with PubSub capabilities using Wisper (https://github.com/krisleech/wisper).}
+  spec.homepage      = "https://github.com/activefx/wisper_interactor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "wisper-rspec"
+
+  spec.add_dependency "wisper", "~> 1.0", "< 2"
+  spec.add_dependency "interactor", "~> 3.0", "< 4"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: wisper_interactor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Solt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wisper-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: interactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Extend Interactor (https://github.com/collectiveidea/interactor) with
+  PubSub capabilities using Wisper (https://github.com/krisleech/wisper).
+email:
+- mattsolt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wisper_interactor.rb
+- lib/wisper_interactor/base.rb
+- lib/wisper_interactor/version.rb
+- wisper_interactor.gemspec
+homepage: https://github.com/activefx/wisper_interactor
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Extend Interactor (https://github.com/collectiveidea/interactor) with PubSub
+  capabilities using Wisper (https://github.com/krisleech/wisper).
+test_files: []