slayer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 731adbde67b9dfe482a51fb05b76e3f77cd0f615
+  data.tar.gz: 1e482c6f28b9d9173252cdce74f18995ca77f0b3
+SHA512:
+  metadata.gz: eb418185d91671b33a0433cd19c63e42e2d0dcb828b47cfbf0a477855d59ebda1a645c5b23eec0adb29cac1429fdb9f7185097295b3df01a2ef375303a77b2ed
+  data.tar.gz: 0e823344bfcb291cbee00d09a96c5fb5023868ea5166ddd46a13214f968dff6d178e6e276f308baaa1617fda79ff96fc3d88b5a820ec944bea2609472f8b4c9a

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log*/*

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Wyatt Kirby
+
+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,87 @@
+![Slayer](https://raw.githubusercontent.com/apsislabs/slayer/master/slayer_logo.png)
+
+# Slayer: A Service Layer
+
+Slayer is intended to operate as a minimal service layer for your ruby application. To achieve this, Slayer provides base classes for writing small, composable services, which should behave as [pure functions](https://en.wikipedia.org/wiki/Pure_function).
+
+Slayer Services should implement `call`, which will `pass` or `fail` the service based on input. Services return a `Slayer::Result` which has a predictable interface for determining `success?` or `failure?`, a `message`, and a `result`.
+
+Services are composed by Composers, which describe the order and arguments for running a number of Services in sequence. If any of these Services fail, those run before it are rolled back by calling `rollback` on the service, passing the service its `result` object, and the original parameters.
+
+Composers also return a `Slayer::Result` object, which has as its `result` parameter a hash of the result objects from its composed services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slayer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slayer
+
+## Usage
+
+```ruby
+# A service that passes when given the string "foo"
+# and fails if given anything else.
+class FooService < Slayer::Service
+    def call(foo:)
+      if foo == "foo"
+        pass! result: foo, message: "Passing FooService"
+      else
+        fail! result: foo, message: "Failing FooService"
+      end
+    end
+end
+
+# A placeholder service that always passes with returned result
+# as the argument passed into it.
+class BarService < Slayer::Service
+    def call(bar:)
+        pass! result: bar, message: "Passing BarService"
+    end
+end
+
+# A simple composer which composes the FooService and BarService
+class FooBarComposer < Slayer::Composer
+    compose FooService, BarService
+
+    def call
+        pass! result: @results,  message: "Yay!"
+    end
+
+    def foo_service_args
+        return { foo: @composer_params[:foo] }
+    end
+
+    def bar_service_args
+        return { bar: foo_service_results.message }
+    end
+end
+
+
+result = FooBarComposer.call(foo: "Jim", bar: "Joe")
+result.success? # => true
+```
+
+## 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.
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/apsislabs/slayer.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slayer"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/slayer/composer.rb

@@ -0,0 +1,80 @@
+module Slayer
+    class Composer < Service
+        attr_accessor :called
+        attr_accessor :results
+        attr_accessor :called_services
+        attr_accessor :composer_params
+
+        class << self
+            def compose(*services)
+                @services = services.flatten
+            end
+
+            def services
+                @services ||= []
+            end
+        end
+
+        # Locate Results from Magic Methods
+        def method_missing(method_sym, *arguments, &block)
+            if method_sym.to_s =~ /^(.*)_results$/
+                results = @results[$1.to_sym]
+                return results unless results.nil?
+            end
+
+            super
+        end
+
+        def run!(**args, &block)
+            @composer_params = args
+            @called_services = []
+            @results = {}
+
+            # Attempt to run each Service, if any fail,
+            # call rollback on all those already run in
+            # reverse order.
+            begin
+                self.class.services.each do |service|
+                    service_sym  = service_to_sym(service)
+                    service_args = service_to_args(service)
+
+                    # Run the service then add it to called_services
+                    @results[service_sym] = service.new.run!(service_args)
+                    @called_services << service
+                end
+            rescue ServiceFailure
+                @called_services.reverse_each do |service|
+                    service_args   = service_to_args(service)
+                    service_result = service_results(service)
+
+                    # Pass the original args and result object
+                    service.rollback(service_args, service_result)
+                end
+
+                raise
+            end
+
+            call
+            @called = true
+        end
+
+        private
+
+            # Convert a Service to an underscored symbol
+            def service_to_sym(service)
+                service.name.underscore.to_sym
+            end
+
+            # Convert a Service to a call to an args method
+            def service_to_args(service)
+                service_sym = service_to_sym(service)
+                self.method("#{service_sym}_args").call
+            end
+
+            # Convert a Service to its result object
+            def service_results(service)
+                service_sym = service_to_sym(service)
+                return @results[service_sym]
+            end
+    end
+end

data/lib/slayer/errors.rb

@@ -0,0 +1,21 @@
+module Slayer
+    class ServiceFailure < StandardError
+        attr_reader :result
+
+        def initialize(result)
+            @result = result
+            super
+        end
+    end
+
+    class ServiceNotImplemented < StandardError
+        def initialize(message = nil)
+            message ||= %q(
+                Service implementation must call `fail!` or `pass!`,
+                or return a <Slayer::Result> object
+            )
+
+            super message
+        end
+    end
+end

data/lib/slayer/result.rb

@@ -0,0 +1,23 @@
+module Slayer
+    class Result
+        attr_reader :result, :message
+
+        def initialize(result, message)
+            @result = result
+            @message = message
+        end
+
+        def success?
+            !failure?
+        end
+
+        def failure?
+            @failure || false
+        end
+
+        def fail!
+            @failure = true
+            raise ServiceFailure, self
+        end
+    end
+end

data/lib/slayer/service.rb

@@ -0,0 +1,52 @@
+module Slayer
+    class Service
+        attr_accessor :result
+
+        # Internal: Service Class Methods
+        class << self
+            def call(*args, &block)
+                # Run the Service and capture the result
+                result = new.tap { |s|
+                    s.run(*args, &block)
+                }.result
+
+                # Throw an exception if we don't return a result
+                raise ServiceNotImplemented unless result.is_a? Result
+                return result
+            end
+        end
+
+        # Run the Service, rescue from Failures
+        def run(*args, &block)
+            begin
+                run!(*args, &block)
+            rescue ServiceFailure
+            end
+        end
+
+        # Run the Service
+        def run!(*args, &block)
+            call(*args, &block)
+        end
+
+        # Fail the Service
+        def fail! result:, message:
+            @result = Result.new(result, message)
+            @result.fail!
+        end
+
+        # Pass the Service
+        def pass! result:, message:
+            @result = Result.new(result, message)
+        end
+
+        # Call the service
+        def call
+            raise NotImplementedError, "Services must define method `#call`."
+        end
+
+        # Do nothing
+        def rollback
+        end
+    end
+end

data/lib/slayer/string_ext.rb

@@ -0,0 +1,11 @@
+class String
+  def underscore
+    word = self.dup
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+end

data/lib/slayer/version.rb

@@ -0,0 +1,3 @@
+module Slayer
+  VERSION = "0.1.0"
+end

data/lib/slayer.rb

@@ -0,0 +1,6 @@
+require "slayer/version"
+require "slayer/string_ext"
+require "slayer/errors"
+require "slayer/result"
+require "slayer/service"
+require "slayer/composer"

data/slayer.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slayer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slayer"
+  spec.version       = Slayer::VERSION
+  spec.authors       = ["Wyatt Kirby"]
+  spec.email         = ["kirby.wa@gmail.com"]
+
+  spec.summary       = %q{A service layer}
+  spec.homepage      = "http://www.apsis.io"
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: slayer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wyatt Kirby
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- kirby.wa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slayer.rb
+- lib/slayer/composer.rb
+- lib/slayer/errors.rb
+- lib/slayer/result.rb
+- lib/slayer/service.rb
+- lib/slayer/string_ext.rb
+- lib/slayer/version.rb
+- slayer.gemspec
+- slayer_logo.png
+homepage: http://www.apsis.io
+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.8
+signing_key: 
+specification_version: 4
+summary: A service layer
+test_files: []