active_workflow_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 760bc7e511153b9589591f3a1aaf245519a8bb1df5265987f884c98faefda1ef
+  data.tar.gz: 984ffb2222a4de580114b000dcd6dbfea631259f6a8478f7452c51dab5ccf781
+SHA512:
+  metadata.gz: 43ba4c7d73088c7b956c630575552c6fc26f60ce6ff1b4f165e4d2ee96cb29388777729b0e0b3a27d71318d77bb5843a34c3becc6db6f14aa9701bc9e7993f54
+  data.tar.gz: 5672d6b21f2ca4cf92b32f10ac73e14e74adf749ae8aca3b5f4a6e647eb12c3b43916415de86740ae36c727a2ef5d1d9ceb997ae64835380b86108ff4eee441b

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.14
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,43 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+.rubocop-https?--*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  SuggestExtensions: false
+  Exclude:
+  - 'active_workflow_agent.gemspec'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 80
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context']
+
+Style/CombinableLoops:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-03-25
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_workflow_agent.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    active_workflow_agent (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_workflow_agent!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Automatic Mode Labs AG
+
+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 @@
+# ActiveWorkflowAgent
+
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/automaticmode/active_workflow_agent/Ruby?label=build&style=flat-square) ![GitHub](https://img.shields.io/github/license/automaticmode/active_workflow_agent?color=27aace&style=flat-square)
+
+This library helps you to write your own [ActiveWorkflow](https://docs.activeworkflow.org/) agents in **Ruby** using ActiveWorkflow's [remote agent API](https://docs.activeworkflow.org/remote-agent-api/).
+
+## Installation
+
+Add this line to your agent's Gemfile:
+
+```ruby
+gem 'active_workflow_agent'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_workflow_agent
+
+## Documentation
+
+For full documentation please see [ActiveWorkflow Agent Ruby](https://docs.activeworkflow.org/activeworkflow-agent-ruby) on ActiveWorkflow's documentation website.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/active_workflow_agent.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "lib/active_workflow_agent/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_workflow_agent"
+  spec.version       = ActiveWorkflowAgent::VERSION
+  spec.authors       = ["Automatic Mode Labs"]
+  spec.email         = ["info@automaticmode.com"]
+
+  spec.summary       = "Helper library for writing ActiveWorkflow agents."
+  spec.homepage      = "https://github.com/automaticmode/active_workflow_agent"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "active_workflow_agent"
+
+# 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(__FILE__)

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/active_workflow_agent.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "active_workflow_agent/version"
+require_relative "active_workflow_agent/parsed_request"
+require_relative "active_workflow_agent/response"
+require_relative "active_workflow_agent/register_response"
+
+module ActiveWorkflowAgent
+  CheckResponse = Response
+  ReceiveResponse = Response
+end

data/lib/active_workflow_agent/parsed_request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ActiveWorkflowAgent
+  #  Helper class to parse the content of a request from the Agent API.
+  class ParsedRequest
+    attr_reader :method, :options, :memory, :credentials, :message
+
+    def initialize(request)
+      @method = request["method"].to_sym
+      # Set to empty for 'register' method.
+      @options = {}
+      @memory = {}
+      @credentials = []
+      @message = {}
+
+      if %i[check receive].include? @method
+        @options = request["params"]["options"]
+        @memory = request["params"]["memory"]
+        @credentials = request["params"]["credentials"]
+      end
+      @message = request["params"]["message"]["payload"] if @method == :receive
+    end
+  end
+end

data/lib/active_workflow_agent/register_response.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "json"
+
+module ActiveWorkflowAgent
+  # Helper class to construct a response to ActiveWorkflow's register method.
+  # https://docs.activeworkflow.org/remote-agent-api#the-register-method
+  class RegisterResponse
+    def initialize(name:, display_name:, description:, default_options: {})
+      @name = name
+      @display_name = display_name
+      @description = description
+      @default_options = default_options
+
+      validate_args
+    end
+
+    def to_h
+      {
+        "result" => {
+          "name" => @name,
+          "display_name" => @display_name,
+          "description" => @description,
+          "default_options" => @default_options
+        }
+      }
+    end
+
+    def to_json(*)
+      JSON.dump(to_h)
+    end
+
+    private
+
+    def validate_args
+      str_msg = "must be a string"
+      empty_msg = "can not be empty"
+      whitespace_msg = "can not have whitespace"
+      hash_msg = "must be a hash"
+
+      # name
+      raise(ArgumentError, "name #{str_msg}") unless @name.is_a?(String)
+      raise(ArgumentError, "name #{empty_msg}") if @name.empty?
+      raise(ArgumentError, "name #{whitespace_msg}") if @name.include?(" ")
+      # display_name
+      # rubocop:disable Layout/LineLength
+      raise(ArgumentError, "display_name #{str_msg}") unless @display_name.is_a?(String)
+      raise(ArgumentError, "display_name #{empty_msg}") if @display_name.empty?
+      # default_options
+      raise(ArgumentError, "default_options #{hash_msg}") unless @default_options.is_a?(Hash)
+      # rubocop:enable Layout/LineLength
+    end
+  end
+end

data/lib/active_workflow_agent/response.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "json"
+
+module ActiveWorkflowAgent
+  # Helper class to construct responses to ActiveWorkflow's agent API.
+  # https://docs.activeworkflow.org/remote-agent-api#responses
+  class Response
+    # Create an object for responding to 'receive' or 'check' methods.
+    def initialize
+      @logs = []
+      @errors = []
+      @messages = []
+      @memory = {}
+    end
+
+    # Add log messages to the response object.
+    def add_logs(*logs)
+      # Validation.
+      must_str = "must be (non-empty) strings"
+      not_empty = "can not be empty strings"
+      logs.each do |log|
+        raise(ArgumentError, "Logs #{must_str}.") unless log.is_a?(String)
+        raise(ArgumentError, "Logs #{not_empty}.") if log == ""
+      end
+
+      logs.each { |log| @logs << log }
+    end
+
+    def add_errors(*errors)
+      # Validation.
+      must_str = "must be (non-empty) strings"
+      not_empty = "can not be empty strings"
+      errors.each do |err|
+        raise(ArgumentError, "Errors #{must_str}.") unless err.is_a?(String)
+        raise(ArgumentError, "Errors #{not_empty}.") if err == ""
+      end
+
+      errors.each { |err| @errors << err }
+    end
+
+    def add_messages(*messages)
+      # Validation.
+      must_hash = "must be (non-empty) hashes"
+      not_empty = "can not be empty hashes"
+      messages.each do |msg|
+        raise(ArgumentError, "Messages #{must_hash}.") unless msg.is_a?(Hash)
+        raise(ArgumentError, "Messages #{not_empty}.") if msg == {}
+      end
+
+      messages.each { |msg| @messages << msg }
+    end
+
+    def add_memory(memory)
+      must_hash = "must be a hash"
+      raise(ArgumentError, "Memory #{must_hash}.") unless memory.is_a?(Hash)
+
+      @memory = memory
+    end
+
+    def to_h
+      {
+        "result" => {
+          "logs" => @logs,
+          "errors" => @errors,
+          "messages" => @messages,
+          "memory" => @memory
+        }
+      }
+    end
+
+    def to_json(*)
+      JSON.dump(to_h)
+    end
+  end
+end

data/lib/active_workflow_agent/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveWorkflowAgent
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: active_workflow_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Automatic Mode Labs
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-25 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- info@automaticmode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_workflow_agent.gemspec
+- bin/console
+- bin/setup
+- lib/active_workflow_agent.rb
+- lib/active_workflow_agent/parsed_request.rb
+- lib/active_workflow_agent/register_response.rb
+- lib/active_workflow_agent/response.rb
+- lib/active_workflow_agent/version.rb
+homepage: https://github.com/automaticmode/active_workflow_agent
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Helper library for writing ActiveWorkflow agents.
+test_files: []