spinnaker-gate-ruby-client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +8 -0
  3. data/Gemfile.lock +85 -0
  4. data/LICENSE +201 -0
  5. data/README.md +240 -0
  6. data/Rakefile +8 -0
  7. data/docs/Account.md +14 -0
  8. data/docs/AccountDetails.md +19 -0
  9. data/docs/AmazonInfrastructureControllerApi.md +128 -0
  10. data/docs/ApplicationControllerApi.md +754 -0
  11. data/docs/ArtifactControllerApi.md +111 -0
  12. data/docs/AuthControllerApi.md +212 -0
  13. data/docs/BakeControllerApi.md +143 -0
  14. data/docs/BuildControllerApi.md +493 -0
  15. data/docs/ClusterControllerApi.md +475 -0
  16. data/docs/ConcourseControllerApi.md +161 -0
  17. data/docs/CredentialsControllerApi.md +129 -0
  18. data/docs/EcsServerGroupEventsControllerApi.md +66 -0
  19. data/docs/ExecutionsControllerApi.md +133 -0
  20. data/docs/FirewallControllerApi.md +171 -0
  21. data/docs/GrantedAuthority.md +8 -0
  22. data/docs/HashMapstringobject.md +7 -0
  23. data/docs/HttpEntity.md +8 -0
  24. data/docs/ImageControllerApi.md +178 -0
  25. data/docs/InstanceControllerApi.md +122 -0
  26. data/docs/JobControllerApi.md +69 -0
  27. data/docs/LoadBalancerControllerApi.md +217 -0
  28. data/docs/Mapstringstring.md +7 -0
  29. data/docs/NetworkControllerApi.md +105 -0
  30. data/docs/PipelineConfigControllerApi.md +144 -0
  31. data/docs/PipelineControllerApi.md +1074 -0
  32. data/docs/PipelineTemplateDependent.md +10 -0
  33. data/docs/PipelineTemplatesControllerApi.md +350 -0
  34. data/docs/ProjectControllerApi.md +196 -0
  35. data/docs/PubsubSubscriptionControllerApi.md +48 -0
  36. data/docs/ReorderPipelinesCommand.md +9 -0
  37. data/docs/ReorderPipelinesControllerApi.md +54 -0
  38. data/docs/ResponseEntity.md +10 -0
  39. data/docs/SearchControllerApi.md +68 -0
  40. data/docs/SecurityGroupControllerApi.md +171 -0
  41. data/docs/ServerGroupControllerApi.md +125 -0
  42. data/docs/ServerGroupManagerControllerApi.md +54 -0
  43. data/docs/SnapshotControllerApi.md +110 -0
  44. data/docs/SubnetControllerApi.md +58 -0
  45. data/docs/TaskControllerApi.md +291 -0
  46. data/docs/User.md +18 -0
  47. data/docs/V2CanaryConfigControllerApi.md +259 -0
  48. data/docs/V2CanaryControllerApi.md +356 -0
  49. data/docs/V2PipelineTemplatesControllerApi.md +356 -0
  50. data/docs/Version.md +8 -0
  51. data/docs/VersionControllerApi.md +48 -0
  52. data/docs/WebhookControllerApi.md +105 -0
  53. data/git_push.sh +55 -0
  54. data/lib/swagger_client.rb +85 -0
  55. data/lib/swagger_client/api/amazon_infrastructure_controller_api.rb +161 -0
  56. data/lib/swagger_client/api/application_controller_api.rb +868 -0
  57. data/lib/swagger_client/api/artifact_controller_api.rb +141 -0
  58. data/lib/swagger_client/api/auth_controller_api.rb +258 -0
  59. data/lib/swagger_client/api/bake_controller_api.rb +179 -0
  60. data/lib/swagger_client/api/build_controller_api.rb +588 -0
  61. data/lib/swagger_client/api/cluster_controller_api.rb +591 -0
  62. data/lib/swagger_client/api/concourse_controller_api.rb +209 -0
  63. data/lib/swagger_client/api/credentials_controller_api.rb +163 -0
  64. data/lib/swagger_client/api/ecs_server_group_events_controller_api.rb +101 -0
  65. data/lib/swagger_client/api/executions_controller_api.rb +169 -0
  66. data/lib/swagger_client/api/firewall_controller_api.rb +209 -0
  67. data/lib/swagger_client/api/image_controller_api.rb +222 -0
  68. data/lib/swagger_client/api/instance_controller_api.rb +160 -0
  69. data/lib/swagger_client/api/job_controller_api.rb +99 -0
  70. data/lib/swagger_client/api/load_balancer_controller_api.rb +258 -0
  71. data/lib/swagger_client/api/network_controller_api.rb +127 -0
  72. data/lib/swagger_client/api/pipeline_config_controller_api.rb +176 -0
  73. data/lib/swagger_client/api/pipeline_controller_api.rb +1268 -0
  74. data/lib/swagger_client/api/pipeline_templates_controller_api.rb +404 -0
  75. data/lib/swagger_client/api/project_controller_api.rb +234 -0
  76. data/lib/swagger_client/api/pubsub_subscription_controller_api.rb +69 -0
  77. data/lib/swagger_client/api/reorder_pipelines_controller_api.rb +75 -0
  78. data/lib/swagger_client/api/search_controller_api.rb +94 -0
  79. data/lib/swagger_client/api/security_group_controller_api.rb +209 -0
  80. data/lib/swagger_client/api/server_group_controller_api.rb +163 -0
  81. data/lib/swagger_client/api/server_group_manager_controller_api.rb +75 -0
  82. data/lib/swagger_client/api/snapshot_controller_api.rb +142 -0
  83. data/lib/swagger_client/api/subnet_controller_api.rb +78 -0
  84. data/lib/swagger_client/api/task_controller_api.rb +345 -0
  85. data/lib/swagger_client/api/v2_canary_config_controller_api.rb +300 -0
  86. data/lib/swagger_client/api/v2_canary_controller_api.rb +421 -0
  87. data/lib/swagger_client/api/v2_pipeline_templates_controller_api.rb +412 -0
  88. data/lib/swagger_client/api/version_controller_api.rb +69 -0
  89. data/lib/swagger_client/api/webhook_controller_api.rb +135 -0
  90. data/lib/swagger_client/api_client.rb +388 -0
  91. data/lib/swagger_client/api_error.rb +38 -0
  92. data/lib/swagger_client/configuration.rb +202 -0
  93. data/lib/swagger_client/models/account.rb +241 -0
  94. data/lib/swagger_client/models/account_details.rb +286 -0
  95. data/lib/swagger_client/models/granted_authority.rb +183 -0
  96. data/lib/swagger_client/models/hash_mapstringobject.rb +174 -0
  97. data/lib/swagger_client/models/http_entity.rb +183 -0
  98. data/lib/swagger_client/models/mapstringstring.rb +174 -0
  99. data/lib/swagger_client/models/pipeline_template_dependent.rb +201 -0
  100. data/lib/swagger_client/models/reorder_pipelines_command.rb +194 -0
  101. data/lib/swagger_client/models/response_entity.rb +235 -0
  102. data/lib/swagger_client/models/user.rb +279 -0
  103. data/lib/swagger_client/models/version.rb +183 -0
  104. data/lib/swagger_client/version.rb +15 -0
  105. data/spec/api/amazon_infrastructure_controller_api_spec.rb +65 -0
  106. data/spec/api/application_controller_api_spec.rb +218 -0
  107. data/spec/api/artifact_controller_api_spec.rb +60 -0
  108. data/spec/api/auth_controller_api_spec.rb +86 -0
  109. data/spec/api/bake_controller_api_spec.rb +68 -0
  110. data/spec/api/build_controller_api_spec.rb +155 -0
  111. data/spec/api/cluster_controller_api_spec.rb +155 -0
  112. data/spec/api/concourse_controller_api_spec.rb +73 -0
  113. data/spec/api/credentials_controller_api_spec.rb +70 -0
  114. data/spec/api/ecs_server_group_events_controller_api_spec.rb +50 -0
  115. data/spec/api/executions_controller_api_spec.rb +72 -0
  116. data/spec/api/firewall_controller_api_spec.rb +77 -0
  117. data/spec/api/image_controller_api_spec.rb +80 -0
  118. data/spec/api/instance_controller_api_spec.rb +64 -0
  119. data/spec/api/job_controller_api_spec.rb +51 -0
  120. data/spec/api/load_balancer_controller_api_spec.rb +87 -0
  121. data/spec/api/network_controller_api_spec.rb +58 -0
  122. data/spec/api/pipeline_config_controller_api_spec.rb +68 -0
  123. data/spec/api/pipeline_controller_api_spec.rb +296 -0
  124. data/spec/api/pipeline_templates_controller_api_spec.rb +118 -0
  125. data/spec/api/project_controller_api_spec.rb +81 -0
  126. data/spec/api/pubsub_subscription_controller_api_spec.rb +45 -0
  127. data/spec/api/reorder_pipelines_controller_api_spec.rb +46 -0
  128. data/spec/api/search_controller_api_spec.rb +52 -0
  129. data/spec/api/security_group_controller_api_spec.rb +77 -0
  130. data/spec/api/server_group_controller_api_spec.rb +66 -0
  131. data/spec/api/server_group_manager_controller_api_spec.rb +46 -0
  132. data/spec/api/snapshot_controller_api_spec.rb +60 -0
  133. data/spec/api/subnet_controller_api_spec.rb +47 -0
  134. data/spec/api/task_controller_api_spec.rb +103 -0
  135. data/spec/api/v2_canary_config_controller_api_spec.rb +96 -0
  136. data/spec/api/v2_canary_controller_api_spec.rb +123 -0
  137. data/spec/api/v2_pipeline_templates_controller_api_spec.rb +121 -0
  138. data/spec/api/version_controller_api_spec.rb +45 -0
  139. data/spec/api/webhook_controller_api_spec.rb +60 -0
  140. data/spec/api_client_spec.rb +226 -0
  141. data/spec/configuration_spec.rb +42 -0
  142. data/spec/models/account_details_spec.rb +107 -0
  143. data/spec/models/account_spec.rb +77 -0
  144. data/spec/models/granted_authority_spec.rb +41 -0
  145. data/spec/models/hash_mapstringobject_spec.rb +35 -0
  146. data/spec/models/http_entity_spec.rb +41 -0
  147. data/spec/models/mapstringstring_spec.rb +35 -0
  148. data/spec/models/pipeline_template_dependent_spec.rb +53 -0
  149. data/spec/models/reorder_pipelines_command_spec.rb +47 -0
  150. data/spec/models/response_entity_spec.rb +57 -0
  151. data/spec/models/user_spec.rb +101 -0
  152. data/spec/models/version_spec.rb +41 -0
  153. data/spec/spec_helper.rb +111 -0
  154. data/spinnaker_gate_ruby_client-1.0.0.gem +0 -0
  155. data/spinnaker_gate_ruby_client.gemspec +45 -0
  156. metadata +427 -0
@@ -0,0 +1,69 @@
1
+ =begin
2
+ #Spinnaker API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
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.7
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module SwaggerClient
16
+ class VersionControllerApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Fetch Gate's current version
23
+ # @param [Hash] opts the optional parameters
24
+ # @return [Version]
25
+ def get_version_using_get(opts = {})
26
+ data, _status_code, _headers = get_version_using_get_with_http_info(opts)
27
+ data
28
+ end
29
+
30
+ # Fetch Gate's current version
31
+ # @param [Hash] opts the optional parameters
32
+ # @return [Array<(Version, Fixnum, Hash)>] Version data, response status code and response headers
33
+ def get_version_using_get_with_http_info(opts = {})
34
+ if @api_client.config.debugging
35
+ @api_client.config.logger.debug 'Calling API: VersionControllerApi.get_version_using_get ...'
36
+ end
37
+ # resource path
38
+ local_var_path = '/version'
39
+
40
+ # query parameters
41
+ query_params = {}
42
+
43
+ # header parameters
44
+ header_params = {}
45
+ # HTTP header 'Accept' (if needed)
46
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
47
+ # HTTP header 'Content-Type'
48
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
49
+
50
+ # form parameters
51
+ form_params = {}
52
+
53
+ # http body (model)
54
+ post_body = nil
55
+ auth_names = []
56
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
57
+ :header_params => header_params,
58
+ :query_params => query_params,
59
+ :form_params => form_params,
60
+ :body => post_body,
61
+ :auth_names => auth_names,
62
+ :return_type => 'Version')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: VersionControllerApi#get_version_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
65
+ end
66
+ return data, status_code, headers
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,135 @@
1
+ =begin
2
+ #Spinnaker API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
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.7
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module SwaggerClient
16
+ class WebhookControllerApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Retrieve a list of preconfigured webhooks in Orca
23
+ # @param [Hash] opts the optional parameters
24
+ # @return [Array<Object>]
25
+ def preconfigured_webhooks_using_get(opts = {})
26
+ data, _status_code, _headers = preconfigured_webhooks_using_get_with_http_info(opts)
27
+ data
28
+ end
29
+
30
+ # Retrieve a list of preconfigured webhooks in Orca
31
+ # @param [Hash] opts the optional parameters
32
+ # @return [Array<(Array<Object>, Fixnum, Hash)>] Array<Object> data, response status code and response headers
33
+ def preconfigured_webhooks_using_get_with_http_info(opts = {})
34
+ if @api_client.config.debugging
35
+ @api_client.config.logger.debug 'Calling API: WebhookControllerApi.preconfigured_webhooks_using_get ...'
36
+ end
37
+ # resource path
38
+ local_var_path = '/webhooks/preconfigured'
39
+
40
+ # query parameters
41
+ query_params = {}
42
+
43
+ # header parameters
44
+ header_params = {}
45
+ # HTTP header 'Accept' (if needed)
46
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
47
+ # HTTP header 'Content-Type'
48
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
49
+
50
+ # form parameters
51
+ form_params = {}
52
+
53
+ # http body (model)
54
+ post_body = nil
55
+ auth_names = []
56
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
57
+ :header_params => header_params,
58
+ :query_params => query_params,
59
+ :form_params => form_params,
60
+ :body => post_body,
61
+ :auth_names => auth_names,
62
+ :return_type => 'Array<Object>')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: WebhookControllerApi#preconfigured_webhooks_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
65
+ end
66
+ return data, status_code, headers
67
+ end
68
+ # Endpoint for posting webhooks to Spinnaker's webhook service
69
+ # @param type type
70
+ # @param source source
71
+ # @param [Hash] opts the optional parameters
72
+ # @option opts [Object] :event event
73
+ # @option opts [String] :x_hub_signature X-Hub-Signature
74
+ # @option opts [String] :x_event_key X-Event-Key
75
+ # @return [Object]
76
+ def webhooks_using_post(type, source, opts = {})
77
+ data, _status_code, _headers = webhooks_using_post_with_http_info(type, source, opts)
78
+ data
79
+ end
80
+
81
+ # Endpoint for posting webhooks to Spinnaker&#39;s webhook service
82
+ # @param type type
83
+ # @param source source
84
+ # @param [Hash] opts the optional parameters
85
+ # @option opts [Object] :event event
86
+ # @option opts [String] :x_hub_signature X-Hub-Signature
87
+ # @option opts [String] :x_event_key X-Event-Key
88
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
89
+ def webhooks_using_post_with_http_info(type, source, opts = {})
90
+ if @api_client.config.debugging
91
+ @api_client.config.logger.debug 'Calling API: WebhookControllerApi.webhooks_using_post ...'
92
+ end
93
+ # verify the required parameter 'type' is set
94
+ if @api_client.config.client_side_validation && type.nil?
95
+ fail ArgumentError, "Missing the required parameter 'type' when calling WebhookControllerApi.webhooks_using_post"
96
+ end
97
+ # verify the required parameter 'source' is set
98
+ if @api_client.config.client_side_validation && source.nil?
99
+ fail ArgumentError, "Missing the required parameter 'source' when calling WebhookControllerApi.webhooks_using_post"
100
+ end
101
+ # resource path
102
+ local_var_path = '/webhooks/{type}/{source}'.sub('{' + 'type' + '}', type.to_s).sub('{' + 'source' + '}', source.to_s)
103
+
104
+ # query parameters
105
+ query_params = {}
106
+
107
+ # header parameters
108
+ header_params = {}
109
+ # HTTP header 'Accept' (if needed)
110
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
111
+ # HTTP header 'Content-Type'
112
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
113
+ header_params[:'X-Hub-Signature'] = opts[:'x_hub_signature'] if !opts[:'x_hub_signature'].nil?
114
+ header_params[:'X-Event-Key'] = opts[:'x_event_key'] if !opts[:'x_event_key'].nil?
115
+
116
+ # form parameters
117
+ form_params = {}
118
+
119
+ # http body (model)
120
+ post_body = @api_client.object_to_http_body(opts[:'event'])
121
+ auth_names = []
122
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
123
+ :header_params => header_params,
124
+ :query_params => query_params,
125
+ :form_params => form_params,
126
+ :body => post_body,
127
+ :auth_names => auth_names,
128
+ :return_type => 'Object')
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug "API called: WebhookControllerApi#webhooks_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
131
+ end
132
+ return data, status_code, headers
133
+ end
134
+ end
135
+ end
@@ -0,0 +1,388 @@
1
+ =begin
2
+ #Spinnaker API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
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.7
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 SwaggerClient
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
+
98
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
99
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
100
+
101
+ req_opts = {
102
+ :method => http_method,
103
+ :headers => header_params,
104
+ :params => query_params,
105
+ :params_encoding => @config.params_encoding,
106
+ :timeout => @config.timeout,
107
+ :ssl_verifypeer => @config.verify_ssl,
108
+ :ssl_verifyhost => _verify_ssl_host,
109
+ :sslcert => @config.cert_file,
110
+ :sslkey => @config.key_file,
111
+ :verbose => @config.debugging
112
+ }
113
+
114
+ # set custom cert, if provided
115
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
116
+
117
+ if [:post, :patch, :put, :delete].include?(http_method)
118
+ req_body = build_request_body(header_params, form_params, opts[:body])
119
+ req_opts.update :body => req_body
120
+ if @config.debugging
121
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
122
+ end
123
+ end
124
+
125
+ request = Typhoeus::Request.new(url, req_opts)
126
+ download_file(request) if opts[:return_type] == 'File'
127
+ request
128
+ end
129
+
130
+ # Check if the given MIME is a JSON MIME.
131
+ # JSON MIME examples:
132
+ # application/json
133
+ # application/json; charset=UTF8
134
+ # APPLICATION/JSON
135
+ # */*
136
+ # @param [String] mime MIME
137
+ # @return [Boolean] True if the MIME is application/json
138
+ def json_mime?(mime)
139
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
140
+ end
141
+
142
+ # Deserialize the response to the given return type.
143
+ #
144
+ # @param [Response] response HTTP response
145
+ # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
146
+ def deserialize(response, return_type)
147
+ body = response.body
148
+
149
+ # handle file downloading - return the File instance processed in request callbacks
150
+ # note that response body is empty when the file is written in chunks in request on_body callback
151
+ return @tempfile if return_type == 'File'
152
+
153
+ return nil if body.nil? || body.empty?
154
+
155
+ # return response body directly for String return type
156
+ return body if return_type == 'String'
157
+
158
+ # ensuring a default content type
159
+ content_type = response.headers['Content-Type'] || 'application/json'
160
+
161
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
162
+
163
+ begin
164
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
165
+ rescue JSON::ParserError => e
166
+ if %w(String Date DateTime).include?(return_type)
167
+ data = body
168
+ else
169
+ raise e
170
+ end
171
+ end
172
+
173
+ convert_to_type data, return_type
174
+ end
175
+
176
+ # Convert data to the given return type.
177
+ # @param [Object] data Data to be converted
178
+ # @param [String] return_type Return type
179
+ # @return [Mixed] Data in a particular type
180
+ def convert_to_type(data, return_type)
181
+ return nil if data.nil?
182
+ case return_type
183
+ when 'String'
184
+ data.to_s
185
+ when 'Integer'
186
+ data.to_i
187
+ when 'Float'
188
+ data.to_f
189
+ when 'BOOLEAN'
190
+ data == true
191
+ when 'DateTime'
192
+ # parse date time (expecting ISO 8601 format)
193
+ DateTime.parse data
194
+ when 'Date'
195
+ # parse date time (expecting ISO 8601 format)
196
+ Date.parse data
197
+ when 'Object'
198
+ # generic object (usually a Hash), return directly
199
+ data
200
+ when /\AArray<(.+)>\z/
201
+ # e.g. Array<Pet>
202
+ sub_type = $1
203
+ data.map { |item| convert_to_type(item, sub_type) }
204
+ when /\AHash\<String, (.+)\>\z/
205
+ # e.g. Hash<String, Integer>
206
+ sub_type = $1
207
+ {}.tap do |hash|
208
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
209
+ end
210
+ else
211
+ # models, e.g. Pet
212
+ SwaggerClient.const_get(return_type).new.tap do |model|
213
+ model.build_from_hash data
214
+ end
215
+ end
216
+ end
217
+
218
+ # Save response body into a file in (the defined) temporary folder, using the filename
219
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
220
+ # The response body is written to the file in chunks in order to handle files which
221
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
222
+ # process can use.
223
+ #
224
+ # @see Configuration#temp_folder_path
225
+ def download_file(request)
226
+ tempfile = nil
227
+ encoding = nil
228
+ request.on_headers do |response|
229
+ content_disposition = response.headers['Content-Disposition']
230
+ if content_disposition && content_disposition =~ /filename=/i
231
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
232
+ prefix = sanitize_filename(filename)
233
+ else
234
+ prefix = 'download-'
235
+ end
236
+ prefix = prefix + '-' unless prefix.end_with?('-')
237
+ encoding = response.body.encoding
238
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
239
+ @tempfile = tempfile
240
+ end
241
+ request.on_body do |chunk|
242
+ chunk.force_encoding(encoding)
243
+ tempfile.write(chunk)
244
+ end
245
+ request.on_complete do |response|
246
+ tempfile.close
247
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
248
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
249
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
250
+ "explicitly with `tempfile.delete`"
251
+ end
252
+ end
253
+
254
+ # Sanitize filename by removing path.
255
+ # e.g. ../../sun.gif becomes sun.gif
256
+ #
257
+ # @param [String] filename the filename to be sanitized
258
+ # @return [String] the sanitized filename
259
+ def sanitize_filename(filename)
260
+ filename.gsub(/.*[\/\\]/, '')
261
+ end
262
+
263
+ def build_request_url(path)
264
+ # Add leading and trailing slashes to path
265
+ path = "/#{path}".gsub(/\/+/, '/')
266
+ URI.encode(@config.base_url + path)
267
+ end
268
+
269
+ # Builds the HTTP request body
270
+ #
271
+ # @param [Hash] header_params Header parameters
272
+ # @param [Hash] form_params Query parameters
273
+ # @param [Object] body HTTP body (JSON/XML)
274
+ # @return [String] HTTP body data in the form of string
275
+ def build_request_body(header_params, form_params, body)
276
+ # http form
277
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
278
+ header_params['Content-Type'] == 'multipart/form-data'
279
+ data = {}
280
+ form_params.each do |key, value|
281
+ case value
282
+ when ::File, ::Array, nil
283
+ # let typhoeus handle File, Array and nil parameters
284
+ data[key] = value
285
+ else
286
+ data[key] = value.to_s
287
+ end
288
+ end
289
+ elsif body
290
+ data = body.is_a?(String) ? body : body.to_json
291
+ else
292
+ data = nil
293
+ end
294
+ data
295
+ end
296
+
297
+ # Update hearder and query params based on authentication settings.
298
+ #
299
+ # @param [Hash] header_params Header parameters
300
+ # @param [Hash] query_params Query parameters
301
+ # @param [String] auth_names Authentication scheme name
302
+ def update_params_for_auth!(header_params, query_params, auth_names)
303
+ Array(auth_names).each do |auth_name|
304
+ auth_setting = @config.auth_settings[auth_name]
305
+ next unless auth_setting
306
+ case auth_setting[:in]
307
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
308
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
309
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
310
+ end
311
+ end
312
+ end
313
+
314
+ # Sets user agent in HTTP header
315
+ #
316
+ # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
317
+ def user_agent=(user_agent)
318
+ @user_agent = user_agent
319
+ @default_headers['User-Agent'] = @user_agent
320
+ end
321
+
322
+ # Return Accept header based on an array of accepts provided.
323
+ # @param [Array] accepts array for Accept
324
+ # @return [String] the Accept header (e.g. application/json)
325
+ def select_header_accept(accepts)
326
+ return nil if accepts.nil? || accepts.empty?
327
+ # use JSON when present, otherwise use all of the provided
328
+ json_accept = accepts.find { |s| json_mime?(s) }
329
+ json_accept || accepts.join(',')
330
+ end
331
+
332
+ # Return Content-Type header based on an array of content types provided.
333
+ # @param [Array] content_types array for Content-Type
334
+ # @return [String] the Content-Type header (e.g. application/json)
335
+ def select_header_content_type(content_types)
336
+ # use application/json by default
337
+ return 'application/json' if content_types.nil? || content_types.empty?
338
+ # use JSON when present, otherwise use the first one
339
+ json_content_type = content_types.find { |s| json_mime?(s) }
340
+ json_content_type || content_types.first
341
+ end
342
+
343
+ # Convert object (array, hash, object, etc) to JSON string.
344
+ # @param [Object] model object to be converted into JSON string
345
+ # @return [String] JSON string representation of the object
346
+ def object_to_http_body(model)
347
+ return model if model.nil? || model.is_a?(String)
348
+ local_body = nil
349
+ if model.is_a?(Array)
350
+ local_body = model.map { |m| object_to_hash(m) }
351
+ else
352
+ local_body = object_to_hash(model)
353
+ end
354
+ local_body.to_json
355
+ end
356
+
357
+ # Convert object(non-array) to hash.
358
+ # @param [Object] obj object to be converted into JSON string
359
+ # @return [String] JSON string representation of the object
360
+ def object_to_hash(obj)
361
+ if obj.respond_to?(:to_hash)
362
+ obj.to_hash
363
+ else
364
+ obj
365
+ end
366
+ end
367
+
368
+ # Build parameter value according to the given collection format.
369
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
370
+ def build_collection_param(param, collection_format)
371
+ case collection_format
372
+ when :csv
373
+ param.join(',')
374
+ when :ssv
375
+ param.join(' ')
376
+ when :tsv
377
+ param.join("\t")
378
+ when :pipes
379
+ param.join('|')
380
+ when :multi
381
+ # return the array directly as typhoeus will handle it as expected
382
+ param
383
+ else
384
+ fail "unknown collection format: #{collection_format.inspect}"
385
+ end
386
+ end
387
+ end
388
+ end