dkron-ruby 1.0.0

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

@@ -0,0 +1,403 @@
+=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
+
+require 'date'
+
+module Dkron
+  # A Job represents a scheduled task to execute.
+  class Job
+    # Name for the job.
+    attr_accessor :name
+
+    # Nice name for the job. Optional.
+    attr_accessor :displayname
+
+    # Cron expression for the job.
+    attr_accessor :schedule
+
+    # Timezone where the job will be executed. By default and when field is set to empty string, the job will run in local time.
+    attr_accessor :timezone
+
+    # Owner of the job
+    attr_accessor :owner
+
+    # Email of the owner
+    attr_accessor :owner_email
+
+    # Number of successful executions
+    attr_accessor :success_count
+
+    # Number of failed executions
+    attr_accessor :error_count
+
+    # Last time this job executed successfully
+    attr_accessor :last_success
+
+    # Last time this job failed
+    attr_accessor :last_error
+
+    # Disabled state of the job
+    attr_accessor :disabled
+
+    # 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
+
+    # The name/id of the job that will trigger the execution of this job
+    attr_accessor :parent_job
+
+    # Array containing the jobs that depends on this one
+    attr_accessor :dependent_jobs
+
+    attr_accessor :processors
+
+    # Concurrency policy for the job allow/forbid
+    attr_accessor :concurrency
+
+    # 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',
+        :'owner_email' => :'owner_email',
+        :'success_count' => :'success_count',
+        :'error_count' => :'error_count',
+        :'last_success' => :'last_success',
+        :'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',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'displayname' => :'String',
+        :'schedule' => :'String',
+        :'timezone' => :'String',
+        :'owner' => :'String',
+        :'owner_email' => :'String',
+        :'success_count' => :'Integer',
+        :'error_count' => :'Integer',
+        :'last_success' => :'DateTime',
+        :'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' => :'Hash<String, String>',
+        :'status' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'name')
+        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
+
+      if attributes.has_key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.has_key?(:'owner')
+        self.owner = attributes[:'owner']
+      end
+
+      if attributes.has_key?(:'owner_email')
+        self.owner_email = attributes[:'owner_email']
+      end
+
+      if attributes.has_key?(:'success_count')
+        self.success_count = attributes[:'success_count']
+      end
+
+      if attributes.has_key?(:'error_count')
+        self.error_count = attributes[:'error_count']
+      end
+
+      if attributes.has_key?(:'last_success')
+        self.last_success = attributes[:'last_success']
+      end
+
+      if attributes.has_key?(:'last_error')
+        self.last_error = attributes[:'last_error']
+      end
+
+      if attributes.has_key?(:'disabled')
+        self.disabled = attributes[:'disabled']
+      end
+
+      if attributes.has_key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Hash)
+          self.tags = value
+        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
+
+      if attributes.has_key?(:'parent_job')
+        self.parent_job = attributes[:'parent_job']
+      end
+
+      if attributes.has_key?(:'dependent_jobs')
+        if (value = attributes[:'dependent_jobs']).is_a?(Array)
+          self.dependent_jobs = value
+        end
+      end
+
+      if attributes.has_key?(:'processors')
+        self.processors = attributes[:'processors']
+      end
+
+      if attributes.has_key?(:'concurrency')
+        self.concurrency = attributes[:'concurrency']
+      end
+
+      if attributes.has_key?(:'executor')
+        self.executor = attributes[:'executor']
+      end
+
+      if attributes.has_key?(:'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
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @schedule.nil?
+        invalid_properties.push('invalid value for "schedule", schedule cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @name.nil?
+      return false if @schedule.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      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 &&
+          owner_email == o.owner_email &&
+          success_count == o.success_count &&
+          error_count == o.error_count &&
+          last_success == o.last_success &&
+          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 &&
+          status == o.status
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def 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
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      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 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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = Dkron.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,288 @@
+=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
+
+require 'date'
+
+module Dkron
+  # A member represents a cluster member node.
+  class Member
+    # Node name
+    attr_accessor :name
+
+    # IP Address
+    attr_accessor :addr
+
+    # Port number
+    attr_accessor :port
+
+    # Tags asociated with this node
+    attr_accessor :tags
+
+    # The serf status of the node see: https://godoc.org/github.com/hashicorp/serf/serf#MemberStatus
+    attr_accessor :status
+
+    # Serf protocol minimum version this node can understand or speak
+    attr_accessor :protocol_min
+
+    # Serf protocol maximum version this node can understand or speak
+    attr_accessor :protocol_max
+
+    # Serf protocol current version this node can understand or speak
+    attr_accessor :protocol_cur
+
+    # Serf delegate protocol minimum version this node can understand or speak
+    attr_accessor :delegate_min
+
+    # Serf delegate protocol maximum version this node can understand or speak
+    attr_accessor :delegate_max
+
+    # Serf delegate protocol current version this node can understand or speak
+    attr_accessor :delegate_cur
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'Name',
+        :'addr' => :'Addr',
+        :'port' => :'Port',
+        :'tags' => :'Tags',
+        :'status' => :'Status',
+        :'protocol_min' => :'ProtocolMin',
+        :'protocol_max' => :'ProtocolMax',
+        :'protocol_cur' => :'ProtocolCur',
+        :'delegate_min' => :'DelegateMin',
+        :'delegate_max' => :'DelegateMax',
+        :'delegate_cur' => :'DelegateCur'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'addr' => :'String',
+        :'port' => :'Integer',
+        :'tags' => :'Hash<String, String>',
+        :'status' => :'Integer',
+        :'protocol_min' => :'Integer',
+        :'protocol_max' => :'Integer',
+        :'protocol_cur' => :'Integer',
+        :'delegate_min' => :'Integer',
+        :'delegate_max' => :'Integer',
+        :'delegate_cur' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'Name')
+        self.name = attributes[:'Name']
+      end
+
+      if attributes.has_key?(:'Addr')
+        self.addr = attributes[:'Addr']
+      end
+
+      if attributes.has_key?(:'Port')
+        self.port = attributes[:'Port']
+      end
+
+      if attributes.has_key?(:'Tags')
+        if (value = attributes[:'Tags']).is_a?(Hash)
+          self.tags = value
+        end
+      end
+
+      if attributes.has_key?(:'Status')
+        self.status = attributes[:'Status']
+      end
+
+      if attributes.has_key?(:'ProtocolMin')
+        self.protocol_min = attributes[:'ProtocolMin']
+      end
+
+      if attributes.has_key?(:'ProtocolMax')
+        self.protocol_max = attributes[:'ProtocolMax']
+      end
+
+      if attributes.has_key?(:'ProtocolCur')
+        self.protocol_cur = attributes[:'ProtocolCur']
+      end
+
+      if attributes.has_key?(:'DelegateMin')
+        self.delegate_min = attributes[:'DelegateMin']
+      end
+
+      if attributes.has_key?(:'DelegateMax')
+        self.delegate_max = attributes[:'DelegateMax']
+      end
+
+      if attributes.has_key?(:'DelegateCur')
+        self.delegate_cur = attributes[:'DelegateCur']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          addr == o.addr &&
+          port == o.port &&
+          tags == o.tags &&
+          status == o.status &&
+          protocol_min == o.protocol_min &&
+          protocol_max == o.protocol_max &&
+          protocol_cur == o.protocol_cur &&
+          delegate_min == o.delegate_min &&
+          delegate_max == o.delegate_max &&
+          delegate_cur == o.delegate_cur
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [name, addr, port, tags, status, protocol_min, protocol_max, protocol_cur, delegate_min, delegate_max, delegate_cur].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      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 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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = Dkron.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end