proton_api 1.8.0

data/lib/proton_api/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+module ProtonApi
+  VERSION = '1.8.0'
+end

data/proton_api.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "proton_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "proton_api"
+  s.version     = ProtonApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Swagger-Codegen"]
+  s.email       = ["info@hydrogenplatform.com"]
+  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.summary     = "Hydrogen Proton API Ruby Gem"
+  s.description = "Financial engineering module of Hydrogen Atom"
+  s.license     = "Unlicense"
+  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_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.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/spec/api/annuities_api_spec.rb

@@ -0,0 +1,107 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ProtonApi::AnnuitiesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AnnuitiesApi' do
+  before do
+    # run before each test
+    @instance = ProtonApi::AnnuitiesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AnnuitiesApi' do
+    it 'should create an instance of AnnuitiesApi' do
+      expect(@instance).to be_instance_of(ProtonApi::AnnuitiesApi)
+    end
+  end
+
+  # unit tests for annuity_calculator_accumulation_horizon
+  # Annuity Calculator - Accumulation Horizon
+  # Calculate the necessary fixed annuity contribution period
+  # @param annuity_calculator_accumulation_horizon_request Request payload for Annuity Calculator - Accumulation Horizon
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'annuity_calculator_accumulation_horizon test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for annuity_calculator_annuity_amount
+  # Annuity Calculator - Annuity Amount
+  # Calculate the achievable fixed annuity amount
+  # @param annuity_calculator_annuity_amount_request Request payload for Annuity Calculator - Annuity Amount
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'annuity_calculator_annuity_amount test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for annuity_calculator_decumulation_horizon
+  # Annuity Calculator - Decumulation Horizon
+  # Calculate the achievable fixed annuity payout period
+  # @param annuity_calculator_decumulation_horizon_request Request payload for Annuity Calculator - Decumulation Horizon
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'annuity_calculator_decumulation_horizon test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for annuity_calculator_deposit_amount
+  # Annuity Calculator - Deposit Amount
+  # Calculate the necessary periodic deposit amount for a fixed annuity
+  # @param annuity_calculator_deposit_amount_request Request payload for Annuity Calculator - Deposit Amount
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'annuity_calculator_deposit_amount test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for annuity_calculator_initial_balance
+  # Annuity Calculator - Initial Balance
+  # Calculate the necessary initial balance for a fixed annuity
+  # @param annuity_calculator_initial_balance_request Request payload for Annuity Calculator - Initial Balance
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'annuity_calculator_initial_balance test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for variable_annuity
+  # Variable Annuity
+  # Project the behavior of a variable annuity over time
+  # @param variable_annuity_request Request payload for Variable Annuity
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'variable_annuity test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/business_financial_management_api_spec.rb

@@ -0,0 +1,95 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ProtonApi::BusinessFinancialManagementApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'BusinessFinancialManagementApi' do
+  before do
+    # run before each test
+    @instance = ProtonApi::BusinessFinancialManagementApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BusinessFinancialManagementApi' do
+    it 'should create an instance of BusinessFinancialManagementApi' do
+      expect(@instance).to be_instance_of(ProtonApi::BusinessFinancialManagementApi)
+    end
+  end
+
+  # unit tests for business_financial_health_check
+  # Business Financial Health Check
+  # Calculate a series of financial ratios to assess business financial health
+  # @param business_financial_health_check_request Request payload for Business Financial Health Check
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'business_financial_health_check test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for cash_analysis
+  # Cash Analysis
+  # Analyze cash activity over time
+  # @param cash_analysis_request Request payload for Cash Analysis
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'cash_analysis test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for customer_analysis
+  # Customer Analysis
+  # Analyze customer revenues over a time period
+  # @param customer_analysis_request Request payload for Customer Analysis
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'customer_analysis test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for financial_statement_analysis
+  # Financial Statement Analysis
+  # Analyze financial statement accounting data for a business
+  # @param financial_statement_analysis_request Request payload for Financial Statement Analysis
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'financial_statement_analysis test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for invoice_analysis
+  # Invoice Analysis
+  # Analyze invoices to understand the context of money owed and paid to a business
+  # @param invoice_analysis_request Request payload for Invoice Analysis
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'invoice_analysis test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/cards_api_spec.rb

@@ -0,0 +1,59 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ProtonApi::CardsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CardsApi' do
+  before do
+    # run before each test
+    @instance = ProtonApi::CardsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CardsApi' do
+    it 'should create an instance of CardsApi' do
+      expect(@instance).to be_instance_of(ProtonApi::CardsApi)
+    end
+  end
+
+  # unit tests for card_limit_check
+  # Card Limit Check
+  # Evaluate card transaction history against spending controls
+  # @param card_limit_check_request Request payload for Card Limit Check
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'card_limit_check test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for card_transaction_authorization
+  # Card Transaction Authorization
+  # Approve or reject a card transaction based on applicable conditions
+  # @param card_transaction_authorization_request Request payload for Card Transaction Authorization
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'card_transaction_authorization test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/financial_health_api_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ProtonApi::FinancialHealthApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FinancialHealthApi' do
+  before do
+    # run before each test
+    @instance = ProtonApi::FinancialHealthApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FinancialHealthApi' do
+    it 'should create an instance of FinancialHealthApi' do
+      expect(@instance).to be_instance_of(ProtonApi::FinancialHealthApi)
+    end
+  end
+
+  # unit tests for diversification_score
+  # Diversification Score
+  # Assess how well a group of investments is diversified
+  # @param diversification_score_request Request payload for Diversification Score
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'diversification_score test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for emergency_fund_calculator
+  # Emergency Fund Calculator
+  # Calculate a target emergency fund amount and savings plan
+  # @param emergency_fund_calculator_request Request payload for Emergency Fund Calculator
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'emergency_fund_calculator test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for financial_health_check
+  # Financial Health Check
+  # Calculate a series of financial ratios to assess financial health
+  # @param financial_health_check_request Request payload for Financial Health Check
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'financial_health_check test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for portfolio_optimization_score
+  # Portfolio Optimization Score
+  # Analyze a group of investments against the optimized result
+  # @param portfolio_optimization_score_request Request payload for Portfolio Optimization Score
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'portfolio_optimization_score test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/financial_planning_api_spec.rb

@@ -0,0 +1,179 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ProtonApi::FinancialPlanningApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FinancialPlanningApi' do
+  before do
+    # run before each test
+    @instance = ProtonApi::FinancialPlanningApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FinancialPlanningApi' do
+    it 'should create an instance of FinancialPlanningApi' do
+      expect(@instance).to be_instance_of(ProtonApi::FinancialPlanningApi)
+    end
+  end
+
+  # unit tests for education_calculator_annual_cost
+  # Education Calculator - Annual Cost
+  # Calculate the achievable education costs
+  # @param education_calculator_annual_cost_request Request payload for Education Calculator - Annual Cost
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'education_calculator_annual_cost test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for education_calculator_deposit_amount
+  # Education Calculator - Deposit Amount
+  # Calculate the necessary periodic deposit amount to achieve education costs
+  # @param education_calculator_deposit_amount_request Request payload for Education Calculator - Deposit Amount
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'education_calculator_deposit_amount test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for education_calculator_percent_covered
+  # Education Calculator - Percent Covered
+  # Calculate the achievable percentage of education costs that can be covered
+  # @param education_calculator_percent_covered_request Request payload for Education Calculator - Percent Covered
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'education_calculator_percent_covered test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for mortgage_calculator_down_payment
+  # Mortgage Calculator - Down Payment
+  # Calculate the necessary down payment for the mortgage
+  # @param mortgage_calculator_down_payment_request Request payload for Mortgage Calculator - Down Payment
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'mortgage_calculator_down_payment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for mortgage_calculator_home_price
+  # Mortgage Calculator - Home Price
+  # Calculate the achievable home price for the mortgage
+  # @param mortgage_calculator_home_price_request Request payload for Mortgage Calculator - Home Price
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'mortgage_calculator_home_price test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for mortgage_calculator_periodic_payment
+  # Mortgage Calculator - Periodic Payment
+  # Calculate the periodic payment for the mortgage
+  # @param mortgage_calculator_periodic_payment_request Request payload for Mortgage Calculator - Periodic Payment
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'mortgage_calculator_periodic_payment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for purchase_calculator_amount
+  # Purchase Calculator - Amount
+  # Calculate the achievable purchase amount
+  # @param purchase_calculator_amount_request Request payload for Purchase Calculator - Amount
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'purchase_calculator_amount test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for purchase_calculator_deposit_amount
+  # Purchase Calculator - Deposit Amount
+  # Calculate the necessary periodic deposit amount to achieve the purchase amount
+  # @param purchase_calculator_deposit_amount_request Request payload for Purchase Calculator - Deposit Amount
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'purchase_calculator_deposit_amount test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for purchase_calculator_horizon
+  # Purchase Calculator - Horizon
+  # Calculate the necessary time horizon to achieve the purchase amount
+  # @param purchase_calculator_horizon_request Request payload for Purchase Calculator - Horizon
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'purchase_calculator_horizon test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retirement_calculator_deposit_amount
+  # Retirement Calculator - Deposit Amount
+  # Calculate the necessary period deposit amount to achieve the retirement expenses
+  # @param retirement_calculator_deposit_amount_request Request payload for Retirement Calculator - Deposit AMount
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'retirement_calculator_deposit_amount test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retirement_calculator_expenses
+  # Retirement Calculator - Expenses
+  # Calculate the achievable retirement expenses
+  # @param retirement_calculator_expenses_request Request payload for Retirement Calculator - Expenses
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'retirement_calculator_expenses test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retirement_calculator_percent_covered
+  # Retirement Calculator - Percent Covered
+  # Calculate the achievable percentage of retirement expenses that can be covered
+  # @param retirement_calculator_percent_covered_request Request payload for Retirement Calculator - Percent Covered
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Object>]
+  describe 'retirement_calculator_percent_covered test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end