iron_functions 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d8021159998d0afaee676abf78c94502054ba96
+  data.tar.gz: 24fc834bab9ef8e55fd05e63abf5ac65e9da4bb8
+SHA512:
+  metadata.gz: 8e74c0f983772aed1876eabfe4a1e67f906f6a8ca7c0170506e20c7c68383e24d157b0e7e456fd81e1751b5581ba15d2cdcf840959f9c392b39b9f62f9fd017f
+  data.tar.gz: 2535377d2b45f11f5f6e074aa2639c8f4fc3f4ee8629468e78e41daf86153f59490fc43f814bb03cf22b8c4d1f9309c4a69753f132a6d605d7ed0a4af0aaaa42

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,109 @@
+# iron_functions
+
+IronFunctions - the Ruby gem for the IronFunctions
+
+null
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 0.0.5
+- Package version: 0.0.5
+- Build date: 2016-10-14T04:20:12.388Z
+- Build package: class io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build iron_functions.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./iron_functions-0.0.5.gem
+```
+(for development, run `gem install --dev ./iron_functions-0.0.5.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 'iron_functions', '~> 0.0.5'
+
+### 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_functions', :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 'iron_functions'
+
+api_instance = IronFunctions::AppsApi.new
+
+app = "app_example" # String | name of the app.
+
+
+begin
+  #Get information for a app.
+  result = api_instance.apps_app_get(app)
+  p result
+rescue IronFunctions::ApiError => e
+  puts "Exception when calling AppsApi->apps_app_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://127.0.0.1:8080/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*IronFunctions::AppsApi* | [**apps_app_get**](docs/AppsApi.md#apps_app_get) | **GET** /apps/{app} | Get information for a app.
+*IronFunctions::AppsApi* | [**apps_app_put**](docs/AppsApi.md#apps_app_put) | **PUT** /apps/{app} | Create/update a app.
+*IronFunctions::AppsApi* | [**apps_get**](docs/AppsApi.md#apps_get) | **GET** /apps | Get all app names.
+*IronFunctions::AppsApi* | [**apps_post**](docs/AppsApi.md#apps_post) | **POST** /apps | Post new app
+*IronFunctions::RoutesApi* | [**apps_app_routes_get**](docs/RoutesApi.md#apps_app_routes_get) | **GET** /apps/{app}/routes | Get route list by app name.
+*IronFunctions::RoutesApi* | [**apps_app_routes_post**](docs/RoutesApi.md#apps_app_routes_post) | **POST** /apps/{app}/routes | Create new Route
+*IronFunctions::RoutesApi* | [**apps_app_routes_route_delete**](docs/RoutesApi.md#apps_app_routes_route_delete) | **DELETE** /apps/{app}/routes/{route} | Deletes the route
+*IronFunctions::RoutesApi* | [**apps_app_routes_route_get**](docs/RoutesApi.md#apps_app_routes_route_get) | **GET** /apps/{app}/routes/{route} | Gets route by name
+*IronFunctions::TasksApi* | [**tasks_get**](docs/TasksApi.md#tasks_get) | **GET** /tasks | Get next task.
+
+
+## Documentation for Models
+
+ - [IronFunctions::App](docs/App.md)
+ - [IronFunctions::AppWrapper](docs/AppWrapper.md)
+ - [IronFunctions::AppsWrapper](docs/AppsWrapper.md)
+ - [IronFunctions::Error](docs/Error.md)
+ - [IronFunctions::ErrorBody](docs/ErrorBody.md)
+ - [IronFunctions::NewTasksWrapper](docs/NewTasksWrapper.md)
+ - [IronFunctions::Route](docs/Route.md)
+ - [IronFunctions::RouteWrapper](docs/RouteWrapper.md)
+ - [IronFunctions::RoutesWrapper](docs/RoutesWrapper.md)
+ - [IronFunctions::Task](docs/Task.md)
+ - [IronFunctions::TaskWrapper](docs/TaskWrapper.md)
+ - [IronFunctions::TasksWrapper](docs/TasksWrapper.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/docs/App.md

@@ -0,0 +1,8 @@
+# IronFunctions::App
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of this app. Must be different than the image name. Can ony contain alphanumeric, -, and _. | [optional] 
+
+

data/docs/AppWrapper.md

@@ -0,0 +1,8 @@
+# IronFunctions::AppWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app** | [**App**](App.md) |  | 
+
+

data/docs/AppsApi.md

@@ -0,0 +1,197 @@
+# IronFunctions::AppsApi
+
+All URIs are relative to *https://127.0.0.1:8080/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**apps_app_get**](AppsApi.md#apps_app_get) | **GET** /apps/{app} | Get information for a app.
+[**apps_app_put**](AppsApi.md#apps_app_put) | **PUT** /apps/{app} | Create/update a app.
+[**apps_get**](AppsApi.md#apps_get) | **GET** /apps | Get all app names.
+[**apps_post**](AppsApi.md#apps_post) | **POST** /apps | Post new app
+
+
+# **apps_app_get**
+> AppWrapper apps_app_get(app)
+
+Get information for a app.
+
+This gives more details about a app, such as statistics.
+
+### Example
+```ruby
+# load the gem
+require 'iron_functions'
+
+api_instance = IronFunctions::AppsApi.new
+
+app = "app_example" # String | name of the app.
+
+
+begin
+  #Get information for a app.
+  result = api_instance.apps_app_get(app)
+  p result
+rescue IronFunctions::ApiError => e
+  puts "Exception when calling AppsApi->apps_app_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app** | **String**| name of the app. | 
+
+### Return type
+
+[**AppWrapper**](AppWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **apps_app_put**
+> AppWrapper apps_app_put(app, body)
+
+Create/update a app.
+
+You can set app level settings here. 
+
+### Example
+```ruby
+# load the gem
+require 'iron_functions'
+
+api_instance = IronFunctions::AppsApi.new
+
+app = "app_example" # String | name of the app.
+
+body = IronFunctions::AppWrapper.new # AppWrapper | App to post.
+
+
+begin
+  #Create/update a app.
+  result = api_instance.apps_app_put(app, body)
+  p result
+rescue IronFunctions::ApiError => e
+  puts "Exception when calling AppsApi->apps_app_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app** | **String**| name of the app. | 
+ **body** | [**AppWrapper**](AppWrapper.md)| App to post. | 
+
+### Return type
+
+[**AppWrapper**](AppWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **apps_get**
+> AppsWrapper apps_get
+
+Get all app names.
+
+Get a list of all the apps in the system.
+
+### Example
+```ruby
+# load the gem
+require 'iron_functions'
+
+api_instance = IronFunctions::AppsApi.new
+
+begin
+  #Get all app names.
+  result = api_instance.apps_get
+  p result
+rescue IronFunctions::ApiError => e
+  puts "Exception when calling AppsApi->apps_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AppsWrapper**](AppsWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **apps_post**
+> AppWrapper apps_post(body)
+
+Post new app
+
+Insert a new app
+
+### Example
+```ruby
+# load the gem
+require 'iron_functions'
+
+api_instance = IronFunctions::AppsApi.new
+
+body = IronFunctions::AppWrapper.new # AppWrapper | App to post.
+
+
+begin
+  #Post new app
+  result = api_instance.apps_post(body)
+  p result
+rescue IronFunctions::ApiError => e
+  puts "Exception when calling AppsApi->apps_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AppWrapper**](AppWrapper.md)| App to post. | 
+
+### Return type
+
+[**AppWrapper**](AppWrapper.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AppsWrapper.md

@@ -0,0 +1,8 @@
+# IronFunctions::AppsWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apps** | [**Array<App>**](App.md) |  | 
+
+

data/docs/Error.md

@@ -0,0 +1,8 @@
+# IronFunctions::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**ErrorBody**](ErrorBody.md) |  | [optional] 
+
+

data/docs/ErrorBody.md

@@ -0,0 +1,9 @@
+# IronFunctions::ErrorBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+**fields** | **String** |  | [optional] 
+
+

data/docs/NewTasksWrapper.md

@@ -0,0 +1,8 @@
+# IronFunctions::NewTasksWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tasks** | [**Array<NewTask>**](NewTask.md) |  | 
+
+

data/docs/Route.md

@@ -0,0 +1,11 @@
+# IronFunctions::Route
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_name** | **String** | App this route belongs to. | [optional] 
+**path** | **String** | URL path that will be matched to this route | [optional] 
+**image** | **String** | Name of Docker image to use in this route. You should include the image tag, which should be a version number, to be more accurate. Can be overridden on a per route basis with route.image. | [optional] 
+**headers** | **String** | Map of http headers that will be sent with the response | [optional] 
+
+

data/docs/RouteWrapper.md

@@ -0,0 +1,8 @@
+# IronFunctions::RouteWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**route** | [**Route**](Route.md) |  | 
+
+