cloudmersive-currency-api-client 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 563ce9475cac1f10d93304c5a21211632e2808e665f219859f510cbfe61c2590
+  data.tar.gz: 3814d04258f24c340e6c78960cdfa415ee55ad2c1a814c85d64137a0812875d0
+SHA512:
+  metadata.gz: d6369de3ae64808421e6931621d3e7fae0379bf56b852b709e242255660ab7a5224f766c34ae0f15bf395fee091f2effcce04a17d471c522c7e18fd64975c9c8
+  data.tar.gz: a89f9f00e567453b1d97e96d5da9d990625136282be8429e8a16ea27def7bde7fb6b1ac44567b0cd6f4447d812436e7092ef0aadfc0e7f410a473d65c701c59e

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 @@
+# cloudmersive-currency-api-client
+
+CloudmersiveCurrencyApiClient - the Ruby gem for the currencyapi
+
+The currency APIs help you retrieve exchange rates and convert prices between currencies easily.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1
+- Package version: 2.0.1
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cloudmersive-currency-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-currency-api-client-2.0.1.gem
+```
+(for development, run `gem install --dev ./cloudmersive-currency-api-client-2.0.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 'cloudmersive-currency-api-client', '~> 2.0.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'cloudmersive-currency-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.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 'cloudmersive-currency-api-client'
+
+# Setup authorization
+CloudmersiveCurrencyApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveCurrencyApiClient::CurrencyExchangeApi.new
+
+source = 'source_example' # String | Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc.
+
+destination = 'destination_example' # String | Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc.
+
+source_price = 1.2 # Float | Input price, such as 19.99 in source currency
+
+
+begin
+  #Converts a price from the source currency into the destination currency
+  result = api_instance.currency_exchange_convert_currency(source, destination, source_price)
+  p result
+rescue CloudmersiveCurrencyApiClient::ApiError => e
+  puts "Exception when calling CurrencyExchangeApi->currency_exchange_convert_currency: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersiveCurrencyApiClient::CurrencyExchangeApi* | [**currency_exchange_convert_currency**](docs/CurrencyExchangeApi.md#currency_exchange_convert_currency) | **POST** /currency/exchange-rates/convert/{source}/to/{destination} | Converts a price from the source currency into the destination currency
+*CloudmersiveCurrencyApiClient::CurrencyExchangeApi* | [**currency_exchange_get_available_currencies**](docs/CurrencyExchangeApi.md#currency_exchange_get_available_currencies) | **POST** /currency/exchange-rates/list-available | Get a list of available currencies and corresponding countries
+*CloudmersiveCurrencyApiClient::CurrencyExchangeApi* | [**currency_exchange_get_exchange_rate**](docs/CurrencyExchangeApi.md#currency_exchange_get_exchange_rate) | **POST** /currency/exchange-rates/get/{source}/to/{destination} | Gets the exchange rate from the source currency into the destination currency
+
+
+## Documentation for Models
+
+ - [CloudmersiveCurrencyApiClient::AvailableCurrency](docs/AvailableCurrency.md)
+ - [CloudmersiveCurrencyApiClient::AvailableCurrencyResponse](docs/AvailableCurrencyResponse.md)
+ - [CloudmersiveCurrencyApiClient::ConvertedCurrencyResult](docs/ConvertedCurrencyResult.md)
+ - [CloudmersiveCurrencyApiClient::ExchangeRateResult](docs/ExchangeRateResult.md)
+
+
+## Documentation for Authorization
+
+
+### Apikey
+
+- **Type**: API key
+- **API key parameter name**: Apikey
+- **Location**: HTTP header
+

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/cloudmersive-currency-api-client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#currencyapi
+
+#The currency APIs help you retrieve exchange rates and convert prices between currencies easily.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cloudmersive-currency-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-currency-api-client"
+  s.version     = CloudmersiveCurrencyApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://www.cloudmersive.com/currency-api"
+  s.summary     = "Manage currency exchange rates and convert prices between currencies."
+  s.description = "The currency APIs help you work with currency data. Convert prices between currencies and retrieve exchange rates."
+  s.license     = 'Apache 2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  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         = Dir['./**/*']
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/AvailableCurrency.md

@@ -0,0 +1,14 @@
+# CloudmersiveCurrencyApiClient::AvailableCurrency
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**iso_currency_code** | **String** | ISO 4217 currency three-letter code associated with the country | [optional] 
+**currency_symbol** | **String** | Symbol associated with the currency | [optional] 
+**currency_english_name** | **String** | Full name of the currency | [optional] 
+**country_name** | **String** | Name of the country | [optional] 
+**country_three_letter_code** | **String** | Three-letter ISO 3166-1 country code | [optional] 
+**country_iso_two_letter_code** | **String** | Two-letter ISO 3166-1 country code | [optional] 
+**is_european_union_member** | **BOOLEAN** | True if this country is currently a member of the European Union (EU), false otherwise | [optional] 
+
+

data/docs/AvailableCurrencyResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveCurrencyApiClient::AvailableCurrencyResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currencies** | [**Array<AvailableCurrency>**](AvailableCurrency.md) | List of available currencies from the API | [optional] 
+
+

data/docs/ConvertedCurrencyResult.md

@@ -0,0 +1,11 @@
+# CloudmersiveCurrencyApiClient::ConvertedCurrencyResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**converted_price** | **Float** | The converted price in the destination currency | [optional] 
+**iso_currency_code** | **String** | ISO 4217 currency three-letter code of destination price | [optional] 
+**currency_symbol** | **String** | Destination currency symbol | [optional] 
+**formatted_price_as_string** | **String** | Formatted price in the destination currency as a string | [optional] 
+
+

data/docs/CurrencyExchangeApi.md

@@ -0,0 +1,176 @@
+# CloudmersiveCurrencyApiClient::CurrencyExchangeApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**currency_exchange_convert_currency**](CurrencyExchangeApi.md#currency_exchange_convert_currency) | **POST** /currency/exchange-rates/convert/{source}/to/{destination} | Converts a price from the source currency into the destination currency
+[**currency_exchange_get_available_currencies**](CurrencyExchangeApi.md#currency_exchange_get_available_currencies) | **POST** /currency/exchange-rates/list-available | Get a list of available currencies and corresponding countries
+[**currency_exchange_get_exchange_rate**](CurrencyExchangeApi.md#currency_exchange_get_exchange_rate) | **POST** /currency/exchange-rates/get/{source}/to/{destination} | Gets the exchange rate from the source currency into the destination currency
+
+
+# **currency_exchange_convert_currency**
+> ConvertedCurrencyResult currency_exchange_convert_currency(source, destination, source_price)
+
+Converts a price from the source currency into the destination currency
+
+Automatically converts the price in the source currency into the destination currency using the latest available currency exchange rate data.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-currency-api-client'
+# setup authorization
+CloudmersiveCurrencyApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveCurrencyApiClient::CurrencyExchangeApi.new
+
+source = 'source_example' # String | Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc.
+
+destination = 'destination_example' # String | Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc.
+
+source_price = 1.2 # Float | Input price, such as 19.99 in source currency
+
+
+begin
+  #Converts a price from the source currency into the destination currency
+  result = api_instance.currency_exchange_convert_currency(source, destination, source_price)
+  p result
+rescue CloudmersiveCurrencyApiClient::ApiError => e
+  puts "Exception when calling CurrencyExchangeApi->currency_exchange_convert_currency: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | **String**| Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc. | 
+ **destination** | **String**| Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc. | 
+ **source_price** | **Float**| Input price, such as 19.99 in source currency | 
+
+### Return type
+
+[**ConvertedCurrencyResult**](ConvertedCurrencyResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **currency_exchange_get_available_currencies**
+> AvailableCurrencyResponse currency_exchange_get_available_currencies
+
+Get a list of available currencies and corresponding countries
+
+Enumerates available currencies and the countries that correspond to these currencies.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-currency-api-client'
+# setup authorization
+CloudmersiveCurrencyApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveCurrencyApiClient::CurrencyExchangeApi.new
+
+begin
+  #Get a list of available currencies and corresponding countries
+  result = api_instance.currency_exchange_get_available_currencies
+  p result
+rescue CloudmersiveCurrencyApiClient::ApiError => e
+  puts "Exception when calling CurrencyExchangeApi->currency_exchange_get_available_currencies: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AvailableCurrencyResponse**](AvailableCurrencyResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **currency_exchange_get_exchange_rate**
+> ExchangeRateResult currency_exchange_get_exchange_rate(source, destination)
+
+Gets the exchange rate from the source currency into the destination currency
+
+Automatically gets the exchange rate from the source currency into the destination currency using the latest available currency exchange rate data.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-currency-api-client'
+# setup authorization
+CloudmersiveCurrencyApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveCurrencyApiClient::CurrencyExchangeApi.new
+
+source = 'source_example' # String | Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc.
+
+destination = 'destination_example' # String | Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc.
+
+
+begin
+  #Gets the exchange rate from the source currency into the destination currency
+  result = api_instance.currency_exchange_get_exchange_rate(source, destination)
+  p result
+rescue CloudmersiveCurrencyApiClient::ApiError => e
+  puts "Exception when calling CurrencyExchangeApi->currency_exchange_get_exchange_rate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | **String**| Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc. | 
+ **destination** | **String**| Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc. | 
+
+### Return type
+
+[**ExchangeRateResult**](ExchangeRateResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/ExchangeRateResult.md

@@ -0,0 +1,8 @@
+# CloudmersiveCurrencyApiClient::ExchangeRateResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exchange_rate** | **Float** | The exchange rate from the source to the destination currency | [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="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="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="Minor update"
+    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'
+