allq_rest 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8686500c26bb7b3aed2588730c25b94afa670e69bcde92d7ca8c45fa47411b5c
+  data.tar.gz: df4ff43537955e1f842c56a1804c8f00c0131196d666448df3bf6f4f03ecbda9
+SHA512:
+  metadata.gz: 76720a631bf7f5a2b0d7b881b7ad44d724ea5a5631e713c32f4c04e1b3e03d779d95cca316b1d73745b241234cb8ac3f5c79ea45f76ea16d649c95b8bbc2b9e8
+  data.tar.gz: a6528bb6d7bdf5d4143f7b18d5d74bcefc5caf73c73d480aff72113519528005eea1e75e3820740396c7d75e8073a3573e0b23efbd658782547b508d3faa564e

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    allq_client (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  allq_client!
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,111 @@
+# allq_client
+
+Allq - the Ruby gem for the AllQ
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build allq_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./allq_client-1.0.0.gem
+```
+(for development, run `gem install --dev ./allq_client-1.0.0.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 'allq_client', '~> 1.0.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 'allq_client', :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 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+job_id = "job_id_example" # String | Job ID
+
+
+begin
+  #Bury
+  result = api_instance.bury_put(job_id)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->bury_put: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:8090*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Allq::ActionsApi* | [**bury_put**](docs/ActionsApi.md#bury_put) | **PUT** /bury | Bury
+*Allq::ActionsApi* | [**job_delete**](docs/ActionsApi.md#job_delete) | **DELETE** /job | Delete
+*Allq::ActionsApi* | [**job_get**](docs/ActionsApi.md#job_get) | **GET** /job | Job
+*Allq::ActionsApi* | [**job_post**](docs/ActionsApi.md#job_post) | **POST** /job | Job
+*Allq::ActionsApi* | [**parent_job_post**](docs/ActionsApi.md#parent_job_post) | **POST** /parent_job | Parent  Job
+*Allq::ActionsApi* | [**peek_get**](docs/ActionsApi.md#peek_get) | **GET** /peek | Peek
+*Allq::ActionsApi* | [**release_put**](docs/ActionsApi.md#release_put) | **PUT** /release | Release
+*Allq::ActionsApi* | [**set_children_started_put**](docs/ActionsApi.md#set_children_started_put) | **PUT** /set_children_started | Set Children Started
+*Allq::ActionsApi* | [**throttle_post**](docs/ActionsApi.md#throttle_post) | **POST** /throttle | Throttle
+*Allq::ActionsApi* | [**touch_put**](docs/ActionsApi.md#touch_put) | **PUT** /touch | Touch
+*Allq::ActionsApi* | [**tube_delete**](docs/ActionsApi.md#tube_delete) | **DELETE** /tube | Clear Tube
+*Allq::AdminApi* | [**stats_get**](docs/AdminApi.md#stats_get) | **GET** /stats | Stats
+*Allq::AdminApi* | [**update_servers_put**](docs/AdminApi.md#update_servers_put) | **PUT** /update_servers | Reset Server Urls
+
+
+## Documentation for Models
+
+ - [Allq::BasicPayload](docs/BasicPayload.md)
+ - [Allq::BasicResponse](docs/BasicResponse.md)
+ - [Allq::JobRef](docs/JobRef.md)
+ - [Allq::JobResponse](docs/JobResponse.md)
+ - [Allq::NewJob](docs/NewJob.md)
+ - [Allq::NewParentJob](docs/NewParentJob.md)
+ - [Allq::StatsInfo](docs/StatsInfo.md)
+ - [Allq::StatsResults](docs/StatsResults.md)
+ - [Allq::StatsTube](docs/StatsTube.md)
+ - [Allq::Throttle](docs/Throttle.md)
+ - [Allq::TubeRef](docs/TubeRef.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/allq_client.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+#
+=begin
+#AllQ
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "allq_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "allq_client"
+  s.version     = Allq::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["support@blitline.com"]
+  s.email       = ["support@blitline.com"]
+  s.homepage    = "http://www.blitline.com"
+  s.summary     = "Ruby client for Allq platform"
+  s.description = "Allq API Client"
+  # TODO uncommnet and update below with a proper license 
+  #s.license     = "Apache 2.0"
+  s.required_ruby_version = "> 2.3"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/allq_rest.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "allq_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "allq_rest"
+  s.version     = Allq::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["support@blitline.com"]
+  s.email       = ["support@blitline.com"]
+  s.homepage    = "http://www.blitline.com"
+  s.summary     = "Ruby REST client for Allq platform"
+  s.description = "Allq API Client"
+  # TODO uncommnet and update below with a proper license 
+  #s.license     = "Apache 2.0"
+  s.required_ruby_version = "> 2.3"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/deploy.sh

@@ -0,0 +1,3 @@
+echo "Did you update the version?"
+gem build allq_rest.gemspec
+gem push allq_rest-1.2.0.gem

data/docs/ActionsApi.md

@@ -0,0 +1,544 @@
+# Allq::ActionsApi
+
+All URIs are relative to *http://localhost:8090*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**bury_put**](ActionsApi.md#bury_put) | **PUT** /bury | Bury
+[**job_delete**](ActionsApi.md#job_delete) | **DELETE** /job | Delete
+[**job_get**](ActionsApi.md#job_get) | **GET** /job | Job
+[**job_post**](ActionsApi.md#job_post) | **POST** /job | Job
+[**parent_job_post**](ActionsApi.md#parent_job_post) | **POST** /parent_job | Parent  Job
+[**peek_get**](ActionsApi.md#peek_get) | **GET** /peek | Peek
+[**release_put**](ActionsApi.md#release_put) | **PUT** /release | Release
+[**set_children_started_put**](ActionsApi.md#set_children_started_put) | **PUT** /set_children_started | Set Children Started
+[**throttle_post**](ActionsApi.md#throttle_post) | **POST** /throttle | Throttle
+[**touch_put**](ActionsApi.md#touch_put) | **PUT** /touch | Touch
+[**tube_delete**](ActionsApi.md#tube_delete) | **DELETE** /tube | Clear Tube
+
+
+# **bury_put**
+> BasicResponse bury_put(job_id)
+
+Bury
+
+Bury Job
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+job_id = "job_id_example" # String | Job ID
+
+
+begin
+  #Bury
+  result = api_instance.bury_put(job_id)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->bury_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_id** | **String**| Job ID | 
+
+### Return type
+
+[**BasicResponse**](BasicResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **job_delete**
+> BasicResponse job_delete(job_id, opts)
+
+Delete
+
+Finished Job
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+job_id = "job_id_example" # String | Job ID
+
+opts = { 
+  tube: "tube_example" # String | Name of Tube (For deleting \"ready\" objects)
+}
+
+begin
+  #Delete
+  result = api_instance.job_delete(job_id, opts)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->job_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_id** | **String**| Job ID | 
+ **tube** | **String**| Name of Tube (For deleting \"ready\" objects) | [optional] 
+
+### Return type
+
+[**BasicResponse**](BasicResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **job_get**
+> JobResponse job_get(tube)
+
+Job
+
+Get job from queue
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+tube = "tube_example" # String | Name of tube
+
+
+begin
+  #Job
+  result = api_instance.job_get(tube)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->job_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tube** | **String**| Name of tube | 
+
+### Return type
+
+[**JobResponse**](JobResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **job_post**
+> JobRef job_post(new_job)
+
+Job
+
+Put job into queue
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+new_job = Allq::NewJob.new # NewJob | New Job Object
+
+
+begin
+  #Job
+  result = api_instance.job_post(new_job)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->job_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **new_job** | [**NewJob**](NewJob.md)| New Job Object | 
+
+### Return type
+
+[**JobRef**](JobRef.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **parent_job_post**
+> JobRef parent_job_post(new_parent_job)
+
+Parent  Job
+
+Create a parent job
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+new_parent_job = Allq::NewParentJob.new # NewParentJob | New Parent Job Data
+
+
+begin
+  #Parent  Job
+  result = api_instance.parent_job_post(new_parent_job)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->parent_job_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **new_parent_job** | [**NewParentJob**](NewParentJob.md)| New Parent Job Data | 
+
+### Return type
+
+[**JobRef**](JobRef.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **peek_get**
+> JobResponse peek_get(tube, opts)
+
+Peek
+
+Peek at next job
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+tube = "tube_example" # String | Tube name
+
+opts = { 
+  buried: "false" # String | Look in buried
+}
+
+begin
+  #Peek
+  result = api_instance.peek_get(tube, opts)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->peek_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tube** | **String**| Tube name | 
+ **buried** | **String**| Look in buried | [optional] [default to false]
+
+### Return type
+
+[**JobResponse**](JobResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **release_put**
+> BasicResponse release_put(job_id)
+
+Release
+
+Releases job back into queue
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+job_id = "job_id_example" # String | Job ID
+
+
+begin
+  #Release
+  result = api_instance.release_put(job_id)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->release_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_id** | **String**| Job ID | 
+
+### Return type
+
+[**BasicResponse**](BasicResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **set_children_started_put**
+> BasicResponse set_children_started_put(job_id)
+
+Set Children Started
+
+When a parent job doesn't know how many children are going to be added, this is the event that sets the final children count on the parent_job, allowing it to run when the children are done.
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+job_id = "job_id_example" # String | Job ID
+
+
+begin
+  #Set Children Started
+  result = api_instance.set_children_started_put(job_id)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->set_children_started_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_id** | **String**| Job ID | 
+
+### Return type
+
+[**BasicResponse**](BasicResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **throttle_post**
+> TubeRef throttle_post(throttle)
+
+Throttle
+
+Creates a throttle on a tube
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+throttle = Allq::Throttle.new # Throttle | Throttle info
+
+
+begin
+  #Throttle
+  result = api_instance.throttle_post(throttle)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->throttle_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **throttle** | [**Throttle**](Throttle.md)| Throttle info | 
+
+### Return type
+
+[**TubeRef**](TubeRef.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **touch_put**
+> BasicResponse touch_put(job_id)
+
+Touch
+
+Touch job
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+job_id = "job_id_example" # String | Job ID
+
+
+begin
+  #Touch
+  result = api_instance.touch_put(job_id)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->touch_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job_id** | **String**| Job ID | 
+
+### Return type
+
+[**BasicResponse**](BasicResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **tube_delete**
+> BasicResponse tube_delete(tube)
+
+Clear Tube
+
+Delete all contents of tube
+
+### Example
+```ruby
+# load the gem
+require 'allq_client'
+
+api_instance = Allq::ActionsApi.new
+
+tube = "tube_example" # String | Tube Name
+
+
+begin
+  #Clear Tube
+  result = api_instance.tube_delete(tube)
+  p result
+rescue Allq::ApiError => e
+  puts "Exception when calling ActionsApi->tube_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tube** | **String**| Tube Name | 
+
+### Return type
+
+[**BasicResponse**](BasicResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+