iron_titan 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2abf37ff69c377cd77f5343af5bafc93bd9ae331
-  data.tar.gz: d9b2a96fa1cd0e4758230d041deb916fc0e2b4a4
+  metadata.gz: 254c42c334e64d44981a5f724fd303695910946c
+  data.tar.gz: 59c3796348174db4b8fed23cf55b9255141d5ed9
 SHA512:
-  metadata.gz: 81f587a06fc30a78c5ff91907bae6acba6e95ed371b4eb67871477723c4f783507285cf7d420c1196d190e8e4e7d0f8e214ad38469da4ffd3c53efec07fa5d01
-  data.tar.gz: 5eb734844536527e63fbf4bf30a5c27a8b50b656892bd2c1d30ac4afd10fcb27c5bf5d9df0780166b47d0dc3a420feef98ac2b2ffedbe33e5d1300c872e13a35
+  metadata.gz: 9d21b88cbe11d9ceb90e67a4537dae81912e0b8d3804b3d9ca61bc3f909f80620f628515f6cfa58e48fdc28e118da27c6d181129bd0675b7c1bdc0cd5b4e9309
+  data.tar.gz: 680acef6b5b575a30c203b7407d0fbb327cf34335b2f8315f219446578253d395b641ee7fb99ce79e49b4fc085122f3280dc022a02deb394ca6287f88be2f99e

data/README.md

@@ -1,46 +1,117 @@
+# iron_titan
 
+IronTitan - the Ruby gem for the Titan API
+
+The ultimate, language agnostic, container based job processing framework.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API verion: 0.2.0
+- Package version: 0.2.0
+- Build date: 2016-03-29T20:51:39.687Z
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
 
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build iron_titan.gemspec
 ```
-gem install iron_titan
+
+Then either install the gem locally:
+
+```shell
+gem install ./iron_titan-0.2.0.gem
 ```
 
-Or add `gem "iron_titan"` to your Gemfile.
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
-## Usage
+Finally add this to the Gemfile:
 
-```ruby
-IronTitan.configure do |config|
-  config.host = "192.168.99.100:8080"
-  config.scheme = "http"
-end
+    gem 'iron_titan', '~> 0.2.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
+
+    gem 'iron_titan', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
 
-@titan = IronTitan::JobsApi.new
+```shell
+ruby -Ilib script.rb
 ```
 
-Then use it:
+## Getting Started
 
+Please follow the [installation](#installation) procedure and then run the following code:
 ```ruby
-# Post a job
-r = @titan.jobs_post(jobs: [{
-  image: 'treeder/echo:latest',
-  delay: 5,
-  payload: {input: 'Test Input'}.to_json
-  }])
-input_string = "Test Input"
-job = r.jobs[0]
-p job
-
-# Get job status
-job = @titan.job_id_get(job.id).job
-puts job.status
-
-# Get logs
-log = @titan.job_id_log_get(r_payload.jobs[0].id).log
-p log
+# Load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::CoreApi.new
+
+id = "id_example" # String | Job id
+
+
+begin
+  #Delete the job.
+  api_instance.job_id_delete(id)
+rescue IronTitan::ApiError => e
+  puts "Exception when calling CoreApi->job_id_delete: #{e}"
+end
+
 ```
 
-## Building/testing this Gem
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost:8080/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*IronTitan::CoreApi* | [**job_id_delete**](docs/CoreApi.md#job_id_delete) | **DELETE** /job/{id} | Delete the job.
+*IronTitan::CoreApi* | [**job_id_get**](docs/CoreApi.md#job_id_get) | **GET** /job/{id} | Gets job by id
+*IronTitan::CoreApi* | [**jobs_consume_get**](docs/CoreApi.md#jobs_consume_get) | **GET** /jobs/consume | Get next job.
+*IronTitan::CoreApi* | [**jobs_post**](docs/CoreApi.md#jobs_post) | **POST** /jobs | Enqueue Job
+*IronTitan::ImagesApi* | [**image_id_get**](docs/ImagesApi.md#image_id_get) | **GET** /image/{id} | Get information for image id.
+*IronTitan::ImagesApi* | [**images_get**](docs/ImagesApi.md#images_get) | **GET** /images | Get all image names.
+*IronTitan::JobsApi* | [**job_id_cancel_post**](docs/JobsApi.md#job_id_cancel_post) | **POST** /job/{id}/cancel | Cancel a job.
+*IronTitan::JobsApi* | [**job_id_delete**](docs/JobsApi.md#job_id_delete) | **DELETE** /job/{id} | Delete the job.
+*IronTitan::JobsApi* | [**job_id_fail_post**](docs/JobsApi.md#job_id_fail_post) | **POST** /job/{id}/fail | Mark job as failed.
+*IronTitan::JobsApi* | [**job_id_get**](docs/JobsApi.md#job_id_get) | **GET** /job/{id} | Gets job by id
+*IronTitan::JobsApi* | [**job_id_log_get**](docs/JobsApi.md#job_id_log_get) | **GET** /job/{id}/log | Get the log of a completed job.
+*IronTitan::JobsApi* | [**job_id_retry_post**](docs/JobsApi.md#job_id_retry_post) | **POST** /job/{id}/retry | Retry a job.
+*IronTitan::JobsApi* | [**job_id_success_post**](docs/JobsApi.md#job_id_success_post) | **POST** /job/{id}/success | Mark job as succeeded.
+*IronTitan::JobsApi* | [**job_id_touch_post**](docs/JobsApi.md#job_id_touch_post) | **POST** /job/{id}/touch | Extend job timeout.
+*IronTitan::JobsApi* | [**jobs_consume_get**](docs/JobsApi.md#jobs_consume_get) | **GET** /jobs/consume | Get next job.
+*IronTitan::JobsApi* | [**jobs_get**](docs/JobsApi.md#jobs_get) | **GET** /jobs | Peek at list of jobs.
+*IronTitan::JobsApi* | [**jobs_name_get**](docs/JobsApi.md#jobs_name_get) | **GET** /jobs/{name} | Get job list by name.
+*IronTitan::JobsApi* | [**jobs_post**](docs/JobsApi.md#jobs_post) | **POST** /jobs | Enqueue Job
+
+
+## Documentation for Models
+
+ - [IronTitan::Error](docs/Error.md)
+ - [IronTitan::ErrorBody](docs/ErrorBody.md)
+ - [IronTitan::IdStatus](docs/IdStatus.md)
+ - [IronTitan::Image](docs/Image.md)
+ - [IronTitan::ImageWrapper](docs/ImageWrapper.md)
+ - [IronTitan::ImagesWrapper](docs/ImagesWrapper.md)
+ - [IronTitan::Job](docs/Job.md)
+ - [IronTitan::JobWrapper](docs/JobWrapper.md)
+ - [IronTitan::JobsWrapper](docs/JobsWrapper.md)
+ - [IronTitan::NewJob](docs/NewJob.md)
+ - [IronTitan::NewJobWithImage](docs/NewJobWithImage.md)
+ - [IronTitan::NewJobsWrapper](docs/NewJobsWrapper.md)
+ - [IronTitan::Reason](docs/Reason.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
 
-This gem is built from the main [Titan repo](https://github.com/iron-io/titan).

data/lib/iron_titan/api/core_api.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
 
@@ -20,6 +20,65 @@ module IronTitan
       @api_client = api_client
     end
 
+    # 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]
+    def job_id_delete(id, opts = {})
+      job_id_delete_with_http_info(id, opts)
+      return nil
+    end
+
+    # 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 [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def job_id_delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: CoreApi#job_id_delete ..."
+      end
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling job_id_delete" if id.nil?
+      
+      # resource path
+      local_var_path = "/job/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CoreApi#job_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Gets job by id
     # Gets a job by id.
     # @param id Job id
@@ -81,27 +140,27 @@ module IronTitan
     end
 
     # 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.
+    # @option opts [Integer] :n Number of jobs to return. (default to 1)
     # @return [JobsWrapper]
-    def jobs_get(opts = {})
-      data, status_code, headers = jobs_get_with_http_info(opts)
+    def jobs_consume_get(opts = {})
+      data, status_code, headers = jobs_consume_get_with_http_info(opts)
       return data
     end
 
     # 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 &lt;=n jobs. Consumers should start processing jobs in order. Each returned job is set to `status` \&quot;running\&quot; 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 [Array<(JobsWrapper, Fixnum, Hash)>] JobsWrapper data, response status code and response headers
-    def jobs_get_with_http_info(opts = {})
+    def jobs_consume_get_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: CoreApi#jobs_get ..."
+        @api_client.config.logger.debug "Calling API: CoreApi#jobs_consume_get ..."
       end
       
       # resource path
-      local_var_path = "/jobs".sub('{format}','json')
+      local_var_path = "/jobs/consume".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -133,13 +192,13 @@ module IronTitan
         :auth_names => auth_names,
         :return_type => 'JobsWrapper')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CoreApi#jobs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: CoreApi#jobs_consume_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # 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]
@@ -149,7 +208,7 @@ module IronTitan
     end
 
     # 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 [Array<(JobsWrapper, Fixnum, Hash)>] JobsWrapper data, response status code and response headers

data/lib/iron_titan/api/images_api.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
 
@@ -20,26 +20,31 @@ module IronTitan
       @api_client = api_client
     end
 
-    # Get all image names.
-    # TODO: Using images for lack of a better term. See https://github.com/iron-io/titan/issues/43 for discussion.
+    # 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]
-    def images_get(opts = {})
-      data, status_code, headers = images_get_with_http_info(opts)
+    # @return [ImageWrapper]
+    def image_id_get(id, opts = {})
+      data, status_code, headers = image_id_get_with_http_info(id, opts)
       return data
     end
 
-    # Get all image names.
-    # TODO: Using images for lack of a better term. See https://github.com/iron-io/titan/issues/43 for discussion.
+    # 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 [Array<(ImagesWrapper, Fixnum, Hash)>] ImagesWrapper data, response status code and response headers
-    def images_get_with_http_info(opts = {})
+    # @return [Array<(ImageWrapper, Fixnum, Hash)>] ImageWrapper data, response status code and response headers
+    def image_id_get_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ImagesApi#images_get ..."
+        @api_client.config.logger.debug "Calling API: ImagesApi#image_id_get ..."
       end
       
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling image_id_get" if id.nil?
+      
       # resource path
-      local_var_path = "/images".sub('{format}','json')
+      local_var_path = "/image/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
       query_params = {}
@@ -68,38 +73,33 @@ module IronTitan
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'ImagesWrapper')
+        :return_type => 'ImageWrapper')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ImagesApi#images_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ImagesApi#image_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # 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.
+    # 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]
-    def images_name_get(name, opts = {})
-      data, status_code, headers = images_name_get_with_http_info(name, opts)
+    # @return [ImagesWrapper]
+    def images_get(opts = {})
+      data, status_code, headers = images_get_with_http_info(opts)
       return data
     end
 
-    # 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.
+    # 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 [Array<(ImageWrapper, Fixnum, Hash)>] ImageWrapper data, response status code and response headers
-    def images_name_get_with_http_info(name, opts = {})
+    # @return [Array<(ImagesWrapper, Fixnum, Hash)>] ImagesWrapper data, response status code and response headers
+    def images_get_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ImagesApi#images_name_get ..."
+        @api_client.config.logger.debug "Calling API: ImagesApi#images_get ..."
       end
       
-      # verify the required parameter 'name' is set
-      fail "Missing the required parameter 'name' when calling images_name_get" if name.nil?
-      
       # resource path
-      local_var_path = "/images/{name}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s)
+      local_var_path = "/images".sub('{format}','json')
 
       # query parameters
       query_params = {}
@@ -128,9 +128,9 @@ module IronTitan
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'ImageWrapper')
+        :return_type => 'ImagesWrapper')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ImagesApi#images_name_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ImagesApi#images_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end