jflow 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8525329c288e5a0027699c40ad1539367224ec2
-  data.tar.gz: 3545904aeda9e29048224b2983e55a805fbaec39
+  metadata.gz: 1c19f0cda04bce68e814c8a80b8c1e12373cfd5d
+  data.tar.gz: 3e5d33715df6f02f4b5dd89d1a80f9723df53c2c
 SHA512:
-  metadata.gz: cdae9e071195443da31a403513674b2cf69378d4b59afde71f5f22d113ed99f9aa9a764d067ebc78a54dd5e5bc7828e4d29a2f8c31d94f091bf54c7c28fac57c
-  data.tar.gz: 0b9d85ff36b13e3bd6bee7568b8a622927ae5b9d0cb87b41e25b956215835a98c11f686051e4fe6650fa1fbf7c503009eeffee701367724bad2d93e6438c2d98
+  metadata.gz: 79c03d1f96f1b1f6993ae9b6aaa0a58de9c9933dcf6e98fda164a54d1e5397c5ebf1421218a4e1d97a833005f6639b63f1ab4a39f09c6cde58d07cfd84d170b2
+  data.tar.gz: 7f4ac32fdce779941b00b9a3ec316d2638b026109d98ef65287a517f13cae4ef9e0b8fe3043f0086a844693131f997b2feedf525cb6c4b52df8d49028d5b051a

data/.travis.yml

@@ -1,4 +1,3 @@
 language: ruby
 rvm:
-  - 1.9.3
-before_install: gem install bundler -v 1.10.6
+  - jruby-9.0.4.0

data/README.md

@@ -1,5 +1,7 @@
 # Jflow
 
+[![Build Status](https://travis-ci.org/djpate/jflow.svg?branch=master)](https://travis-ci.org/djpate/jflow)
+
 JFlow is a gem that aims to let you start SWF flow activity workers for JRuby.
 
 The official framework uses Forking and thus not compatible with the JVM. This aims to give an alternative for Jruby.
@@ -28,7 +30,7 @@ Or install it yourself as:
 
 ```ruby
 Class FooActivity
-  include JFlow::ActivityMixin
+  include JFlow::Activity::Mixin
 
   activity "policy_scan.run" do
     {
@@ -76,5 +78,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jflow.
+Bug reports and pull requests are welcome on GitHub at https://github.com/djpate/jflow.
 

data/bin/jflow_worker

@@ -22,6 +22,7 @@ raise "configuration is invalid! #{validator.errors}" unless validator.valid?
 
 JFlow.configure do |c|
   c.load_paths = configuration["activities_path"]
+  c.swf_client = Aws::SWF::Client.new
 end
 
 JFlow.load_activities
@@ -32,7 +33,7 @@ configuration["number_of_workers"].times do |i|
   threads << Thread.new do
     domain   = configuration["domain"]
     tasklist = configuration["tasklist"]
-    JFlow::ActivityWorker.new(domain, tasklist)
+    JFlow::Activity::Worker.new(domain, tasklist)
                          .start!
   end
 end

data/jflow.gemspec

@@ -26,11 +26,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "slop", "~> 4"
+
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "hash_validator"
+  spec.add_development_dependency "aws-sdk", "~> 2"
 
-  spec.add_dependency "aws-sdk", "~> 2"
-  spec.add_dependency "hash_validator"
-  spec.add_dependency "slop", "~> 4"
 end

data/lib/jflow.rb

@@ -1,12 +1,15 @@
-require "jflow/version"
-require "jflow/activity.rb"
-require "jflow/activity_mixin.rb"
-require "jflow/activity_worker.rb"
-require "jflow/configuration.rb"
 require "yaml"
 require "json"
 require "hash_validator"
 require 'aws-sdk'
+require 'logger'
+require "jflow/version"
+require "jflow/configuration.rb"
+require "jflow/activity/definition.rb"
+require "jflow/activity/mixin.rb"
+require "jflow/activity/task.rb"
+require "jflow/activity/map.rb"
+require "jflow/activity/worker.rb"
 
 module JFlow
   class << self
@@ -17,10 +20,6 @@ module JFlow
     @configuration ||= Configuration.new
   end
 
-  def self.reset
-    @configuration = Configuration.new
-  end
-
   def self.configure
     yield(configuration)
   end

data/lib/jflow/activity/definition.rb

@@ -0,0 +1,83 @@
+module JFlow
+  module Activity
+    class Definition
+
+      DEFAULT_OPTIONS = {}
+
+      OPTIONS_VALIDATOR = {
+        :version => "string",
+        :domain  => "string",
+        :name    => "string",
+        :default_task_list => {
+          :name => "string"
+        }
+      }
+
+      attr_reader :options, :klass
+
+      # Possible options are :
+      # domain: "DomainName", # required
+      # name: "Name", # required
+      # version: "Version", # required
+      # description: "Description",
+      # default_task_start_to_close_timeout: "DurationInSecondsOptional",
+      # default_task_heartbeat_timeout: "DurationInSecondsOptional",
+      # default_task_list: {
+      #   name: "Name", # required
+      # },
+      # default_task_priority: "TaskPriority",
+      # default_task_schedule_to_start_timeout: "DurationInSecondsOptional",
+      # default_task_schedule_to_close_timeout: "DurationInSecondsOptional",
+      def initialize(klass, options = {})
+        @klass = klass
+        @options = DEFAULT_OPTIONS.merge(options)
+        @options[:name] = name
+        validate_activity!
+        register_activity unless registered?
+        add_to_activity_mapping
+      end
+
+      def register_activity
+        JFlow.configuration.swf_client.register_activity_type(options)
+        JFlow.configuration.logger.info "Activity #{name} was registered successfuly"
+      end
+
+      def add_to_activity_mapping
+        JFlow.configuration.activity_map.add_activity(name, options[:version], klass, options)
+      end
+
+      def name
+        @options[:name] || klass.name.to_s.split('::').last.scan(/[A-Z][a-z]*/).join("_").downcase
+      end
+
+      def version
+        @options[:version]
+      end
+
+      def registered?
+        response = JFlow.configuration.swf_client.list_activity_types({
+          domain: options[:domain],
+          name: name,
+          registration_status: "REGISTERED"
+        })
+
+        response.type_infos.each do |type_info|
+          if type_info.activity_type.name == name && type_info.activity_type.version == version
+            JFlow.configuration.logger.info "Activity #{name} #{version} is already registered"
+            return true
+          end
+        end
+
+        return false
+      end
+
+      private
+
+      def validate_activity!
+        validator = HashValidator.validate(@options, OPTIONS_VALIDATOR)
+        raise "Activity #{options[:name]}definition is invalid! #{validator.errors}" unless validator.valid?
+      end
+
+    end
+  end
+end

data/lib/jflow/activity/map.rb

@@ -0,0 +1,21 @@
+module JFlow
+  module Activity
+    class Map
+      def initialize
+        @map = {}
+      end
+
+      def add_activity(name, version, klass, options)
+        @map ||= {}
+        @map[name] ||= {}
+        @map[name][version] = {:class => klass, :options => options}
+      end
+
+      def klass_for(name, version)
+        return nil if !@map.has_key?(name) || !@map[name][version]
+        @map[name][version][:class]
+      end
+
+    end
+  end
+end

data/lib/jflow/activity/mixin.rb

@@ -0,0 +1,20 @@
+module JFlow
+  module Activity
+    module Mixin
+
+      def self.included base
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def activity(name = nil)
+          options = {}
+          options = yield if block_given?
+          options[:name] = name
+          JFlow.configuration.logger.debug "loading #{name}"
+          JFlow::Activity::Definition.new(self, options)
+        end
+      end
+    end
+  end
+end

data/lib/jflow/activity/task.rb

@@ -0,0 +1,77 @@
+module JFlow
+  module Activity
+    class Task
+
+      attr_reader :task
+
+      def initialize(task)
+        @task = task
+      end
+
+      def input
+        YAML.load(task.input)
+      end
+
+
+      def name
+        task.activity_type.name
+      end
+
+      def version
+        task.activity_type.version
+      end
+
+      def token
+        task.token
+      end
+
+      def klass
+        @klass_value ||= JFlow.configuration.activity_map.klass_for(name,version)
+        raise "Could not find code to run for given activity" unless @klass_value
+        @klass_value
+      end
+
+      def method
+        if name.split('.').size > 1
+          method = name.split('.').last
+        else
+          method = "process"
+        end
+      end
+
+      def run!
+        log "Started #{klass}##{method} with #{input}"
+        result = klass.new.send(method, input) || "done"
+        log "Result is #{result.class} #{result}"
+        completed!(result)
+      end
+
+      def completed!(result)
+        swf_client.respond_activity_task_completed({
+          task_token: token,
+          result: result,
+        })
+      end
+
+
+      def failed!(exception)
+        swf_client.respond_activity_task_failed({
+          task_token: token,
+          reason: exception.message,
+          details: exception.backtrace.join("\n"),
+        })
+      end
+
+      private
+
+      def swf_client
+        JFlow.configuration
+             .swf_client
+      end
+
+      def log(str)
+        JFlow.configuration.logger.info "[#{Thread.current.object_id}] #{str}"
+      end
+    end
+  end
+end

data/lib/jflow/activity/worker.rb

@@ -0,0 +1,60 @@
+module JFlow
+  module Activity
+    class Worker
+
+      attr_reader :domain, :tasklist
+
+      def initialize(domain, tasklist)
+        @domain = domain
+        @tasklist = tasklist
+      end
+
+      def start!
+        loop do
+          log "Polling for task on #{domain} - #{tasklist}"
+          poll
+        end
+      end
+
+      private
+
+      def poll
+        response = JFlow.configuration.swf_client.poll_for_activity_task(poll_params)
+        if response.task_token
+          process_task(response)
+        else
+          log "Got no task"
+        end
+      end
+
+      def process_task(response)
+        log "Got task #{response.task_token}"
+        task = ActivityTask.new(response)
+        begin
+          task.run!
+        rescue => exception
+          task.failed!(e)
+        end
+      end
+
+      def identity
+        @identity ||= "#{`hostname`.chomp}-#{Thread.current.object_id}"
+      end
+
+      def log(str)
+        JFlow.configuration.logger.info "[#{Thread.current.object_id}] #{str}"
+      end
+
+      def poll_params
+        {
+          domain: domain,
+          task_list: {
+            name: tasklist,
+          },
+          identity: identity,
+        }
+      end
+
+    end
+  end
+end

data/lib/jflow/configuration.rb

@@ -1,12 +1,13 @@
 module JFlow
   class Configuration
 
-    attr_accessor :swf_client, :load_paths, :logger
+    attr_accessor :swf_client, :load_paths, :logger, :activity_map
 
     def initialize
-      @swf_client = Aws::SWF::Client.new
-      @load_paths = []
-      @logger     = Logger.new(STDOUT)
+      @swf_client    = nil
+      @load_paths    = []
+      @logger        = Logger.new(STDOUT)
+      @activity_map  = JFlow::Activity::Map.new
     end
   end
 end

data/lib/jflow/version.rb

@@ -1,3 +1,3 @@
 module JFlow
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jflow
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Christophe Verbinnen
@@ -10,16 +10,30 @@ bindir: bin
 cert_chain: []
 date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: bundler
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   prerelease: false
@@ -28,12 +42,12 @@ dependencies:
   name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   prerelease: false
@@ -42,58 +56,58 @@ dependencies:
   name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: simplecov
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   prerelease: false
-  type: :runtime
+  type: :development
 - !ruby/object:Gem::Dependency
   name: hash_validator
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   prerelease: false
-  type: :runtime
+  type: :development
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: aws-sdk
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '2'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '2'
   prerelease: false
-  type: :runtime
+  type: :development
 description: you know, for flow
 email:
 - christophe.verbinnen@lookout.com
@@ -104,9 +118,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -115,9 +129,11 @@ files:
 - bin/setup
 - jflow.gemspec
 - lib/jflow.rb
-- lib/jflow/activity.rb
-- lib/jflow/activity_mixin.rb
-- lib/jflow/activity_worker.rb
+- lib/jflow/activity/definition.rb
+- lib/jflow/activity/map.rb
+- lib/jflow/activity/mixin.rb
+- lib/jflow/activity/task.rb
+- lib/jflow/activity/worker.rb
 - lib/jflow/configuration.rb
 - lib/jflow/version.rb
 homepage: https://github.com/djpate/jflow
@@ -130,17 +146,17 @@ 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
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: SWF Flow framework for jRuby

data/lib/jflow/activity.rb

@@ -1,81 +0,0 @@
-module JFlow
-  class Activity
-
-    DEFAULT_OPTIONS = {}
-
-    OPTIONS_VALIDATOR = {
-      :version => "string",
-      :domain  => "string",
-      :name    => "string",
-      :default_task_list => {
-        :name => "string"
-      }
-    }
-
-    attr_reader :options, :klass
-
-    # Possible options are :
-    # domain: "DomainName", # required
-    # name: "Name", # required
-    # version: "Version", # required
-    # description: "Description",
-    # default_task_start_to_close_timeout: "DurationInSecondsOptional",
-    # default_task_heartbeat_timeout: "DurationInSecondsOptional",
-    # default_task_list: {
-    #   name: "Name", # required
-    # },
-    # default_task_priority: "TaskPriority",
-    # default_task_schedule_to_start_timeout: "DurationInSecondsOptional",
-    # default_task_schedule_to_close_timeout: "DurationInSecondsOptional",
-    def initialize(klass, options = {})
-      @klass = klass
-      @options = DEFAULT_OPTIONS.merge(options)
-      @options[:name] = name
-      validate_activity!
-      register_activity unless registered?
-      add_to_activity_mapping
-    end
-
-    def register_activity
-      JFlow.configuration.swf_client.register_activity_type(options)
-      JFlow.configuration.logger.info "Activity #{name} was registered successfuly"
-    end
-
-    def add_to_activity_mapping
-      $activity_map ||= {}
-      $activity_map[name] ||= {}
-      $activity_map[name][options[:version]] = {:class => klass, :options => options}
-    end
-
-    def name
-      @options[:name] || klass.name.to_s.split('::').last.scan(/[A-Z][a-z]*/).join("_").downcase
-    end
-
-    def version
-      @options[:version]
-    end
-
-    def validate_activity!
-      validator = HashValidator.validate(@options, OPTIONS_VALIDATOR)
-      raise "Activity #{options[:name]}definition is invalid! #{validator.errors}" unless validator.valid?
-    end
-
-    def registered?
-      response = JFlow.configuration.swf_client.list_activity_types({
-        domain: options[:domain],
-        name: name,
-        registration_status: "REGISTERED"
-      })
-
-      response.type_infos.each do |type_info|
-        if type_info.activity_type.name == name && type_info.activity_type.version == version
-          JFlow.configuration.logger.info "Activity #{name} #{version} is already registered"
-          return true
-        end
-      end
-
-      return false
-    end
-
-  end
-end

data/lib/jflow/activity_mixin.rb

@@ -1,18 +0,0 @@
-module JFlow
-  module ActivityMixin
-
-    def self.included base
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def activity(name = nil)
-        options = {}
-        options = yield if block_given?
-        options[:name] = name
-        JFlow.configuration.logger.debug "loading #{name}"
-        JFlow::Activity.new(self, options)
-      end
-    end
-  end
-end

data/lib/jflow/activity_worker.rb

@@ -1,81 +0,0 @@
-module JFlow
-  class ActivityWorker
-
-    attr_reader :domain, :tasklist
-
-    def initialize(domain, tasklist)
-      @domain = domain
-      @tasklist = tasklist
-    end
-
-    def start!
-      loop do
-        log "Polling for task on #{domain} - #{tasklist}"
-        poll
-      end
-    end
-
-    private
-
-    def poll
-      response = JFlow.configuration.swf_client.poll_for_activity_task(poll_params)
-      if response.task_token
-        process_task(response)
-      else
-        log "Got no task"
-      end
-    end
-
-    def process_task(response)
-      log "Got task #{response.task_token}"
-
-      klass = class_for_activity(response.activity_type)
-      raise "Could not find code to run for given activity" unless klass
-
-      begin
-        JFlow.configuration.logger.debug "Started #{klass}#process with #{YAML.load(response.input)}"
-        if response.activity_type.name.split('.').size > 1
-          method = response.activity_type.name.split('.').last
-        else
-          method = "process"
-        end
-        result = klass.new.send(method, YAML.load(response.input)) || true
-        JFlow.configuration.logger.debug "Done #{klass}##{method}"
-        JFlow.configuration.swf_client.respond_activity_task_completed({
-          task_token: response.task_token,
-          result: result,
-        })
-      rescue => e
-        JFlow.configuration.swf_client.respond_activity_task_failed({
-          task_token: response.task_token,
-          reason: e.message,
-          details: e.backtrace.join("\n"),
-        })
-      end
-
-    end
-
-    def identity
-      @identity ||= "#{`hostname`.chomp}-#{Thread.current.object_id}"
-    end
-
-    def log(str)
-      JFlow.configuration.logger.info "[#{Thread.current.object_id}] #{str}"
-    end
-
-    def poll_params
-      {
-        domain: domain,
-        task_list: {
-          name: tasklist,
-        },
-        identity: identity,
-      }
-    end
-
-    def class_for_activity(activity_type)
-      $activity_map[activity_type.name][activity_type.version][:class]
-    end
-
-  end
-end