helpstation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af844a5e1a3e0032fadba5408b8db05619ac7f0d
+  data.tar.gz: 9d068182dd59f310b67b3991cd4f92988872c830
+SHA512:
+  metadata.gz: e90170974a29ea0af256d79060a48855f377a96db297c4d6bc20a4ad070b5776a71c6aa831cd3a56ca1a37d9f15eb502126ed3949b5abcd91e984cfa5a10dd6d
+  data.tar.gz: adeab0cd8b5602b6aae4cc0b668323747523162fc4695b7be1f2c6eead0754ba71dfe77167cdee6da426fbf5b2c1f108e95d45fd4efe1facc75cc820b00e1b3c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+helpstation

data/.ruby-version

@@ -0,0 +1 @@
+2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Indrek Juhkam
+
+MIT License
+
+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,77 @@
+# Helpstation
+
+Helps to unify SaleMove services
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'helpstation'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+TODO: Write proper usage instructions here
+
+Example:
+```ruby
+require 'helpstation'
+
+class PersonFinder < Helpstation::Process
+  def call
+    person = env.db.find_person(input.fetch(:person_id))
+    success(input.merge(person: person))
+  end
+end
+
+class ExportReadinessChecker < Helpstation::Process
+  def call
+    person = input.fetch(:person)
+    if SomeClassThatChecksPersonExportReadiness.check?(person)
+      success(input)
+    else
+      error('not ready')
+    end
+  end
+end
+
+class PersonExporter < Helpstation::Action
+  def call
+    # ... export ...
+    success
+  end
+end
+
+class ExportEmailNotifier < Helpstation::Observer
+  def call
+    mailer.deliver('...') if success?
+  end
+end
+
+substation = Helpstation.build_substation(env)
+substation.register(:export) do
+  process PersonFinder
+  process ExportReadinessChecker
+  call PersonExporter, Substation::Chain::EMPTY, ExportEmailNotifier
+end
+
+response = substation.call(:export, {person_id: 5})
+if response.success?
+  puts 'Everything went fine'
+  do_something_with response.output
+else
+  puts 'Got error'
+end
+
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/helpstation.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'helpstation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'helpstation'
+  spec.version       = Helpstation::VERSION
+  spec.authors       = ['Indrek Juhkam']
+  spec.email         = ['indrek@salemove.com']
+  spec.description   = %q{Helps to unify SaleMove services}
+  spec.summary       = %q{}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'substation', '~> 0.0', '>= 0.0.10'
+end

data/lib/helpstation.rb

@@ -0,0 +1,17 @@
+require 'substation'
+
+require_relative 'helpstation/version'
+require_relative 'helpstation/evaluator'
+require_relative 'helpstation/processor'
+require_relative 'helpstation/action'
+require_relative 'helpstation/observer'
+require_relative 'helpstation/legacy_process'
+
+module Helpstation
+  def self.build_substation(env)
+    Substation::Environment.build(env) do
+      register :process, Substation::Processor::Evaluator::Request
+      register :call, Substation::Processor::Evaluator::Pivot
+    end
+  end
+end

data/lib/helpstation/action.rb

@@ -0,0 +1,7 @@
+module Helpstation
+  class Action < Evaluator
+    def success(data)
+      @request.success({success: true}.merge(data))
+    end
+  end
+end

data/lib/helpstation/evaluator.rb

@@ -0,0 +1,36 @@
+module Helpstation
+  class Evaluator
+    include AbstractType
+
+    # Perform the usecase
+    #
+    # @param [Substation::Request] request
+    #   the request passed to the registered action
+    #
+    # @return [Substation::Response]
+    #   the response returned when calling the action
+    #
+    # @api private
+    def self.call(request)
+      new(request).call
+    end
+
+    def initialize(request)
+      @request = request
+      @env     = request.env
+      @input   = request.input
+    end
+
+    abstract_method :call
+
+    private
+
+    attr_reader :request
+    attr_reader :env
+    attr_reader :input
+
+    def error(data)
+      @request.error(success: false, error: data)
+    end
+  end
+end

data/lib/helpstation/legacy_process.rb

@@ -0,0 +1,8 @@
+module Helpstation
+  class LegacyProcess
+    def self.call(request)
+      result = process(request.env, request.input)
+      result[:success] ? request.success(result) : request.error(result)
+    end
+  end
+end

data/lib/helpstation/observer.rb

@@ -0,0 +1,35 @@
+module Helpstation
+  class Observer
+    include AbstractType
+
+    # Perform the observer
+    #
+    # @param [Substation::Response]
+    #   the response returned when calling the action
+    #
+    # @api private
+    def self.call(response)
+      new(response).call
+    end
+
+    def initialize(response)
+      @response = response
+      @env      = response.env
+      @input    = response.input
+      @output   = response.output
+      @request  = response.request
+    end
+
+    abstract_method :call
+
+    private
+
+    attr_reader :env
+    attr_reader :input
+    attr_reader :output
+
+    def success?
+      @response.success?
+    end
+  end
+end

data/lib/helpstation/processor.rb

@@ -0,0 +1,7 @@
+module Helpstation
+  class Processor < Evaluator
+    def success(data)
+      @request.success(data)
+    end
+  end
+end

data/lib/helpstation/version.rb

@@ -0,0 +1,3 @@
+module Helpstation
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: helpstation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Indrek Juhkam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: substation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+description: Helps to unify SaleMove services
+email:
+- indrek@salemove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- helpstation.gemspec
+- lib/helpstation.rb
+- lib/helpstation/action.rb
+- lib/helpstation/evaluator.rb
+- lib/helpstation/legacy_process.rb
+- lib/helpstation/observer.rb
+- lib/helpstation/processor.rb
+- lib/helpstation/version.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []