worker_ruby 0.5.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5acfe5aa02b6ec924cb7b791e840f3f734f362a
+  data.tar.gz: 8a85757f9f682f345a4200bd55f0bc1d73ee8426
+SHA512:
+  metadata.gz: 32212cbe00795d403ff4b532d0596f6dc59a8b564277a1edc96f151cf7599c939980f45dfaa51e9347ae0108a6cdb6770e0f9f8a0e91b181d36fe215a30d6e39
+  data.tar.gz: f51aa0dfa2f1152dae67ce33640bcd0c20184f23889f5510720d05549998094a536f97abf1da52e2ab2c06d6d5828aed9d21b231178b3207734eb74363f75e6e

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.

data/README.md

@@ -0,0 +1,118 @@
+# worker_ruby
+
+IronWorker - the Ruby gem for the IronWorker CE API
+
+The ultimate, language agnostic, container based task processing framework.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 0.5.7
+- Package version: 0.5.7
+- Build date: 2016-08-24T18:32:37.039Z
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build worker_ruby.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./worker_ruby-0.5.7.gem
+```
+(for development, run `gem install --dev ./worker_ruby-0.5.7.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'worker_ruby', '~> 0.5.7'
+
+### 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 'worker_ruby', :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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'worker_ruby'
+
+api_instance = IronWorker::GroupsApi.new
+
+begin
+  #Get all group names.
+  result = api_instance.groups_get
+  p result
+rescue IronWorker::ApiError => e
+  puts "Exception when calling GroupsApi->groups_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost:8080/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*IronWorker::GroupsApi* | [**groups_get**](docs/GroupsApi.md#groups_get) | **GET** /groups | Get all group names.
+*IronWorker::GroupsApi* | [**groups_name_get**](docs/GroupsApi.md#groups_name_get) | **GET** /groups/{name} | Get information for a group.
+*IronWorker::GroupsApi* | [**groups_name_put**](docs/GroupsApi.md#groups_name_put) | **PUT** /groups/{name} | Create/update a task group.
+*IronWorker::GroupsApi* | [**groups_post**](docs/GroupsApi.md#groups_post) | **POST** /groups | Post new group
+*IronWorker::RunnerApi* | [**groups_name_tasks_id_error_post**](docs/RunnerApi.md#groups_name_tasks_id_error_post) | **POST** /groups/{name}/tasks/{id}/error | Mark task as failed.
+*IronWorker::RunnerApi* | [**groups_name_tasks_id_start_post**](docs/RunnerApi.md#groups_name_tasks_id_start_post) | **POST** /groups/{name}/tasks/{id}/start | Mark task as started, ie: status = 'running'
+*IronWorker::RunnerApi* | [**groups_name_tasks_id_success_post**](docs/RunnerApi.md#groups_name_tasks_id_success_post) | **POST** /groups/{name}/tasks/{id}/success | Mark task as succeeded.
+*IronWorker::TasksApi* | [**groups_name_tasks_get**](docs/TasksApi.md#groups_name_tasks_get) | **GET** /groups/{name}/tasks | Get task list by group name.
+*IronWorker::TasksApi* | [**groups_name_tasks_id_cancel_post**](docs/TasksApi.md#groups_name_tasks_id_cancel_post) | **POST** /groups/{name}/tasks/{id}/cancel | Cancel a task.
+*IronWorker::TasksApi* | [**groups_name_tasks_id_delete**](docs/TasksApi.md#groups_name_tasks_id_delete) | **DELETE** /groups/{name}/tasks/{id} | Delete the task.
+*IronWorker::TasksApi* | [**groups_name_tasks_id_error_post**](docs/TasksApi.md#groups_name_tasks_id_error_post) | **POST** /groups/{name}/tasks/{id}/error | Mark task as failed.
+*IronWorker::TasksApi* | [**groups_name_tasks_id_get**](docs/TasksApi.md#groups_name_tasks_id_get) | **GET** /groups/{name}/tasks/{id} | Gets task by id
+*IronWorker::TasksApi* | [**groups_name_tasks_id_log_get**](docs/TasksApi.md#groups_name_tasks_id_log_get) | **GET** /groups/{name}/tasks/{id}/log | Get the log of a completed task.
+*IronWorker::TasksApi* | [**groups_name_tasks_id_log_post**](docs/TasksApi.md#groups_name_tasks_id_log_post) | **POST** /groups/{name}/tasks/{id}/log | Send in a log for storage.
+*IronWorker::TasksApi* | [**groups_name_tasks_id_retry_post**](docs/TasksApi.md#groups_name_tasks_id_retry_post) | **POST** /groups/{name}/tasks/{id}/retry | Retry a task.
+*IronWorker::TasksApi* | [**groups_name_tasks_id_start_post**](docs/TasksApi.md#groups_name_tasks_id_start_post) | **POST** /groups/{name}/tasks/{id}/start | Mark task as started, ie: status = 'running'
+*IronWorker::TasksApi* | [**groups_name_tasks_id_success_post**](docs/TasksApi.md#groups_name_tasks_id_success_post) | **POST** /groups/{name}/tasks/{id}/success | Mark task as succeeded.
+*IronWorker::TasksApi* | [**groups_name_tasks_id_touch_post**](docs/TasksApi.md#groups_name_tasks_id_touch_post) | **POST** /groups/{name}/tasks/{id}/touch | Extend task timeout.
+*IronWorker::TasksApi* | [**groups_name_tasks_post**](docs/TasksApi.md#groups_name_tasks_post) | **POST** /groups/{name}/tasks | Enqueue task
+*IronWorker::TasksApi* | [**tasks_get**](docs/TasksApi.md#tasks_get) | **GET** /tasks | Get next task.
+
+
+## Documentation for Models
+
+ - [IronWorker::Complete](docs/Complete.md)
+ - [IronWorker::Error](docs/Error.md)
+ - [IronWorker::ErrorBody](docs/ErrorBody.md)
+ - [IronWorker::Group](docs/Group.md)
+ - [IronWorker::GroupWrapper](docs/GroupWrapper.md)
+ - [IronWorker::GroupsWrapper](docs/GroupsWrapper.md)
+ - [IronWorker::IdStatus](docs/IdStatus.md)
+ - [IronWorker::NewTask](docs/NewTask.md)
+ - [IronWorker::NewTasksWrapper](docs/NewTasksWrapper.md)
+ - [IronWorker::Start](docs/Start.md)
+ - [IronWorker::Task](docs/Task.md)
+ - [IronWorker::TaskWrapper](docs/TaskWrapper.md)
+ - [IronWorker::TasksWrapper](docs/TasksWrapper.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/VERSION

@@ -0,0 +1 @@
+0.5.7

data/VERSION.txt

@@ -0,0 +1 @@
+0.5.2

data/docs/Complete.md

@@ -0,0 +1,10 @@
+# IronWorker::Complete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**completed_at** | **DateTime** | Time when task was completed. Always in UTC. | [optional] 
+**reason** | **String** | Machine readable reason failure, if status=error. Only used by the /error endpoint. | [optional] 
+**error** | **String** | Error message, if status=error. Only used by the /error endpoint. | [optional] 
+
+

data/docs/CoreApi.md

@@ -0,0 +1,200 @@
+# IronTitan::CoreApi
+
+All URIs are relative to *https://localhost:8080/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**job_id_delete**](CoreApi.md#job_id_delete) | **DELETE** /job/{id} | Delete the job.
+[**job_id_get**](CoreApi.md#job_id_get) | **GET** /job/{id} | Gets job by id
+[**jobs_consume_get**](CoreApi.md#jobs_consume_get) | **GET** /jobs/consume | Get next job.
+[**jobs_post**](CoreApi.md#jobs_post) | **POST** /jobs | Enqueue Job
+
+
+# **job_id_delete**
+> job_id_delete(id)
+
+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.
+
+### Example
+```ruby
+# 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
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Job id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **job_id_get**
+> JobWrapper job_id_get(id)
+
+Gets job by id
+
+Gets a job by id.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::CoreApi.new
+
+id = "id_example" # String | Job id
+
+
+begin
+  #Gets job by id
+  result = api_instance.job_id_get(id)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling CoreApi->job_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Job id | 
+
+### Return type
+
+[**JobWrapper**](JobWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **jobs_consume_get**
+> JobsWrapper jobs_consume_get(opts)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::CoreApi.new
+
+opts = { 
+  n: 1 # Integer | Number of jobs to return.
+}
+
+begin
+  #Get next job.
+  result = api_instance.jobs_consume_get(opts)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling CoreApi->jobs_consume_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **n** | **Integer**| Number of jobs to return. | [optional] [default to 1]
+
+### Return type
+
+[**JobsWrapper**](JobsWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **jobs_post**
+> JobsWrapper jobs_post(body)
+
+Enqueue Job
+
+Enqueues job(s). If any of the jobs is invalid, none of the jobs are enqueued.
+
+### Example
+```ruby
+# load the gem
+require 'iron_titan'
+
+api_instance = IronTitan::CoreApi.new
+
+body = IronTitan::NewJobsWrapper.new # NewJobsWrapper | Array of jobs to post.
+
+
+begin
+  #Enqueue Job
+  result = api_instance.jobs_post(body)
+  p result
+rescue IronTitan::ApiError => e
+  puts "Exception when calling CoreApi->jobs_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**NewJobsWrapper**](NewJobsWrapper.md)| Array of jobs to post. | 
+
+### Return type
+
+[**JobsWrapper**](JobsWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+