dkron-rb 1.0.0 → 1.1.0

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.2
+Swagger Codegen version: 2.4.18
 
 =end
 

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.2
+Swagger Codegen version: 2.4.18
 
 =end
 
@@ -22,6 +22,7 @@ module Dkron
     # Create or updates a new job. 
     # @param body Updated job object
     # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :runoncreate If present, regardless of any value, causes the job to be run immediately after being succesfully created or updated.
     # @return [Job]
     def create_or_update_job(body, opts = {})
       data, _status_code, _headers = create_or_update_job_with_http_info(body, opts)
@@ -31,6 +32,7 @@ module Dkron
     # Create or updates a new job. 
     # @param body Updated job object
     # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :runoncreate If present, regardless of any value, causes the job to be run immediately after being succesfully created or updated.
     # @return [Array<(Job, Fixnum, Hash)>] Job data, response status code and response headers
     def create_or_update_job_with_http_info(body, opts = {})
       if @api_client.config.debugging
@@ -45,6 +47,7 @@ module Dkron
 
       # query parameters
       query_params = {}
+      query_params[:'runoncreate'] = opts[:'runoncreate'] if !opts[:'runoncreate'].nil?
 
       # header parameters
       header_params = {}
@@ -125,7 +128,12 @@ module Dkron
     end
     # List jobs. 
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :tags Filter jobs by tags
+    # @option opts [Array<String>] :metadata Filter jobs by metadata
+    # @option opts [String] :_sort Sorting field
+    # @option opts [String] :_order Sort order (ASC/DESC)
+    # @option opts [String] :q Filter query text
+    # @option opts [Integer] :_start Start index
+    # @option opts [Integer] :_end End index
     # @return [Array<Job>]
     def get_jobs(opts = {})
       data, _status_code, _headers = get_jobs_with_http_info(opts)
@@ -134,7 +142,12 @@ module Dkron
 
     # List jobs. 
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :tags Filter jobs by tags
+    # @option opts [Array<String>] :metadata Filter jobs by metadata
+    # @option opts [String] :_sort Sorting field
+    # @option opts [String] :_order Sort order (ASC/DESC)
+    # @option opts [String] :q Filter query text
+    # @option opts [Integer] :_start Start index
+    # @option opts [Integer] :_end End index
     # @return [Array<(Array<Job>, Fixnum, Hash)>] Array<Job> data, response status code and response headers
     def get_jobs_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -145,7 +158,12 @@ module Dkron
 
       # query parameters
       query_params = {}
-      query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :multi) if !opts[:'tags'].nil?
+      query_params[:'metadata'] = @api_client.build_collection_param(opts[:'metadata'], :multi) if !opts[:'metadata'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+      query_params[:'_order'] = opts[:'_order'] if !opts[:'_order'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'_start'] = opts[:'_start'] if !opts[:'_start'].nil?
+      query_params[:'_end'] = opts[:'_end'] if !opts[:'_end'].nil?
 
       # header parameters
       header_params = {}
@@ -172,6 +190,59 @@ module Dkron
       end
       return data, status_code, headers
     end
+    # Restore jobs from json file. 
+    # @param file Json file that needs to be restored.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Restore>]
+    def restore(file, opts = {})
+      data, _status_code, _headers = restore_with_http_info(file, opts)
+      data
+    end
+
+    # Restore jobs from json file. 
+    # @param file Json file that needs to be restored.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Restore>, Fixnum, Hash)>] Array<Restore> data, response status code and response headers
+    def restore_with_http_info(file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.restore ...'
+      end
+      # verify the required parameter 'file' is set
+      if @api_client.config.client_side_validation && file.nil?
+        fail ArgumentError, "Missing the required parameter 'file' when calling JobsApi.restore"
+      end
+      # resource path
+      local_var_path = '/restore'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params['file'] = file
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Restore>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#restore\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Executes a job. 
     # @param job_name The job that needs to be run.
     # @param [Hash] opts the optional parameters

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.2
+Swagger Codegen version: 2.4.18
 
 =end
 

data/lib/dkron-rb/api_client.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.2
+Swagger Codegen version: 2.4.18
 
 =end
 
@@ -15,7 +15,7 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'typhoeus'
-require 'uri'
+require 'addressable/uri'
 
 module Dkron
   class ApiClient
@@ -63,7 +63,7 @@ module Dkron
                             :message => response.return_message)
         else
           fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
+                            :response_headers => response.headers.to_h,
                             :response_body => response.body),
                response.status_message
         end
@@ -111,6 +111,8 @@ module Dkron
         :verbose => @config.debugging
       }
 
+      req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
+
       # set custom cert, if provided
       req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
 
@@ -263,7 +265,7 @@ module Dkron
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
+      Addressable::URI.encode(@config.base_url + path)
     end
 
     # Builds the HTTP request body

data/lib/dkron-rb/api_error.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.2
+Swagger Codegen version: 2.4.18
 
 =end
 

data/lib/dkron-rb/configuration.rb

@@ -6,11 +6,11 @@
 OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.2
+Swagger Codegen version: 2.4.18
 
 =end
 
-require 'uri'
+require 'addressable/uri'
 
 module Dkron
   class Configuration
@@ -175,7 +175,7 @@ module Dkron
 
     def base_url
       url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      Addressable::URI.encode(url)
     end
 
     # Gets API key (with prefix if set).

data/lib/dkron-rb/models/execution.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.2
+Swagger Codegen version: 2.4.18
 
 =end
 
@@ -135,7 +135,7 @@ module Dkron
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
             self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
@@ -231,5 +231,6 @@ module Dkron
         value
       end
     end
+
   end
 end

data/lib/dkron-rb/models/job.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.2
+Swagger Codegen version: 2.4.18
 
 =end
 
@@ -15,9 +15,12 @@ require 'date'
 module Dkron
   # A Job represents a scheduled task to execute.
   class Job
-    # Name for the job.
+    # Name for the job. Use only lower case letters (unicode), digits, underscore and dash.
     attr_accessor :name
 
+    # Nice name for the job. Optional.
+    attr_accessor :displayname
+
     # Cron expression for the job.
     attr_accessor :schedule
 
@@ -48,6 +51,9 @@ module Dkron
     # Target nodes tags of this job
     attr_accessor :tags
 
+    # Extra metadata tags for this job
+    attr_accessor :metadata
+
     # Number of times to retry a failed job execution
     attr_accessor :retries
 
@@ -65,12 +71,17 @@ module Dkron
     # Executor plugin used to run the job
     attr_accessor :executor
 
+    # Executor plugin parameters
     attr_accessor :executor_config
 
+    # Status of the job
+    attr_accessor :status
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
+        :'displayname' => :'displayname',
         :'schedule' => :'schedule',
         :'timezone' => :'timezone',
         :'owner' => :'owner',
@@ -81,13 +92,15 @@ module Dkron
         :'last_error' => :'last_error',
         :'disabled' => :'disabled',
         :'tags' => :'tags',
+        :'metadata' => :'metadata',
         :'retries' => :'retries',
         :'parent_job' => :'parent_job',
         :'dependent_jobs' => :'dependent_jobs',
         :'processors' => :'processors',
         :'concurrency' => :'concurrency',
         :'executor' => :'executor',
-        :'executor_config' => :'executor_config'
+        :'executor_config' => :'executor_config',
+        :'status' => :'status'
       }
     end
 
@@ -95,6 +108,7 @@ module Dkron
     def self.swagger_types
       {
         :'name' => :'String',
+        :'displayname' => :'String',
         :'schedule' => :'String',
         :'timezone' => :'String',
         :'owner' => :'String',
@@ -105,13 +119,15 @@ module Dkron
         :'last_error' => :'DateTime',
         :'disabled' => :'BOOLEAN',
         :'tags' => :'Hash<String, String>',
+        :'metadata' => :'Hash<String, String>',
         :'retries' => :'Integer',
         :'parent_job' => :'String',
         :'dependent_jobs' => :'Array<String>',
         :'processors' => :'Processors',
         :'concurrency' => :'String',
         :'executor' => :'String',
-        :'executor_config' => :'ExecutorConfig'
+        :'executor_config' => :'Hash<String, String>',
+        :'status' => :'String'
       }
     end
 
@@ -127,6 +143,10 @@ module Dkron
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'displayname')
+        self.displayname = attributes[:'displayname']
+      end
+
       if attributes.has_key?(:'schedule')
         self.schedule = attributes[:'schedule']
       end
@@ -169,6 +189,12 @@ module Dkron
         end
       end
 
+      if attributes.has_key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
       if attributes.has_key?(:'retries')
         self.retries = attributes[:'retries']
       end
@@ -196,7 +222,13 @@ module Dkron
       end
 
       if attributes.has_key?(:'executor_config')
-        self.executor_config = attributes[:'executor_config']
+        if (value = attributes[:'executor_config']).is_a?(Hash)
+          self.executor_config = value
+        end
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
       end
     end
 
@@ -229,6 +261,7 @@ module Dkron
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
+          displayname == o.displayname &&
           schedule == o.schedule &&
           timezone == o.timezone &&
           owner == o.owner &&
@@ -239,13 +272,15 @@ module Dkron
           last_error == o.last_error &&
           disabled == o.disabled &&
           tags == o.tags &&
+          metadata == o.metadata &&
           retries == o.retries &&
           parent_job == o.parent_job &&
           dependent_jobs == o.dependent_jobs &&
           processors == o.processors &&
           concurrency == o.concurrency &&
           executor == o.executor &&
-          executor_config == o.executor_config
+          executor_config == o.executor_config &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -257,7 +292,7 @@ module Dkron
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, schedule, timezone, owner, owner_email, success_count, error_count, last_success, last_error, disabled, tags, retries, parent_job, dependent_jobs, processors, concurrency, executor, executor_config].hash
+      [name, displayname, schedule, timezone, owner, owner_email, success_count, error_count, last_success, last_error, disabled, tags, metadata, retries, parent_job, dependent_jobs, processors, concurrency, executor, executor_config, status].hash
     end
 
     # Builds the object from hash
@@ -267,7 +302,7 @@ module Dkron
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
             self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
@@ -363,5 +398,6 @@ module Dkron
         value
       end
     end
+
   end
 end

data/lib/dkron-rb/models/member.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: 1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.2
+Swagger Codegen version: 2.4.18
 
 =end
 
@@ -187,7 +187,7 @@ module Dkron
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
             self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
@@ -283,5 +283,6 @@ module Dkron
         value
       end
     end
+
   end
 end