iron_titan 0.3.10 → 0.4.0

data/lib/iron_titan/models/start.rb

@@ -3,26 +3,37 @@ 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 Start
     # Time when job started execution. Always in UTC.
     attr_accessor :started_at
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'started_at' => :'started_at'
-        
       }
     end
 
@@ -30,24 +41,38 @@ module IronTitan
     def self.swagger_types
       {
         :'started_at' => :'DateTime'
-        
       }
     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[:'started_at']
+      if attributes.has_key?(:'started_at')
         self.started_at = attributes[:'started_at']
       end
-      
+
+    end
+
+    # 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
 
-    # Check equality by comparing each attribute.
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -55,35 +80,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
       [started_at].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
@@ -117,21 +148,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|
@@ -142,8 +177,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) }
@@ -159,4 +196,5 @@ module IronTitan
     end
 
   end
+
 end

data/lib/iron_titan/version.rb

@@ -3,13 +3,24 @@ 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
 
 module IronTitan
-  VERSION = "0.3.10"
+  VERSION = "0.4.0"
 end

data/lib/iron_titan.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/spec/api/groups_api_spec.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,7 +39,7 @@ describe 'GroupsApi' do
 
   describe 'test an instance of GroupsApi' do
     it 'should create an instact of GroupsApi' do
-      @instance.should be_a(IronTitan::GroupsApi)
+      expect(@instance).to be_instance_of(IronTitan::GroupsApi)
     end
   end
 
@@ -39,11 +50,7 @@ describe 'GroupsApi' do
   # @return [GroupsWrapper]
   describe 'groups_get test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
@@ -55,11 +62,7 @@ describe 'GroupsApi' do
   # @return [GroupWrapper]
   describe 'groups_name_get test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
@@ -71,11 +74,7 @@ describe 'GroupsApi' do
   # @return [GroupWrapper]
   describe 'groups_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 

data/spec/api/jobs_api_spec.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,7 +39,7 @@ describe 'JobsApi' do
 
   describe 'test an instance of JobsApi' do
     it 'should create an instact of JobsApi' do
-      @instance.should be_a(IronTitan::JobsApi)
+      expect(@instance).to be_instance_of(IronTitan::JobsApi)
     end
   end
 
@@ -42,51 +53,39 @@ describe 'JobsApi' do
   # @return [JobsWrapper]
   describe 'groups_name_jobs_get test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_id_cancel_post
   # Cancel a job.
-  # Cancels a job in delayed, queued or running status. The worker may continue to run a running job. reason is set to `client_request`. The job's completed_at field is set to the current time on the jobserver.
+  # Cancels a job in delayed, queued or running status. The worker may continue to run a running job. reason is set to `client_request`. The job's completed_at field is set to the current time on the jobserver.
   # @param name Name of group for this set of jobs.
   # @param id Job id
   # @param [Hash] opts the optional parameters
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_cancel_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_id_delete
   # Delete the job.
-  # Delete only succeeds if job status is one of `succeeded\n| failed | cancelled`. Cancel a job if it is another state and needs to\nbe deleted.  All information about the job, including the log, is\nirretrievably lost when this is invoked.\n
+  # Delete only succeeds if job status is one of `succeeded | failed | cancelled`. Cancel a job if it is another state and needs to be deleted.  All information about the job, including the log, is irretrievably lost when this is invoked. 
   # @param name Name of group for this set of jobs.
   # @param id Job id
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'groups_name_jobs_id_delete test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_id_error_post
   # 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 
@@ -94,11 +93,7 @@ describe 'JobsApi' do
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_error_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
@@ -111,11 +106,7 @@ describe 'JobsApi' do
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_get test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
@@ -128,11 +119,7 @@ describe 'JobsApi' do
   # @return [String]
   describe 'groups_name_jobs_id_log_get test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
@@ -141,39 +128,31 @@ describe 'JobsApi' do
   # Logs are sent after a job completes since they may be very large and the runner can process the next job.
   # @param name Name of group for this set of jobs.
   # @param id Job id
-  # @param log Output log for the job. Content-Type must be \"text/plain; charset=utf-8\".
+  # @param log Output log for the job. Content-Type must be \"text/plain; charset=utf-8\".
   # @param [Hash] opts the optional parameters
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_log_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_id_retry_post
   # Retry a job.
-  # \"The /retry endpoint can be used to force a retry of jobs\nwith status succeeded or cancelled. It can also be used to retry jobs\nthat in the failed state, but whose max_retries field is 0. The retried\njob will continue to have max_retries = 0.\"\n
+  # \"The /retry endpoint can be used to force a retry of jobs with status succeeded or cancelled. It can also be used to retry jobs that in the failed state, but whose max_retries field is 0. The retried job will continue to have max_retries = 0.\" 
   # @param name Name of group for this set of jobs.
   # @param id Job id
   # @param [Hash] opts the optional parameters
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_retry_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_id_start_post
-  # Mark job as started, ie: status = 'running'
-  # Job status is changed to 'running' if it was in a valid state before. Job's `started_at` time is initialized.
+  # Mark job as started, ie: status = 'running'
+  # Job status is changed to 'running' if it was in a valid state before. Job's `started_at` time is initialized.
   # @param name Name of group for this set of jobs.
   # @param id Job id
   # @param body 
@@ -181,17 +160,13 @@ describe 'JobsApi' do
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_start_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_id_success_post
   # Mark job as succeeded.
-  # Job status is changed to succeeded if it was in a valid state before. Job's `completed_at` time is initialized.
+  # Job status is changed to succeeded if it was in a valid state before. Job's `completed_at` time is initialized.
   # @param name Name of group for this set of jobs.
   # @param id Job id
   # @param body 
@@ -199,61 +174,45 @@ describe 'JobsApi' do
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_success_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_id_touch_post
   # Extend job timeout.
-  # Consumers can sometimes take a while to run the task after accepting it.  An example is when the runner does not have the docker image locally, it can spend a significant time downloading the image.\nIf the timeout is small, the job may never get to run, or run but not be accepted by Titan. Consumers can touch the job before it times out. Titan will reset the timeout, giving the consumer another timeout seconds to run the job.\nTouch is only valid while the job is in a running state. If touch fails, the runner may stop running the job.\n
+  # Consumers can sometimes take a while to run the task after accepting it.  An example is when the runner does not have the docker image locally, it can spend a significant time downloading the image. If the timeout is small, the job may never get to run, or run but not be accepted by Titan. Consumers can touch the job before it times out. Titan will reset the timeout, giving the consumer another timeout seconds to run the job. Touch is only valid while the job is in a running state. If touch fails, the runner may stop running the job. 
   # @param name Name of group for this set of jobs.
   # @param id Job id
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'groups_name_jobs_id_touch_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_post
   # Enqueue Job
-  # Enqueues job(s). If any of the jobs is invalid, none of the jobs are enqueued.\n
+  # Enqueues job(s). If any of the jobs is invalid, none of the jobs are enqueued. 
   # @param name name of the group.
   # @param body Array of jobs to post.
   # @param [Hash] opts the optional parameters
   # @return [JobsWrapper]
   describe 'groups_name_jobs_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for jobs_get
   # Get next job.
-  # Gets the next job in the queue, ready for processing. Titan may return <=n jobs. Consumers should start processing jobs in order. Each returned job is set to `status` \"running\" and `started_at` is set to the current time. No other consumer can retrieve this job.
+  # Gets the next job in the queue, ready for processing. Titan may return <=n jobs. Consumers should start processing jobs in order. Each returned job is set to `status` \"running\" and `started_at` is set to the current time. No other consumer can retrieve this job.
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :n Number of jobs to return.
   # @return [JobsWrapper]
   describe 'jobs_get test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 

data/spec/api/runner_api_spec.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,13 +39,13 @@ describe 'RunnerApi' do
 
   describe 'test an instance of RunnerApi' do
     it 'should create an instact of RunnerApi' do
-      @instance.should be_a(IronTitan::RunnerApi)
+      expect(@instance).to be_instance_of(IronTitan::RunnerApi)
     end
   end
 
   # unit tests for groups_name_jobs_id_error_post
   # 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 
@@ -42,17 +53,13 @@ describe 'RunnerApi' do
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_error_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_id_start_post
-  # Mark job as started, ie: status = 'running'
-  # Job status is changed to 'running' if it was in a valid state before. Job's `started_at` time is initialized.
+  # Mark job as started, ie: status = 'running'
+  # Job status is changed to 'running' if it was in a valid state before. Job's `started_at` time is initialized.
   # @param name Name of group for this set of jobs.
   # @param id Job id
   # @param body 
@@ -60,17 +67,13 @@ describe 'RunnerApi' do
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_start_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for groups_name_jobs_id_success_post
   # Mark job as succeeded.
-  # Job status is changed to succeeded if it was in a valid state before. Job's `completed_at` time is initialized.
+  # Job status is changed to succeeded if it was in a valid state before. Job's `completed_at` time is initialized.
   # @param name Name of group for this set of jobs.
   # @param id Job id
   # @param body 
@@ -78,11 +81,7 @@ describe 'RunnerApi' do
   # @return [JobWrapper]
   describe 'groups_name_jobs_id_success_post test' do
     it "should work" do
-      # assertion here
-      # should be_a()
-      # should be_nil
-      # should ==
-      # should_not ==
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end