dkron-rb 0.11.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 49834e6dc68ff58937a3d32e05959ba28251551c
-  data.tar.gz: d84b01ede79f593daadeee41eba39f1f7d2afb61
+SHA256:
+  metadata.gz: 5e525a0fff59d56719b7dcd52ebebb35de2561bbbc053212f73e78cec344e6f2
+  data.tar.gz: 3ac0326c956ab1a6947bfefeba6c748f9ef0c62bd39e145c17d8e04c60a43e58
 SHA512:
-  metadata.gz: b3f3826cea04680a60ca4e9411050b56e1bcd0454d941a42d4d1a11efb7d92c3c79023684c0c83f7543bfd9fd9692e7bbaea4e10b30b5454663b5201944083ba
-  data.tar.gz: e447340e8a3c3cb20f34b18b09b7ded1d4fcea68e7f01cae2aabad1955fb947a878e357ec696ebbf50a59015c0e9aee154677283195317458fbb2f3ead77c971
+  metadata.gz: 8af3e0af0cb5f73d2aeddff537d9102f480ec4d56277c03af5fec7c497c2f830b26ea1a78f90cd61fba283f2c305d9df795d7fd8424a4273fe6b8babb247873a
+  data.tar.gz: bf534a2000f0966a41f3d51ac7245d207d3339201afe498e05ba10a2e520dd9e6d86ebb81ba2878160c4f697bbc3a0eac27d3d7dcb5c89115264d04f86407410

data/README.md

@@ -6,8 +6,8 @@ You can communicate with Dkron using a RESTful JSON API over HTTP. Dkron nodes u
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 0.11.2
-- Package version: 0.10.0
+- API version: 1
+- Package version: 1.0.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,21 +23,21 @@ gem build dkron-rb.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./dkron-rb-0.10.0.gem
+gem install ./dkron-rb-1.0.0.gem
 ```
-(for development, run `gem install --dev ./dkron-rb-0.10.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dkron-rb-1.0.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'dkron-rb', '~> 0.10.0'
+    gem 'dkron-rb', '~> 1.0.0'
 
 ### Install from Git
 
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
 
-    gem 'dkron-rb', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+    gem 'dkron-rb', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
 
 ### Include the Ruby code directly
 
@@ -80,6 +80,7 @@ Class | Method | HTTP request | Description
 *Dkron::JobsApi* | [**get_jobs**](docs/JobsApi.md#get_jobs) | **GET** /jobs | 
 *Dkron::JobsApi* | [**run_job**](docs/JobsApi.md#run_job) | **POST** /jobs/{job_name} | 
 *Dkron::JobsApi* | [**show_job_by_name**](docs/JobsApi.md#show_job_by_name) | **GET** /jobs/{job_name} | 
+*Dkron::JobsApi* | [**toggle_job**](docs/JobsApi.md#toggle_job) | **POST** /jobs/{job_name}/toggle | 
 *Dkron::MembersApi* | [**get_member**](docs/MembersApi.md#get_member) | **GET** /members | 
 
 

data/Rakefile

@@ -6,7 +6,3 @@ begin
 rescue LoadError
   # no rspec available
 end
-
-task(:codegen) do
-  sh('swagger-codegen', 'generate', '-i', 'https://dkron.io/swagger.yaml', '-l', 'ruby', '-o', '.', '-c', 'config.json')
-end

data/dkron-rb.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-#
+
 =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: 0.11.2
+OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.2
 
 =end
 
@@ -19,17 +19,16 @@ Gem::Specification.new do |s|
   s.name        = "dkron-rb"
   s.version     = Dkron::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Swagger-Codegen"]
-  s.email       = [""]
-  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.authors     = ["Victor Castell"]
+  s.email       = ["victor.castell@jobandtalent.com"]
+  s.homepage    = "https://dkron.io"
   s.summary     = "Dkron REST API Ruby Gem"
-  s.description = "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. "
-  # TODO uncommnet and update below with a proper license 
-  #s.license     = "Apache 2.0"
+  s.description = "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. "
+  s.license     = 'Apache 2.0'
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
-  s.add_runtime_dependency 'json', '~> 1', '>= 1.4'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
@@ -39,7 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
   s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
 
-  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]

data/docs/ExecutionsApi.md

@@ -21,7 +21,7 @@ require 'dkron-rb'
 
 api_instance = Dkron::ExecutionsApi.new
 
-job_name = "job_name_example" # String | The job that owns the executions to be fetched.
+job_name = 'job_name_example' # String | The job that owns the executions to be fetched.
 
 
 begin

data/docs/JobsApi.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**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**
@@ -71,7 +72,7 @@ require 'dkron-rb'
 
 api_instance = Dkron::JobsApi.new
 
-job_name = "job_name_example" # String | The job that needs to be deleted.
+job_name = 'job_name_example' # String | The job that needs to be deleted.
 
 
 begin
@@ -104,7 +105,7 @@ No authorization required
 
 
 # **get_jobs**
-> Array<Job> get_jobs
+> Array<Job> get_jobs(opts)
 
 
 
@@ -117,8 +118,12 @@ require 'dkron-rb'
 
 api_instance = Dkron::JobsApi.new
 
+opts = { 
+  tags: ['tags_example'] # Array<String> | Filter jobs by tags
+}
+
 begin
-  result = api_instance.get_jobs
+  result = api_instance.get_jobs(opts)
   p result
 rescue Dkron::ApiError => e
   puts "Exception when calling JobsApi->get_jobs: #{e}"
@@ -126,7 +131,10 @@ end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tags** | [**Array&lt;String&gt;**](String.md)| Filter jobs by tags | [optional] 
 
 ### Return type
 
@@ -157,7 +165,7 @@ require 'dkron-rb'
 
 api_instance = Dkron::JobsApi.new
 
-job_name = "job_name_example" # String | The job that needs to be run.
+job_name = 'job_name_example' # String | The job that needs to be run.
 
 
 begin
@@ -203,7 +211,7 @@ require 'dkron-rb'
 
 api_instance = Dkron::JobsApi.new
 
-job_name = "job_name_example" # String | The job that needs to be fetched.
+job_name = 'job_name_example' # String | The job that needs to be fetched.
 
 
 begin
@@ -235,3 +243,49 @@ No authorization required
 
 
 
+# **toggle_job**
+> Job toggle_job(job_name)
+
+
+
+Toggle a job. 
+
+### Example
+```ruby
+# load the gem
+require 'dkron-rb'
+
+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/Status.md

@@ -3,5 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**agent** | [****](.md) | Node basic details | [optional] 
+**serf** | [****](.md) | Serf status | [optional] 
+**tags** | [****](.md) | Tags asociated with this node | [optional] 
 
 

data/git_push.sh

@@ -11,17 +11,17 @@ git_repo_id=$2
 release_note=$3
 
 if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
+    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="GIT_REPO_ID"
+    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="Minor update"
+    release_note=""
     echo "[INFO] No command line input provided. Set \$release_note to $release_note"
 fi
 

data/lib/dkron-rb.rb

@@ -3,10 +3,10 @@
 
 #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: 0.11.2
+OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.2
 
 =end
 

data/lib/dkron-rb/api/default_api.rb

@@ -3,14 +3,14 @@
 
 #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: 0.11.2
+OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.2
 
 =end
 
-require "uri"
+require 'uri'
 
 module Dkron
   class DefaultApi
@@ -19,26 +19,23 @@ module Dkron
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-
-    # 
     # List leader of cluster. 
     # @param [Hash] opts the optional parameters
     # @return [Member]
     def get_leader(opts = {})
       data, _status_code, _headers = get_leader_with_http_info(opts)
-      return data
+      data
     end
 
-    # 
     # List leader of cluster. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Member, Fixnum, Hash)>] Member data, response status code and response headers
     def get_leader_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: DefaultApi.get_leader ..."
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_leader ...'
       end
       # resource path
-      local_var_path = "/leader"
+      local_var_path = '/leader'
 
       # query parameters
       query_params = {}
@@ -68,26 +65,23 @@ module Dkron
       end
       return data, status_code, headers
     end
-
-    # 
     # Force the node to leave the cluster. 
     # @param [Hash] opts the optional parameters
     # @return [Array<Member>]
     def leave(opts = {})
       data, _status_code, _headers = leave_with_http_info(opts)
-      return data
+      data
     end
 
-    # 
     # Force the node to leave the cluster. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Member>, Fixnum, Hash)>] Array<Member> data, response status code and response headers
     def leave_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: DefaultApi.leave ..."
+        @api_client.config.logger.debug 'Calling API: DefaultApi.leave ...'
       end
       # resource path
-      local_var_path = "/leave"
+      local_var_path = '/leave'
 
       # query parameters
       query_params = {}
@@ -117,26 +111,23 @@ module Dkron
       end
       return data, status_code, headers
     end
-
-    # 
     # Gets `Status` object. 
     # @param [Hash] opts the optional parameters
     # @return [Status]
     def status(opts = {})
       data, _status_code, _headers = status_with_http_info(opts)
-      return data
+      data
     end
 
-    # 
     # Gets &#x60;Status&#x60; object. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Status, Fixnum, Hash)>] Status data, response status code and response headers
     def status_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: DefaultApi.status ..."
+        @api_client.config.logger.debug 'Calling API: DefaultApi.status ...'
       end
       # resource path
-      local_var_path = "/"
+      local_var_path = '/'
 
       # query parameters
       query_params = {}

data/lib/dkron-rb/api/executions_api.rb

@@ -3,14 +3,14 @@
 
 #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: 0.11.2
+OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.2
 
 =end
 
-require "uri"
+require 'uri'
 
 module Dkron
   class ExecutionsApi
@@ -19,32 +19,29 @@ module Dkron
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-
-    # 
     # List executions. 
     # @param job_name The job that owns the executions to be fetched.
     # @param [Hash] opts the optional parameters
     # @return [Array<Execution>]
     def list_executions_by_job(job_name, opts = {})
       data, _status_code, _headers = list_executions_by_job_with_http_info(job_name, opts)
-      return data
+      data
     end
 
-    # 
     # List executions. 
     # @param job_name The job that owns the executions to be fetched.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Execution>, Fixnum, Hash)>] Array<Execution> data, response status code and response headers
     def list_executions_by_job_with_http_info(job_name, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ExecutionsApi.list_executions_by_job ..."
+        @api_client.config.logger.debug 'Calling API: ExecutionsApi.list_executions_by_job ...'
       end
       # verify the required parameter 'job_name' is set
       if @api_client.config.client_side_validation && job_name.nil?
         fail ArgumentError, "Missing the required parameter 'job_name' when calling ExecutionsApi.list_executions_by_job"
       end
       # resource path
-      local_var_path = "/jobs/{job_name}/executions".sub('{' + 'job_name' + '}', job_name.to_s)
+      local_var_path = '/jobs/{job_name}/executions'.sub('{' + 'job_name' + '}', job_name.to_s)
 
       # query parameters
       query_params = {}