Rebuild Ruby petstore sample

This commit is contained in:
xhh 2015-07-27 16:37:26 +08:00
parent 47c8597d36
commit 7af5db3565
10 changed files with 499 additions and 652 deletions

View File

@ -1,8 +1,6 @@
# Common files # Common files
require 'petstore/api_client' require 'petstore/api_client'
require 'petstore/api_error' require 'petstore/api_error'
require 'petstore/request'
require 'petstore/response'
require 'petstore/version' require 'petstore/version'
# Models # Models

View File

@ -30,25 +30,30 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = ['application/json', 'application/xml'] _header_content_type = ['application/json', 'application/xml']
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
# http body (model) # http body (model)
post_body = Request.object_to_http_body(opts[:'body']) post_body = @api_client.object_to_http_body(opts[:'body'])
auth_names = ['petstore_auth'] auth_names = ['petstore_auth']
Request.new(@api_client, :PUT, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:PUT, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: PetApi#update_pet" @api_client.logger.debug "API called: PetApi#update_pet"
end end
nil return nil
end end
# Add a new pet to the store # Add a new pet to the store
@ -72,25 +77,30 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = ['application/json', 'application/xml'] _header_content_type = ['application/json', 'application/xml']
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
# http body (model) # http body (model)
post_body = Request.object_to_http_body(opts[:'body']) post_body = @api_client.object_to_http_body(opts[:'body'])
auth_names = ['petstore_auth'] auth_names = ['petstore_auth']
Request.new(@api_client, :POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:POST, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: PetApi#add_pet" @api_client.logger.debug "API called: PetApi#add_pet"
end end
nil return nil
end end
# Finds Pets by status # Finds Pets by status
@ -115,11 +125,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -129,12 +139,17 @@ module Petstore
auth_names = ['petstore_auth'] auth_names = ['petstore_auth']
response = Request.new(@api_client, :GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make result = @api_client.call_api(:GET, path,
result = response.deserialize('Array<Pet>') :header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'Array<Pet>')
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: PetApi#find_pets_by_status. Result: #{result.inspect}" @api_client.logger.debug "API called: PetApi#find_pets_by_status. Result: #{result.inspect}"
end end
result return result
end end
# Finds Pets by tags # Finds Pets by tags
@ -159,11 +174,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -173,12 +188,17 @@ module Petstore
auth_names = ['petstore_auth'] auth_names = ['petstore_auth']
response = Request.new(@api_client, :GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make result = @api_client.call_api(:GET, path,
result = response.deserialize('Array<Pet>') :header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'Array<Pet>')
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: PetApi#find_pets_by_tags. Result: #{result.inspect}" @api_client.logger.debug "API called: PetApi#find_pets_by_tags. Result: #{result.inspect}"
end end
result return result
end end
# Find pet by ID # Find pet by ID
@ -205,11 +225,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -219,12 +239,17 @@ module Petstore
auth_names = ['api_key', 'petstore_auth'] auth_names = ['api_key', 'petstore_auth']
response = Request.new(@api_client, :GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make result = @api_client.call_api(:GET, path,
result = response.deserialize('Pet') :header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'Pet')
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: PetApi#get_pet_by_id. Result: #{result.inspect}" @api_client.logger.debug "API called: PetApi#get_pet_by_id. Result: #{result.inspect}"
end end
result return result
end end
# Updates a pet in the store with form data # Updates a pet in the store with form data
@ -253,11 +278,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = ['application/x-www-form-urlencoded'] _header_content_type = ['application/x-www-form-urlencoded']
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -269,11 +294,16 @@ module Petstore
auth_names = ['petstore_auth'] auth_names = ['petstore_auth']
Request.new(@api_client, :POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:POST, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: PetApi#update_pet_with_form" @api_client.logger.debug "API called: PetApi#update_pet_with_form"
end end
nil return nil
end end
# Deletes a pet # Deletes a pet
@ -301,11 +331,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
header_params[:'api_key'] = opts[:'api_key'] if opts[:'api_key'] header_params[:'api_key'] = opts[:'api_key'] if opts[:'api_key']
# form parameters # form parameters
@ -316,11 +346,16 @@ module Petstore
auth_names = ['petstore_auth'] auth_names = ['petstore_auth']
Request.new(@api_client, :DELETE, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:DELETE, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: PetApi#delete_pet" @api_client.logger.debug "API called: PetApi#delete_pet"
end end
nil return nil
end end
# uploads an image # uploads an image
@ -349,11 +384,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = ['multipart/form-data'] _header_content_type = ['multipart/form-data']
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -365,11 +400,16 @@ module Petstore
auth_names = ['petstore_auth'] auth_names = ['petstore_auth']
Request.new(@api_client, :POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:POST, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: PetApi#upload_file" @api_client.logger.debug "API called: PetApi#upload_file"
end end
nil return nil
end end
end end
end end

View File

@ -29,11 +29,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -43,12 +43,17 @@ module Petstore
auth_names = ['api_key'] auth_names = ['api_key']
response = Request.new(@api_client, :GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make result = @api_client.call_api(:GET, path,
result = response.deserialize('Hash<String, Integer>') :header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'Hash<String, Integer>')
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: StoreApi#get_inventory. Result: #{result.inspect}" @api_client.logger.debug "API called: StoreApi#get_inventory. Result: #{result.inspect}"
end end
result return result
end end
# Place an order for a pet # Place an order for a pet
@ -72,26 +77,31 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
# http body (model) # http body (model)
post_body = Request.object_to_http_body(opts[:'body']) post_body = @api_client.object_to_http_body(opts[:'body'])
auth_names = [] auth_names = []
response = Request.new(@api_client, :POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make result = @api_client.call_api(:POST, path,
result = response.deserialize('Order') :header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'Order')
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: StoreApi#place_order. Result: #{result.inspect}" @api_client.logger.debug "API called: StoreApi#place_order. Result: #{result.inspect}"
end end
result return result
end end
# Find purchase order by ID # Find purchase order by ID
@ -118,11 +128,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -132,12 +142,17 @@ module Petstore
auth_names = [] auth_names = []
response = Request.new(@api_client, :GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make result = @api_client.call_api(:GET, path,
result = response.deserialize('Order') :header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'Order')
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: StoreApi#get_order_by_id. Result: #{result.inspect}" @api_client.logger.debug "API called: StoreApi#get_order_by_id. Result: #{result.inspect}"
end end
result return result
end end
# Delete purchase order by ID # Delete purchase order by ID
@ -164,11 +179,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -178,11 +193,16 @@ module Petstore
auth_names = [] auth_names = []
Request.new(@api_client, :DELETE, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:DELETE, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: StoreApi#delete_order" @api_client.logger.debug "API called: StoreApi#delete_order"
end end
nil return nil
end end
end end
end end

View File

@ -30,25 +30,30 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
# http body (model) # http body (model)
post_body = Request.object_to_http_body(opts[:'body']) post_body = @api_client.object_to_http_body(opts[:'body'])
auth_names = [] auth_names = []
Request.new(@api_client, :POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:POST, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: UserApi#create_user" @api_client.logger.debug "API called: UserApi#create_user"
end end
nil return nil
end end
# Creates list of users with given input array # Creates list of users with given input array
@ -72,25 +77,30 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
# http body (model) # http body (model)
post_body = Request.object_to_http_body(opts[:'body']) post_body = @api_client.object_to_http_body(opts[:'body'])
auth_names = [] auth_names = []
Request.new(@api_client, :POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:POST, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: UserApi#create_users_with_array_input" @api_client.logger.debug "API called: UserApi#create_users_with_array_input"
end end
nil return nil
end end
# Creates list of users with given input array # Creates list of users with given input array
@ -114,25 +124,30 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
# http body (model) # http body (model)
post_body = Request.object_to_http_body(opts[:'body']) post_body = @api_client.object_to_http_body(opts[:'body'])
auth_names = [] auth_names = []
Request.new(@api_client, :POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:POST, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: UserApi#create_users_with_list_input" @api_client.logger.debug "API called: UserApi#create_users_with_list_input"
end end
nil return nil
end end
# Logs user into the system # Logs user into the system
@ -159,11 +174,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -173,12 +188,17 @@ module Petstore
auth_names = [] auth_names = []
response = Request.new(@api_client, :GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make result = @api_client.call_api(:GET, path,
result = response.deserialize('String') :header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'String')
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: UserApi#login_user. Result: #{result.inspect}" @api_client.logger.debug "API called: UserApi#login_user. Result: #{result.inspect}"
end end
result return result
end end
# Logs out current logged in user session # Logs out current logged in user session
@ -201,11 +221,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -215,11 +235,16 @@ module Petstore
auth_names = [] auth_names = []
Request.new(@api_client, :GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:GET, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: UserApi#logout_user" @api_client.logger.debug "API called: UserApi#logout_user"
end end
nil return nil
end end
# Get user by user name # Get user by user name
@ -246,11 +271,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -260,12 +285,17 @@ module Petstore
auth_names = [] auth_names = []
response = Request.new(@api_client, :GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make result = @api_client.call_api(:GET, path,
result = response.deserialize('User') :header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'User')
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: UserApi#get_user_by_name. Result: #{result.inspect}" @api_client.logger.debug "API called: UserApi#get_user_by_name. Result: #{result.inspect}"
end end
result return result
end end
# Updated user # Updated user
@ -293,25 +323,30 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
# http body (model) # http body (model)
post_body = Request.object_to_http_body(opts[:'body']) post_body = @api_client.object_to_http_body(opts[:'body'])
auth_names = [] auth_names = []
Request.new(@api_client, :PUT, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:PUT, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: UserApi#update_user" @api_client.logger.debug "API called: UserApi#update_user"
end end
nil return nil
end end
# Delete user # Delete user
@ -338,11 +373,11 @@ module Petstore
# HTTP header 'Accept' (if needed) # HTTP header 'Accept' (if needed)
_header_accept = ['application/json', 'application/xml'] _header_accept = ['application/json', 'application/xml']
_header_accept_result = Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
# HTTP header 'Content-Type' # HTTP header 'Content-Type'
_header_content_type = [] _header_content_type = []
header_params['Content-Type'] = Request.select_header_content_type(_header_content_type) header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
# form parameters # form parameters
form_params = {} form_params = {}
@ -352,11 +387,16 @@ module Petstore
auth_names = [] auth_names = []
Request.new(@api_client, :DELETE, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make @api_client.call_api(:DELETE, path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names)
if @api_client.debugging if @api_client.debugging
@api_client.logger.debug "API called: UserApi#delete_user" @api_client.logger.debug "API called: UserApi#delete_user"
end end
nil return nil
end end
end end
end end

View File

@ -1,9 +1,13 @@
require 'logger' require 'date'
require 'json' require 'json'
require 'logger'
require 'tempfile'
require 'typhoeus'
require 'uri'
module Petstore module Petstore
class ApiClient class ApiClient
attr_accessor :scheme, :host, :base_path, :user_agent, :format, :auth_token, :inject_format, :force_ending_format attr_accessor :scheme, :host, :base_path, :user_agent
# Defines the username used with HTTP basic authentication. # Defines the username used with HTTP basic authentication.
# #
@ -82,7 +86,6 @@ module Petstore
# client.api_key['api_key'] = 'your key' # api key authentication # client.api_key['api_key'] = 'your key' # api key authentication
# client.username = 'your username' # username for http basic authentication # client.username = 'your username' # username for http basic authentication
# client.password = 'your password' # password for http basic authentication # client.password = 'your password' # password for http basic authentication
# client.format = 'json' # optional, defaults to 'json'
# end # end
def initialize(&block) def initialize(&block)
@format = 'json' @format = 'json'
@ -131,9 +134,256 @@ module Petstore
@base_path = "" if @base_path == "/" @base_path = "" if @base_path == "/"
end end
def call_api(http_method, path, opts = {})
request = build_request(http_method, path, opts)
response = request.run
# record as last response
@last_response = response
if debugging
logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
end
unless response.success?
fail ApiError.new(:code => response.code,
:response_headers => response.headers,
:response_body => response.body),
response.status_message
end
if opts[:return_type]
return deserialize(response, opts[:return_type])
else
return nil
end
end
def build_request(http_method, path, opts = {})
url = build_request_url(path)
http_method = http_method.to_sym.downcase
header_params = @default_headers.merge(opts[:header_params] || {})
query_params = opts[:query_params] || {}
form_params = opts[:form_params] || {}
update_params_for_auth! header_params, query_params, opts[:auth_names]
req_opts = {
:method => http_method,
:headers => header_params,
:params => query_params,
:ssl_verifypeer => @verify_ssl,
:cainfo => @ssl_ca_cert,
:verbose => @debugging
}
if [:post, :patch, :put, :delete].include?(http_method)
req_body = build_request_body(header_params, form_params, opts[:body])
req_opts.update :body => req_body
if debugging
logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
end
end
Typhoeus::Request.new(url, req_opts)
end
# Deserialize the response to the given return type.
#
# @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
def deserialize(response, return_type)
body = response.body
return nil if body.nil? || body.empty?
# handle file downloading - save response body into a tmp file and return the File instance
return download_file(response) if return_type == 'File'
# ensuring a default content type
content_type = response.headers['Content-Type'] || 'application/json'
unless content_type.start_with?('application/json')
fail "Content-Type is not supported: #{content_type}"
end
begin
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
rescue JSON::ParserError => e
if %w(String Date DateTime).include?(return_type)
data = body
else
raise e
end
end
convert_to_type data, return_type
end
# Convert data to the given return type.
def convert_to_type(data, return_type)
return nil if data.nil?
case return_type
when 'String'
data.to_s
when 'Integer'
data.to_i
when 'Float'
data.to_f
when 'BOOLEAN'
data == true
when 'DateTime'
# parse date time (expecting ISO 8601 format)
DateTime.parse data
when 'Date'
# parse date time (expecting ISO 8601 format)
Date.parse data
when 'Object'
# generic object, return directly
data
when /\AArray<(.+)>\z/
# e.g. Array<Pet>
sub_type = $1
data.map {|item| convert_to_type(item, sub_type) }
when /\AHash\<String, (.+)\>\z/
# e.g. Hash<String, Integer>
sub_type = $1
{}.tap do |hash|
data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
end
else
# models, e.g. Pet
Petstore.const_get(return_type).new.tap do |model|
model.build_from_hash data
end
end
end
# Save response body into a file in (the defined) temporary folder, using the filename
# from the "Content-Disposition" header if provided, otherwise a random filename.
#
# @see Configuration#temp_folder_path
# @return [File] the file downloaded
def download_file(response)
tmp_file = Tempfile.new '', @temp_folder_path
content_disposition = response.headers['Content-Disposition']
if content_disposition
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
path = File.join File.dirname(tmp_file), filename
else
path = tmp_file.path
end
# close and delete temp file
tmp_file.close!
File.open(path, 'w') { |file| file.write(response.body) }
logger.info "File written to #{path}. Please move the file to a proper folder for further processing and delete the temp afterwards"
return File.new(path)
end
def build_request_url(path)
url = [host, base_path, path].join('/').gsub(/\/+/, '/')
url = "#{scheme}://#{url}"
URI.encode(url)
end
def build_request_body(header_params, form_params, body)
# http form
if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
data = form_params.dup
data.each do |key, value|
data[key] = value.to_s if value && !value.is_a?(File)
end
elsif body
data = body.is_a?(String) ? body : body.to_json
else
data = nil
end
return data
end
# Update hearder and query params based on authentication settings.
def update_params_for_auth!(header_params, query_params, auth_names)
return unless auth_names
auth_names.each do |auth_name|
case auth_name
when 'api_key'
header_params ||= {}
header_params['api_key'] = get_api_key_with_prefix('api_key')
when 'petstore_auth'
# TODO: support oauth
end
end
end
# Get API key (with prefix if set).
# @param [String] param_name the parameter name of API key auth
def get_api_key_with_prefix(param_name)
if @api_key_prefix[param_name]
"#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
else
@api_key[param_name]
end
end
def user_agent=(user_agent) def user_agent=(user_agent)
@user_agent = user_agent @user_agent = user_agent
@default_headers['User-Agent'] = @user_agent @default_headers['User-Agent'] = @user_agent
end end
# Return Accept header based on an array of accepts provided.
# @param [Array] accepts array for Accept
# @return [String] the Accept header (e.g. application/json)
def select_header_accept(accepts)
if accepts.empty?
return
elsif accepts.any?{ |s| s.casecmp('application/json') == 0 }
'application/json' # look for json data by default
else
accepts.join(',')
end
end
# Return Content-Type header based on an array of content types provided.
# @param [Array] content_types array for Content-Type
# @return [String] the Content-Type header (e.g. application/json)
def select_header_content_type(content_types)
if content_types.empty?
'application/json' # use application/json by default
elsif content_types.any?{ |s| s.casecmp('application/json')==0 }
'application/json' # use application/json if it's included
else
content_types[0] # otherwise, use the first one
end
end
# Convert object (array, hash, object, etc) to JSON string.
# @param [Object] model object to be converted into JSON string
# @return [String] JSON string representation of the object
def object_to_http_body(model)
return if model.nil?
_body = nil
if model.is_a?(Array)
_body = model.map{|m| object_to_hash(m) }
else
_body = object_to_hash(model)
end
_body.to_json
end
# Convert object(non-array) to hash.
# @param [Object] obj object to be converted into JSON string
# @return [String] JSON string representation of the object
def object_to_hash(obj)
if obj.respond_to?(:to_hash)
obj.to_hash
else
obj
end
end
end end
end end

View File

@ -1,207 +0,0 @@
require 'uri'
require 'typhoeus'
module Petstore
class Request
attr_accessor :host, :path, :format, :params, :body, :http_method, :headers, :form_params, :auth_names, :response
# All requests must have an HTTP method and a path
# Optionals parameters are :params, :headers, :body, :format, :host
def initialize(api_client, http_method, path, attributes = {})
@api_client = api_client
@http_method = http_method.to_sym.downcase
@path = path
attributes.each { |name, value| send "#{name}=", value }
@format ||= @api_client.format
@params ||= {}
# Apply default headers
@headers = @api_client.default_headers.merge(@headers || {})
update_params_for_auth!
end
# Update hearder and query params based on authentication settings.
def update_params_for_auth!
(@auth_names || []).each do |auth_name|
case auth_name
when 'api_key'
@headers ||= {}
@headers['api_key'] = get_api_key_with_prefix('api_key')
when 'petstore_auth'
# TODO: support oauth
end
end
end
# Get API key (with prefix if set).
# @param [String] param_name the parameter name of API key auth
def get_api_key_with_prefix(param_name)
if @api_client.api_key_prefix[param_name]
"#{@api_client.api_key_prefix[param_name]} #{@api_client.api_key[param_name]}"
else
@api_client.api_key[param_name]
end
end
# Construct the request URL.
def url(options = {})
_path = self.interpreted_path
_path = "/#{_path}" unless _path.start_with?('/')
"#{@api_client.scheme}://#{@api_client.host}#{_path}"
end
# Iterate over the params hash, injecting any path values into the path string
# e.g. /word.{format}/{word}/entries => /word.json/cat/entries
def interpreted_path
p = self.path.dup
# Stick a .{format} placeholder into the path if there isn't
# one already or an actual format like json or xml
# e.g. /words/blah => /words.{format}/blah
if @api_client.inject_format
unless ['.json', '.xml', '{format}'].any? {|s| p.downcase.include? s }
p = p.sub(/^(\/?\w+)/, "\\1.#{format}")
end
end
# Stick a .{format} placeholder on the end of the path if there isn't
# one already or an actual format like json or xml
# e.g. /words/blah => /words/blah.{format}
if @api_client.force_ending_format
unless ['.json', '.xml', '{format}'].any? {|s| p.downcase.include? s }
p = "#{p}.#{format}"
end
end
p = p.sub("{format}", self.format.to_s)
URI.encode [@api_client.base_path, p].join("/").gsub(/\/+/, '/')
end
# If body is an object, JSONify it before making the actual request.
# For form parameters, remove empty value
def outgoing_body
# http form
if headers['Content-Type'] == 'application/x-www-form-urlencoded'
data = form_params.dup
data.each do |key, value|
data[key] = value.to_s if value && !value.is_a?(File) # remove emtpy form parameter
end
elsif @body # http body is JSON
data = @body.is_a?(String) ? @body : @body.to_json
else
data = nil
end
if @api_client.debugging
@api_client.logger.debug "HTTP request body param ~BEGIN~\n#{data}\n~END~\n"
end
data
end
def make
request_options = {
:method => self.http_method,
:headers => self.headers,
:params => self.params,
:ssl_verifypeer => @api_client.verify_ssl,
:cainfo => @api_client.ssl_ca_cert,
:verbose => @api_client.debugging
}
if [:post, :patch, :put, :delete].include?(self.http_method)
request_options.update :body => self.outgoing_body
end
raw = Typhoeus::Request.new(self.url, request_options).run
@response = Response.new(@api_client, raw)
if @api_client.debugging
@api_client.logger.debug "HTTP response body ~BEGIN~\n#{@response.body}\n~END~\n"
end
# record as last response
@api_client.last_response = @response
unless @response.success?
fail ApiError.new(:code => @response.code,
:response_headers => @response.headers,
:response_body => @response.body),
@response.status_message
end
@response
end
def response_code_pretty
return unless @response
@response.code.to_s
end
def response_headers_pretty
return unless @response
# JSON.pretty_generate(@response.headers).gsub(/\n/, '<br/>') # <- This was for RestClient
@response.headers.gsub(/\n/, '<br/>') # <- This is for Typhoeus
end
# return 'Accept' based on an array of accept provided
# @param [Array] header_accept_array Array fo 'Accept'
# @return String Accept (e.g. application/json)
def self.select_header_accept header_accept_array
if header_accept_array.empty?
return
elsif header_accept_array.any?{ |s| s.casecmp('application/json')==0 }
'application/json' # look for json data by default
else
header_accept_array.join(',')
end
end
# return the content type based on an array of content-type provided
# @param [Array] content_type_array Array fo content-type
# @return String Content-Type (e.g. application/json)
def self.select_header_content_type content_type_array
if content_type_array.empty?
'application/json' # use application/json by default
elsif content_type_array.any?{ |s| s.casecmp('application/json')==0 }
'application/json' # use application/json if it's included
else
content_type_array[0]; # otherwise, use the first one
end
end
# static method to convert object (array, hash, object, etc) to JSON string
# @param model object to be converted into JSON string
# @return string JSON string representation of the object
def self.object_to_http_body model
return if model.nil?
_body = nil
if model.is_a?(Array)
_body = model.map{|m| object_to_hash(m) }
else
_body = object_to_hash(model)
end
_body.to_json
end
# static method to convert object(non-array) to hash
# @param obj object to be converted into JSON string
# @return string JSON string representation of the object
def self.object_to_hash obj
if obj.respond_to?(:to_hash)
obj.to_hash
else
obj
end
end
end
end

View File

@ -1,155 +0,0 @@
require 'json'
require 'date'
require 'tempfile'
module Petstore
class Response
attr_accessor :raw
def initialize(api_client, raw)
@api_client = api_client
@raw = raw
end
def code
raw.code
end
def status_message
raw.status_message
end
def body
raw.body
end
def success?
raw.success?
end
# Deserialize the raw response body to the given return type.
#
# @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
def deserialize(return_type)
return nil if body.nil? || body.empty?
# handle file downloading - save response body into a tmp file and return the File instance
return download_file if return_type == 'File'
# ensuring a default content type
content_type = raw.headers['Content-Type'] || 'application/json'
unless content_type.start_with?('application/json')
fail "Content-Type is not supported: #{content_type}"
end
begin
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
rescue JSON::ParserError => e
if %w(String Date DateTime).include?(return_type)
data = body
else
raise e
end
end
convert_to_type data, return_type
end
# Convert data to the given return type.
def convert_to_type(data, return_type)
return nil if data.nil?
case return_type
when 'String'
data.to_s
when 'Integer'
data.to_i
when 'Float'
data.to_f
when 'BOOLEAN'
data == true
when 'DateTime'
# parse date time (expecting ISO 8601 format)
DateTime.parse data
when 'Date'
# parse date time (expecting ISO 8601 format)
Date.parse data
when 'Object'
# generic object, return directly
data
when /\AArray<(.+)>\z/
# e.g. Array<Pet>
sub_type = $1
data.map {|item| convert_to_type(item, sub_type) }
when /\AHash\<String, (.+)\>\z/
# e.g. Hash<String, Integer>
sub_type = $1
{}.tap do |hash|
data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
end
else
# models, e.g. Pet
Petstore.const_get(return_type).new.tap do |model|
model.build_from_hash data
end
end
end
# Save response body into a file in (the defined) temporary folder, using the filename
# from the "Content-Disposition" header if provided, otherwise a random filename.
#
# @see Configuration#temp_folder_path
# @return [File] the file downloaded
def download_file
tmp_file = Tempfile.new '', @api_client.temp_folder_path
content_disposition = raw.headers['Content-Disposition']
if content_disposition
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
path = File.join File.dirname(tmp_file), filename
else
path = tmp_file.path
end
# close and delete temp file
tmp_file.close!
File.open(path, 'w') { |file| file.write(raw.body) }
@api_client.logger.info "File written to #{path}. Please move the file to a proper folder for further processing and delete the temp afterwards"
return File.new(path)
end
# `headers_hash` is a Typhoeus-specific extension of Hash,
# so simplify it back into a regular old Hash.
def headers
h = {}
raw.headers_hash.each {|k,v| h[k] = v }
h
end
# Extract the response format from the header hash
# e.g. {'Content-Type' => 'application/json'}
def format
headers['Content-Type'].split("/").last.downcase
end
def json?
format == 'json'
end
def xml?
format == 'xml'
end
def pretty_body
return unless body
if format == 'json'
JSON.pretty_generate(JSON.parse(body)).gsub(/\n/, '<br/>')
else
body
end
end
def pretty_headers
JSON.pretty_generate(headers).gsub(/\n/, '<br/>')
end
end
end

View File

@ -50,4 +50,55 @@ describe Petstore::ApiClient do
end end
describe "#update_params_for_auth!" do
it "sets header api-key parameter with prefix" do
api_client = Petstore::ApiClient.new do |c|
c.api_key_prefix['api_key'] = 'PREFIX'
c.api_key['api_key'] = 'special-key'
end
header_params = {}
query_params = {}
auth_names = ['api_key', 'unknown']
api_client.update_params_for_auth! header_params, query_params, auth_names
header_params.should == {'api_key' => 'PREFIX special-key'}
query_params.should == {}
end
it "sets header api-key parameter without prefix" do
api_client = Petstore::ApiClient.new do |c|
c.api_key_prefix['api_key'] = nil
c.api_key['api_key'] = 'special-key'
end
header_params = {}
query_params = {}
auth_names = ['api_key', 'unknown']
api_client.update_params_for_auth! header_params, query_params, auth_names
header_params.should == {'api_key' => 'special-key'}
query_params.should == {}
end
end
describe "#deserialize" do
it "handles Hash<String, String>" do
api_client = Petstore::ApiClient.new
headers = {'Content-Type' => 'application/json'}
response = double('response', headers: headers, body: '{"message": "Hello"}')
data = api_client.deserialize(response, 'Hash<String, String>')
data.should be_a(Hash)
data.should == {:message => 'Hello'}
end
it "handles Hash<String, Pet>" do
api_client = Petstore::ApiClient.new
headers = {'Content-Type' => 'application/json'}
response = double('response', headers: headers, body: '{"pet": {"id": 1}}')
data = api_client.deserialize(response, 'Hash<String, Pet>')
data.should be_a(Hash)
data.keys.should == [:pet]
pet = data[:pet]
pet.should be_a(Petstore::Pet)
pet.id.should == 1
end
end
end end

View File

@ -1,113 +0,0 @@
require 'spec_helper'
describe Petstore::Request do
before(:each) do
@api_client = Petstore::ApiClient.new do |config|
inject_format = true
config.api_key['api_key'] = 'special-key'
config.host = 'petstore.swagger.io'
config.base_path = '/v2'
end
@default_http_method = :get
@default_path = "pet.{format}/fancy"
@default_params = {
:params => {:foo => "1", :bar => "2"}
}
@request = Petstore::Request.new(@api_client, @default_http_method, @default_path, @default_params)
end
describe "initialization" do
it "sets default response format to json" do
@request.format.should == 'json'
end
it "sets default headers correctly" do
@request.headers.should == {'Content-Type' => 'application/json', 'User-Agent' => 'ruby-swagger-1.0.0'}
end
it "allows params to be nil" do
@request = Petstore::Request.new(@api_client, @default_http_method, @default_path, :params => nil)
@request.params.should == {}
end
end
describe "attr_accessors" do
it "has working attributes" do
@request.format.to_s.should == 'json'
end
it "allows attributes to be overwritten" do
@request.http_method.should == :get
@request.http_method = "post"
@request.http_method.should == 'post'
end
end
describe "url" do
it "constructs a full url" do
@request.url.should == "http://petstore.swagger.io/v2/pet.json/fancy"
end
end
describe "path" do
it "accounts for a total absence of format in the path string" do
@request = Petstore::Request.new(@api_client, :get, "/word.{format}/cat/entries", @default_params.merge({
:format => "xml",
:params => {
}
}))
@request.url.should == "http://petstore.swagger.io/v2/word.xml/cat/entries"
end
it "does string substitution (format) on path params" do
@request = Petstore::Request.new(@api_client, :get, "/word.{format}/cat/entries", @default_params.merge({
:format => "xml",
:params => {
}
}))
@request.url.should == "http://petstore.swagger.io/v2/word.xml/cat/entries"
end
it "URI encodes the path" do
@request = Petstore::Request.new(@api_client, :get, "word.{format}/bill gates/definitions", @default_params.merge({
:params => {
:word => "bill gates"
}
}))
@request.url.should =~ /word.json\/bill\%20gates\/definitions/
end
end
describe "#update_params_for_auth!" do
it "sets header api-key parameter with prefix" do
@api_client.configure do |config|
inject_format = true
config.api_key_prefix['api_key'] = 'PREFIX'
end
@request.auth_names = ['api_key', 'unknown']
@request.update_params_for_auth!
@request.headers['api_key'].should == 'PREFIX special-key'
end
it "sets header api-key parameter without prefix" do
@api_client.configure do |config|
inject_format = true
config.api_key_prefix['api_key'] = nil
end
@request.auth_names = ['api_key', 'unknown']
@request.update_params_for_auth!
@request.headers['api_key'].should == 'special-key'
end
end
end

View File

@ -1,77 +0,0 @@
require 'spec_helper'
describe Petstore::Response do
before(:each) do
VCR.use_cassette('pet_resource', :record => :new_episodes) do
@raw = Typhoeus::Request.get("http://petstore.swagger.io/v2/pet/10002")
end
@response = Petstore::Response.new(API_CLIENT, @raw)
end
describe "initialization" do
it "sets body" do
@response.body.should be_a(String)
data = JSON.parse(@response.body)
data.should be_a(Hash)
data['id'].should == 10002
end
it "sets code" do
@response.code.should == 200
end
it "converts header string into a hash" do
@response.headers.class.should == Hash
end
end
describe "format" do
it "recognizes json" do
@response.format.should == 'json'
@response.json?.should == true
end
it "recognizes xml" do
VCR.use_cassette('xml_response_request', :record => :new_episodes) do
@raw = Typhoeus::Request.get("http://petstore.swagger.io/v2/pet/10002",
:headers => {'Accept'=> "application/xml"})
end
@response = Petstore::Response.new(API_CLIENT, @raw)
@response.format.should == 'xml'
@response.xml?.should == true
end
end
describe "prettiness" do
it "has a pretty json body" do
@response.pretty_body.should =~ /\{.*\}/
end
it "has pretty headers" do
@response.pretty_headers.should =~ /\{.*\}/
end
end
describe "deserialize" do
it "handles Hash<String, String>" do
@response.stub(:body) { '{"message": "Hello"}' }
data = @response.deserialize('Hash<String, String>')
data.should be_a(Hash)
data.should == {:message => 'Hello'}
end
it "handles Hash<String, Pet>" do
json = @response.body
@response.stub(:body) { "{\"pet\": #{json}}" }
data = @response.deserialize('Hash<String, Pet>')
data.should be_a(Hash)
data.keys.should == [:pet]
pet = data[:pet]
pet.should be_a(Petstore::Pet)
pet.id.should == 10002
end
end
end