intrinio-sdk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +176 -0
- data/Rakefile +8 -0
- data/docs/ApiResponseCompanies.md +9 -0
- data/docs/ApiResponseCompanyFilings.md +10 -0
- data/docs/ApiResponseCompanyFundamentals.md +10 -0
- data/docs/ApiResponseCompanyHistoricalData.md +10 -0
- data/docs/ApiResponseCompanyNews.md +10 -0
- data/docs/ApiResponseCompanySecurities.md +10 -0
- data/docs/ApiResponseDataTags.md +9 -0
- data/docs/ApiResponseEconomicIndexHistoricalData.md +10 -0
- data/docs/ApiResponseEconomicIndices.md +9 -0
- data/docs/ApiResponseFilings.md +9 -0
- data/docs/ApiResponseHistoricalData.md +9 -0
- data/docs/ApiResponseNews.md +9 -0
- data/docs/ApiResponseReportedFinancials.md +10 -0
- data/docs/ApiResponseSICIndexHistoricalData.md +10 -0
- data/docs/ApiResponseSICIndices.md +9 -0
- data/docs/ApiResponseSecurities.md +9 -0
- data/docs/ApiResponseSecurityHistoricalData.md +10 -0
- data/docs/ApiResponseSecurityStockPriceAdjustments.md +10 -0
- data/docs/ApiResponseSecurityStockPrices.md +10 -0
- data/docs/ApiResponseStandardizedFinancials.md +10 -0
- data/docs/ApiResponseStockExchangeSecurities.md +10 -0
- data/docs/ApiResponseStockExchangeStockPriceAdjustments.md +10 -0
- data/docs/ApiResponseStockExchangeStockPrices.md +10 -0
- data/docs/ApiResponseStockExchanges.md +9 -0
- data/docs/ApiResponseStockMarketIndexHistoricalData.md +10 -0
- data/docs/ApiResponseStockMarketIndices.md +9 -0
- data/docs/Company.md +39 -0
- data/docs/CompanyApi.md +659 -0
- data/docs/CompanyFiling.md +17 -0
- data/docs/CompanyNews.md +13 -0
- data/docs/CompanyNewsSummary.md +12 -0
- data/docs/CompanySummary.md +12 -0
- data/docs/DataPointApi.md +96 -0
- data/docs/DataTag.md +17 -0
- data/docs/DataTagApi.md +184 -0
- data/docs/DataTagSummary.md +11 -0
- data/docs/EconomicIndex.md +19 -0
- data/docs/EconomicIndexSummary.md +18 -0
- data/docs/Filing.md +17 -0
- data/docs/FilingApi.md +142 -0
- data/docs/FilingSummary.md +16 -0
- data/docs/Fundamental.md +16 -0
- data/docs/FundamentalSummary.md +15 -0
- data/docs/FundamentalsApi.md +181 -0
- data/docs/HistoricalData.md +9 -0
- data/docs/HistoricalDataApi.md +64 -0
- data/docs/IndexApi.md +800 -0
- data/docs/ReportedFinancial.md +9 -0
- data/docs/ReportedTag.md +14 -0
- data/docs/SICIndex.md +12 -0
- data/docs/Security.md +34 -0
- data/docs/SecurityApi.md +420 -0
- data/docs/SecurityScreenClause.md +10 -0
- data/docs/SecurityScreenGroup.md +10 -0
- data/docs/SecurityScreenResult.md +9 -0
- data/docs/SecurityScreenResultData.md +10 -0
- data/docs/SecuritySummary.md +17 -0
- data/docs/StandardizedFinancial.md +9 -0
- data/docs/StockExchange.md +17 -0
- data/docs/StockExchangeApi.md +267 -0
- data/docs/StockMarketIndex.md +17 -0
- data/docs/StockMarketIndexSummary.md +16 -0
- data/docs/StockPrice.md +21 -0
- data/docs/StockPriceAdjustment.md +12 -0
- data/docs/StockPriceAdjustmentSummary.md +13 -0
- data/docs/StockPriceSummary.md +20 -0
- data/git_push.sh +55 -0
- data/intrinio-sdk.gemspec +45 -0
- data/lib/intrinio-sdk.rb +105 -0
- data/lib/intrinio-sdk/api/company_api.rb +885 -0
- data/lib/intrinio-sdk/api/data_point_api.rb +141 -0
- data/lib/intrinio-sdk/api/data_tag_api.rb +251 -0
- data/lib/intrinio-sdk/api/filing_api.rb +192 -0
- data/lib/intrinio-sdk/api/fundamentals_api.rb +261 -0
- data/lib/intrinio-sdk/api/historical_data_api.rb +100 -0
- data/lib/intrinio-sdk/api/index_api.rb +1079 -0
- data/lib/intrinio-sdk/api/security_api.rb +568 -0
- data/lib/intrinio-sdk/api/stock_exchange_api.rb +353 -0
- data/lib/intrinio-sdk/api_client.rb +389 -0
- data/lib/intrinio-sdk/api_error.rb +38 -0
- data/lib/intrinio-sdk/configuration.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_companies.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_company_filings.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_company_news.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_company_securities.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_data_tags.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_economic_indices.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_filings.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_historical_data.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_news.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_reported_financials.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_securities.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_sic_indices.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +211 -0
- data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +200 -0
- data/lib/intrinio-sdk/models/company.rb +498 -0
- data/lib/intrinio-sdk/models/company_filing.rb +278 -0
- data/lib/intrinio-sdk/models/company_news.rb +239 -0
- data/lib/intrinio-sdk/models/company_news_summary.rb +229 -0
- data/lib/intrinio-sdk/models/company_summary.rb +229 -0
- data/lib/intrinio-sdk/models/data_tag.rb +312 -0
- data/lib/intrinio-sdk/models/data_tag_summary.rb +219 -0
- data/lib/intrinio-sdk/models/economic_index.rb +299 -0
- data/lib/intrinio-sdk/models/economic_index_summary.rb +289 -0
- data/lib/intrinio-sdk/models/filing.rb +278 -0
- data/lib/intrinio-sdk/models/filing_summary.rb +269 -0
- data/lib/intrinio-sdk/models/fundamental.rb +302 -0
- data/lib/intrinio-sdk/models/fundamental_summary.rb +292 -0
- data/lib/intrinio-sdk/models/historical_data.rb +199 -0
- data/lib/intrinio-sdk/models/reported_financial.rb +198 -0
- data/lib/intrinio-sdk/models/reported_tag.rb +249 -0
- data/lib/intrinio-sdk/models/security.rb +453 -0
- data/lib/intrinio-sdk/models/security_screen_clause.rb +242 -0
- data/lib/intrinio-sdk/models/security_screen_group.rb +213 -0
- data/lib/intrinio-sdk/models/security_screen_result.rb +199 -0
- data/lib/intrinio-sdk/models/security_screen_result_data.rb +209 -0
- data/lib/intrinio-sdk/models/security_summary.rb +279 -0
- data/lib/intrinio-sdk/models/sic_index.rb +229 -0
- data/lib/intrinio-sdk/models/standardized_financial.rb +198 -0
- data/lib/intrinio-sdk/models/stock_exchange.rb +279 -0
- data/lib/intrinio-sdk/models/stock_market_index.rb +279 -0
- data/lib/intrinio-sdk/models/stock_market_index_summary.rb +269 -0
- data/lib/intrinio-sdk/models/stock_price.rb +352 -0
- data/lib/intrinio-sdk/models/stock_price_adjustment.rb +229 -0
- data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +239 -0
- data/lib/intrinio-sdk/models/stock_price_summary.rb +342 -0
- data/lib/intrinio-sdk/version.rb +15 -0
- data/spec/api/company_api_spec.rb +233 -0
- data/spec/api/data_point_api_spec.rb +61 -0
- data/spec/api/data_tag_api_spec.rb +88 -0
- data/spec/api/filing_api_spec.rb +75 -0
- data/spec/api/fundamentals_api_spec.rb +86 -0
- data/spec/api/historical_data_api_spec.rb +53 -0
- data/spec/api/index_api_spec.rb +275 -0
- data/spec/api/security_api_spec.rb +161 -0
- data/spec/api/stock_exchange_api_spec.rb +113 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/api_response_companies_spec.rb +48 -0
- data/spec/models/api_response_company_filings_spec.rb +54 -0
- data/spec/models/api_response_company_fundamentals_spec.rb +54 -0
- data/spec/models/api_response_company_historical_data_spec.rb +54 -0
- data/spec/models/api_response_company_news_spec.rb +54 -0
- data/spec/models/api_response_company_securities_spec.rb +54 -0
- data/spec/models/api_response_data_tags_spec.rb +48 -0
- data/spec/models/api_response_economic_index_historical_data_spec.rb +54 -0
- data/spec/models/api_response_economic_indices_spec.rb +48 -0
- data/spec/models/api_response_filings_spec.rb +48 -0
- data/spec/models/api_response_historical_data_spec.rb +48 -0
- data/spec/models/api_response_news_spec.rb +48 -0
- data/spec/models/api_response_reported_financials_spec.rb +54 -0
- data/spec/models/api_response_securities_spec.rb +48 -0
- data/spec/models/api_response_security_historical_data_spec.rb +54 -0
- data/spec/models/api_response_security_stock_price_adjustments_spec.rb +54 -0
- data/spec/models/api_response_security_stock_prices_spec.rb +54 -0
- data/spec/models/api_response_sic_index_historical_data_spec.rb +54 -0
- data/spec/models/api_response_sic_indices_spec.rb +48 -0
- data/spec/models/api_response_standardized_financials_spec.rb +54 -0
- data/spec/models/api_response_stock_exchange_securities_spec.rb +54 -0
- data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +54 -0
- data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +54 -0
- data/spec/models/api_response_stock_exchanges_spec.rb +48 -0
- data/spec/models/api_response_stock_market_index_historical_data_spec.rb +54 -0
- data/spec/models/api_response_stock_market_indices_spec.rb +48 -0
- data/spec/models/company_filing_spec.rb +96 -0
- data/spec/models/company_news_spec.rb +72 -0
- data/spec/models/company_news_summary_spec.rb +66 -0
- data/spec/models/company_spec.rb +228 -0
- data/spec/models/company_summary_spec.rb +66 -0
- data/spec/models/data_tag_spec.rb +100 -0
- data/spec/models/data_tag_summary_spec.rb +60 -0
- data/spec/models/economic_index_spec.rb +108 -0
- data/spec/models/economic_index_summary_spec.rb +102 -0
- data/spec/models/filing_spec.rb +96 -0
- data/spec/models/filing_summary_spec.rb +90 -0
- data/spec/models/fundamental_spec.rb +94 -0
- data/spec/models/fundamental_summary_spec.rb +88 -0
- data/spec/models/historical_data_spec.rb +48 -0
- data/spec/models/reported_financial_spec.rb +48 -0
- data/spec/models/reported_tag_spec.rb +78 -0
- data/spec/models/security_screen_clause_spec.rb +58 -0
- data/spec/models/security_screen_group_spec.rb +54 -0
- data/spec/models/security_screen_result_data_spec.rb +54 -0
- data/spec/models/security_screen_result_spec.rb +48 -0
- data/spec/models/security_spec.rb +198 -0
- data/spec/models/security_summary_spec.rb +96 -0
- data/spec/models/sic_index_spec.rb +66 -0
- data/spec/models/standardized_financial_spec.rb +48 -0
- data/spec/models/stock_exchange_spec.rb +96 -0
- data/spec/models/stock_market_index_spec.rb +96 -0
- data/spec/models/stock_market_index_summary_spec.rb +90 -0
- data/spec/models/stock_price_adjustment_spec.rb +66 -0
- data/spec/models/stock_price_adjustment_summary_spec.rb +72 -0
- data/spec/models/stock_price_spec.rb +124 -0
- data/spec/models/stock_price_summary_spec.rb +118 -0
- data/spec/spec_helper.rb +111 -0
- metadata +509 -0
|
@@ -0,0 +1,353 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Intrinio API
|
|
3
|
+
|
|
4
|
+
#Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.3.0-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require "uri"
|
|
14
|
+
|
|
15
|
+
module Intrinio
|
|
16
|
+
class StockExchangeApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Filter Stock Exchanges
|
|
24
|
+
# Return Stock Exchanges matching the given filters
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @option opts [String] :city Filter by city
|
|
27
|
+
# @option opts [String] :country Filter by country
|
|
28
|
+
# @option opts [String] :country_code Filter by ISO country code
|
|
29
|
+
# @return [ApiResponseStockExchanges]
|
|
30
|
+
def filter_stock_exchanges(opts = {})
|
|
31
|
+
data, _status_code, _headers = filter_stock_exchanges_with_http_info(opts)
|
|
32
|
+
return data
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Filter Stock Exchanges
|
|
36
|
+
# Return Stock Exchanges matching the given filters
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @option opts [String] :city Filter by city
|
|
39
|
+
# @option opts [String] :country Filter by country
|
|
40
|
+
# @option opts [String] :country_code Filter by ISO country code
|
|
41
|
+
# @return [Array<(ApiResponseStockExchanges, Fixnum, Hash)>] ApiResponseStockExchanges data, response status code and response headers
|
|
42
|
+
def filter_stock_exchanges_with_http_info(opts = {})
|
|
43
|
+
if @api_client.config.debugging
|
|
44
|
+
@api_client.config.logger.debug "Calling API: StockExchangeApi.filter_stock_exchanges ..."
|
|
45
|
+
end
|
|
46
|
+
# resource path
|
|
47
|
+
local_var_path = "/stock_exchanges/filter"
|
|
48
|
+
|
|
49
|
+
# query parameters
|
|
50
|
+
query_params = {}
|
|
51
|
+
query_params[:'city'] = opts[:'city'] if !opts[:'city'].nil?
|
|
52
|
+
query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
|
|
53
|
+
query_params[:'country_code'] = opts[:'country_code'] if !opts[:'country_code'].nil?
|
|
54
|
+
|
|
55
|
+
# header parameters
|
|
56
|
+
header_params = {}
|
|
57
|
+
# HTTP header 'Accept' (if needed)
|
|
58
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
59
|
+
|
|
60
|
+
# form parameters
|
|
61
|
+
form_params = {}
|
|
62
|
+
|
|
63
|
+
# http body (model)
|
|
64
|
+
post_body = nil
|
|
65
|
+
auth_names = ['ApiKeyAuth']
|
|
66
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
67
|
+
:header_params => header_params,
|
|
68
|
+
:query_params => query_params,
|
|
69
|
+
:form_params => form_params,
|
|
70
|
+
:body => post_body,
|
|
71
|
+
:auth_names => auth_names,
|
|
72
|
+
:return_type => 'ApiResponseStockExchanges')
|
|
73
|
+
if @api_client.config.debugging
|
|
74
|
+
@api_client.config.logger.debug "API called: StockExchangeApi#filter_stock_exchanges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
75
|
+
end
|
|
76
|
+
return data, status_code, headers
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Get All Stock Exchanges
|
|
80
|
+
# Return All Stock Exchanges
|
|
81
|
+
# @param [Hash] opts the optional parameters
|
|
82
|
+
# @return [ApiResponseStockExchanges]
|
|
83
|
+
def get_all_stock_exchanges(opts = {})
|
|
84
|
+
data, _status_code, _headers = get_all_stock_exchanges_with_http_info(opts)
|
|
85
|
+
return data
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Get All Stock Exchanges
|
|
89
|
+
# Return All Stock Exchanges
|
|
90
|
+
# @param [Hash] opts the optional parameters
|
|
91
|
+
# @return [Array<(ApiResponseStockExchanges, Fixnum, Hash)>] ApiResponseStockExchanges data, response status code and response headers
|
|
92
|
+
def get_all_stock_exchanges_with_http_info(opts = {})
|
|
93
|
+
if @api_client.config.debugging
|
|
94
|
+
@api_client.config.logger.debug "Calling API: StockExchangeApi.get_all_stock_exchanges ..."
|
|
95
|
+
end
|
|
96
|
+
# resource path
|
|
97
|
+
local_var_path = "/stock_exchanges"
|
|
98
|
+
|
|
99
|
+
# query parameters
|
|
100
|
+
query_params = {}
|
|
101
|
+
|
|
102
|
+
# header parameters
|
|
103
|
+
header_params = {}
|
|
104
|
+
# HTTP header 'Accept' (if needed)
|
|
105
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
106
|
+
|
|
107
|
+
# form parameters
|
|
108
|
+
form_params = {}
|
|
109
|
+
|
|
110
|
+
# http body (model)
|
|
111
|
+
post_body = nil
|
|
112
|
+
auth_names = ['ApiKeyAuth']
|
|
113
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
114
|
+
:header_params => header_params,
|
|
115
|
+
:query_params => query_params,
|
|
116
|
+
:form_params => form_params,
|
|
117
|
+
:body => post_body,
|
|
118
|
+
:auth_names => auth_names,
|
|
119
|
+
:return_type => 'ApiResponseStockExchanges')
|
|
120
|
+
if @api_client.config.debugging
|
|
121
|
+
@api_client.config.logger.debug "API called: StockExchangeApi#get_all_stock_exchanges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
122
|
+
end
|
|
123
|
+
return data, status_code, headers
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# Get Stock Exchange by ID
|
|
127
|
+
#
|
|
128
|
+
# @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
|
|
129
|
+
# @param [Hash] opts the optional parameters
|
|
130
|
+
# @return [StockExchange]
|
|
131
|
+
def get_stock_exchange_by_id(identifier, opts = {})
|
|
132
|
+
data, _status_code, _headers = get_stock_exchange_by_id_with_http_info(identifier, opts)
|
|
133
|
+
return data
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# Get Stock Exchange by ID
|
|
137
|
+
#
|
|
138
|
+
# @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
|
|
139
|
+
# @param [Hash] opts the optional parameters
|
|
140
|
+
# @return [Array<(StockExchange, Fixnum, Hash)>] StockExchange data, response status code and response headers
|
|
141
|
+
def get_stock_exchange_by_id_with_http_info(identifier, opts = {})
|
|
142
|
+
if @api_client.config.debugging
|
|
143
|
+
@api_client.config.logger.debug "Calling API: StockExchangeApi.get_stock_exchange_by_id ..."
|
|
144
|
+
end
|
|
145
|
+
# verify the required parameter 'identifier' is set
|
|
146
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
|
147
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling StockExchangeApi.get_stock_exchange_by_id"
|
|
148
|
+
end
|
|
149
|
+
# resource path
|
|
150
|
+
local_var_path = "/stock_exchanges/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)
|
|
151
|
+
|
|
152
|
+
# query parameters
|
|
153
|
+
query_params = {}
|
|
154
|
+
|
|
155
|
+
# header parameters
|
|
156
|
+
header_params = {}
|
|
157
|
+
# HTTP header 'Accept' (if needed)
|
|
158
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
159
|
+
|
|
160
|
+
# form parameters
|
|
161
|
+
form_params = {}
|
|
162
|
+
|
|
163
|
+
# http body (model)
|
|
164
|
+
post_body = nil
|
|
165
|
+
auth_names = ['ApiKeyAuth']
|
|
166
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
167
|
+
:header_params => header_params,
|
|
168
|
+
:query_params => query_params,
|
|
169
|
+
:form_params => form_params,
|
|
170
|
+
:body => post_body,
|
|
171
|
+
:auth_names => auth_names,
|
|
172
|
+
:return_type => 'StockExchange')
|
|
173
|
+
if @api_client.config.debugging
|
|
174
|
+
@api_client.config.logger.debug "API called: StockExchangeApi#get_stock_exchange_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
175
|
+
end
|
|
176
|
+
return data, status_code, headers
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
# Get Stock Price Adjustments by Exchange
|
|
180
|
+
# Return stock price adjustments for the Stock Exchange with the given `identifier`
|
|
181
|
+
# @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
|
|
182
|
+
# @param [Hash] opts the optional parameters
|
|
183
|
+
# @option opts [Date] :date The date for which to return price adjustments
|
|
184
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
|
185
|
+
# @return [ApiResponseStockExchangeStockPriceAdjustments]
|
|
186
|
+
def get_stock_exchange_price_adjustments(identifier, opts = {})
|
|
187
|
+
data, _status_code, _headers = get_stock_exchange_price_adjustments_with_http_info(identifier, opts)
|
|
188
|
+
return data
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
# Get Stock Price Adjustments by Exchange
|
|
192
|
+
# Return stock price adjustments for the Stock Exchange with the given `identifier`
|
|
193
|
+
# @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
|
|
194
|
+
# @param [Hash] opts the optional parameters
|
|
195
|
+
# @option opts [Date] :date The date for which to return price adjustments
|
|
196
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
|
197
|
+
# @return [Array<(ApiResponseStockExchangeStockPriceAdjustments, Fixnum, Hash)>] ApiResponseStockExchangeStockPriceAdjustments data, response status code and response headers
|
|
198
|
+
def get_stock_exchange_price_adjustments_with_http_info(identifier, opts = {})
|
|
199
|
+
if @api_client.config.debugging
|
|
200
|
+
@api_client.config.logger.debug "Calling API: StockExchangeApi.get_stock_exchange_price_adjustments ..."
|
|
201
|
+
end
|
|
202
|
+
# verify the required parameter 'identifier' is set
|
|
203
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
|
204
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling StockExchangeApi.get_stock_exchange_price_adjustments"
|
|
205
|
+
end
|
|
206
|
+
# resource path
|
|
207
|
+
local_var_path = "/stock_exchanges/{identifier}/prices/adjustments".sub('{' + 'identifier' + '}', identifier.to_s)
|
|
208
|
+
|
|
209
|
+
# query parameters
|
|
210
|
+
query_params = {}
|
|
211
|
+
query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
|
|
212
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
|
213
|
+
|
|
214
|
+
# header parameters
|
|
215
|
+
header_params = {}
|
|
216
|
+
# HTTP header 'Accept' (if needed)
|
|
217
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
218
|
+
|
|
219
|
+
# form parameters
|
|
220
|
+
form_params = {}
|
|
221
|
+
|
|
222
|
+
# http body (model)
|
|
223
|
+
post_body = nil
|
|
224
|
+
auth_names = ['ApiKeyAuth']
|
|
225
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
226
|
+
:header_params => header_params,
|
|
227
|
+
:query_params => query_params,
|
|
228
|
+
:form_params => form_params,
|
|
229
|
+
:body => post_body,
|
|
230
|
+
:auth_names => auth_names,
|
|
231
|
+
:return_type => 'ApiResponseStockExchangeStockPriceAdjustments')
|
|
232
|
+
if @api_client.config.debugging
|
|
233
|
+
@api_client.config.logger.debug "API called: StockExchangeApi#get_stock_exchange_price_adjustments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
234
|
+
end
|
|
235
|
+
return data, status_code, headers
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
# Get Stock Prices by Exchange
|
|
239
|
+
# Return daily Stock Prices for Securities on the Stock Exchange with `identifier` and on the `price_date` (or the latest date that prices are available)
|
|
240
|
+
# @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
|
|
241
|
+
# @param [Hash] opts the optional parameters
|
|
242
|
+
# @option opts [Date] :date The date for which to return prices
|
|
243
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
|
244
|
+
# @return [ApiResponseStockExchangeStockPrices]
|
|
245
|
+
def get_stock_exchange_prices(identifier, opts = {})
|
|
246
|
+
data, _status_code, _headers = get_stock_exchange_prices_with_http_info(identifier, opts)
|
|
247
|
+
return data
|
|
248
|
+
end
|
|
249
|
+
|
|
250
|
+
# Get Stock Prices by Exchange
|
|
251
|
+
# Return daily Stock Prices for Securities on the Stock Exchange with `identifier` and on the `price_date` (or the latest date that prices are available)
|
|
252
|
+
# @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
|
|
253
|
+
# @param [Hash] opts the optional parameters
|
|
254
|
+
# @option opts [Date] :date The date for which to return prices
|
|
255
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
|
256
|
+
# @return [Array<(ApiResponseStockExchangeStockPrices, Fixnum, Hash)>] ApiResponseStockExchangeStockPrices data, response status code and response headers
|
|
257
|
+
def get_stock_exchange_prices_with_http_info(identifier, opts = {})
|
|
258
|
+
if @api_client.config.debugging
|
|
259
|
+
@api_client.config.logger.debug "Calling API: StockExchangeApi.get_stock_exchange_prices ..."
|
|
260
|
+
end
|
|
261
|
+
# verify the required parameter 'identifier' is set
|
|
262
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
|
263
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling StockExchangeApi.get_stock_exchange_prices"
|
|
264
|
+
end
|
|
265
|
+
# resource path
|
|
266
|
+
local_var_path = "/stock_exchanges/{identifier}/prices".sub('{' + 'identifier' + '}', identifier.to_s)
|
|
267
|
+
|
|
268
|
+
# query parameters
|
|
269
|
+
query_params = {}
|
|
270
|
+
query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
|
|
271
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
|
272
|
+
|
|
273
|
+
# header parameters
|
|
274
|
+
header_params = {}
|
|
275
|
+
# HTTP header 'Accept' (if needed)
|
|
276
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
277
|
+
|
|
278
|
+
# form parameters
|
|
279
|
+
form_params = {}
|
|
280
|
+
|
|
281
|
+
# http body (model)
|
|
282
|
+
post_body = nil
|
|
283
|
+
auth_names = ['ApiKeyAuth']
|
|
284
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
285
|
+
:header_params => header_params,
|
|
286
|
+
:query_params => query_params,
|
|
287
|
+
:form_params => form_params,
|
|
288
|
+
:body => post_body,
|
|
289
|
+
:auth_names => auth_names,
|
|
290
|
+
:return_type => 'ApiResponseStockExchangeStockPrices')
|
|
291
|
+
if @api_client.config.debugging
|
|
292
|
+
@api_client.config.logger.debug "API called: StockExchangeApi#get_stock_exchange_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
293
|
+
end
|
|
294
|
+
return data, status_code, headers
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
# Get Securities by Exchange
|
|
298
|
+
# Return Securities traded on the Stock Exchange with `identifier`
|
|
299
|
+
# @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
|
|
300
|
+
# @param [Hash] opts the optional parameters
|
|
301
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
|
302
|
+
# @return [ApiResponseStockExchangeSecurities]
|
|
303
|
+
def get_stock_exchange_securities(identifier, opts = {})
|
|
304
|
+
data, _status_code, _headers = get_stock_exchange_securities_with_http_info(identifier, opts)
|
|
305
|
+
return data
|
|
306
|
+
end
|
|
307
|
+
|
|
308
|
+
# Get Securities by Exchange
|
|
309
|
+
# Return Securities traded on the Stock Exchange with `identifier`
|
|
310
|
+
# @param identifier A Stock Exchange identifier (MIC or Intrinio ID)
|
|
311
|
+
# @param [Hash] opts the optional parameters
|
|
312
|
+
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
|
313
|
+
# @return [Array<(ApiResponseStockExchangeSecurities, Fixnum, Hash)>] ApiResponseStockExchangeSecurities data, response status code and response headers
|
|
314
|
+
def get_stock_exchange_securities_with_http_info(identifier, opts = {})
|
|
315
|
+
if @api_client.config.debugging
|
|
316
|
+
@api_client.config.logger.debug "Calling API: StockExchangeApi.get_stock_exchange_securities ..."
|
|
317
|
+
end
|
|
318
|
+
# verify the required parameter 'identifier' is set
|
|
319
|
+
if @api_client.config.client_side_validation && identifier.nil?
|
|
320
|
+
fail ArgumentError, "Missing the required parameter 'identifier' when calling StockExchangeApi.get_stock_exchange_securities"
|
|
321
|
+
end
|
|
322
|
+
# resource path
|
|
323
|
+
local_var_path = "/stock_exchanges/{identifier}/securities".sub('{' + 'identifier' + '}', identifier.to_s)
|
|
324
|
+
|
|
325
|
+
# query parameters
|
|
326
|
+
query_params = {}
|
|
327
|
+
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
|
328
|
+
|
|
329
|
+
# header parameters
|
|
330
|
+
header_params = {}
|
|
331
|
+
# HTTP header 'Accept' (if needed)
|
|
332
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
333
|
+
|
|
334
|
+
# form parameters
|
|
335
|
+
form_params = {}
|
|
336
|
+
|
|
337
|
+
# http body (model)
|
|
338
|
+
post_body = nil
|
|
339
|
+
auth_names = ['ApiKeyAuth']
|
|
340
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
341
|
+
:header_params => header_params,
|
|
342
|
+
:query_params => query_params,
|
|
343
|
+
:form_params => form_params,
|
|
344
|
+
:body => post_body,
|
|
345
|
+
:auth_names => auth_names,
|
|
346
|
+
:return_type => 'ApiResponseStockExchangeSecurities')
|
|
347
|
+
if @api_client.config.debugging
|
|
348
|
+
@api_client.config.logger.debug "API called: StockExchangeApi#get_stock_exchange_securities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
349
|
+
end
|
|
350
|
+
return data, status_code, headers
|
|
351
|
+
end
|
|
352
|
+
end
|
|
353
|
+
end
|
|
@@ -0,0 +1,389 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Intrinio API
|
|
3
|
+
|
|
4
|
+
#Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.3.0-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'json'
|
|
15
|
+
require 'logger'
|
|
16
|
+
require 'tempfile'
|
|
17
|
+
require 'typhoeus'
|
|
18
|
+
require 'uri'
|
|
19
|
+
|
|
20
|
+
module Intrinio
|
|
21
|
+
class ApiClient
|
|
22
|
+
# The Configuration object holding settings to be used in the API client.
|
|
23
|
+
attr_accessor :config
|
|
24
|
+
|
|
25
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
|
26
|
+
#
|
|
27
|
+
# @return [Hash]
|
|
28
|
+
attr_accessor :default_headers
|
|
29
|
+
|
|
30
|
+
# Initializes the ApiClient
|
|
31
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
|
32
|
+
def initialize(config = Configuration.default)
|
|
33
|
+
@config = config
|
|
34
|
+
@user_agent = "Swagger-Codegen/#{VERSION}/ruby"
|
|
35
|
+
@default_headers = {
|
|
36
|
+
'Content-Type' => "application/json",
|
|
37
|
+
'User-Agent' => @user_agent
|
|
38
|
+
}
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def self.default
|
|
42
|
+
@@default ||= ApiClient.new
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Call an API with given options.
|
|
46
|
+
#
|
|
47
|
+
# @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
|
|
48
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
|
49
|
+
def call_api(http_method, path, opts = {})
|
|
50
|
+
request = build_request(http_method, path, opts)
|
|
51
|
+
response = request.run
|
|
52
|
+
|
|
53
|
+
if @config.debugging
|
|
54
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
unless response.success?
|
|
58
|
+
if response.timed_out?
|
|
59
|
+
fail ApiError.new('Connection timed out')
|
|
60
|
+
elsif response.code == 0
|
|
61
|
+
# Errors from libcurl will be made visible here
|
|
62
|
+
fail ApiError.new(:code => 0,
|
|
63
|
+
:message => response.return_message)
|
|
64
|
+
else
|
|
65
|
+
fail ApiError.new(:code => response.code,
|
|
66
|
+
:response_headers => response.headers,
|
|
67
|
+
:response_body => response.body),
|
|
68
|
+
response.status_message
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
if opts[:return_type]
|
|
73
|
+
data = deserialize(response, opts[:return_type])
|
|
74
|
+
else
|
|
75
|
+
data = nil
|
|
76
|
+
end
|
|
77
|
+
return data, response.code, response.headers
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Builds the HTTP request
|
|
81
|
+
#
|
|
82
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
|
83
|
+
# @param [String] path URL path (e.g. /account/new)
|
|
84
|
+
# @option opts [Hash] :header_params Header parameters
|
|
85
|
+
# @option opts [Hash] :query_params Query parameters
|
|
86
|
+
# @option opts [Hash] :form_params Query parameters
|
|
87
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
|
88
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
|
89
|
+
def build_request(http_method, path, opts = {})
|
|
90
|
+
url = build_request_url(path)
|
|
91
|
+
http_method = http_method.to_sym.downcase
|
|
92
|
+
|
|
93
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
|
94
|
+
query_params = opts[:query_params] || {}
|
|
95
|
+
form_params = opts[:form_params] || {}
|
|
96
|
+
|
|
97
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
|
98
|
+
|
|
99
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
|
100
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
|
101
|
+
|
|
102
|
+
req_opts = {
|
|
103
|
+
:method => http_method,
|
|
104
|
+
:headers => header_params,
|
|
105
|
+
:params => query_params,
|
|
106
|
+
:params_encoding => @config.params_encoding,
|
|
107
|
+
:timeout => @config.timeout,
|
|
108
|
+
:ssl_verifypeer => @config.verify_ssl,
|
|
109
|
+
:ssl_verifyhost => _verify_ssl_host,
|
|
110
|
+
:sslcert => @config.cert_file,
|
|
111
|
+
:sslkey => @config.key_file,
|
|
112
|
+
:verbose => @config.debugging
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
# set custom cert, if provided
|
|
116
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
|
117
|
+
|
|
118
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
|
119
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
|
120
|
+
req_opts.update :body => req_body
|
|
121
|
+
if @config.debugging
|
|
122
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
request = Typhoeus::Request.new(url, req_opts)
|
|
127
|
+
download_file(request) if opts[:return_type] == 'File'
|
|
128
|
+
request
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# Check if the given MIME is a JSON MIME.
|
|
132
|
+
# JSON MIME examples:
|
|
133
|
+
# application/json
|
|
134
|
+
# application/json; charset=UTF8
|
|
135
|
+
# APPLICATION/JSON
|
|
136
|
+
# */*
|
|
137
|
+
# @param [String] mime MIME
|
|
138
|
+
# @return [Boolean] True if the MIME is application/json
|
|
139
|
+
def json_mime?(mime)
|
|
140
|
+
(mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
# Deserialize the response to the given return type.
|
|
144
|
+
#
|
|
145
|
+
# @param [Response] response HTTP response
|
|
146
|
+
# @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
|
|
147
|
+
def deserialize(response, return_type)
|
|
148
|
+
body = response.body
|
|
149
|
+
|
|
150
|
+
# handle file downloading - return the File instance processed in request callbacks
|
|
151
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
|
152
|
+
return @tempfile if return_type == 'File'
|
|
153
|
+
|
|
154
|
+
return nil if body.nil? || body.empty?
|
|
155
|
+
|
|
156
|
+
# return response body directly for String return type
|
|
157
|
+
return body if return_type == 'String'
|
|
158
|
+
|
|
159
|
+
# ensuring a default content type
|
|
160
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
|
161
|
+
|
|
162
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
|
163
|
+
|
|
164
|
+
begin
|
|
165
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
|
166
|
+
rescue JSON::ParserError => e
|
|
167
|
+
if %w(String Date DateTime).include?(return_type)
|
|
168
|
+
data = body
|
|
169
|
+
else
|
|
170
|
+
raise e
|
|
171
|
+
end
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
convert_to_type data, return_type
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Convert data to the given return type.
|
|
178
|
+
# @param [Object] data Data to be converted
|
|
179
|
+
# @param [String] return_type Return type
|
|
180
|
+
# @return [Mixed] Data in a particular type
|
|
181
|
+
def convert_to_type(data, return_type)
|
|
182
|
+
return nil if data.nil?
|
|
183
|
+
case return_type
|
|
184
|
+
when 'String'
|
|
185
|
+
data.to_s
|
|
186
|
+
when 'Integer'
|
|
187
|
+
data.to_i
|
|
188
|
+
when 'Float'
|
|
189
|
+
data.to_f
|
|
190
|
+
when 'BOOLEAN'
|
|
191
|
+
data == true
|
|
192
|
+
when 'DateTime'
|
|
193
|
+
# parse date time (expecting ISO 8601 format)
|
|
194
|
+
DateTime.parse data
|
|
195
|
+
when 'Date'
|
|
196
|
+
# parse date time (expecting ISO 8601 format)
|
|
197
|
+
Date.parse data
|
|
198
|
+
when 'Object'
|
|
199
|
+
# generic object (usually a Hash), return directly
|
|
200
|
+
data
|
|
201
|
+
when /\AArray<(.+)>\z/
|
|
202
|
+
# e.g. Array<Pet>
|
|
203
|
+
sub_type = $1
|
|
204
|
+
data.map {|item| convert_to_type(item, sub_type) }
|
|
205
|
+
when /\AHash\<String, (.+)\>\z/
|
|
206
|
+
# e.g. Hash<String, Integer>
|
|
207
|
+
sub_type = $1
|
|
208
|
+
{}.tap do |hash|
|
|
209
|
+
data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
|
|
210
|
+
end
|
|
211
|
+
else
|
|
212
|
+
# models, e.g. Pet
|
|
213
|
+
Intrinio.const_get(return_type).new.tap do |model|
|
|
214
|
+
model.build_from_hash data
|
|
215
|
+
end
|
|
216
|
+
end
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
|
220
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
|
221
|
+
# The response body is written to the file in chunks in order to handle files which
|
|
222
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
|
223
|
+
# process can use.
|
|
224
|
+
#
|
|
225
|
+
# @see Configuration#temp_folder_path
|
|
226
|
+
def download_file(request)
|
|
227
|
+
tempfile = nil
|
|
228
|
+
encoding = nil
|
|
229
|
+
request.on_headers do |response|
|
|
230
|
+
content_disposition = response.headers['Content-Disposition']
|
|
231
|
+
if content_disposition and content_disposition =~ /filename=/i
|
|
232
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
|
233
|
+
prefix = sanitize_filename(filename)
|
|
234
|
+
else
|
|
235
|
+
prefix = 'download-'
|
|
236
|
+
end
|
|
237
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
|
238
|
+
encoding = response.body.encoding
|
|
239
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
|
240
|
+
@tempfile = tempfile
|
|
241
|
+
end
|
|
242
|
+
request.on_body do |chunk|
|
|
243
|
+
chunk.force_encoding(encoding)
|
|
244
|
+
tempfile.write(chunk)
|
|
245
|
+
end
|
|
246
|
+
request.on_complete do |response|
|
|
247
|
+
tempfile.close
|
|
248
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
|
249
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
|
250
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
|
251
|
+
"explicitly with `tempfile.delete`"
|
|
252
|
+
end
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# Sanitize filename by removing path.
|
|
256
|
+
# e.g. ../../sun.gif becomes sun.gif
|
|
257
|
+
#
|
|
258
|
+
# @param [String] filename the filename to be sanitized
|
|
259
|
+
# @return [String] the sanitized filename
|
|
260
|
+
def sanitize_filename(filename)
|
|
261
|
+
filename.gsub(/.*[\/\\]/, '')
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
def build_request_url(path)
|
|
265
|
+
# Add leading and trailing slashes to path
|
|
266
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
|
267
|
+
URI.encode(@config.base_url + path)
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
# Builds the HTTP request body
|
|
271
|
+
#
|
|
272
|
+
# @param [Hash] header_params Header parameters
|
|
273
|
+
# @param [Hash] form_params Query parameters
|
|
274
|
+
# @param [Object] body HTTP body (JSON/XML)
|
|
275
|
+
# @return [String] HTTP body data in the form of string
|
|
276
|
+
def build_request_body(header_params, form_params, body)
|
|
277
|
+
# http form
|
|
278
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
|
279
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
|
280
|
+
data = {}
|
|
281
|
+
form_params.each do |key, value|
|
|
282
|
+
case value
|
|
283
|
+
when ::File, ::Array, nil
|
|
284
|
+
# let typhoeus handle File, Array and nil parameters
|
|
285
|
+
data[key] = value
|
|
286
|
+
else
|
|
287
|
+
data[key] = value.to_s
|
|
288
|
+
end
|
|
289
|
+
end
|
|
290
|
+
elsif body
|
|
291
|
+
data = body.is_a?(String) ? body : body.to_json
|
|
292
|
+
else
|
|
293
|
+
data = nil
|
|
294
|
+
end
|
|
295
|
+
data
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
# Update hearder and query params based on authentication settings.
|
|
299
|
+
#
|
|
300
|
+
# @param [Hash] header_params Header parameters
|
|
301
|
+
# @param [Hash] query_params Query parameters
|
|
302
|
+
# @param [String] auth_names Authentication scheme name
|
|
303
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
|
304
|
+
Array(auth_names).each do |auth_name|
|
|
305
|
+
auth_setting = @config.auth_settings[auth_name]
|
|
306
|
+
next unless auth_setting
|
|
307
|
+
case auth_setting[:in]
|
|
308
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
|
309
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
|
310
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
|
311
|
+
end
|
|
312
|
+
end
|
|
313
|
+
end
|
|
314
|
+
|
|
315
|
+
# Sets user agent in HTTP header
|
|
316
|
+
#
|
|
317
|
+
# @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
|
|
318
|
+
def user_agent=(user_agent)
|
|
319
|
+
@user_agent = user_agent
|
|
320
|
+
@default_headers['User-Agent'] = @user_agent
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
# Return Accept header based on an array of accepts provided.
|
|
324
|
+
# @param [Array] accepts array for Accept
|
|
325
|
+
# @return [String] the Accept header (e.g. application/json)
|
|
326
|
+
def select_header_accept(accepts)
|
|
327
|
+
return nil if accepts.nil? || accepts.empty?
|
|
328
|
+
# use JSON when present, otherwise use all of the provided
|
|
329
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
|
330
|
+
return json_accept || accepts.join(',')
|
|
331
|
+
end
|
|
332
|
+
|
|
333
|
+
# Return Content-Type header based on an array of content types provided.
|
|
334
|
+
# @param [Array] content_types array for Content-Type
|
|
335
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
|
336
|
+
def select_header_content_type(content_types)
|
|
337
|
+
# use application/json by default
|
|
338
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
|
339
|
+
# use JSON when present, otherwise use the first one
|
|
340
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
|
341
|
+
return json_content_type || content_types.first
|
|
342
|
+
end
|
|
343
|
+
|
|
344
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
|
345
|
+
# @param [Object] model object to be converted into JSON string
|
|
346
|
+
# @return [String] JSON string representation of the object
|
|
347
|
+
def object_to_http_body(model)
|
|
348
|
+
return model if model.nil? || model.is_a?(String)
|
|
349
|
+
local_body = nil
|
|
350
|
+
if model.is_a?(Array)
|
|
351
|
+
local_body = model.map{|m| object_to_hash(m) }
|
|
352
|
+
else
|
|
353
|
+
local_body = object_to_hash(model)
|
|
354
|
+
end
|
|
355
|
+
local_body.to_json
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
# Convert object(non-array) to hash.
|
|
359
|
+
# @param [Object] obj object to be converted into JSON string
|
|
360
|
+
# @return [String] JSON string representation of the object
|
|
361
|
+
def object_to_hash(obj)
|
|
362
|
+
if obj.respond_to?(:to_hash)
|
|
363
|
+
obj.to_hash
|
|
364
|
+
else
|
|
365
|
+
obj
|
|
366
|
+
end
|
|
367
|
+
end
|
|
368
|
+
|
|
369
|
+
# Build parameter value according to the given collection format.
|
|
370
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
|
371
|
+
def build_collection_param(param, collection_format)
|
|
372
|
+
case collection_format
|
|
373
|
+
when :csv
|
|
374
|
+
param.join(',')
|
|
375
|
+
when :ssv
|
|
376
|
+
param.join(' ')
|
|
377
|
+
when :tsv
|
|
378
|
+
param.join("\t")
|
|
379
|
+
when :pipes
|
|
380
|
+
param.join('|')
|
|
381
|
+
when :multi
|
|
382
|
+
# return the array directly as typhoeus will handle it as expected
|
|
383
|
+
param
|
|
384
|
+
else
|
|
385
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
|
386
|
+
end
|
|
387
|
+
end
|
|
388
|
+
end
|
|
389
|
+
end
|