workflows 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82262e54a1a6ddd11b7c05f8169f4035ff289677
+  data.tar.gz: 3562c0579e24c0b92dbc3d23426f2c31d840f167
+SHA512:
+  metadata.gz: f9346dde057c147c66444331dc18570906db016f862b27b77dda6760fc635bf19a30244d18e5c8a8c87dc92f927e698cf4b2aa8232a4ead91ee300aa69feffbd
+  data.tar.gz: fc07d9ecf4933fc9ea77488528df903a11440a96c4e3cc35e21b1ef586aa1bf02aa48b098f97ebfc7cbe631360f98aae6be0bfb7acbdeac61b604fdcf0f876aa

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Shamim
+
+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,41 @@
+# Workflows
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/workflows`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'workflows'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workflows
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/sjahandideh/workflows. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.
+
+
+## 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,13 @@
+require 'bundler/gem_tasks'
+
+####
+# minitest automations
+####
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "workflows"
+
+# 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/example/signup/models.rb

@@ -0,0 +1,34 @@
+require 'workflows'
+
+module Example::Signup
+  module Models
+
+    class User
+      attr_reader :name, :dob
+      attr_accessor :notified
+
+      def initialize(name, dob)
+        @name = name
+        @dob = dob
+        @notified = false
+      end
+
+      def create; true; end
+      def notify; true; end
+    end
+
+    class Admin
+      attr_accessor :notified
+
+      def self.get
+        new
+      end
+
+      def initialize
+        @notified = false
+      end
+
+      def notify_about(user); true; end
+    end
+  end
+end

data/lib/example/signup/signup_workflow.rb

@@ -0,0 +1,41 @@
+require 'workflows'
+require_relative 'models'
+require_relative 'step_services/create_user'
+require_relative 'step_services/notify_user'
+require_relative 'step_services/notify_admin'
+
+module Example::Signup
+  # @example
+  #   signup_wf = Example::Signup::SignupWorkflow.new(
+  #     create_user:  { name: 'Harry Potter', dob: '31-07-1980' },
+  #     notify_user:  {},
+  #     notify_admin: { admin: Example::Signup::Models::Admin.get }
+  #   )
+  #
+  #   signup_wf.run
+  #   signup_wf.status -> [:ok, :ok, :fail]
+  #   signup_wf.output -> ["Harry Potter is successfully created.", "Harry Potter is notified", "Admin is notified"]
+  #   signup_wf.state  -> Models::User.new(name: 'Harry Potter', ...)
+  ###
+  class SignupWorkflow
+    include Workflows
+
+    has_flow [
+      {
+        name: 'create_user',
+        service: Example::Signup::CreateUserService,
+        args: [:name, :dob]
+      },
+      {
+        name: 'notify_user',
+        service: Example::Signup::NotifyUserService,
+        args: []
+      },
+      {
+        name: 'notify_admin',
+        service: Example::Signup::NotifyAdminService,
+        args: [:admin]
+      }
+    ]
+  end
+end

data/lib/example/signup/step_services/create_user.rb

@@ -0,0 +1,22 @@
+require 'workflows'
+
+require_relative '../models'
+
+module Example::Signup
+
+  class CreateUserService
+    include Workflows::StepService
+
+    def run
+      user = Models::User.new(args.name, args.dob)
+      if user.create
+        # success
+        set_state(user: user)
+        set_output "#{user.name} is successfully created."
+      else
+        # failure
+        raise "Unable to create user"
+      end
+    end
+  end
+end

data/lib/example/signup/step_services/notify_admin.rb

@@ -0,0 +1,27 @@
+require 'workflows'
+
+module Example::Signup
+
+  class NotifyAdminService
+    include Workflows::StepService
+
+    def run
+      if admin.notify_about(user)
+        # no need to reset the state
+        set_output "Admin is notified."
+      else
+        raise "Unable to notify admin about new user"
+      end
+    end
+
+    private
+
+    def user
+      @user ||= get_state.user
+    end
+
+    def admin
+      @admin ||= args.admin
+    end
+  end
+end

data/lib/example/signup/step_services/notify_user.rb

@@ -0,0 +1,24 @@
+require 'workflows'
+
+module Example::Signup
+
+  class NotifyUserService
+    include Workflows::StepService
+
+    def run
+      if user.notify
+        user.notified = true
+        set_state(user: user)
+        set_output "#{user.name} is notified."
+      else
+        raise "Unable to notify user"
+      end
+    end
+
+    private
+
+    def user
+      @user ||= get_state.user
+    end
+  end
+end

data/lib/example/signup.rb

@@ -0,0 +1,7 @@
+require_relative '../example'
+require_relative 'signup/signup_workflow'
+
+module Example
+  module Signup
+  end
+end

data/lib/example.rb

@@ -0,0 +1,2 @@
+module Example
+end

data/lib/workflows/step.rb

@@ -0,0 +1,55 @@
+require 'ostruct'
+require_relative 'step_service'
+
+module Workflows
+  class Step
+
+    def self.build_all(steps = [])
+      steps.map do |step_hash|
+        new(step_hash)
+      end
+    end
+
+    attr_reader :service_obj,
+                :status,
+                :output,
+                :state,
+                :name
+
+    def initialize(args = {})
+      @name = args[:name]
+      @klass = args[:service]
+      @strategy = args[:strategy] || :fail
+      @service_args = args[:args]
+
+      @service_obj = @klass.new
+    end
+
+    def run
+      @status = :ok
+      service_obj.run
+      @output = service_obj.get_output
+    rescue => e
+      @status = :fail
+      @output = e.message
+    ensure
+      @state = service_obj.get_state
+    end
+
+    def set_args(args)
+      service_obj.set_args args
+    end
+
+    def set_state(state)
+      service_obj.set_state state
+    end
+
+    def get_state
+      service_obj.get_state
+    end
+
+    def get_output
+      service_obj.get_output
+    end
+  end
+end

data/lib/workflows/step_service.rb

@@ -0,0 +1,38 @@
+require 'ostruct'
+require 'pry'
+require 'pry-byebug'
+
+module Workflows
+  module StepService
+
+    ####
+    # Getter, Setter methods
+    ####
+
+    def set_args(args)
+      @wf_args ||=
+        OpenStruct.new(args)
+    end
+
+    def args
+      @wf_args
+    end
+    alias :get_args :args
+
+    def set_state(state)
+      @wf_state = OpenStruct.new(state)
+    end
+
+    def get_state
+      @wf_state
+    end
+
+    def set_output(output)
+      @wf_output = output
+    end
+
+    def get_output
+      @wf_output
+    end
+  end
+end

data/lib/workflows/version.rb

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

data/lib/workflows.rb

@@ -0,0 +1,56 @@
+require_relative 'workflows/version'
+require_relative 'workflows/step'
+
+module Workflows
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def has_flow(args = [])
+      class_eval <<-EVAL, __FILE__, __LINE__ + 1
+        def wf_steps
+          @wf_steps ||= Step.build_all(#{args})
+        end
+      EVAL
+    end
+  end
+
+  ####
+  # instance methods
+  ####
+
+  def initialize(service_args = {})
+    # TODO: validate service_args
+    # make sure there is one for each service
+    # according to the wf structure defined with has_flow
+    wf_steps.each do |wf_step|
+      args = service_args.fetch(wf_step.name.to_sym)
+      wf_step.set_args args
+    end
+  end
+
+  def run(args = {})
+    previous_state = {}
+    wf_steps.each do |wf_step|
+      wf_step.set_state(previous_state)
+      wf_step.run
+      previous_state = wf_step.get_state
+    end
+
+    wf_steps.last.get_output
+  end
+
+  def state
+    wf_steps.last.get_state
+  end
+
+  def status
+    wf_steps.map { |wf_step| wf_step.status }
+  end
+
+  def output
+    wf_steps.map { |wf_step| wf_step.output }
+  end
+end

data/workflows.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workflows/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "workflows"
+  spec.version       = Workflows::VERSION
+  spec.authors       = ["Shamim"]
+  spec.email         = ["shamim.jahandideh@gmail.com"]
+
+  spec.summary       = %q{Organising multi-step functionalities into workflows.}
+  spec.description   = %q{Creating a workflow class that organises and supervises micro-services.}
+  spec.homepage      = "https://github.com/sjahandideh/workflows"
+  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 "pry"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: workflows
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shamim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-14 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: pry
+  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: pry-byebug
+  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'
+description: Creating a workflow class that organises and supervises micro-services.
+email:
+- shamim.jahandideh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/example.rb
+- lib/example/signup.rb
+- lib/example/signup/models.rb
+- lib/example/signup/signup_workflow.rb
+- lib/example/signup/step_services/create_user.rb
+- lib/example/signup/step_services/notify_admin.rb
+- lib/example/signup/step_services/notify_user.rb
+- lib/workflows.rb
+- lib/workflows/step.rb
+- lib/workflows/step_service.rb
+- lib/workflows/version.rb
+- workflows.gemspec
+homepage: https://github.com/sjahandideh/workflows
+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
+signing_key: 
+specification_version: 4
+summary: Organising multi-step functionalities into workflows.
+test_files: []