fluere 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Hinze
+
+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,29 @@
+# Fluere
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluere'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluere
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'test'
+end
+
+task :default => :test

data/fluere.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fluere/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluere"
+  spec.version       = Fluere::VERSION
+  spec.authors       = ['Paul Hinze']
+  spec.email         = ['paulh@instructure.com']
+  spec.description   = %q{A an elegant aws-flow adapter}
+  spec.summary       = %q{A wrapper around aws-flow that makes it easier to work with}
+  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_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+
+  spec.add_dependency 'aws-flow'
+end

data/lib/fluere.rb

@@ -0,0 +1,77 @@
+require 'aws/decider'
+
+require 'fluere/activity'
+require 'fluere/config'
+require 'fluere/exceptions'
+require 'fluere/version'
+require 'fluere/worker'
+require 'fluere/workflow'
+
+module Fluere
+  def self.configure(&block)
+    yield Fluere::Config
+  end
+
+  def self.workflows
+    @workflows ||= []
+  end
+
+  def self.swf
+    @swf ||= AWS::SimpleWorkflow.new
+  end
+
+  def self.domain
+    swf.domains[Config.domain]
+  end
+
+  def self.prefixed_task_list(task_list)
+    [Fluere::Config.task_list_prefix, task_list].join
+  end
+
+  def self.start_execution(klass, *args)
+    if stubbed?
+      if perform_executions?
+        method = klass.workflows.first.options.execution_method.to_sym
+        klass.new.send(method, *args)
+      end
+    else
+      klass.workflow_client.start_execution(*args)
+    end
+  end
+
+  def self.flush!
+    domain.workflow_executions.with_status(:open).map { |we| we.terminate }
+  end
+
+  def self.stubbed?
+    @stubbed
+  end
+
+  def self.stub!
+    @stubbed = true
+  end
+
+  def self.unstub!
+    @stubbed = false
+  end
+
+  def self.assert_stubbed
+    raise StubbedPathOnlyError.new unless stubbed?
+  end
+
+  def self.perform_executions?
+    !ignore_executions?
+  end
+
+  def self.ignore_executions?
+    @ignore_executions
+  end
+
+  def self.ignore_executions
+    raise "only allowed to ignore executions when stubbed!" unless stubbed?
+    @ignore_executions = true
+    yield
+  ensure
+    @ignore_executions = false
+  end
+end

data/lib/fluere/activity.rb

@@ -0,0 +1,30 @@
+module Fluere
+  module Activity
+    def self.extended(base)
+      base.extend AWS::Flow::Activities
+      base.extend ClassOverrides
+      base.send(:include, InstanceOverrides)
+    end
+
+    def fluere_worker_klass
+      AWS::Flow::ActivityWorker
+    end
+
+    module ClassOverrides
+      def activity(name, &block)
+        super(name) do
+          block.call.tap do |activity_options|
+            activity_options[:task_list] = Fluere.prefixed_task_list(activity_options[:default_task_list])
+          end
+        end
+      end
+    end
+
+    module InstanceOverrides
+      def send_async(*args)
+        Fluere.assert_stubbed
+        self.send(*args)
+      end
+    end
+  end
+end

data/lib/fluere/config.rb

@@ -0,0 +1,10 @@
+module Fluere
+  class Config
+    class << self
+      attr_accessor :domain
+      attr_accessor :logger
+      attr_accessor :use_forking
+      attr_accessor :task_list_prefix
+    end
+  end
+end

data/lib/fluere/exceptions.rb

@@ -0,0 +1,7 @@
+module Fluere
+  class StubbedPathOnlyError < RuntimeError
+    def initialize
+      super("Fluere must be stubbed when executing this code path.")
+    end
+  end
+end

data/lib/fluere/version.rb

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

data/lib/fluere/worker.rb

@@ -0,0 +1,42 @@
+module Fluere
+  class Worker
+    def self.for(klass)
+      assert_fluere_class(klass)
+      new(klass)
+    end
+
+    def self.assert_fluere_class(klass)
+      unless klass.respond_to? :fluere_worker_klass
+        raise "must pass class extended with Fluere::Worker or Fluere::Activity"
+      end
+    end
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def aws_flow_worker
+      @aws_flow_worker ||= @klass.fluere_worker_klass.new(
+        Fluere.swf.client,
+        Fluere.domain,
+        Fluere.prefixed_task_list(@klass.task_list),
+        @klass,
+      ) {{
+        logger:      Fluere::Config.logger,
+        use_forking: Fluere::Config.use_forking
+      }}
+    end
+
+    def start
+      aws_flow_worker.start
+    end
+
+    def run_once
+      aws_flow_worker.run_once
+    end
+
+    def register
+      aws_flow_worker.register
+    end
+  end
+end

data/lib/fluere/workflow.rb

@@ -0,0 +1,60 @@
+module Fluere
+  module Workflow
+    def self.extended(base)
+      base.extend(AWS::Flow::Workflows)
+      base.extend(ClassOverrides)
+      base.send(:include, InstanceOverrides)
+      Fluere.workflows << base
+    end
+
+    def fluere_worker_klass
+      AWS::Flow::WorkflowWorker
+    end
+
+    def start_execution(*args)
+      workflow_client.start_execution(*args)
+    end
+
+    def workflow_client
+      AWS::Flow.workflow_client(
+        Fluere.swf.client,
+        Fluere.domain
+      ) {{
+        from_class: self.name
+      }}
+    end
+
+    module ClassOverrides
+      def activity_client(name, &block)
+        flow_method = "#{name}_flow".to_sym
+        super(flow_method, &block)
+        define_method(name) do
+          if Fluere.stubbed?
+            klass = self.class.const_get(block.call[:from_class])
+            klass.new
+          else
+            send(flow_method)
+          end
+        end
+      end
+
+      def workflow(name, &block)
+        super(name) do
+          block.call.tap do |workflow_options|
+            workflow_options[:task_list] = Fluere.prefixed_task_list(workflow_options[:task_list])
+          end
+        end
+      end
+    end
+
+    module InstanceOverrides
+      def wait_for_all(*args)
+        if Fluere.stubbed?
+          true # pass
+        else
+          super(*args)
+        end
+      end
+    end
+  end
+end

data/test/fluere/activity_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+describe 'Fluere::Activity' do
+  it 'implies AWS::Flow::Activities' do
+    klass = Class.new
+    klass.extend(Fluere::Activity)
+    extended_modules = (class << klass; self; end).included_modules
+    extended_modules.must_include AWS::Flow::Activities
+  end
+
+  describe 'with a task prefix set' do
+    before { Fluere::Config.task_list_prefix = 'testprefix-' }
+    after  { Fluere::Config.task_list_prefix = nil           }
+
+    it 'prefixes the activity task_list based off the default_task_list' do
+      ActivityWithTaskListPrefix = Class.new
+      ActivityWithTaskListPrefix.extend(Fluere::Activity)
+
+      ActivityWithTaskListPrefix.activity(:test_activity) {{ :default_task_list => 'task_list_name' }}
+
+      test_activity = ActivityWithTaskListPrefix.activities.find { |a| a.name == 'ActivityWithTaskListPrefix.test_activity' }
+      test_activity.options.task_list.must_equal 'testprefix-task_list_name'
+    end
+  end
+end

data/test/fluere/workflow_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+describe 'Fluere::Workflow' do
+  it 'implies AWS::Flow::Workflows' do
+    klass = Class.new
+    klass.extend(Fluere::Workflow)
+    extended_modules = (class << klass; self; end).included_modules
+    extended_modules.must_include AWS::Flow::Workflows
+  end
+
+  describe 'with a task prefix set' do
+    before { Fluere::Config.task_list_prefix = 'testprefix-' }
+    after  { Fluere::Config.task_list_prefix = nil           }
+
+    it 'prefixes the workflow task_list' do
+      WorkflowWithTaskListPrefix = Class.new
+      WorkflowWithTaskListPrefix.extend(Fluere::Workflow)
+
+      WorkflowWithTaskListPrefix.workflow(:test_workflow) {{ :task_list => 'task_list_name' }}
+
+      test_workflow = WorkflowWithTaskListPrefix.workflows.find { |w| w.name == 'WorkflowWithTaskListPrefix.test_workflow' }
+      test_workflow.options.task_list.must_equal 'testprefix-task_list_name'
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+FLUERE_LIB_DIR = File.expand_path('../lib', File.dirname(__FILE__))
+$LOAD_PATH << FLUERE_LIB_DIR
+require 'fluere'
+gem 'minitest'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: fluere
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Hinze
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: aws-flow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A an elegant aws-flow adapter
+email:
+- paulh@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluere.gemspec
+- lib/fluere.rb
+- lib/fluere/activity.rb
+- lib/fluere/config.rb
+- lib/fluere/exceptions.rb
+- lib/fluere/version.rb
+- lib/fluere/worker.rb
+- lib/fluere/workflow.rb
+- test/fluere/activity_test.rb
+- test/fluere/workflow_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3200458554492036828
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3200458554492036828
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A wrapper around aws-flow that makes it easier to work with
+test_files:
+- test/fluere/activity_test.rb
+- test/fluere/workflow_test.rb
+- test/test_helper.rb