mistral_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0746e5658fe10edda68289b63a11f8e8306f939d
+  data.tar.gz: fb5750de1c4bc90795b0b3bc49e06267f284c1d1
+SHA512:
+  metadata.gz: 15483eea25a2f62af9a40b7efce8d7bfdaa2b1896ce905b2d55d48655114805ee9b29fb350d28bb28e827f9830ddf0f65dc500e50b38d8b878716eaad5665847
+  data.tar.gz: f246cac33c6292e134d8f1f56805ef90bf3721fd7987316085733293f6683e1dcbb62627de47c86267345cf91a379d1845ce3e440e567c836024bf257cb164d2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.5
+  - 2.4.2
+before_install:
+  - rvm @global do gem install bundler
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## 1.0.0 - 2017-10-09
+
+* Initial Release
+
+[Unreleased]: https://github.com/civisanalytics/mistral_client/compare/v1.0.0...HEAD

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@civisanalytics.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to MistralClient
+
+We welcome bug reports and pull requests from everyone!
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## Getting Started
+
+1. Fork it ( https://github.com/civisanalytics/mistral_client/fork )
+2. Install the development dependencies (`bundle install`)
+3. Make sure you are able to run the test suite locally (`rake`)
+4. Create a feature branch (`git checkout -b my-new-feature`)
+5. Make your change. Don't forget tests
+6. Make sure the test suite, including your new tests, passes (`rake`)
+7. Commit your changes (`git commit -am 'Add some feature'`)
+8. Push to the branch (`git push origin my-new-feature`)
+9. Create a new pull request
+10. If the Travis build fails, address any issues
+
+## Tips
+
+- All pull requests must include test coverage. If you’re not sure how to test
+  your changes, feel free to ask for help.
+- Contributions must conform to the
+  [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).
+- Don’t forget to add your change to the [CHANGELOG](CHANGELOG.md). See
+  [Keep a CHANGELOG](http://keepachangelog.com/) for guidelines.
+
+Thank you for taking the time to contribute to MistralClient!

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,27 @@
+Copyright (c) 2017, Civis Analytics
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of Civis Analytics nor the names of its contributors may be
+  used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,155 @@
+# MistralClient
+
+[![Build Status](https://travis-ci.org/civisanalytics/mistral_client.svg?branch=master)](https://travis-ci.org/civisanalytics/mistral_client)
+[![Gem Version](https://badge.fury.io/rb/mistral_client.svg)](http://badge.fury.io/rb/mistral_client)
+[![Dependency Status](https://gemnasium.com/civisanalytics/mistral_client.svg)](https://gemnasium.com/civisanalytics/mistral_client)
+
+MistralClient provides a Ruby interface to a limited subset of
+the [Mistral] [API].
+
+[Mistral]: https://wiki.openstack.org/wiki/Mistral
+[API]: https://docs.openstack.org/mistral/latest/api/v2.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mistral_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mistral_client
+
+## Usage
+
+### Instantiate a Client
+
+The Mistral base URL is required:
+
+```ruby
+client = MistralClient.new('https://mistral.local/v2')
+```
+
+If running Mistral with a self-signed certificate (*e.g.*, during development),
+you can bypass certificate verification by specifying `verify: false`:
+
+```ruby
+client = MistralClient.new('https://mistral.local/v2', verify: false)
+```
+
+You can also pass in other connection options in the same way you would with
+[HTTParty](https://github.com/jnunemaker/httparty):
+
+```ruby
+client = MistralClient.new('https://mistral.local/v2', timeout: 20)
+```
+
+### Environment Operations
+
+#### Create an Environment
+
+```ruby
+environment = client.environment(definition)
+```
+
+#### Delete an Environment
+
+```ruby
+environment.delete!
+```
+
+### Workflow Operations
+
+#### Instantiate a Workflow
+
+```ruby
+workflow = client.workflow(definition)
+```
+
+You can instantiate a workflow object using an existing Mistral workflow ID:
+
+```ruby
+workflow = client.workflow(id: id)
+```
+
+or workflow name:
+
+```ruby
+workflow = client.workflow(name: name)
+```
+
+#### Execute a Workflow
+
+```ruby
+workflow.execute!
+```
+
+If your workflow uses an environment, you can specify the environment with the
+`env` keyword argument:
+
+```ruby
+workflow.execute!(env: name)
+```
+
+#### Update a Workflow Execution
+
+```ruby
+execution.patch(state: 'CANCELLED')
+```
+
+#### Update a Task
+
+```ruby
+task.patch(state: 'RUNNING', reset: true)
+```
+
+#### Delete a Workflow
+
+```ruby
+workflow.delete!
+```
+
+#### Validate a Workflow
+
+```ruby
+client.workflow.valid?(definition)
+```
+
+You can also get validation error details:
+
+```ruby
+client.workflow.validate(definition)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake` to run the tests. 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).
+
+### To Record New VCR Cassettes
+
+Recording new cassettes is as simple as ensuring you have a Mistral server
+available at the `LOCAL_MISTRAL_URL` defined in `spec/spec_helper.rb` and
+running `rake`. To rerecord existing cassettes, simply remove the relevant
+cassettes from `spec/cassettes` and run `rake`.
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## License
+
+MistralClient is released under the [BSD 3-Clause License](LICENSE.md).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mistral_client'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/mistral_client/action_execution.rb

@@ -0,0 +1,37 @@
+module MistralClient
+  class ActionExecution < Base
+    UNICODE_FIELDS = %w[
+      description
+      name
+      state
+      state_info
+      task_execution_id
+      task_name
+      workflow_name
+    ].freeze
+
+    JSON_FIELDS = %w[input output params].freeze
+    BOOL_FIELDS = %w[accepted].freeze
+
+    PATH = 'action_executions'.freeze
+
+    include MistralClient::Mixins::MistralObject
+
+    def initialize(server, id: nil)
+      @server = server
+      @path = 'action_executions'
+      @id = id
+      reload if @id
+    end
+
+    def patch(state: nil, output: nil)
+      body = {}
+      body[:state] = state unless state.nil?
+      body[:output] = output unless output.nil?
+      return if body.empty?
+
+      resp = @server.put("#{PATH}/#{@id}", body.to_json, json: true)
+      ivars_from_response(resp)
+    end
+  end
+end

data/lib/mistral_client/base.rb

@@ -0,0 +1,5 @@
+module MistralClient
+  class Base
+    DATE_FIELDS = %w[created_at updated_at].freeze
+  end
+end

data/lib/mistral_client/client.rb

@@ -0,0 +1,76 @@
+module MistralClient
+  class Client
+    DEFAULT_HTTP_OPTIONS = { verify: true }.freeze
+
+    def initialize(base, options = {})
+      raise ConfigurationError, 'base is required' if base.to_s.empty?
+
+      @base = base
+      @http_options = DEFAULT_HTTP_OPTIONS.merge(options)
+    end
+
+    def delete(path)
+      HTTParty.delete("#{@base}/#{path}", @http_options)
+    end
+
+    def get(path)
+      resp = HTTParty.get("#{@base}/#{path}", @http_options)
+      check_for_error(resp)
+      JSON.parse(resp.body)
+    end
+
+    def post(path, body, json: false)
+      post_or_put(:post, path, body, json)
+    end
+
+    def put(path, body, json: false)
+      post_or_put(:put, path, body, json)
+    end
+
+    def self.resources
+      {
+        action_execution: MistralClient::ActionExecution,
+        environment: MistralClient::Environment,
+        execution: MistralClient::Execution,
+        task: MistralClient::Task,
+        workflow: MistralClient::Workflow
+      }
+    end
+
+    def method_missing(name, *args, &block)
+      if self.class.resources.keys.include?(name)
+        self.class.resources[name].new(self, *args)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      self.class.resources.keys.include?(name) || super
+    end
+
+    private
+
+    def post_or_put(verb, path, body, json)
+      raise ArgumentError unless %i[post put].include?(verb)
+      headers = if json
+                  { 'Content-Type' => 'application/json' }
+                else
+                  { 'Content-Type' => 'text/plain' }
+                end
+      options = @http_options.merge(headers: headers, body: body)
+      resp = HTTParty.send(verb, "#{@base}/#{path}", options)
+      check_for_error(resp)
+      JSON.parse(resp.body)
+    end
+
+    def check_for_error(resp)
+      return if resp.code >= 200 && resp.code < 300
+      if resp.code == 404
+        raise MissingObjectError, JSON.parse(resp.body)['faultstring']
+      end
+      raise MistralError,
+            "Could not perform the requested operation:\n#{resp.body}"
+    end
+  end
+end

data/lib/mistral_client/environment.rb

@@ -0,0 +1,46 @@
+module MistralClient
+  class Environment < Base
+    UNICODE_FIELDS = %w[name scope description].freeze
+    JSON_FIELDS = %w[variables].freeze
+    BOOL_FIELDS = [].freeze
+    PATH = 'environments'.freeze
+    include MistralClient::Mixins::MistralObject
+    include MistralClient::Mixins::Definable
+
+    def initialize(server, definition = nil, name: nil)
+      @server = server
+      @definition = parse_definition(definition) if definition
+      @name = name
+      if @name
+        reload
+      elsif @definition
+        create_environment
+      end
+    end
+
+    def reload
+      super(@name)
+    end
+
+    def delete!
+      resp = @server.delete("#{PATH}/#{@name}")
+      return true if resp.code == 204
+      raise MistralClient::MistralError,
+            "Could not perform the requested operation:\n#{resp.body}"
+    end
+
+    private
+
+    def create_environment
+      resp = @server.post(PATH, @definition.to_json, json: true)
+      ivars_from_response(resp)
+    end
+
+    def massage_definition(definition)
+      if definition['variables'].is_a? Hash
+        definition['variables'] = definition['variables'].to_json
+      end
+      definition
+    end
+  end
+end

data/lib/mistral_client/error.rb

@@ -0,0 +1,6 @@
+module MistralClient
+  class MistralError < StandardError; end
+
+  class ConfigurationError < MistralError; end
+  class MissingObjectError < MistralError; end
+end

data/lib/mistral_client/execution.rb

@@ -0,0 +1,64 @@
+module MistralClient
+  class Execution < Base
+    UNICODE_FIELDS = %w[
+      workflow_id
+      workflow_name
+      description
+      state
+      state_info
+    ].freeze
+
+    DATE_FIELDS = %w[created_at updated_at].freeze
+    JSON_FIELDS = %w[input output params].freeze
+    BOOL_FIELDS = [].freeze
+
+    PATH = 'executions'.freeze
+
+    include MistralClient::Mixins::MistralObject
+    include MistralClient::Mixins::Definable
+    include MistralClient::Mixins::Deletable
+
+    def initialize(server, workflow_id: nil, env: nil, task_name: nil,
+                   id: nil)
+      set_attributes(server, workflow_id, env, task_name, id)
+      if @id
+        reload
+      elsif @workflow_id
+        create_execution
+      end
+    end
+
+    def patch(description: nil, state: nil, env: nil)
+      body = {}
+      body[:description] = description unless description.nil?
+      body[:state] = state if state
+      body[:params] = { env: env } if env
+
+      return if body.empty?
+
+      resp = @server.put("#{PATH}/#{@id}", body.to_json, json: true)
+      ivars_from_response(resp)
+    end
+
+    private
+
+    def set_attributes(server, workflow_id, env, task_name, id)
+      @server = server
+      @env = env
+      @task_name = task_name
+      @id = id
+      @workflow_id = workflow_id
+    end
+
+    def create_execution
+      body = { workflow_id: @workflow_id }
+      params = {}
+      params[:env] = @env if @env
+      params[:task_name] = @task_name if @task_name
+      body[:params] = params unless params.empty?
+
+      resp = @server.post(PATH, body.to_json, json: true)
+      ivars_from_response(resp)
+    end
+  end
+end

data/lib/mistral_client/mixins/definable.rb

@@ -0,0 +1,24 @@
+module MistralClient
+  module Mixins
+    module Definable
+      # rubocop:disable Metrics/MethodLength
+      def parse_definition(definition)
+        if definition.is_a?(Hash) || definition.is_a?(Array)
+          return YAML.dump(definition)
+        end
+        definition = File.read(definition) if File.exist?(definition)
+        # Called outside the if/else to validate the YAML.
+        parsed = YAML.safe_load(definition, [], [], true)
+        if defined? massage_definition
+          massage_definition(parsed)
+        else
+          definition
+        end
+      rescue Psych::SyntaxError
+        raise ConfigurationError,
+              'Only filenames or raw or parsed strings of YAML are supported.'
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+  end
+end

data/lib/mistral_client/mixins/deletable.rb

@@ -0,0 +1,12 @@
+module MistralClient
+  module Mixins
+    module Deletable
+      def delete!
+        resp = @server.delete("#{self.class::PATH}/#{id}")
+        return true if resp.code == 204
+        raise MistralClient::MistralError,
+              "Could not perform the requested operation:\n#{resp.body}"
+      end
+    end
+  end
+end

data/lib/mistral_client/mixins/mistral_object.rb

@@ -0,0 +1,52 @@
+module MistralClient
+  module Mixins
+    module MistralObject
+      def self.included(child)
+        child.send(:attr_reader, :id)
+
+        %w[UNICODE_FIELDS DATE_FIELDS JSON_FIELDS BOOL_FIELDS].each do |fields|
+          next unless child.const_defined? fields
+          child.send(:attr_reader, *child.const_get(fields))
+        end
+      end
+
+      def reload(id = @id)
+        resp = @server.get("#{self.class::PATH}/#{id}")
+        ivars_from_response(resp)
+        self
+      end
+
+      def list(params = {})
+        resp = @server.get("#{self.class::PATH}?#{URI.encode_www_form(params)}")
+        resp[self.class::PATH].map do |t|
+          task = self.class.new(@server)
+          task.ivars_from_response(t)
+          task
+        end
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def ivars_from_response(resp)
+        klass = self.class
+        @id = resp['id']
+        klass::UNICODE_FIELDS.each do |var|
+          instance_variable_set("@#{var}", resp[var]) if resp[var]
+        end
+        klass::BOOL_FIELDS.each do |var|
+          instance_variable_set("@#{var}", resp[var]) if resp.key? var
+        end
+        klass::DATE_FIELDS.each do |var|
+          if resp[var]
+            instance_variable_set("@#{var}", DateTime.parse(resp[var]))
+          end
+        end
+        klass::JSON_FIELDS.each do |var|
+          instance_variable_set("@#{var}", JSON.parse(resp[var])) if resp[var]
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/mistral_client/task.rb

@@ -0,0 +1,41 @@
+require 'uri'
+
+module MistralClient
+  class Task < Base
+    UNICODE_FIELDS = %w[
+      workflow_id
+      workflow_execution_id
+      workflow_name
+      state
+      state_info
+      result
+      name
+    ].freeze
+
+    JSON_FIELDS = %w[published runtime_context].freeze
+    BOOL_FIELDS = %w[reset processed].freeze
+
+    PATH = 'tasks'.freeze
+
+    include MistralClient::Mixins::MistralObject
+
+    def initialize(server, id: nil)
+      @server = server
+      @path = 'tasks'
+      @id = id
+      reload if id
+    end
+
+    def patch(state: nil, reset: nil, env: nil)
+      body = {}
+      body[:state] = state if state
+      body[:reset] = reset if reset
+      body[:env] = env if env
+
+      return if body.empty?
+
+      resp = @server.put("#{PATH}/#{@id}", body.to_json, json: true)
+      ivars_from_response(resp)
+    end
+  end
+end

data/lib/mistral_client/version.rb

@@ -0,0 +1,3 @@
+module MistralClient
+  VERSION = '1.0.0'.freeze
+end

data/lib/mistral_client/workflow.rb

@@ -0,0 +1,53 @@
+module MistralClient
+  class Workflow < Base
+    UNICODE_FIELDS = %w[definition input name project_id scope].freeze
+    BOOL_FIELDS = [].freeze
+    JSON_FIELDS = [].freeze
+
+    PATH = 'workflows'.freeze
+
+    include MistralClient::Mixins::MistralObject
+    include MistralClient::Mixins::Definable
+    include MistralClient::Mixins::Deletable
+
+    def initialize(server, definition = nil, id: nil, name: nil)
+      @server = server
+      if definition
+        @definition = parse_definition(definition)
+        create_workflow
+      elsif id || name
+        @id = id || name
+        reload
+      end
+    end
+
+    def execute!(env: nil, task_name: nil)
+      Execution.new(@server, workflow_id: @id, env: env, task_name: task_name)
+    end
+
+    def valid?(definition)
+      resp = perform_validation(definition)
+      resp['valid']
+    end
+
+    def validate(definition)
+      resp = perform_validation(definition)
+      resp['error']&.split("\n")&.first
+    end
+
+    private
+
+    def create_workflow
+      resp = @server.post(PATH, @definition)
+      if resp['workflows'].length > 1
+        raise ConfigurationError,
+              'Only one workflow per definition is supported'
+      end
+      ivars_from_response(resp['workflows'][0])
+    end
+
+    def perform_validation(definition)
+      @server.post("#{PATH}/validate", parse_definition(definition))
+    end
+  end
+end

data/lib/mistral_client.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+require 'yaml'
+require 'mistral_client/mixins/definable'
+require 'mistral_client/mixins/deletable'
+require 'mistral_client/mixins/mistral_object'
+require 'mistral_client/base'
+require 'mistral_client/action_execution'
+require 'mistral_client/client'
+require 'mistral_client/environment'
+require 'mistral_client/error'
+require 'mistral_client/execution'
+require 'mistral_client/task'
+require 'mistral_client/version'
+require 'mistral_client/workflow'
+
+module MistralClient
+  class << self
+    def new(base = nil, options = {})
+      Client.new(base, options)
+    end
+  end
+end

data/mistral_client.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mistral_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mistral_client'
+  spec.version       = MistralClient::VERSION
+  spec.authors       = ['Matt Brennan', 'Jeff Cousens', 'Mike Saelim']
+  spec.email         = ['opensource@civisanalytics.com']
+
+  spec.summary       = 'Ruby client for Mistral.'
+  spec.description   = "A Ruby client for OpenStack's Mistral " \
+                       '<https://wiki.openstack.org/wiki/Mistral>.'
+  spec.homepage      = 'https://github.com/civisanalytics/mistral_client'
+  spec.license       = 'BSD 3-Clause'
+
+  spec.required_ruby_version = '~> 2.3'
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.15.6'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry', '~> 0.11.1'
+  spec.add_development_dependency 'rake', '~> 12.1'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rubocop', '~> 0.50.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.1'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: mistral_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Brennan
+- Jeff Cousens
+- Mike Saelim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: A Ruby client for OpenStack's Mistral <https://wiki.openstack.org/wiki/Mistral>.
+email:
+- opensource@civisanalytics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mistral_client.rb
+- lib/mistral_client/action_execution.rb
+- lib/mistral_client/base.rb
+- lib/mistral_client/client.rb
+- lib/mistral_client/environment.rb
+- lib/mistral_client/error.rb
+- lib/mistral_client/execution.rb
+- lib/mistral_client/mixins/definable.rb
+- lib/mistral_client/mixins/deletable.rb
+- lib/mistral_client/mixins/mistral_object.rb
+- lib/mistral_client/task.rb
+- lib/mistral_client/version.rb
+- lib/mistral_client/workflow.rb
+- mistral_client.gemspec
+homepage: https://github.com/civisanalytics/mistral_client
+licenses:
+- BSD 3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby client for Mistral.
+test_files: []