iron_titan 0.3.10 → 0.4.0

data/lib/iron_titan/api/runner_api.rb

@@ -3,10 +3,21 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.3.10
+OpenAPI spec version: 0.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -28,12 +39,12 @@ module IronTitan
     # @param [Hash] opts the optional parameters
     # @return [JobWrapper]
     def groups_name_jobs_id_error_post(name, id, body, opts = {})
-      data, status_code, headers = groups_name_jobs_id_error_post_with_http_info(name, id, body, opts)
+      data, _status_code, _headers = groups_name_jobs_id_error_post_with_http_info(name, id, body, opts)
       return data
     end
 
     # Mark job as failed.
-    # Job is marked as failed if it was in a valid state. Job's `finished_at` time is initialized.
+    # Job is marked as failed if it was in a valid state. Job's `finished_at` time is initialized.
     # @param name Name of group for this set of jobs.
     # @param id Job id
     # @param body 
@@ -41,18 +52,14 @@ module IronTitan
     # @return [Array<(JobWrapper, Fixnum, Hash)>] JobWrapper data, response status code and response headers
     def groups_name_jobs_id_error_post_with_http_info(name, id, body, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: RunnerApi#groups_name_jobs_id_error_post ..."
+        @api_client.config.logger.debug "Calling API: RunnerApi.groups_name_jobs_id_error_post ..."
       end
-      
       # verify the required parameter 'name' is set
-      fail "Missing the required parameter 'name' when calling groups_name_jobs_id_error_post" if name.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'name' when calling RunnerApi.groups_name_jobs_id_error_post" if name.nil?
       # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling groups_name_jobs_id_error_post" if id.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'id' when calling RunnerApi.groups_name_jobs_id_error_post" if id.nil?
       # verify the required parameter 'body' is set
-      fail "Missing the required parameter 'body' when calling groups_name_jobs_id_error_post" if body.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'body' when calling RunnerApi.groups_name_jobs_id_error_post" if body.nil?
       # resource path
       local_var_path = "/groups/{name}/jobs/{id}/error".sub('{format}','json').sub('{' + 'name' + '}', name.to_s).sub('{' + 'id' + '}', id.to_s)
 
@@ -63,19 +70,18 @@ module IronTitan
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
-      _header_accept = ['application/json']
-      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
 
       # HTTP header 'Content-Type'
-      _header_content_type = ['application/json']
-      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
 
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
-      
       auth_names = []
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -98,12 +104,12 @@ module IronTitan
     # @param [Hash] opts the optional parameters
     # @return [JobWrapper]
     def groups_name_jobs_id_start_post(name, id, body, opts = {})
-      data, status_code, headers = groups_name_jobs_id_start_post_with_http_info(name, id, body, opts)
+      data, _status_code, _headers = groups_name_jobs_id_start_post_with_http_info(name, id, body, opts)
       return data
     end
 
-    # Mark job as started, ie: status = &#39;running&#39;
-    # Job status is changed to &#39;running&#39; if it was in a valid state before. Job&#39;s `started_at` time is initialized.
+    # Mark job as started, ie: status &#x3D; &#39;running&#39;
+    # Job status is changed to &#39;running&#39; if it was in a valid state before. Job&#39;s &#x60;started_at&#x60; time is initialized.
     # @param name Name of group for this set of jobs.
     # @param id Job id
     # @param body 
@@ -111,18 +117,14 @@ module IronTitan
     # @return [Array<(JobWrapper, Fixnum, Hash)>] JobWrapper data, response status code and response headers
     def groups_name_jobs_id_start_post_with_http_info(name, id, body, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: RunnerApi#groups_name_jobs_id_start_post ..."
+        @api_client.config.logger.debug "Calling API: RunnerApi.groups_name_jobs_id_start_post ..."
       end
-      
       # verify the required parameter 'name' is set
-      fail "Missing the required parameter 'name' when calling groups_name_jobs_id_start_post" if name.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'name' when calling RunnerApi.groups_name_jobs_id_start_post" if name.nil?
       # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling groups_name_jobs_id_start_post" if id.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'id' when calling RunnerApi.groups_name_jobs_id_start_post" if id.nil?
       # verify the required parameter 'body' is set
-      fail "Missing the required parameter 'body' when calling groups_name_jobs_id_start_post" if body.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'body' when calling RunnerApi.groups_name_jobs_id_start_post" if body.nil?
       # resource path
       local_var_path = "/groups/{name}/jobs/{id}/start".sub('{format}','json').sub('{' + 'name' + '}', name.to_s).sub('{' + 'id' + '}', id.to_s)
 
@@ -133,19 +135,18 @@ module IronTitan
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
-      _header_accept = ['application/json']
-      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
 
       # HTTP header 'Content-Type'
-      _header_content_type = ['application/json']
-      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
 
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
-      
       auth_names = []
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -168,12 +169,12 @@ module IronTitan
     # @param [Hash] opts the optional parameters
     # @return [JobWrapper]
     def groups_name_jobs_id_success_post(name, id, body, opts = {})
-      data, status_code, headers = groups_name_jobs_id_success_post_with_http_info(name, id, body, opts)
+      data, _status_code, _headers = groups_name_jobs_id_success_post_with_http_info(name, id, body, opts)
       return data
     end
 
     # Mark job as succeeded.
-    # Job status is changed to succeeded if it was in a valid state before. Job&#39;s `completed_at` time is initialized.
+    # Job status is changed to succeeded if it was in a valid state before. Job&#39;s &#x60;completed_at&#x60; time is initialized.
     # @param name Name of group for this set of jobs.
     # @param id Job id
     # @param body 
@@ -181,18 +182,14 @@ module IronTitan
     # @return [Array<(JobWrapper, Fixnum, Hash)>] JobWrapper data, response status code and response headers
     def groups_name_jobs_id_success_post_with_http_info(name, id, body, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: RunnerApi#groups_name_jobs_id_success_post ..."
+        @api_client.config.logger.debug "Calling API: RunnerApi.groups_name_jobs_id_success_post ..."
       end
-      
       # verify the required parameter 'name' is set
-      fail "Missing the required parameter 'name' when calling groups_name_jobs_id_success_post" if name.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'name' when calling RunnerApi.groups_name_jobs_id_success_post" if name.nil?
       # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling groups_name_jobs_id_success_post" if id.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'id' when calling RunnerApi.groups_name_jobs_id_success_post" if id.nil?
       # verify the required parameter 'body' is set
-      fail "Missing the required parameter 'body' when calling groups_name_jobs_id_success_post" if body.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'body' when calling RunnerApi.groups_name_jobs_id_success_post" if body.nil?
       # resource path
       local_var_path = "/groups/{name}/jobs/{id}/success".sub('{format}','json').sub('{' + 'name' + '}', name.to_s).sub('{' + 'id' + '}', id.to_s)
 
@@ -203,19 +200,18 @@ module IronTitan
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
-      _header_accept = ['application/json']
-      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
 
       # HTTP header 'Content-Type'
-      _header_content_type = ['application/json']
-      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
 
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = @api_client.object_to_http_body(body)
-      
       auth_names = []
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,

data/lib/iron_titan/api_client.rb

@@ -3,10 +3,21 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.3.10
+OpenAPI spec version: 0.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -27,6 +38,8 @@ module IronTitan
     # @return [Hash]
     attr_accessor :default_headers
 
+    # Initializes the ApiClient
+    # @option config [Configuration] Configuraiton for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
       @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
@@ -67,6 +80,15 @@ module IronTitan
       return data, response.code, response.headers
     end
 
+    # Builds the HTTP request
+    #
+    # @param [String] http_method HTTP method/verb (e.g. POST)
+    # @param [String] path URL path (e.g. /account/new)
+    # @option opts [Hash] :header_params Header parameters
+    # @option opts [Hash] :query_params Query parameters
+    # @option opts [Hash] :form_params Query parameters
+    # @option opts [Object] :body HTTP body (JSON/XML)
+    # @return [Typhoeus::Request] A Typhoeus Request
     def build_request(http_method, path, opts = {})
       url = build_request_url(path)
       http_method = http_method.to_sym.downcase
@@ -75,7 +97,6 @@ module IronTitan
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 
-      
 
       req_opts = {
         :method => http_method,
@@ -106,12 +127,15 @@ module IronTitan
     #   application/json
     #   application/json; charset=UTF8
     #   APPLICATION/JSON
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is applicaton/json
     def json_mime?(mime)
-       !!(mime =~ /\Aapplication\/json(;.*)?\z/i)
+       !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
     end
 
     # Deserialize the response to the given return type.
     #
+    # @param [Response] response HTTP response
     # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
     def deserialize(response, return_type)
       body = response.body
@@ -142,6 +166,9 @@ module IronTitan
     end
 
     # Convert data to the given return type.
+    # @param [Object] data Data to be converted
+    # @param [String] return_type Return type
+    # @return [Mixed] Data in a particular type
     def convert_to_type(data, return_type)
       return nil if data.nil?
       case return_type
@@ -214,7 +241,7 @@ module IronTitan
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub /.*[\/\\]/, ''
+      filename.gsub(/.*[\/\\]/, '')
     end
 
     def build_request_url(path)
@@ -223,6 +250,12 @@ module IronTitan
       URI.encode(@config.base_url + path)
     end
 
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
     def build_request_body(header_params, form_params, body)
       # http form
       if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
@@ -246,6 +279,10 @@ module IronTitan
     end
 
     # Update hearder and query params based on authentication settings.
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [String] auth_names Authentication scheme name
     def update_params_for_auth!(header_params, query_params, auth_names)
       Array(auth_names).each do |auth_name|
         auth_setting = @config.auth_settings[auth_name]
@@ -258,6 +295,9 @@ module IronTitan
       end
     end
 
+    # Sets user agent in HTTP header
+    #
+    # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
     def user_agent=(user_agent)
       @user_agent = user_agent
       @default_headers['User-Agent'] = @user_agent
@@ -289,13 +329,13 @@ module IronTitan
     # @return [String] JSON string representation of the object
     def object_to_http_body(model)
       return model if model.nil? || model.is_a?(String)
-      _body = nil
+      local_body = nil
       if model.is_a?(Array)
-        _body = model.map{|m| object_to_hash(m) }
+        local_body = model.map{|m| object_to_hash(m) }
       else
-        _body = object_to_hash(model)
+        local_body = object_to_hash(model)
       end
-      _body.to_json
+      local_body.to_json
     end
 
     # Convert object(non-array) to hash.

data/lib/iron_titan/api_error.rb

@@ -3,10 +3,21 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.3.10
+OpenAPI spec version: 0.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 

data/lib/iron_titan/configuration.rb

@@ -1,3 +1,26 @@
+=begin
+Titan API
+
+The ultimate, language agnostic, container based job processing framework.
+
+OpenAPI spec version: 0.4.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
 require 'uri'
 
 module IronTitan

data/lib/iron_titan/models/complete.rb

@@ -3,16 +3,28 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.3.10
+OpenAPI spec version: 0.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
 require 'date'
 
 module IronTitan
+
   class Complete
     # Time when job was completed. Always in UTC.
     attr_accessor :completed_at
@@ -23,16 +35,13 @@ module IronTitan
     # Error message, if status=error. Only used by the /error endpoint.
     attr_accessor :error
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'completed_at' => :'completed_at',
-        
         :'reason' => :'reason',
-        
         :'error' => :'error'
-        
       }
     end
 
@@ -42,32 +51,46 @@ module IronTitan
         :'completed_at' => :'DateTime',
         :'reason' => :'String',
         :'error' => :'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.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
-      if attributes[:'completed_at']
+      if attributes.has_key?(:'completed_at')
         self.completed_at = attributes[:'completed_at']
       end
-      
-      if attributes[:'reason']
+
+      if attributes.has_key?(:'reason')
         self.reason = attributes[:'reason']
       end
-      
-      if attributes[:'error']
+
+      if attributes.has_key?(:'error')
         self.error = attributes[:'error']
       end
-      
+
     end
 
-    # Check equality by comparing each attribute.
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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 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 &&
@@ -77,35 +100,41 @@ module IronTitan
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
       [completed_at, reason, error].hash
     end
 
-    # build the object from hash
+    # 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 =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the 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) } )
-          else
-            #TODO show warning in debug mode
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        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
@@ -139,21 +168,25 @@ module IronTitan
           end
         end
       else # model
-        _model = IronTitan.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = IronTitan.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_body (backward compatibility))
+    # 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
 
-    # return the object in the form of hash
+    # 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|
@@ -164,8 +197,10 @@ module IronTitan
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # 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) }
@@ -181,4 +216,5 @@ module IronTitan
     end
 
   end
+
 end