mistral_client 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0746e5658fe10edda68289b63a11f8e8306f939d
-  data.tar.gz: fb5750de1c4bc90795b0b3bc49e06267f284c1d1
+SHA256:
+  metadata.gz: 34f8fe4927bf0a63c4116a071881feeaa08c2e7aaf395ffa6fda00be01a25a3d
+  data.tar.gz: 71c54308a991fd231ab0689577d19a424de75768c149ab3e02e8703e7f55d1c1
 SHA512:
-  metadata.gz: 15483eea25a2f62af9a40b7efce8d7bfdaa2b1896ce905b2d55d48655114805ee9b29fb350d28bb28e827f9830ddf0f65dc500e50b38d8b878716eaad5665847
-  data.tar.gz: f246cac33c6292e134d8f1f56805ef90bf3721fd7987316085733293f6683e1dcbb62627de47c86267345cf91a379d1845ce3e440e567c836024bf257cb164d2
+  metadata.gz: 551bae7ab6e7a7758882c7af6af1f5c6aa6ce829a6eff64c74e337480f2fdaced3bc0d49f2107aab1f27edcbdd7df3732a874d9a2b0193f0b2b3a753d78ca65b
+  data.tar.gz: a83d532bee4796185fffedc1364f7ec123b30594e16742c2a0b9e061b63da026a32d32bf911860424b0f6e3b182d81f984b27cf8ae28fd249c902fdcfddf6c5f

data/.rspec

@@ -1 +1,2 @@
 --color
+--warnings

data/.rubocop.yml

@@ -1,3 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: disable
+  SuggestExtensions: false
+
 Style/Documentation:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-2.4.2
+3.0.0

data/.travis.yml

@@ -1,10 +1,12 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.5
-  - 2.4.2
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
 before_install:
-  - rvm @global do gem install bundler
+  - gem install bundler
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -5,8 +5,54 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [2.0.0] - 2021-02-09
+
+### Added
+- Added Ruby 2.7 and 3.0 to the Travis build matrix
+
+### Changed
+- Bumped the Ruby version for development to 3.0.0
+- Fixed deprecation warnings around positional and keyword arguments from ruby 2.7.0
+- Updated rubocop to v1.9.1, and fixed rubocop violations
+- Configured rspec to emit warnings, and fix them
+- Re-recorded the spec cassettes
+- Fixed broken links in the README
+
+### Removed
+- Removed Ruby 2.3 and 2.4 from the Travis build matrix
+
+## [1.3.0] - 2020-04-20
+
+### Changed
+- Relaxed the constraint on the httparty dependency
+- Added Ruby 2.5 and 2.6 to the build matrix
+- Updated development dependencies
+
+## [1.2.1] - 2019-11-07
+
+### Added
+- A new exception with the request to mistral attached
+
+## [1.2.0] - 2018-12-17
+
+### Added
+- A get health endpoint
+
+## [1.1.0] - 2017-12-15
+
+### Added
+- Made the input parameter available to execute! so that users can parameterize workflows.
+
+### Changed
+- Fixed transient spec failure in task_spec.rb
+
 ## 1.0.0 - 2017-10-09
 
 * Initial Release
 
-[Unreleased]: https://github.com/civisanalytics/mistral_client/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/civisanalytics/mistral_client/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/civisanalytics/mistral_client/compare/v1.3.0...v2.0.0
+[1.3.0]: https://github.com/civisanalytics/mistral_client/compare/v1.2.1...v1.3.0
+[1.2.1]: https://github.com/civisanalytics/mistral_client/compare/v1.2.0...v1.2.1
+[1.2.0]: https://github.com/civisanalytics/mistral_client/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/civisanalytics/mistral_client/compare/v1.0.0...v1.1.0

data/README.md

@@ -1,14 +1,13 @@
 # MistralClient
 
-[![Build Status](https://travis-ci.org/civisanalytics/mistral_client.svg?branch=master)](https://travis-ci.org/civisanalytics/mistral_client)
+[![Build Status](https://travis-ci.com/civisanalytics/mistral_client.svg?branch=master)](https://travis-ci.com/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
+[Mistral]: https://docs.openstack.org/mistral/latest/
+[API]: https://docs.openstack.org/mistral/latest/user/rest_api_v2.html
 
 ## Installation
 

data/lib/mistral_client.rb

@@ -9,6 +9,7 @@ require 'mistral_client/client'
 require 'mistral_client/environment'
 require 'mistral_client/error'
 require 'mistral_client/execution'
+require 'mistral_client/health'
 require 'mistral_client/task'
 require 'mistral_client/version'
 require 'mistral_client/workflow'

data/lib/mistral_client/action_execution.rb

@@ -18,6 +18,7 @@ module MistralClient
     include MistralClient::Mixins::MistralObject
 
     def initialize(server, id: nil)
+      super()
       @server = server
       @path = 'action_executions'
       @id = id

data/lib/mistral_client/client.rb

@@ -32,14 +32,19 @@ module MistralClient
         action_execution: MistralClient::ActionExecution,
         environment: MistralClient::Environment,
         execution: MistralClient::Execution,
+        health: MistralClient::Health,
         task: MistralClient::Task,
         workflow: MistralClient::Workflow
       }
     end
 
-    def method_missing(name, *args, &block)
+    def method_missing(name, *args, **kwargs, &block)
       if self.class.resources.keys.include?(name)
-        self.class.resources[name].new(self, *args)
+        if kwargs.nil? || kwargs.empty?
+          self.class.resources[name].new(self, *args)
+        else
+          self.class.resources[name].new(self, *args, **kwargs)
+        end
       else
         super
       end
@@ -53,6 +58,7 @@ module MistralClient
 
     def post_or_put(verb, path, body, json)
       raise ArgumentError unless %i[post put].include?(verb)
+
       headers = if json
                   { 'Content-Type' => 'application/json' }
                 else
@@ -66,10 +72,9 @@ module MistralClient
 
     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,
+      raise MissingObjectError, JSON.parse(resp.body)['faultstring'] if resp.code == 404
+
+      raise MistralResponseError.new(resp),
             "Could not perform the requested operation:\n#{resp.body}"
     end
   end

data/lib/mistral_client/environment.rb

@@ -8,8 +8,9 @@ module MistralClient
     include MistralClient::Mixins::Definable
 
     def initialize(server, definition = nil, name: nil)
+      super()
       @server = server
-      @definition = parse_definition(definition) if definition
+      @definition = definition ? parse_definition(definition) : nil
       @name = name
       if @name
         reload
@@ -25,6 +26,7 @@ module MistralClient
     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
@@ -37,9 +39,7 @@ module MistralClient
     end
 
     def massage_definition(definition)
-      if definition['variables'].is_a? Hash
-        definition['variables'] = definition['variables'].to_json
-      end
+      definition['variables'] = definition['variables'].to_json if definition['variables'].is_a? Hash
       definition
     end
   end

data/lib/mistral_client/error.rb

@@ -2,5 +2,15 @@ module MistralClient
   class MistralError < StandardError; end
 
   class ConfigurationError < MistralError; end
+
   class MissingObjectError < MistralError; end
+
+  class MistralResponseError < MistralError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super(response)
+    end
+  end
 end

data/lib/mistral_client/execution.rb

@@ -18,15 +18,18 @@ module MistralClient
     include MistralClient::Mixins::Definable
     include MistralClient::Mixins::Deletable
 
+    # rubocop:disable Metrics/ParameterLists
     def initialize(server, workflow_id: nil, env: nil, task_name: nil,
-                   id: nil)
-      set_attributes(server, workflow_id, env, task_name, id)
+                   id: nil, input: nil)
+      super()
+      set_attributes(server, workflow_id, env, task_name, id, input)
       if @id
         reload
       elsif @workflow_id
         create_execution
       end
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def patch(description: nil, state: nil, env: nil)
       body = {}
@@ -42,13 +45,16 @@ module MistralClient
 
     private
 
-    def set_attributes(server, workflow_id, env, task_name, id)
+    # rubocop:disable Metrics/ParameterLists
+    def set_attributes(server, workflow_id, env, task_name, id, input)
       @server = server
       @env = env
       @task_name = task_name
       @id = id
       @workflow_id = workflow_id
+      @input = input
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def create_execution
       body = { workflow_id: @workflow_id }
@@ -56,6 +62,7 @@ module MistralClient
       params[:env] = @env if @env
       params[:task_name] = @task_name if @task_name
       body[:params] = params unless params.empty?
+      body[:input] = input unless input.nil?
 
       resp = @server.post(PATH, body.to_json, json: true)
       ivars_from_response(resp)

data/lib/mistral_client/health.rb

@@ -0,0 +1,14 @@
+module MistralClient
+  class Health < Base
+    PATH = ''.freeze
+
+    def initialize(server)
+      super()
+      @server = server
+    end
+
+    def get
+      @server.get(PATH.to_s)
+    end
+  end
+end

data/lib/mistral_client/mixins/definable.rb

@@ -3,9 +3,8 @@ module MistralClient
     module Definable
       # rubocop:disable Metrics/MethodLength
       def parse_definition(definition)
-        if definition.is_a?(Hash) || definition.is_a?(Array)
-          return YAML.dump(definition)
-        end
+        return YAML.dump(definition) if definition.is_a?(Hash) || definition.is_a?(Array)
+
         definition = File.read(definition) if File.exist?(definition)
         # Called outside the if/else to validate the YAML.
         parsed = YAML.safe_load(definition, [], [], true)

data/lib/mistral_client/mixins/deletable.rb

@@ -4,6 +4,7 @@ module MistralClient
       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

data/lib/mistral_client/mixins/mistral_object.rb

@@ -6,6 +6,7 @@ module MistralClient
 
         %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
@@ -26,7 +27,9 @@ module MistralClient
       end
 
       # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/PerceivedComplexity
       def ivars_from_response(resp)
         klass = self.class
         @id = resp['id']
@@ -37,15 +40,15 @@ module MistralClient
           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
+          instance_variable_set("@#{var}", DateTime.parse(resp[var])) if resp[var]
         end
         klass::JSON_FIELDS.each do |var|
           instance_variable_set("@#{var}", JSON.parse(resp[var])) if resp[var]
         end
       end
+      # rubocop:enable Metrics/PerceivedComplexity
       # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/AbcSize
     end
   end

data/lib/mistral_client/task.rb

@@ -20,6 +20,7 @@ module MistralClient
     include MistralClient::Mixins::MistralObject
 
     def initialize(server, id: nil)
+      super()
       @server = server
       @path = 'tasks'
       @id = id

data/lib/mistral_client/version.rb

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

data/lib/mistral_client/workflow.rb

@@ -11,6 +11,7 @@ module MistralClient
     include MistralClient::Mixins::Deletable
 
     def initialize(server, definition = nil, id: nil, name: nil)
+      super()
       @server = server
       if definition
         @definition = parse_definition(definition)
@@ -21,8 +22,12 @@ module MistralClient
       end
     end
 
-    def execute!(env: nil, task_name: nil)
-      Execution.new(@server, workflow_id: @id, env: env, task_name: task_name)
+    def execute!(env: nil, task_name: nil, input: nil)
+      Execution.new(@server,
+                    workflow_id: @id,
+                    env: env,
+                    task_name: task_name,
+                    input: input)
     end
 
     def valid?(definition)

data/mistral_client.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mistral_client/version'
 
@@ -10,11 +10,11 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Ruby client for Mistral.'
   spec.description   = "A Ruby client for OpenStack's Mistral " \
-                       '<https://wiki.openstack.org/wiki/Mistral>.'
+                       '<https://docs.openstack.org/mistral/latest/>.'
   spec.homepage      = 'https://github.com/civisanalytics/mistral_client'
-  spec.license       = 'BSD 3-Clause'
+  spec.license       = 'BSD-3-Clause'
 
-  spec.required_ruby_version = '~> 2.3'
+  spec.required_ruby_version = ['>= 2.5', '< 3.1']
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -22,12 +22,12 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_dependency 'httparty', '~> 0.15'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 1.9.1'
+  spec.add_development_dependency 'vcr', '~> 5.1'
+  spec.add_development_dependency 'webmock', '~> 3.8'
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: mistral_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Matt Brennan
 - Jeff Cousens
 - Mike Saelim
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -18,113 +18,113 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 1.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 1.9.1
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.8'
   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>.
+        version: '3.8'
+description: A Ruby client for OpenStack's Mistral <https://docs.openstack.org/mistral/latest/>.
 email:
 - opensource@civisanalytics.com
 executables: []
@@ -152,6 +152,7 @@ files:
 - lib/mistral_client/environment.rb
 - lib/mistral_client/error.rb
 - lib/mistral_client/execution.rb
+- lib/mistral_client/health.rb
 - lib/mistral_client/mixins/definable.rb
 - lib/mistral_client/mixins/deletable.rb
 - lib/mistral_client/mixins/mistral_object.rb
@@ -161,26 +162,28 @@ files:
 - mistral_client.gemspec
 homepage: https://github.com/civisanalytics/mistral_client
 licenses:
-- BSD 3-Clause
+- BSD-3-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Ruby client for Mistral.
 test_files: []