vantage-client 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 243fe9208fe7924d332f6f03b25564d991e66b3d039408005493ac4c7dbfe107
-  data.tar.gz: 5fc8d08e8ea14bb6653733e7fea7e8628ee41949923e4f64d1615e73284fdf77
+  metadata.gz: f7247776b559b6a8d00a27fedd29ed81616a47ffbd7b654a903568955cc66df0
+  data.tar.gz: 6a8dad9ef5f488c2bb01a52e4828967acc1a5d281d953a44ef451f4902f98fbb
 SHA512:
-  metadata.gz: 3792d480fac0f037811c53328b460da141a7c6f98b00b0d234a65e013d6bab9e36e9b933fbd2612b825e35e7a2a53b8e74562b287d46f1a46d7fead501fd57c3
-  data.tar.gz: 24dc77ecc924688bbd0a807339157acd02eceade6e43304ca67cf20d92b9c0d1579b8b7f94ca56466498eadc8a1f63423c22526d4783ab28916f3537b3e1b864
+  metadata.gz: c575b3412c5941653d86de027945027b46fa291309d0f2453c4c319783ddaf7e587f0bd9671170748ac63f87d4cd9818ca1f7ee6ec1949dbe1670daeae049f59
+  data.tar.gz: a22d005f893b9af0d0fca3d7e2fa8035a7f4c8618126910139885bef89e27b12f39005f3cd48a8704d8d7cf2cebffc396c98362b8f61d482c7c045dd58cc0909

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    vantage-client (0.1.0.beta.2)
+      addressable (~> 2.3, >= 2.3.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.12.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.18)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.0)
+    hashdiff (1.0.1)
+    json (2.5.1)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  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.3.3)
+  rspec (~> 3.6, >= 3.6.0)
+  vantage-client!
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   2.2.3

data/README.md

@@ -1,111 +1,171 @@
-# vantage-client
+[![Build Status](https://www.travis-ci.com/vantage-sh/vantage-ruby.svg?branch=main)](https://www.travis-ci.com/vantage-sh/vantage-ruby)
 
-Vantage - the Ruby gem for the Vantage
+# Vantage Ruby Client
 
-Vantage API
+![Vantage Picture](https://uploads-ssl.webflow.com/5f9ba05ba40d6414f341df34/5f9bb1764b6670c6f7739564_moutain-scene.svg)
 
-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.6
-- Build package: io.swagger.codegen.languages.RubyClientCodegen
-For more information, please visit [https://www.vantage.sh](https://www.vantage.sh)
+[Vantage](http://vantage.sh/) is a cloud cost transparency platform. This is the official Ruby client for the [Vantage API](http://vantage.readme.io/). You can use the API to get EC2 instance price and product information through a few simple-to-use API calls. The data offered through this API is heavily inspired from data avaiable from [ec2instances.info](http://ec2instances.info/). The feedback we get from users is that this API is significantly easier than learning and using AWS Pricing APIs. We have plans to expand the data available through this API in the future.
 
-## Installation
-
-### Build a gem
+## Need Help?
 
-To build the Ruby code into a gem:
+Feel free to join us in our [community Slack](https://join.slack.com/t/vantagecommunity/shared_invite/zt-oey52myv-gq4AWRKkX25kjp1UGziPTw) in the #api channel. We're happy to chat and help. You're also welcome to email support@vantage.sh or ping [@JoinVantage](https://twitter.com/joinvantage) on Twitter and we're happy to give assistance. Lastly, we monitor issues on this repo if you have any feature requests or issues. 
 
-```shell
-gem build vantage-client.gemspec
-```
+## Installation
 
-Then either install the gem locally:
+The easiest way to get going is to install the client through RubyGems:
 
 ```shell
-gem install ./vantage-client-0.0.6.gem
+gem install vantage-client
 ```
-(for development, run `gem install --dev ./vantage-client-0.0.6.gem` to install the development dependencies)
 
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+## Generate a Free API Token
+The Vantage API is provided completely for free but requires an API token to use. To generate a free API token, follow these steps:
 
-Finally add this to the Gemfile:
+* Head to [http://vantage.sh/](http://vantage.sh/)
+* Register a free account and confirm your email
+* When you're asked _"What would you like to do first?"_ click _"Access Cloud Pricing API"_
+* Create an API token from the account profile page and you're all set
 
-    gem 'vantage-client', '~> 0.0.6'
+You'll only need to do this once and you can use your API token for all usage going forward. 
 
-### Install from Git
+## API Primitives
 
-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:
+The Vantage API is currently organized into four different primitives. Understanding the relationships between these primitives will be helpful as you onboard to the API. Since Vantage only supports EC2 on AWS at the moment, this is provided mainly to show how we are looking at support for future data:
 
-    gem 'vantage-client', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+* **Providers**: Providers are the highest level API Primitive. A Provider represents either cloud infrastructure provider or a cloud service provider. Some examples of Providers include AWS, GCP or Azure. Providers offer many Services, which is documented below.
+* **Services**: Services are what Providers offer to their customers. A Service is always tied to a Provider. Some examples of Services are EC2 or S3 from a Provider of AWS. A Service has one or more Products offered, which is documented below.
+* **Products**: Products are what Services ultimately price on. Using the example of a Provider of 'AWS' and a Service of 'EC2', Products would be the individual EC2 Instance Types available such as 'm5d.16xlarge' or 'c5.xlarge'. A Product has one or more Prices, which is documented below.
+* **Prices**: A Product has one or more Prices available to it. For example with EC2 instance types, a single instance type may have potential prices including an on-demand price, a spot price or a reserved instance price.
 
-### 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:
+Once you've installed the client, you'll want to confirm your API token is working correctly. We offer a "ping" endpoint for testing this and overall API healthiness:
+
 ```ruby
 # Load the gem
 require 'vantage-client'
 
-# Setup authorization
+# Configure Vantage with your API token. Replace "YOUR_API_TOKEN" with the token you generate. 
 Vantage.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
+  config.access_token = 'YOUR_API_TOKEN'
 end
 
-api_instance = Vantage::PingApi.new
+api_instance = Vantage::CostsApi.new
+
+report_id = 'report_id_example' # String | 
+
+opts = { 
+  start_date: 'start_date_example', # String | Query costs by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
+  end_date: 'end_date_example' # String | Query costs by the last date you would like to filter to. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
+}
 
 begin
-  api_instance.ping
+  result = api_instance.get_costs(report_id, opts)
+  p result
 rescue Vantage::ApiError => e
-  puts "Exception when calling PingApi->ping: #{e}"
+  puts "Exception when calling CostsApi->get_costs: #{e}"
 end
 
+# {
+#   :ping => "pong"
+# }
+
 ```
 
-## Documentation for API Endpoints
+## Getting EC2 Instance Information
+
+Getting EC2 instance product information is one of the most used functions of the API. Here's an example of how to get product information for a c5.xlarge EC2 instance:
+
+```ruby
 
-All URIs are relative to *https://api.vantage.sh*
+# Load the gem
+require 'vantage-client'
 
-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 | 
+# Configure Vantage with your API token. Replace "YOUR_API_TOKEN" with the token you generate. 
+Vantage.configure do |config|
+  config.access_token = 'YOUR_API_TOKEN'
+end
 
+# The Vantage::PricesApi class helps get simple information 
+vantage_client = Vantage::PricesApi.new
+
+# Find all instances with the instance type name of 'c5.xlarge'
+response = vantage_client.get_products(name: 'c5.xlarge')
+
+# See the entire response
+puts response.products.first
+# { 
+#   :id=>"aws-ec2-c5_xlarge", 
+#   :category=>"compute", 
+#   :name=>"c5.xlarge", 
+#   :service_id=>"aws-ec2", 
+#   :provider_id=>"aws", 
+#   :details=>{
+#     :gpu=>0, 
+#     :name=>"C5 High-CPU Extra Large", 
+#     :vcpu=>4, 
+#     :memory=>8.0, 
+#     :storage=>nil, 
+#     :clock_speed_ghz=>3.0, 
+#     :physical_processor_description=>"Intel Xeon Platinum 8124M", 
+#     :network_performance_description=>"Up to 10 Gigabit"
+#   }
+# }
+
+```
+
+## Getting EC2 Instance Pricing
+
+Getting the price of an EC2 instance is also easy to do. Here's an example of how to get the price for a c5.xlarge. You'll need the product ID from the prior call to retrive prices. Note that Vantage will return all prices across all regions, platforms and lifecycle so client-side you'll want to filter for the appropriate region, platform and lifecycle.
+
+The price returned in the example below will give you the **on-demand** price for a **linux** EC2 instance in **us-east-1**.
+
+```ruby 
+
+# Load the gem
+require 'vantage-client'
+
+# Configure Vantage with your API token.  Replace "YOUR_API_TOKEN" with the token you generate. 
+Vantage.configure do |config|
+  config.access_token = 'YOUR_API_TOKEN'
+end
+
+# The Vantage::PricesApi class helps get simple information 
+vantage_client = Vantage::PricesApi.new
+
+# Find all prices using the product ID returned in the previous example
+# Note that this will return all prices across all regions and platform types by default.
+response = vantage_client.get_prices('aws-ec2-c5_xlarge')
+
+puts response.prices.first
+# {
+#   :id=>"aws-ec2-c5_xlarge-us_east_1-on_demand-linux", 
+#   :unit=>"hour", 
+#   :region=>"us-east-1", 
+#   :rate_type=>"compute", 
+#   :currency=>"USD", 
+#   :amount=>0.17, 
+#   :details=>{
+#     :platform=>"linux", 
+#     :lifecycle=>"on-demand"
+#   }
+# }
+```
 
 ## Documentation for Models
 
+ - [Vantage::Cost](docs/Cost.md)
+ - [Vantage::Costs](docs/Costs.md)
  - [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::Report](docs/Report.md)
+ - [Vantage::Reports](docs/Reports.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/docs/Cost.md

@@ -0,0 +1,11 @@
+# Vantage::Cost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accrued_at** | **String** | The date the cost was accrued. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00. | [optional] 
+**amount** | **String** | The amount of the cost. | [optional] 
+**provider** | **String** | The service provider where the cost was incurred. e.g. AWS | [optional] 
+**service** | **String** | The service which incurred the cost. e.g. Amazon ElastiCache | [optional] 
+
+

data/docs/Costs.md

@@ -0,0 +1,11 @@
+# Vantage::Costs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | **Object** |  | [optional] 
+**total** | **String** | The sum of all amounts of costs for the entire report for the requested period. | [optional] 
+**currency** | **String** | The currency both the total and cost amount values are represented in. e.g. USD | [optional] 
+**costs** | [**Array<Cost>**](Cost.md) |  | [optional] 
+
+

data/docs/CostsApi.md

@@ -0,0 +1,177 @@
+# Vantage::CostsApi
+
+All URIs are relative to *https://api.vantage.sh*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_costs**](CostsApi.md#get_costs) | **GET** /v1/reports/{report_id}/costs | 
+[**get_report**](CostsApi.md#get_report) | **GET** /v1/reports/{report_id} | 
+[**get_reports**](CostsApi.md#get_reports) | **GET** /v1/reports | 
+
+
+# **get_costs**
+> Costs get_costs(report_id, opts)
+
+
+
+Return available Costs for the specified Cost Report and optional time period. If no time period is specified it will return all available costs for the report.
+
+### 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::CostsApi.new
+
+report_id = 'report_id_example' # String | 
+
+opts = { 
+  start_date: 'start_date_example', # String | Query costs by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
+  end_date: 'end_date_example', # String | Query costs by the last date you would like to filter to. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
+  page: 2, # Integer | The page of results to return.
+  limit: 500 # Integer | The amount of results to return. The maximum is 1000
+}
+
+begin
+  result = api_instance.get_costs(report_id, opts)
+  p result
+rescue Vantage::ApiError => e
+  puts "Exception when calling CostsApi->get_costs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **report_id** | **String**|  | 
+ **start_date** | **String**| Query costs by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00. | [optional] 
+ **end_date** | **String**| Query costs by the last date you would like to filter to. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00. | [optional] 
+ **page** | **Integer**| The page of results to return. | [optional] 
+ **limit** | **Integer**| The amount of results to return. The maximum is 1000 | [optional] 
+
+### Return type
+
+[**Costs**](Costs.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_report**
+> Report get_report(report_id)
+
+
+
+Return a Cost Report.
+
+### 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::CostsApi.new
+
+report_id = 'report_id_example' # String | 
+
+
+begin
+  result = api_instance.get_report(report_id)
+  p result
+rescue Vantage::ApiError => e
+  puts "Exception when calling CostsApi->get_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **report_id** | **String**|  | 
+
+### Return type
+
+[**Report**](Report.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_reports**
+> Reports get_reports(opts)
+
+
+
+Return all Cost Reports.
+
+### 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::CostsApi.new
+
+opts = { 
+  page: 2, # Integer | The page of results to return.
+  limit: 500 # Integer | The amount of results to return. The maximum is 1000
+}
+
+begin
+  result = api_instance.get_reports(opts)
+  p result
+rescue Vantage::ApiError => e
+  puts "Exception when calling CostsApi->get_reports: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page of results to return. | [optional] 
+ **limit** | **Integer**| The amount of results to return. The maximum is 1000 | [optional] 
+
+### Return type
+
+[**Reports**](Reports.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+