dkron-ruby 1.0.0

data/docs/JobsApi.md

@@ -0,0 +1,295 @@
+# Dkron::JobsApi
+
+All URIs are relative to *http://localhost:8080/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_or_update_job**](JobsApi.md#create_or_update_job) | **POST** /jobs | 
+[**delete_job**](JobsApi.md#delete_job) | **DELETE** /jobs/{job_name} | 
+[**get_jobs**](JobsApi.md#get_jobs) | **GET** /jobs | 
+[**run_job**](JobsApi.md#run_job) | **POST** /jobs/{job_name} | 
+[**show_job_by_name**](JobsApi.md#show_job_by_name) | **GET** /jobs/{job_name} | 
+[**toggle_job**](JobsApi.md#toggle_job) | **POST** /jobs/{job_name}/toggle | 
+
+
+# **create_or_update_job**
+> Job create_or_update_job(body, opts)
+
+
+
+Create or updates a new job. 
+
+### Example
+```ruby
+# load the gem
+require 'dkron-ruby'
+
+api_instance = Dkron::JobsApi.new
+
+body = Dkron::Job.new # Job | Updated job object
+
+opts = { 
+  runoncreate: nil # Object | If present, regardless of any value, causes the job to be run immediately after being succesfully created or updated.
+}
+
+begin
+  result = api_instance.create_or_update_job(body, opts)
+  p result
+rescue Dkron::ApiError => e
+  puts "Exception when calling JobsApi->create_or_update_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Job**](Job.md)| Updated job object | 
+ **runoncreate** | [**Object**](.md)| If present, regardless of any value, causes the job to be run immediately after being succesfully created or updated. | [optional] 
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_job**
+> Job delete_job(job_name)
+
+
+
+Delete a job. 
+
+### Example
+```ruby
+# load the gem
+require 'dkron-ruby'
+
+api_instance = Dkron::JobsApi.new
+
+job_name = 'job_name_example' # String | The job that needs to be deleted.
+
+
+begin
+  result = api_instance.delete_job(job_name)
+  p result
+rescue Dkron::ApiError => e
+  puts "Exception when calling JobsApi->delete_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_name** | **String**| The job that needs to be deleted. | 
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_jobs**
+> Array<Job> get_jobs(opts)
+
+
+
+List jobs. 
+
+### Example
+```ruby
+# load the gem
+require 'dkron-ruby'
+
+api_instance = Dkron::JobsApi.new
+
+opts = { 
+  metadata: ['metadata_example'] # Array<String> | Filter jobs by metadata
+}
+
+begin
+  result = api_instance.get_jobs(opts)
+  p result
+rescue Dkron::ApiError => e
+  puts "Exception when calling JobsApi->get_jobs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **metadata** | [**Array&lt;String&gt;**](String.md)| Filter jobs by metadata | [optional] 
+
+### Return type
+
+[**Array&lt;Job&gt;**](Job.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **run_job**
+> Job run_job(job_name)
+
+
+
+Executes a job. 
+
+### Example
+```ruby
+# load the gem
+require 'dkron-ruby'
+
+api_instance = Dkron::JobsApi.new
+
+job_name = 'job_name_example' # String | The job that needs to be run.
+
+
+begin
+  result = api_instance.run_job(job_name)
+  p result
+rescue Dkron::ApiError => e
+  puts "Exception when calling JobsApi->run_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_name** | **String**| The job that needs to be run. | 
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **show_job_by_name**
+> Job show_job_by_name(job_name)
+
+
+
+Show a job. 
+
+### Example
+```ruby
+# load the gem
+require 'dkron-ruby'
+
+api_instance = Dkron::JobsApi.new
+
+job_name = 'job_name_example' # String | The job that needs to be fetched.
+
+
+begin
+  result = api_instance.show_job_by_name(job_name)
+  p result
+rescue Dkron::ApiError => e
+  puts "Exception when calling JobsApi->show_job_by_name: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_name** | **String**| The job that needs to be fetched. | 
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **toggle_job**
+> Job toggle_job(job_name)
+
+
+
+Toggle a job. 
+
+### Example
+```ruby
+# load the gem
+require 'dkron-ruby'
+
+api_instance = Dkron::JobsApi.new
+
+job_name = 'job_name_example' # String | The job that needs to be toggled.
+
+
+begin
+  result = api_instance.toggle_job(job_name)
+  p result
+rescue Dkron::ApiError => e
+  puts "Exception when calling JobsApi->toggle_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_name** | **String**| The job that needs to be toggled. | 
+
+### Return type
+
+[**Job**](Job.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Member.md

@@ -0,0 +1,18 @@
+# Dkron::Member
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Node name | [optional] 
+**addr** | **String** | IP Address | [optional] 
+**port** | **Integer** | Port number | [optional] 
+**tags** | **Hash<String, String>** | Tags asociated with this node | [optional] 
+**status** | **Integer** | The serf status of the node see: https://godoc.org/github.com/hashicorp/serf/serf#MemberStatus | [optional] 
+**protocol_min** | **Integer** | Serf protocol minimum version this node can understand or speak | [optional] 
+**protocol_max** | **Integer** | Serf protocol maximum version this node can understand or speak | [optional] 
+**protocol_cur** | **Integer** | Serf protocol current version this node can understand or speak | [optional] 
+**delegate_min** | **Integer** | Serf delegate protocol minimum version this node can understand or speak | [optional] 
+**delegate_max** | **Integer** | Serf delegate protocol maximum version this node can understand or speak | [optional] 
+**delegate_cur** | **Integer** | Serf delegate protocol current version this node can understand or speak | [optional] 
+
+

data/docs/MembersApi.md

@@ -0,0 +1,49 @@
+# Dkron::MembersApi
+
+All URIs are relative to *http://localhost:8080/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_member**](MembersApi.md#get_member) | **GET** /members | 
+
+
+# **get_member**
+> Array<Member> get_member
+
+
+
+List members. 
+
+### Example
+```ruby
+# load the gem
+require 'dkron-ruby'
+
+api_instance = Dkron::MembersApi.new
+
+begin
+  result = api_instance.get_member
+  p result
+rescue Dkron::ApiError => e
+  puts "Exception when calling MembersApi->get_member: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Member>**](Member.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Processors.md

@@ -0,0 +1,7 @@
+# Dkron::Processors
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Status.md

@@ -0,0 +1,10 @@
+# Dkron::Status
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent** | **Object** | Node basic details | [optional] 
+**serf** | **Object** | Serf status | [optional] 
+**tags** | **Object** | Tags asociated with this node | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id=""
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id=""
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note=""
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/dkron-ruby.rb

@@ -0,0 +1,48 @@
+=begin
+#Dkron REST API
+
+#You can communicate with Dkron using a RESTful JSON API over HTTP. Dkron nodes usually listen on port `8080` for API requests. All examples in this section assume that you've found a running leader at `localhost:8080`.  Dkron implements a RESTful JSON API over HTTP to communicate with software clients. Dkron listens in port `8080` by default. All examples in this section assume that you're using the default port.  Default API responses are unformatted JSON add the `pretty=true` param to format the response. 
+
+OpenAPI spec version: 2.2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.13
+
+=end
+
+# Common files
+require 'dkron-ruby/api_client'
+require 'dkron-ruby/api_error'
+require 'dkron-ruby/version'
+require 'dkron-ruby/configuration'
+
+# Models
+require 'dkron-ruby/models/execution'
+require 'dkron-ruby/models/job'
+require 'dkron-ruby/models/member'
+require 'dkron-ruby/models/processors'
+require 'dkron-ruby/models/status'
+
+# APIs
+require 'dkron-ruby/api/default_api'
+require 'dkron-ruby/api/executions_api'
+require 'dkron-ruby/api/jobs_api'
+require 'dkron-ruby/api/members_api'
+
+module Dkron
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Dkron.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end