iron_titan 0.1.1 → 0.2.0

data/lib/iron_titan.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -17,22 +17,24 @@ require 'iron_titan/version'
 require 'iron_titan/configuration'
 
 # Models
-require 'iron_titan/models/jobs_wrapper'
+require 'iron_titan/models/error'
 require 'iron_titan/models/error_body'
-require 'iron_titan/models/new_jobs_wrapper'
+require 'iron_titan/models/id_status'
+require 'iron_titan/models/image'
 require 'iron_titan/models/image_wrapper'
-require 'iron_titan/models/log'
 require 'iron_titan/models/images_wrapper'
-require 'iron_titan/models/error'
-require 'iron_titan/models/job_wrapper'
 require 'iron_titan/models/job'
-require 'iron_titan/models/image'
+require 'iron_titan/models/job_wrapper'
+require 'iron_titan/models/jobs_wrapper'
 require 'iron_titan/models/new_job'
+require 'iron_titan/models/new_job_with_image'
+require 'iron_titan/models/new_jobs_wrapper'
+require 'iron_titan/models/reason'
 
 # APIs
-require 'iron_titan/api/jobs_api'
-require 'iron_titan/api/images_api'
 require 'iron_titan/api/core_api'
+require 'iron_titan/api/images_api'
+require 'iron_titan/api/jobs_api'
 
 module IronTitan
   class << self

data/spec/api/core_api_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -32,6 +32,22 @@ describe 'CoreApi' do
     end
   end
 
+  # unit tests for job_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.
+  # @param id Job id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'job_id_delete test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
   # unit tests for job_id_get
   # Gets job by id
   # Gets a job by id.
@@ -48,13 +64,13 @@ describe 'CoreApi' do
     end
   end
 
-  # unit tests for jobs_get
+  # unit tests for jobs_consume_get
   # Get next job.
-  # Gets the next job in the queue, ready for processing.
+  # 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
+  describe 'jobs_consume_get test' do
     it "should work" do
       # assertion here
       # should be_a()
@@ -66,7 +82,7 @@ describe 'CoreApi' do
 
   # unit tests for jobs_post
   # Enqueue Job
-  # Enqueues a job.
+  # Enqueues job(s). If any of the jobs is invalid, none of the jobs are enqueued.
   # @param body Array of jobs to post.
   # @param [Hash] opts the optional parameters
   # @return [JobsWrapper]

data/spec/api/images_api_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -32,12 +32,13 @@ describe 'ImagesApi' do
     end
   end
 
-  # unit tests for images_get
-  # Get all image names.
-  # TODO: Using images for lack of a better term. See https://github.com/iron-io/titan/issues/43 for discussion.
+  # unit tests for image_id_get
+  # Get information for image id.
+  # This gives more details about on image, such as the image name and other statistics.
+  # @param id ID of the image.
   # @param [Hash] opts the optional parameters
-  # @return [ImagesWrapper]
-  describe 'images_get test' do
+  # @return [ImageWrapper]
+  describe 'image_id_get test' do
     it "should work" do
       # assertion here
       # should be_a()
@@ -47,13 +48,12 @@ describe 'ImagesApi' do
     end
   end
 
-  # unit tests for images_name_get
-  # Get image by name.
-  # NOT IMPLEMENTED YET. This gives more details about on image, such as statistics and what not.
-  # @param name Name of the image.
+  # unit tests for images_get
+  # Get all image names.
+  # TODO: Using images for lack of a better term. See https://github.com/iron-io/titan/issues/43 for discussion.
   # @param [Hash] opts the optional parameters
-  # @return [ImageWrapper]
-  describe 'images_name_get test' do
+  # @return [ImagesWrapper]
+  describe 'images_get test' do
     it "should work" do
       # assertion here
       # should be_a()

data/spec/api/jobs_api_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -32,13 +32,30 @@ describe 'JobsApi' do
     end
   end
 
-  # unit tests for job_id_get
-  # Gets job by id
-  # Gets a job by id.
+  # unit tests for job_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`.
   # @param id Job id
+  # @param details Human-readable detailed message explaining cancellation reason.
   # @param [Hash] opts the optional parameters
   # @return [JobWrapper]
-  describe 'job_id_get test' do
+  describe 'job_id_cancel_post test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for job_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.
+  # @param id Job id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'job_id_delete test' do
     it "should work" do
       # assertion here
       # should be_a()
@@ -48,14 +65,16 @@ describe 'JobsApi' do
     end
   end
 
-  # unit tests for job_id_patch
-  # Update a job
-  # Typically used to update status on error/completion. TODO: only allow 'status' field.
+  # unit tests for job_id_fail_post
+  # Mark job as failed.
+  # Job is marked as failed if it was in a valid state. Job's `completed_at` time is initialized.
   # @param id Job id
-  # @param body Job data to post
+  # @param reason Reason for job failure.
+  # @param details Details of job failure.
+  # @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 'job_id_patch test' do
+  describe 'job_id_fail_post test' do
     it "should work" do
       # assertion here
       # should be_a()
@@ -65,13 +84,13 @@ describe 'JobsApi' do
     end
   end
 
-  # unit tests for job_id_cancel_post
-  # Cancel a job.
-  # This will prevent a job from running. TODO: should we attempt to kill a running job?
+  # unit tests for job_id_get
+  # Gets job by id
+  # Gets a job by id.
   # @param id Job id
   # @param [Hash] opts the optional parameters
   # @return [JobWrapper]
-  describe 'job_id_cancel_post test' do
+  describe 'job_id_get test' do
     it "should work" do
       # assertion here
       # should be_a()
@@ -86,7 +105,7 @@ describe 'JobsApi' do
   # Retrieves the log from log storage.
   # @param id Job id
   # @param [Hash] opts the optional parameters
-  # @return [Log]
+  # @return [String]
   describe 'job_id_log_get test' do
     it "should work" do
       # assertion here
@@ -99,7 +118,7 @@ describe 'JobsApi' do
 
   # unit tests for job_id_retry_post
   # Retry a job.
-  # If a job fails, you can retry the job with the original payload.
+  # 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 id Job id
   # @param [Hash] opts the optional parameters
   # @return [JobWrapper]
@@ -113,13 +132,46 @@ describe 'JobsApi' do
     end
   end
 
-  # unit tests for jobs_get
+  # unit tests for job_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.
+  # @param id Job id
+  # @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 'job_id_success_post test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for job_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.
+  # @param id Job id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'job_id_touch_post test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for jobs_consume_get
   # Get next job.
-  # Gets the next job in the queue, ready for processing.
+  # 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
+  describe 'jobs_consume_get test' do
     it "should work" do
       # assertion here
       # should be_a()
@@ -129,13 +181,13 @@ describe 'JobsApi' do
     end
   end
 
-  # unit tests for jobs_post
-  # Enqueue Job
-  # Enqueues a job.
-  # @param body Array of jobs to post.
+  # unit tests for jobs_get
+  # Peek at list of jobs.
+  # Get a list of active jobs. This endpoint can be used to observe the state of jobs in Titan. To run a job, use /jobs/consume. TODO: Needs pagination support.
   # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :n Number of jobs to return. Titan may return <=n jobs. Titan does not make any guarantees about job ordering, but jobs will not be repeated. To make sure you get unique jobs, use the cursor effectively. TODO: We don't actually support pagination.
   # @return [JobsWrapper]
-  describe 'jobs_post test' do
+  describe 'jobs_get test' do
     it "should work" do
       # assertion here
       # should be_a()
@@ -163,4 +215,20 @@ describe 'JobsApi' do
     end
   end
 
+  # unit tests for jobs_post
+  # Enqueue Job
+  # Enqueues job(s). If any of the jobs is invalid, none of the jobs are enqueued.
+  # @param body Array of jobs to post.
+  # @param [Hash] opts the optional parameters
+  # @return [JobsWrapper]
+  describe 'jobs_post test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
 end

data/spec/models/Error_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -14,7 +14,7 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for IronTitan::
+# Unit tests for IronTitan::Error
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'Error' do

data/spec/models/Job_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -14,7 +14,7 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for IronTitan::
+# Unit tests for IronTitan::Job
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'Job' do
@@ -32,7 +32,7 @@ describe 'Job' do
       @instance.should be_a(IronTitan::Job) 
     end
   end
-  describe 'test attribute "image"' do
+  describe 'test attribute "payload"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -42,7 +42,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "retry_from_id"' do
+  describe 'test attribute "delay"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -52,7 +52,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "created_at"' do
+  describe 'test attribute "timeout"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -72,7 +72,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "retries_delay"' do
+  describe 'test attribute "max_retries"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -82,7 +82,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "error"' do
+  describe 'test attribute "retries_delay"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -92,7 +92,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "timeout"' do
+  describe 'test attribute "id"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -102,7 +102,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "retries"' do
+  describe 'test attribute "status"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -112,7 +112,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "completed_at"' do
+  describe 'test attribute "image_id"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -122,7 +122,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "delay"' do
+  describe 'test attribute "reason"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -132,7 +132,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "payload"' do
+  describe 'test attribute "details"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -142,7 +142,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "name"' do
+  describe 'test attribute "created_at"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -162,17 +162,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "id"' do
-    it 'should work' do
-       # assertion here
-       # should be_a()
-       # should be_nil
-       # should ==
-       # should_not ==
-    end
-  end
-
-  describe 'test attribute "retry_id"' do
+  describe 'test attribute "completed_at"' do
     it 'should work' do
        # assertion here
        # should be_a()
@@ -182,7 +172,7 @@ describe 'Job' do
     end
   end
 
-  describe 'test attribute "status"' do
+  describe 'test attribute "retry_of"' do
     it 'should work' do
        # assertion here
        # should be_a()

data/spec/models/error_body_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -14,7 +14,7 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for IronTitan::
+# Unit tests for IronTitan::ErrorBody
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'ErrorBody' do

data/spec/models/id_status_spec.rb

@@ -0,0 +1,56 @@
+=begin
+Titan API
+
+The ultimate, language agnostic, container based job processing framework.
+
+OpenAPI spec version: 0.2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for IronTitan::IdStatus
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'IdStatus' do
+  before do
+    # run before each test
+    @instance = IronTitan::IdStatus.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IdStatus' do
+    it 'should create an instact of IdStatus' do
+      @instance.should be_a(IronTitan::IdStatus) 
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+       # assertion here
+       # should be_a()
+       # should be_nil
+       # should ==
+       # should_not ==
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+       # assertion here
+       # should be_a()
+       # should be_nil
+       # should ==
+       # should_not ==
+    end
+  end
+
+end
+

data/spec/models/image_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -14,7 +14,7 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for IronTitan::
+# Unit tests for IronTitan::Image
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'Image' do
@@ -32,7 +32,7 @@ describe 'Image' do
       @instance.should be_a(IronTitan::Image) 
     end
   end
-  describe 'test attribute "name"' do
+  describe 'test attribute "image"' do
     it 'should work' do
        # assertion here
        # should be_a()

data/spec/models/image_wrapper_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -14,7 +14,7 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for IronTitan::
+# Unit tests for IronTitan::ImageWrapper
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'ImageWrapper' do

data/spec/models/images_wrapper_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -14,7 +14,7 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for IronTitan::
+# Unit tests for IronTitan::ImagesWrapper
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'ImagesWrapper' do

data/spec/models/job_wrapper_spec.rb

@@ -3,7 +3,7 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.1.1
+OpenAPI spec version: 0.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -14,7 +14,7 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for IronTitan::
+# Unit tests for IronTitan::JobWrapper
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'JobWrapper' do