vantage-client 0.0.1.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b3b6e5c6f534e26d84d3a6aac5e525b68cca4361f4904ada855149df5e2d62b
+  data.tar.gz: 18eaf4925a9b4a76a16fa3670a09672e2d26963cb24a07819d1d001221d87a85
+SHA512:
+  metadata.gz: 6215a44441f74d46f4651da777eab3b3b497dc46e8ad9be74c1afc187e791d25c0b33625a7715f734c6f7de9c308717b698a2e4a2d7c69bc2a99762ffe3047ee
+  data.tar.gz: 91eff07d89265beef7d2151d6d763aee9fed9d20e29b14162639b1cc484ee511bbfae1886f2496050222991ad15982631f03433ec12bedb63d4729c7ddb49797

data/Gemfile

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

data/README.md

@@ -0,0 +1,111 @@
+# vantage-client
+
+Vantage - the Ruby gem for the Vantage
+
+Vantage API
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0
+- Package version: 0.0.1.beta.1
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.vantage.sh](https://www.vantage.sh)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build vantage-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./vantage-client-0.0.1.beta.1.gem
+```
+(for development, run `gem install --dev ./vantage-client-0.0.1.beta.1.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 'vantage-client', '~> 0.0.1.beta.1'
+
+### 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 'vantage-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 'vantage-client'
+
+# Setup authorization
+Vantage.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Vantage::PingApi.new
+
+begin
+  api_instance.ping
+rescue Vantage::ApiError => e
+  puts "Exception when calling PingApi->ping: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.vantage.sh*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Vantage::PingApi* | [**ping**](docs/PingApi.md#ping) | **GET** /v1/ping | 
+*Vantage::PricesApi* | [**get_price**](docs/PricesApi.md#get_price) | **GET** /v1/products/{product_id}/prices/{id} | 
+*Vantage::PricesApi* | [**get_prices**](docs/PricesApi.md#get_prices) | **GET** /v1/products/{product_id}/prices | 
+*Vantage::PricesApi* | [**get_product**](docs/PricesApi.md#get_product) | **GET** /v1/products/{id} | 
+*Vantage::PricesApi* | [**get_products**](docs/PricesApi.md#get_products) | **GET** /v1/products | 
+*Vantage::PricesApi* | [**get_providers**](docs/PricesApi.md#get_providers) | **GET** /v1/providers | 
+*Vantage::PricesApi* | [**get_services**](docs/PricesApi.md#get_services) | **GET** /v1/services | 
+
+
+## Documentation for Models
+
+ - [Vantage::Price](docs/Price.md)
+ - [Vantage::Prices](docs/Prices.md)
+ - [Vantage::Product](docs/Product.md)
+ - [Vantage::Products](docs/Products.md)
+ - [Vantage::Provider](docs/Provider.md)
+ - [Vantage::Providers](docs/Providers.md)
+ - [Vantage::Service](docs/Service.md)
+ - [Vantage::Services](docs/Services.md)
+
+
+## Documentation for Authorization
+
+
+### oauth2
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - read: Grants read access
+

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/docs/PingApi.md

@@ -0,0 +1,53 @@
+# Vantage::PingApi
+
+All URIs are relative to *https://api.vantage.sh*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**ping**](PingApi.md#ping) | **GET** /v1/ping | 
+
+
+# **ping**
+> ping
+
+
+
+This is a health check endpoint that can be used to determine Vantage API healthiness. It will return a 200 success with the raw text of \"pong\" if everything is running smoothly.
+
+### Example
+```ruby
+# load the gem
+require 'vantage-client'
+# setup authorization
+Vantage.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Vantage::PingApi.new
+
+begin
+  api_instance.ping
+rescue Vantage::ApiError => e
+  puts "Exception when calling PingApi->ping: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Price.md

@@ -0,0 +1,14 @@
+# Vantage::Price
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**unit** | **String** | The unit in which the amount is billed. | [optional] 
+**region** | **String** | The region the price is specific to. | [optional] 
+**rate_type** | **String** | The part of the product the price applies to. (compute, transfer, etc..) | [optional] 
+**currency** | **String** | The currency of the amount. | [optional] 
+**amount** | **Float** | The amount of money this specific product price costs. | [optional] 
+**details** | **Object** | Service specific metadata. | [optional] 
+
+

data/docs/Prices.md

@@ -0,0 +1,9 @@
+# Vantage::Prices
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | **Object** |  | [optional] 
+**prices** | [**Array<Price>**](Price.md) |  | [optional] 
+
+

data/docs/PricesApi.md

@@ -0,0 +1,323 @@
+# Vantage::PricesApi
+
+All URIs are relative to *https://api.vantage.sh*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_price**](PricesApi.md#get_price) | **GET** /v1/products/{product_id}/prices/{id} | 
+[**get_prices**](PricesApi.md#get_prices) | **GET** /v1/products/{product_id}/prices | 
+[**get_product**](PricesApi.md#get_product) | **GET** /v1/products/{id} | 
+[**get_products**](PricesApi.md#get_products) | **GET** /v1/products | 
+[**get_providers**](PricesApi.md#get_providers) | **GET** /v1/providers | 
+[**get_services**](PricesApi.md#get_services) | **GET** /v1/services | 
+
+
+# **get_price**
+> Price get_price(product_id, id)
+
+
+
+Returns a price
+
+### Example
+```ruby
+# load the gem
+require 'vantage-client'
+# setup authorization
+Vantage.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Vantage::PricesApi.new
+
+product_id = 'product_id_example' # String | 
+
+id = 'id_example' # String | Unique identifier of the price e.g. aws-ec2-m5d_16xlarge-eu_central_1-on_demand-linux_enterprise
+
+
+begin
+  result = api_instance.get_price(product_id, id)
+  p result
+rescue Vantage::ApiError => e
+  puts "Exception when calling PricesApi->get_price: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**|  | 
+ **id** | **String**| Unique identifier of the price e.g. aws-ec2-m5d_16xlarge-eu_central_1-on_demand-linux_enterprise | 
+
+### Return type
+
+[**Price**](Price.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_prices**
+> Prices get_prices(product_id)
+
+
+
+Return available Prices across all Regions for a Product.
+
+### Example
+```ruby
+# load the gem
+require 'vantage-client'
+# setup authorization
+Vantage.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Vantage::PricesApi.new
+
+product_id = 'product_id_example' # String | The Product ID that you wish to query prices for.
+
+
+begin
+  result = api_instance.get_prices(product_id)
+  p result
+rescue Vantage::ApiError => e
+  puts "Exception when calling PricesApi->get_prices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| The Product ID that you wish to query prices for. | 
+
+### Return type
+
+[**Prices**](Prices.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_product**
+> Product get_product(id)
+
+
+
+Return a product
+
+### Example
+```ruby
+# load the gem
+require 'vantage-client'
+# setup authorization
+Vantage.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Vantage::PricesApi.new
+
+id = 'id_example' # String | Unique identifier of the product e.g. aws-ec2-m5d_16xlarge
+
+
+begin
+  result = api_instance.get_product(id)
+  p result
+rescue Vantage::ApiError => e
+  puts "Exception when calling PricesApi->get_product: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique identifier of the product e.g. aws-ec2-m5d_16xlarge | 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_products**
+> Products get_products(opts)
+
+
+
+Return available Products for a Service. For example, with a Provider of AWS and a Service of EC2, Products will be a list of all EC2 Instances. By default, this endpoint returns all Products across all Services and Providers but has optional query parameters for filtering listed below.
+
+### Example
+```ruby
+# load the gem
+require 'vantage-client'
+# setup authorization
+Vantage.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Vantage::PricesApi.new
+
+opts = { 
+  provider_id: 'provider_id_example', # String | Query by Provider to list all Products across all Services for a Provider. e.g. aws
+  service_id: 'service_id_example', # String | Query by Service to list all Products for a specific provider service. e.g. aws-ec2
+  name: 'name_example' # String | Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge
+}
+
+begin
+  result = api_instance.get_products(opts)
+  p result
+rescue Vantage::ApiError => e
+  puts "Exception when calling PricesApi->get_products: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **provider_id** | **String**| Query by Provider to list all Products across all Services for a Provider. e.g. aws | [optional] 
+ **service_id** | **String**| Query by Service to list all Products for a specific provider service. e.g. aws-ec2 | [optional] 
+ **name** | **String**| Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge | [optional] 
+
+### Return type
+
+[**Products**](Products.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_providers**
+> Providers get_providers
+
+
+
+Providers are cloud infrastructure and service providers from which all cloud prices are derived. You can think of example Providers as being AWS, GCP, Cloudflare or Datadog. Currently, Vantage only supports a single provider of AWS but over time more will be added. Use this endpoint to retrieve a provider id for other API calls.
+
+### Example
+```ruby
+# load the gem
+require 'vantage-client'
+# setup authorization
+Vantage.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Vantage::PricesApi.new
+
+begin
+  result = api_instance.get_providers
+  p result
+rescue Vantage::ApiError => e
+  puts "Exception when calling PricesApi->get_providers: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Providers**](Providers.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_services**
+> Services get_services(opts)
+
+
+
+Return all Services. Examples of Services are EC2 for AWS. This endpoint will return all Services by default but you have the ability to filter Services by Provider using the optional query parameter documented below.
+
+### Example
+```ruby
+# load the gem
+require 'vantage-client'
+# setup authorization
+Vantage.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Vantage::PricesApi.new
+
+opts = { 
+  provider_id: 'provider_id_example' # String | Query services for a specific provider. e.g. aws
+}
+
+begin
+  result = api_instance.get_services(opts)
+  p result
+rescue Vantage::ApiError => e
+  puts "Exception when calling PricesApi->get_services: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **provider_id** | **String**| Query services for a specific provider. e.g. aws | [optional] 
+
+### Return type
+
+[**Services**](Services.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Product.md

@@ -0,0 +1,12 @@
+# Vantage::Product
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**category** | **String** | The category of the cloud product | [optional] 
+**name** | **String** | The common name of the product. | [optional] 
+**service_id** | **String** | A unique slug for the service the product belongs to. | [optional] 
+**provider_id** | **String** | A unique slug for the provider the product belongs to. | [optional] 
+
+

data/docs/Products.md

@@ -0,0 +1,9 @@
+# Vantage::Products
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | **Object** |  | [optional] 
+**products** | [**Array<Product>**](Product.md) |  | [optional] 
+
+

data/docs/Provider.md

@@ -0,0 +1,10 @@
+# Vantage::Provider
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** | The common name of the provider. | [optional] 
+**description** | **String** | The full descriptive name of the provider. | [optional] 
+
+

data/docs/Providers.md

@@ -0,0 +1,9 @@
+# Vantage::Providers
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | **Object** |  | [optional] 
+**providers** | [**Array<Provider>**](Provider.md) |  | [optional] 
+
+

data/docs/Service.md

@@ -0,0 +1,11 @@
+# Vantage::Service
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**category** | **String** | The type of cloud service. | [optional] 
+**name** | **String** | The common name of the service. Usually an abbreviation. | [optional] 
+**description** | **String** | The full name of the service. | [optional] 
+
+

data/docs/Services.md

@@ -0,0 +1,9 @@
+# Vantage::Services
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | **Object** |  | [optional] 
+**services** | [**Array<Service>**](Service.md) |  | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id=""
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id=""
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note=""
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+