coinmarketcap_client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (80) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +121 -0
  4. data/Rakefile +8 -0
  5. data/coinmarketcap_api.gemspec +45 -0
  6. data/coinmarketcap_client.gemspec +45 -0
  7. data/docs/DefaultApi.md +262 -0
  8. data/docs/Info.md +18 -0
  9. data/docs/InfoUrls.md +15 -0
  10. data/docs/InlineResponse200.md +9 -0
  11. data/docs/InlineResponse2001.md +9 -0
  12. data/docs/InlineResponse2002.md +9 -0
  13. data/docs/InlineResponse2003.md +9 -0
  14. data/docs/InlineResponse2004.md +9 -0
  15. data/docs/InlineResponse2005.md +9 -0
  16. data/docs/InlineResponseDefault.md +8 -0
  17. data/docs/InlineResponseDefault1.md +8 -0
  18. data/docs/Map.md +15 -0
  19. data/docs/MarketData.md +21 -0
  20. data/docs/Platform.md +12 -0
  21. data/docs/Quote.md +14 -0
  22. data/docs/Status.md +12 -0
  23. data/git_push.sh +55 -0
  24. data/lib/coinmarketcap_api.rb +50 -0
  25. data/lib/coinmarketcap_api/api/default_api.rb +145 -0
  26. data/lib/coinmarketcap_api/api_client.rb +389 -0
  27. data/lib/coinmarketcap_api/api_error.rb +38 -0
  28. data/lib/coinmarketcap_api/configuration.rb +209 -0
  29. data/lib/coinmarketcap_api/models/info.rb +276 -0
  30. data/lib/coinmarketcap_api/models/info_urls.rb +263 -0
  31. data/lib/coinmarketcap_api/models/inline_response_200.rb +194 -0
  32. data/lib/coinmarketcap_api/models/inline_response_200_1.rb +185 -0
  33. data/lib/coinmarketcap_api/models/inline_response_200_2.rb +194 -0
  34. data/lib/coinmarketcap_api/models/inline_response_200_3.rb +185 -0
  35. data/lib/coinmarketcap_api/models/inline_response_default.rb +183 -0
  36. data/lib/coinmarketcap_api/models/inline_response_default_1.rb +183 -0
  37. data/lib/coinmarketcap_api/models/map.rb +246 -0
  38. data/lib/coinmarketcap_api/models/status.rb +219 -0
  39. data/lib/coinmarketcap_api/version.rb +15 -0
  40. data/lib/coinmarketcap_client.rb +55 -0
  41. data/lib/coinmarketcap_client/api/default_api.rb +300 -0
  42. data/lib/coinmarketcap_client/api_client.rb +389 -0
  43. data/lib/coinmarketcap_client/api_error.rb +38 -0
  44. data/lib/coinmarketcap_client/configuration.rb +209 -0
  45. data/lib/coinmarketcap_client/models/info.rb +276 -0
  46. data/lib/coinmarketcap_client/models/info_urls.rb +263 -0
  47. data/lib/coinmarketcap_client/models/inline_response_200.rb +194 -0
  48. data/lib/coinmarketcap_client/models/inline_response_200_1.rb +194 -0
  49. data/lib/coinmarketcap_client/models/inline_response_200_2.rb +194 -0
  50. data/lib/coinmarketcap_client/models/inline_response_200_3.rb +194 -0
  51. data/lib/coinmarketcap_client/models/inline_response_200_4.rb +194 -0
  52. data/lib/coinmarketcap_client/models/inline_response_200_5.rb +194 -0
  53. data/lib/coinmarketcap_client/models/inline_response_default.rb +183 -0
  54. data/lib/coinmarketcap_client/models/inline_response_default_1.rb +183 -0
  55. data/lib/coinmarketcap_client/models/map.rb +246 -0
  56. data/lib/coinmarketcap_client/models/market_data.rb +304 -0
  57. data/lib/coinmarketcap_client/models/platform.rb +220 -0
  58. data/lib/coinmarketcap_client/models/quote.rb +237 -0
  59. data/lib/coinmarketcap_client/models/status.rb +219 -0
  60. data/lib/coinmarketcap_client/version.rb +15 -0
  61. data/spec/api/default_api_spec.rb +63 -0
  62. data/spec/api_client_spec.rb +226 -0
  63. data/spec/configuration_spec.rb +42 -0
  64. data/spec/models/info_spec.rb +101 -0
  65. data/spec/models/info_urls_spec.rb +83 -0
  66. data/spec/models/inline_response_200_1_spec.rb +41 -0
  67. data/spec/models/inline_response_200_2_spec.rb +47 -0
  68. data/spec/models/inline_response_200_3_spec.rb +41 -0
  69. data/spec/models/inline_response_200_4_spec.rb +47 -0
  70. data/spec/models/inline_response_200_5_spec.rb +47 -0
  71. data/spec/models/inline_response_200_spec.rb +47 -0
  72. data/spec/models/inline_response_default_1_spec.rb +41 -0
  73. data/spec/models/inline_response_default_spec.rb +41 -0
  74. data/spec/models/map_spec.rb +83 -0
  75. data/spec/models/market_data_spec.rb +119 -0
  76. data/spec/models/platform_spec.rb +65 -0
  77. data/spec/models/quote_spec.rb +77 -0
  78. data/spec/models/status_spec.rb +65 -0
  79. data/spec/spec_helper.rb +111 -0
  80. metadata +320 -0
@@ -0,0 +1,15 @@
1
+ =begin
2
+ #Coinmarketcap API Swagger Implementation
3
+
4
+ #Define coinmarketcap's api in swagger 2.0 openapi standard
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.4
10
+
11
+ =end
12
+
13
+ module CoinmarketcapAPI
14
+ VERSION = '1.0.0'
15
+ end
@@ -0,0 +1,55 @@
1
+ =begin
2
+ #Coinmarketcap API Swagger Implementation
3
+
4
+ #Define coinmarketcap's api in swagger 2.0 openapi standard
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.4
10
+
11
+ =end
12
+
13
+ # Common files
14
+ require 'coinmarketcap_client/api_client'
15
+ require 'coinmarketcap_client/api_error'
16
+ require 'coinmarketcap_client/version'
17
+ require 'coinmarketcap_client/configuration'
18
+
19
+ # Models
20
+ require 'coinmarketcap_client/models/info'
21
+ require 'coinmarketcap_client/models/info_urls'
22
+ require 'coinmarketcap_client/models/inline_response_200'
23
+ require 'coinmarketcap_client/models/inline_response_200_1'
24
+ require 'coinmarketcap_client/models/inline_response_200_2'
25
+ require 'coinmarketcap_client/models/inline_response_200_3'
26
+ require 'coinmarketcap_client/models/inline_response_200_4'
27
+ require 'coinmarketcap_client/models/inline_response_200_5'
28
+ require 'coinmarketcap_client/models/inline_response_default'
29
+ require 'coinmarketcap_client/models/inline_response_default_1'
30
+ require 'coinmarketcap_client/models/map'
31
+ require 'coinmarketcap_client/models/market_data'
32
+ require 'coinmarketcap_client/models/platform'
33
+ require 'coinmarketcap_client/models/quote'
34
+ require 'coinmarketcap_client/models/status'
35
+
36
+ # APIs
37
+ require 'coinmarketcap_client/api/default_api'
38
+
39
+ module CoinmarketcapAPI
40
+ class << self
41
+ # Customize default settings for the SDK using block.
42
+ # CoinmarketcapAPI.configure do |config|
43
+ # config.username = "xxx"
44
+ # config.password = "xxx"
45
+ # end
46
+ # If no block given, return the default Configuration object.
47
+ def configure
48
+ if block_given?
49
+ yield(Configuration.default)
50
+ else
51
+ Configuration.default
52
+ end
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,300 @@
1
+ =begin
2
+ #Coinmarketcap API Swagger Implementation
3
+
4
+ #Define coinmarketcap's api in swagger 2.0 openapi standard
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.4
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module CoinmarketcapAPI
16
+ class DefaultApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get metadata
23
+ # Returns all static metadata for one or more cryptocurrencies including name, symbol, logo, and its various registered URLs.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :id One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \&quot;1,2\&quot;
26
+ # @option opts [String] :symbol Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \&quot;BTC,ETH\&quot;. At least one \&quot;id\&quot; or \&quot;symbol\&quot; is required.
27
+ # @return [InlineResponse2004]
28
+ def cryptocurrency_info_get(opts = {})
29
+ data, _status_code, _headers = cryptocurrency_info_get_with_http_info(opts)
30
+ data
31
+ end
32
+
33
+ # Get metadata
34
+ # Returns all static metadata for one or more cryptocurrencies including name, symbol, logo, and its various registered URLs.
35
+ # @param [Hash] opts the optional parameters
36
+ # @option opts [String] :id One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \&quot;1,2\&quot;
37
+ # @option opts [String] :symbol Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \&quot;BTC,ETH\&quot;. At least one \&quot;id\&quot; or \&quot;symbol\&quot; is required.
38
+ # @return [Array<(InlineResponse2004, Fixnum, Hash)>] InlineResponse2004 data, response status code and response headers
39
+ def cryptocurrency_info_get_with_http_info(opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: DefaultApi.cryptocurrency_info_get ...'
42
+ end
43
+ # resource path
44
+ local_var_path = '/cryptocurrency/info'
45
+
46
+ # query parameters
47
+ query_params = {}
48
+ query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
49
+ query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
50
+
51
+ # header parameters
52
+ header_params = {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+
56
+ # form parameters
57
+ form_params = {}
58
+
59
+ # http body (model)
60
+ post_body = nil
61
+ auth_names = ['ApiKeyAuth']
62
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
63
+ :header_params => header_params,
64
+ :query_params => query_params,
65
+ :form_params => form_params,
66
+ :body => post_body,
67
+ :auth_names => auth_names,
68
+ :return_type => 'InlineResponse2004')
69
+ if @api_client.config.debugging
70
+ @api_client.config.logger.debug "API called: DefaultApi#cryptocurrency_info_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
71
+ end
72
+ return data, status_code, headers
73
+ end
74
+ # List all cryptocurrencies (historical)
75
+ # Get a paginated list of all cryptocurrencies with market data for a given historical time. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.
76
+ # @param [Hash] opts the optional parameters
77
+ # @option opts [String] :timestamp Timestamp (Unix or ISO 8601) to return historical cryptocurrency listings for.
78
+ # @option opts [Integer] :start Optionally offset the start (1-based index) of the paginated list of items to return. (default to 1)
79
+ # @option opts [Integer] :limit Optionally specify the number of results to return. Use this parameter and the \&quot;start\&quot; parameter to determine your own pagination size. (default to 100)
80
+ # @option opts [String] :convert Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \&quot;quote\&quot; object. (default to USD)
81
+ # @option opts [String] :sort Valid values: &#x60;name&#x60; &#x60;symbol&#x60; &#x60;date_added&#x60; &#x60;market_cap&#x60; &#x60;price&#x60; &#x60;circulating_supply&#x60; &#x60;total_supply&#x60; &#x60;max_supply&#x60; &#x60;num_market_pairs&#x60; &#x60;volume_24h&#x60; &#x60;percent_change_1h&#x60; &#x60;percent_change_24h&#x60; &#x60;percent_change_7d&#x60; What field to sort the list of cryptocurrencies by. (default to market_cap)
82
+ # @option opts [String] :sort_dir Valid values: &#x60;asc&#x60; &#x60;desc&#x60;. The direction in which to order cryptocurrencies against the specified sort.
83
+ # @option opts [String] :cryptocurrency_type Valid values: &#x60;all&#x60; &#x60;coins&#x60; &#x60;tokens&#x60; The type of cryptocurrency to include.
84
+ # @return [InlineResponse2005]
85
+ def cryptocurrency_listings_historical_get(opts = {})
86
+ data, _status_code, _headers = cryptocurrency_listings_historical_get_with_http_info(opts)
87
+ data
88
+ end
89
+
90
+ # List all cryptocurrencies (historical)
91
+ # Get a paginated list of all cryptocurrencies with market data for a given historical time. Use the \&quot;convert\&quot; option to return market values in multiple fiat and cryptocurrency conversions in the same call.
92
+ # @param [Hash] opts the optional parameters
93
+ # @option opts [String] :timestamp Timestamp (Unix or ISO 8601) to return historical cryptocurrency listings for.
94
+ # @option opts [Integer] :start Optionally offset the start (1-based index) of the paginated list of items to return.
95
+ # @option opts [Integer] :limit Optionally specify the number of results to return. Use this parameter and the \&quot;start\&quot; parameter to determine your own pagination size.
96
+ # @option opts [String] :convert Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \&quot;quote\&quot; object.
97
+ # @option opts [String] :sort Valid values: &#x60;name&#x60; &#x60;symbol&#x60; &#x60;date_added&#x60; &#x60;market_cap&#x60; &#x60;price&#x60; &#x60;circulating_supply&#x60; &#x60;total_supply&#x60; &#x60;max_supply&#x60; &#x60;num_market_pairs&#x60; &#x60;volume_24h&#x60; &#x60;percent_change_1h&#x60; &#x60;percent_change_24h&#x60; &#x60;percent_change_7d&#x60; What field to sort the list of cryptocurrencies by.
98
+ # @option opts [String] :sort_dir Valid values: &#x60;asc&#x60; &#x60;desc&#x60;. The direction in which to order cryptocurrencies against the specified sort.
99
+ # @option opts [String] :cryptocurrency_type Valid values: &#x60;all&#x60; &#x60;coins&#x60; &#x60;tokens&#x60; The type of cryptocurrency to include.
100
+ # @return [Array<(InlineResponse2005, Fixnum, Hash)>] InlineResponse2005 data, response status code and response headers
101
+ def cryptocurrency_listings_historical_get_with_http_info(opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: DefaultApi.cryptocurrency_listings_historical_get ...'
104
+ end
105
+ if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'] < 1
106
+ fail ArgumentError, 'invalid value for "opts[:"start"]" when calling DefaultApi.cryptocurrency_listings_historical_get, must be greater than or equal to 1.'
107
+ end
108
+
109
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5000
110
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DefaultApi.cryptocurrency_listings_historical_get, must be smaller than or equal to 5000.'
111
+ end
112
+
113
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
114
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DefaultApi.cryptocurrency_listings_historical_get, must be greater than or equal to 1.'
115
+ end
116
+
117
+ # resource path
118
+ local_var_path = '/cryptocurrency/listings/historical'
119
+
120
+ # query parameters
121
+ query_params = {}
122
+ query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'timestamp'].nil?
123
+ query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
124
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
125
+ query_params[:'convert'] = opts[:'convert'] if !opts[:'convert'].nil?
126
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
127
+ query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
128
+ query_params[:'cryptocurrency_type'] = opts[:'cryptocurrency_type'] if !opts[:'cryptocurrency_type'].nil?
129
+
130
+ # header parameters
131
+ header_params = {}
132
+ # HTTP header 'Accept' (if needed)
133
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
134
+
135
+ # form parameters
136
+ form_params = {}
137
+
138
+ # http body (model)
139
+ post_body = nil
140
+ auth_names = ['ApiKeyAuth']
141
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
142
+ :header_params => header_params,
143
+ :query_params => query_params,
144
+ :form_params => form_params,
145
+ :body => post_body,
146
+ :auth_names => auth_names,
147
+ :return_type => 'InlineResponse2005')
148
+ if @api_client.config.debugging
149
+ @api_client.config.logger.debug "API called: DefaultApi#cryptocurrency_listings_historical_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
150
+ end
151
+ return data, status_code, headers
152
+ end
153
+ # List all cryptocurrencies (latest)
154
+ # Get a paginated list of all cryptocurrencies with latest market data. You can configure this call to sort by market cap or another market ranking field. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.
155
+ # @param [Hash] opts the optional parameters
156
+ # @option opts [Integer] :start Optionally offset the start (1-based index) of the paginated list of items to return. (default to 1)
157
+ # @option opts [Integer] :limit Optionally specify the number of results to return. Use this parameter and the \&quot;start\&quot; parameter to determine your own pagination size. (default to 100)
158
+ # @option opts [String] :convert Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \&quot;quote\&quot; object. (default to USD)
159
+ # @option opts [String] :sort Valid values: &#x60;name&#x60; &#x60;symbol&#x60; &#x60;date_added&#x60; &#x60;market_cap&#x60; &#x60;price&#x60; &#x60;circulating_supply&#x60; &#x60;total_supply&#x60; &#x60;max_supply&#x60; &#x60;num_market_pairs&#x60; &#x60;volume_24h&#x60; &#x60;percent_change_1h&#x60; &#x60;percent_change_24h&#x60; &#x60;percent_change_7d&#x60; What field to sort the list of cryptocurrencies by. (default to market_cap)
160
+ # @option opts [String] :sort_dir Valid values: &#x60;asc&#x60; &#x60;desc&#x60;. The direction in which to order cryptocurrencies against the specified sort.
161
+ # @option opts [String] :cryptocurrency_type Valid values: &#x60;all&#x60; &#x60;coins&#x60; &#x60;tokens&#x60; The type of cryptocurrency to include.
162
+ # @return [InlineResponse2005]
163
+ def cryptocurrency_listings_latest_get(opts = {})
164
+ data, _status_code, _headers = cryptocurrency_listings_latest_get_with_http_info(opts)
165
+ data
166
+ end
167
+
168
+ # List all cryptocurrencies (latest)
169
+ # Get a paginated list of all cryptocurrencies with latest market data. You can configure this call to sort by market cap or another market ranking field. Use the \&quot;convert\&quot; option to return market values in multiple fiat and cryptocurrency conversions in the same call.
170
+ # @param [Hash] opts the optional parameters
171
+ # @option opts [Integer] :start Optionally offset the start (1-based index) of the paginated list of items to return.
172
+ # @option opts [Integer] :limit Optionally specify the number of results to return. Use this parameter and the \&quot;start\&quot; parameter to determine your own pagination size.
173
+ # @option opts [String] :convert Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found here. Each conversion is returned in its own \&quot;quote\&quot; object.
174
+ # @option opts [String] :sort Valid values: &#x60;name&#x60; &#x60;symbol&#x60; &#x60;date_added&#x60; &#x60;market_cap&#x60; &#x60;price&#x60; &#x60;circulating_supply&#x60; &#x60;total_supply&#x60; &#x60;max_supply&#x60; &#x60;num_market_pairs&#x60; &#x60;volume_24h&#x60; &#x60;percent_change_1h&#x60; &#x60;percent_change_24h&#x60; &#x60;percent_change_7d&#x60; What field to sort the list of cryptocurrencies by.
175
+ # @option opts [String] :sort_dir Valid values: &#x60;asc&#x60; &#x60;desc&#x60;. The direction in which to order cryptocurrencies against the specified sort.
176
+ # @option opts [String] :cryptocurrency_type Valid values: &#x60;all&#x60; &#x60;coins&#x60; &#x60;tokens&#x60; The type of cryptocurrency to include.
177
+ # @return [Array<(InlineResponse2005, Fixnum, Hash)>] InlineResponse2005 data, response status code and response headers
178
+ def cryptocurrency_listings_latest_get_with_http_info(opts = {})
179
+ if @api_client.config.debugging
180
+ @api_client.config.logger.debug 'Calling API: DefaultApi.cryptocurrency_listings_latest_get ...'
181
+ end
182
+ if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'] < 1
183
+ fail ArgumentError, 'invalid value for "opts[:"start"]" when calling DefaultApi.cryptocurrency_listings_latest_get, must be greater than or equal to 1.'
184
+ end
185
+
186
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5000
187
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DefaultApi.cryptocurrency_listings_latest_get, must be smaller than or equal to 5000.'
188
+ end
189
+
190
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
191
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DefaultApi.cryptocurrency_listings_latest_get, must be greater than or equal to 1.'
192
+ end
193
+
194
+ # resource path
195
+ local_var_path = '/cryptocurrency/listings/latest'
196
+
197
+ # query parameters
198
+ query_params = {}
199
+ query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
200
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
201
+ query_params[:'convert'] = opts[:'convert'] if !opts[:'convert'].nil?
202
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
203
+ query_params[:'sort_dir'] = opts[:'sort_dir'] if !opts[:'sort_dir'].nil?
204
+ query_params[:'cryptocurrency_type'] = opts[:'cryptocurrency_type'] if !opts[:'cryptocurrency_type'].nil?
205
+
206
+ # header parameters
207
+ header_params = {}
208
+ # HTTP header 'Accept' (if needed)
209
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
210
+
211
+ # form parameters
212
+ form_params = {}
213
+
214
+ # http body (model)
215
+ post_body = nil
216
+ auth_names = ['ApiKeyAuth']
217
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
218
+ :header_params => header_params,
219
+ :query_params => query_params,
220
+ :form_params => form_params,
221
+ :body => post_body,
222
+ :auth_names => auth_names,
223
+ :return_type => 'InlineResponse2005')
224
+ if @api_client.config.debugging
225
+ @api_client.config.logger.debug "API called: DefaultApi#cryptocurrency_listings_latest_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
226
+ end
227
+ return data, status_code, headers
228
+ end
229
+ # Get CoinMarketCap ID map
230
+ # Returns a paginated list of all cryptocurrencies by CoinMarketCap ID. We recommend using this convenience endpoint to lookup and utilize our unique cryptocurrency id across all endpoints as typical identifiers like ticker symbols can match multiple cryptocurrencies and change over time. As a convenience you may pass a comma-separated list of cryptocurrency symbols as symbol to filter this list to only those you require.
231
+ # @param [Hash] opts the optional parameters
232
+ # @option opts [String] :listing_status Only active coins are returned by default. Pass &#39;inactive&#39; to get a list of coins that are no longer active. (default to active)
233
+ # @option opts [Integer] :start Optionally offset the start (1-based index) of the paginated list of items to return. (default to 1)
234
+ # @option opts [Integer] :limit Optionally specify the number of results to return. Use this parameter and the \&quot;start\&quot; parameter to determine your own pagination size.
235
+ # @option opts [String] :symbol Optionally pass a comma-separated list of cryptocurrency symbols to return CoinMarketCap IDs for. If this option is passed, other options will be ignored.
236
+ # @return [InlineResponse2003]
237
+ def cryptocurrency_map_get(opts = {})
238
+ data, _status_code, _headers = cryptocurrency_map_get_with_http_info(opts)
239
+ data
240
+ end
241
+
242
+ # Get CoinMarketCap ID map
243
+ # Returns a paginated list of all cryptocurrencies by CoinMarketCap ID. We recommend using this convenience endpoint to lookup and utilize our unique cryptocurrency id across all endpoints as typical identifiers like ticker symbols can match multiple cryptocurrencies and change over time. As a convenience you may pass a comma-separated list of cryptocurrency symbols as symbol to filter this list to only those you require.
244
+ # @param [Hash] opts the optional parameters
245
+ # @option opts [String] :listing_status Only active coins are returned by default. Pass &#39;inactive&#39; to get a list of coins that are no longer active.
246
+ # @option opts [Integer] :start Optionally offset the start (1-based index) of the paginated list of items to return.
247
+ # @option opts [Integer] :limit Optionally specify the number of results to return. Use this parameter and the \&quot;start\&quot; parameter to determine your own pagination size.
248
+ # @option opts [String] :symbol Optionally pass a comma-separated list of cryptocurrency symbols to return CoinMarketCap IDs for. If this option is passed, other options will be ignored.
249
+ # @return [Array<(InlineResponse2003, Fixnum, Hash)>] InlineResponse2003 data, response status code and response headers
250
+ def cryptocurrency_map_get_with_http_info(opts = {})
251
+ if @api_client.config.debugging
252
+ @api_client.config.logger.debug 'Calling API: DefaultApi.cryptocurrency_map_get ...'
253
+ end
254
+ if @api_client.config.client_side_validation && !opts[:'start'].nil? && opts[:'start'] < 1
255
+ fail ArgumentError, 'invalid value for "opts[:"start"]" when calling DefaultApi.cryptocurrency_map_get, must be greater than or equal to 1.'
256
+ end
257
+
258
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5000
259
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DefaultApi.cryptocurrency_map_get, must be smaller than or equal to 5000.'
260
+ end
261
+
262
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
263
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DefaultApi.cryptocurrency_map_get, must be greater than or equal to 1.'
264
+ end
265
+
266
+ # resource path
267
+ local_var_path = '/cryptocurrency/map'
268
+
269
+ # query parameters
270
+ query_params = {}
271
+ query_params[:'listing_status'] = opts[:'listing_status'] if !opts[:'listing_status'].nil?
272
+ query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
273
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
274
+ query_params[:'symbol'] = opts[:'symbol'] if !opts[:'symbol'].nil?
275
+
276
+ # header parameters
277
+ header_params = {}
278
+ # HTTP header 'Accept' (if needed)
279
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
280
+
281
+ # form parameters
282
+ form_params = {}
283
+
284
+ # http body (model)
285
+ post_body = nil
286
+ auth_names = ['ApiKeyAuth']
287
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
288
+ :header_params => header_params,
289
+ :query_params => query_params,
290
+ :form_params => form_params,
291
+ :body => post_body,
292
+ :auth_names => auth_names,
293
+ :return_type => 'InlineResponse2003')
294
+ if @api_client.config.debugging
295
+ @api_client.config.logger.debug "API called: DefaultApi#cryptocurrency_map_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
296
+ end
297
+ return data, status_code, headers
298
+ end
299
+ end
300
+ end
@@ -0,0 +1,389 @@
1
+ =begin
2
+ #Coinmarketcap API Swagger Implementation
3
+
4
+ #Define coinmarketcap's api in swagger 2.0 openapi standard
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.4
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 CoinmarketcapAPI
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
+ CoinmarketcapAPI.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 && 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
+ 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
+ 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