No OneTemporary
Actions

Size

20 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/lib/open_api_spex/cast/discriminator.ex b/lib/open_api_spex/cast/discriminator.ex
	index 913b031..8945d76 100644
	--- a/lib/open_api_spex/cast/discriminator.ex
	+++ b/lib/open_api_spex/cast/discriminator.ex
	@@ -1,112 +1,112 @@
	defmodule OpenApiSpex.Cast.Discriminator do
	@moduledoc """
	Defines the `OpenApiSpex.Discriminator.t` type.
	"""

	alias OpenApiSpex.{Cast, Reference, Schema}

	@enforce_keys :propertyName
	defstruct [
	:propertyName,
	:mapping
	]

	@typedoc """
	[Discriminator Object](https://swagger.io/specification/#discriminatorObject)

	When request bodies or response payloads may be one of a number of different schemas,
	a discriminator object can be used to aid in serialization, deserialization, and validation.
	The discriminator is a specific object in a schema which is used to inform the consumer of the
	specification of an alternative schema based on the value associated with it.

	A discriminator requires a composite key be set on the schema:

	* `allOf`
	* `oneOf`
	* `anyOf`
	"""
	@type t :: %__MODULE__{
	propertyName: String.t(),
	mapping: %{String.t() => String.t()} \| nil
	}

	def cast(ctx) do
	case cast_discriminator(ctx) do
	{:ok, result} -> {:ok, result}
	error -> error
	end
	end

	defp cast_discriminator(%_{value: value, schema: schema} = ctx) do
	{discriminator_property, mappings} = discriminator_details(schema)

	case Map.pop(value, "#{discriminator_property}") do
	{"", _} ->
	error(:no_value_for_discriminator, ctx)

	{discriminator_value, _castable_value} ->
	# The cast specified by the composite key (allOf, anyOf, oneOf) MUST succeed
	# or return an error according to the Open API Spec.
	composite_ctx = %{
	ctx
	\| schema: %{schema \| discriminator: nil},
	path: ["#{discriminator_property}" \| ctx.path]
	}

	cast_composition(composite_ctx, ctx, discriminator_value, mappings)
	end
	end

	defp cast_composition(composite_ctx, ctx, discriminator_value, mappings) do
	with {composite_schemas, {:ok, _}} <- cast_composition(composite_ctx),
	%{} = schema <-
	find_discriminator_schema(discriminator_value, mappings, composite_schemas) do
	Cast.cast(%{composite_ctx \| schema: schema})
	else
	nil -> error(:invalid_discriminator_value, ctx)
	other -> other
	end
	end

	defp cast_composition(%_{schema: %{anyOf: schemas, discriminator: nil}} = ctx)
	when is_list(schemas),
	do: {schemas \|> _locate_schemas(ctx.schemas), Cast.cast(ctx)}

	defp cast_composition(%_{schema: %{allOf: schemas, discriminator: nil}} = ctx)
	when is_list(schemas),
	do: {schemas \|> _locate_schemas(ctx.schemas), Cast.cast(ctx)}

	defp cast_composition(%_{schema: %{oneOf: schemas, discriminator: nil}} = ctx)
	when is_list(schemas),
	do: {schemas \|> _locate_schemas(ctx.schemas), Cast.cast(ctx)}

	defp find_discriminator_schema(discriminator, mappings = %{}, schemas) do
	- with {:ok, "#/components/schemas/" <> name} <- Map.fetch(mappings, discriminator) \|> IO.inspect(label: "the fetching got us this") do
	+ with {:ok, "#/components/schemas/" <> name} <- Map.fetch(mappings, discriminator) do
	find_discriminator_schema(name, nil, schemas)
	else
	{:ok, name} -> find_discriminator_schema(name, nil, schemas)
	:error -> find_discriminator_schema(discriminator, nil, schemas)
	end
	end

	defp find_discriminator_schema(discriminator, _, schemas) do
	Enum.find(schemas, &Kernel.==(&1.title, discriminator))
	end

	defp discriminator_details(%{discriminator: %{propertyName: property_name, mapping: mappings}}),
	do: {String.to_existing_atom(property_name), mappings}

	defp error(message, %{schema: %{discriminator: %{propertyName: property}}} = ctx) do
	Cast.error(ctx, {message, property})
	end

	defp _locate_schemas(schemas, ctx_schemas) do
	schemas
	\|> Enum.map(fn
	%Schema{} = schema ->
	schema
	%Reference{} = schema ->
	Reference.resolve_schema(schema, ctx_schemas)
	end)
	end
	end
	diff --git a/lib/open_api_spex/cast_parameters.ex b/lib/open_api_spex/cast_parameters.ex
	index a2e7c1b..dc6f613 100644
	--- a/lib/open_api_spex/cast_parameters.ex
	+++ b/lib/open_api_spex/cast_parameters.ex
	@@ -1,112 +1,115 @@
	defmodule OpenApiSpex.CastParameters do
	@moduledoc false
	alias OpenApiSpex.{Cast, Operation, Parameter, Schema, Reference, Components}
	alias OpenApiSpex.Cast.{Error, Object}
	alias Plug.Conn

	@spec cast(Plug.Conn.t(), Operation.t(), Components.t()) ::
	{:error, [Error.t()]} \| {:ok, Conn.t()}
	def cast(conn, operation, components) do
	with {:ok, params} <- cast_to_params(conn, operation, components) do
	{:ok, %{conn \| params: params}}
	end
	end

	defp cast_to_params(conn, operation, components) do
	operation
	\|> schemas_by_location(components)
	\|> Enum.map(fn {location, schema} -> cast_location(location, schema, components, conn) end)
	\|> reduce_cast_results()
	end

	defp get_params_by_location(conn, :query, _) do
	Plug.Conn.fetch_query_params(conn).query_params
	end

	defp get_params_by_location(conn, :path, _) do
	conn.path_params
	end

	defp get_params_by_location(conn, :cookie, _) do
	Plug.Conn.fetch_cookies(conn).req_cookies
	end

	defp get_params_by_location(conn, :header, expected_names) do
	conn.req_headers
	\|> Enum.filter(fn {key, _value} ->
	Enum.member?(expected_names, String.downcase(key))
	end)
	\|> Map.new()
	end

	defp create_location_schema(parameters) do
	%Schema{
	type: :object,
	additionalProperties: false,
	properties: parameters \|> Map.new(fn p -> {p.name, Parameter.schema(p)} end),
	required: parameters \|> Enum.filter(& &1.required) \|> Enum.map(& &1.name)
	}
	\|> maybe_add_additional_properties()
	end

	defp schemas_by_location(operation, components) do
	param_specs_by_location =
	operation.parameters
	\|> Enum.map(fn
	+ %Reference{} = ref ->
	+ Reference.resolve_parameter(ref, components.parameters)
	+
	%Parameter{schema: %Reference{"$ref": "#/components/parameters/" <> _}} = param ->
	schema = Reference.resolve_parameter(param.schema, components.parameter)
	param \|> Map.put(:schema, schema)

	%Parameter{schema: %Reference{"$ref": "#/components/schemas/" <> _}} = param ->
	schema = Reference.resolve_schema(param.schema, components.schemas)
	param \|> Map.put(:schema, schema)

	%Parameter{} = param ->
	param
	end)
	\|> Enum.group_by(& &1.in)

	Map.new(param_specs_by_location, fn {location, parameters} ->
	{location, create_location_schema(parameters)}
	end)
	end

	defp cast_location(location, schema, components, conn) do
	params =
	get_params_by_location(
	conn,
	location,
	schema.properties \|> Map.keys() \|> Enum.map(&Atom.to_string/1)
	)

	ctx = %Cast{
	value: params,
	schema: schema,
	schemas: components.schemas
	}

	Object.cast(ctx)
	end

	defp reduce_cast_results(results) do
	Enum.reduce_while(results, {:ok, %{}}, fn
	{:ok, params}, {:ok, all_params} -> {:cont, {:ok, Map.merge(all_params, params)}}
	cast_error, _ -> {:halt, cast_error}
	end)
	end

	defp maybe_add_additional_properties(schema) do
	ap_schema =
	Enum.reject(
	schema.properties,
	fn {_name, %{additionalProperties: ap}} ->
	is_nil(ap) or ap == false
	end
	)

	case ap_schema do
	[{_, %{additionalProperties: ap}}] -> %{schema \| additionalProperties: ap}
	_ -> schema
	end
	end
	end
	diff --git a/test/plug/cast_test.exs b/test/plug/cast_test.exs
	index 03de35e..ab978ac 100644
	--- a/test/plug/cast_test.exs
	+++ b/test/plug/cast_test.exs
	@@ -1,305 +1,302 @@
	defmodule OpenApiSpex.Plug.CastTest do
	use ExUnit.Case
	- @moduletag :stuff

	describe "query params - basics" do
	test "Valid Param" do
	conn =
	:get
	\|> Plug.Test.conn("/api/users?validParam=true")
	\|> OpenApiSpexTest.Router.call([])

	assert conn.status == 200
	end

	test "Invalid value" do
	conn =
	:get
	\|> Plug.Test.conn("/api/users?validParam=123")
	\|> OpenApiSpexTest.Router.call([])

	assert conn.status == 422
	end

	test "Invalid Param" do
	conn =
	:get
	\|> Plug.Test.conn("/api/users?validParam=123")
	\|> OpenApiSpexTest.Router.call([])

	assert conn.status == 422
	error_resp = Jason.decode!(conn.resp_body)

	assert error_resp == %{
	"errors" => [
	%{
	"message" => "Invalid boolean. Got: string",
	"source" => %{"pointer" => "/validParam"},
	"title" => "Invalid value"
	}
	]
	}
	end

	test "with requestBody" do
	body =
	Jason.encode!(%{
	phone_number: "123-456-789",
	postal_address: "123 Lane St"
	})

	conn =
	:post
	\|> Plug.Test.conn("/api/users/123/contact_info", body)
	\|> Plug.Conn.put_req_header("content-type", "application/json")
	\|> OpenApiSpexTest.Router.call([])

	assert conn.status == 200
	end
	end

	describe "query params - param with custom error handling" do
	test "Valid Param" do
	conn =
	:get
	\|> Plug.Test.conn("/api/custom_error_users?validParam=true")
	\|> OpenApiSpexTest.Router.call([])

	assert conn.status == 200
	end

	test "Invalid value" do
	conn =
	:get
	\|> Plug.Test.conn("/api/custom_error_users?validParam=123")
	\|> OpenApiSpexTest.Router.call([])

	assert conn.status == 400
	end

	test "Invalid Param" do
	conn =
	:get
	\|> Plug.Test.conn("/api/custom_error_users?validParam=123")
	\|> OpenApiSpexTest.Router.call([])

	assert conn.status == 400
	assert conn.resp_body == "Invalid boolean. Got: string"
	end
	end

	describe "body params" do
	test "Valid Request" do
	request_body = %{
	"user" => %{
	"id" => 123,
	"name" => "asdf",
	"email" => "foo@bar.com",
	"updated_at" => "2017-09-12T14:44:55Z"
	}
	}

	conn =
	:post
	\|> Plug.Test.conn("/api/users", Jason.encode!(request_body))
	\|> Plug.Conn.put_req_header("content-type", "application/json; charset=UTF-8")
	\|> OpenApiSpexTest.Router.call([])

	assert conn.body_params == %OpenApiSpexTest.Schemas.UserRequest{
	user: %OpenApiSpexTest.Schemas.User{
	id: 123,
	name: "asdf",
	email: "foo@bar.com",
	updated_at: ~N[2017-09-12T14:44:55Z] \|> DateTime.from_naive!("Etc/UTC")
	}
	}

	assert Jason.decode!(conn.resp_body) == %{
	"data" => %{
	"email" => "foo@bar.com",
	"id" => 1234,
	"inserted_at" => nil,
	"name" => "asdf",
	"updated_at" => "2017-09-12T14:44:55Z"
	}
	}
	end

	test "Invalid Request" do
	request_body = %{
	"user" => %{
	"id" => 123,
	"name" => "*1234",
	"email" => "foo@bar.com",
	"updated_at" => "2017-09-12T14:44:55Z"
	}
	}

	conn =
	:post
	\|> Plug.Test.conn("/api/users", Jason.encode!(request_body))
	\|> Plug.Conn.put_req_header("content-type", "application/json")

	conn = OpenApiSpexTest.Router.call(conn, [])
	assert conn.status == 422

	resp_data = Jason.decode!(conn.resp_body)

	assert resp_data ==
	%{
	"errors" => [
	%{
	"message" => "Invalid format. Expected ~r/[a-zA-Z][a-zA-Z0-9_]+/",
	"source" => %{"pointer" => "/user/name"},
	"title" => "Invalid value"
	}
	]
	}
	end
	end

	describe "oneOf body params" do
	- @tag :stuff2
	test "Valid Request" do
	request_body = %{
	"pet" => %{
	"pet_type" => "Dog",
	"bark" => "woof"
	}
	}

	conn =
	:post
	\|> Plug.Test.conn("/api/pets", Jason.encode!(request_body))
	\|> Plug.Conn.put_req_header("content-type", "application/json; charset=UTF-8")
	\|> OpenApiSpexTest.Router.call([])

	assert conn.body_params == %OpenApiSpexTest.Schemas.PetRequest{
	pet: %OpenApiSpexTest.Schemas.Dog{
	pet_type: "Dog",
	bark: "woof"
	}
	}

	assert Jason.decode!(conn.resp_body) == %{
	"data" => %{
	"pet_type" => "Dog",
	"bark" => "woof"
	}
	}
	end

	@tag :capture_log
	test "Invalid Request" do
	request_body = %{
	"pet" => %{
	"pet_type" => "Human",
	"says" => "yes"
	}
	}

	conn =
	:post
	\|> Plug.Test.conn("/api/pets", Jason.encode!(request_body))
	\|> Plug.Conn.put_req_header("content-type", "application/json")

	conn = OpenApiSpexTest.Router.call(conn, [])
	assert conn.status == 422

	resp_body = Jason.decode!(conn.resp_body)

	assert resp_body == %{
	"errors" => [
	%{
	"source" => %{
	"pointer" => "/pet"
	},
	"title" => "Invalid value",
	"message" => "Failed to cast value to one of: [] (no schemas provided)"
	}
	]
	}
	end

	test "Header params" do
	conn =
	:post
	\|> Plug.Test.conn("/api/pets/1/adopt")
	\|> Plug.Conn.put_req_header("content-type", "application/json; charset=UTF-8")
	\|> Plug.Conn.put_req_header("x-user-id", "123456")
	\|> OpenApiSpexTest.Router.call([])

	assert Jason.decode!(conn.resp_body) == %{
	"data" => %{
	"pet_type" => "Dog",
	"bark" => "woof"
	}
	}
	end

	test "Optional param" do
	conn =
	:post
	\|> Plug.Test.conn("/api/pets/1/adopt?status=adopted")
	\|> Plug.Conn.put_req_header("content-type", "application/json; charset=UTF-8")
	\|> Plug.Conn.put_req_header("x-user-id", "123456")
	\|> OpenApiSpexTest.Router.call([])

	assert Jason.decode!(conn.resp_body) == %{
	"data" => %{
	"pet_type" => "Dog",
	"bark" => "woof"
	}
	}
	end

	test "Cookie params" do
	conn =
	:post
	\|> Plug.Test.conn("/api/pets/1/adopt")
	\|> Plug.Conn.put_req_header("content-type", "application/json; charset=UTF-8")
	\|> Plug.Conn.put_req_header("x-user-id", "123456")
	\|> Plug.Conn.put_req_header("cookie", "debug=1")
	\|> OpenApiSpexTest.Router.call([])

	assert Jason.decode!(conn.resp_body) == %{
	"data" => %{
	"pet_type" => "Debug-Dog",
	"bark" => "woof"
	}
	}
	end

	- @tag :stuff1
	test "Discriminator with mapping" do
	body =
	Jason.encode!(%{
	appointment_type: "grooming",
	hair_trim: true,
	nail_clip: false
	})

	conn =
	:post
	\|> Plug.Test.conn("/api/pets/appointment", body)
	\|> Plug.Conn.put_req_header("content-type", "application/json")
	\|> OpenApiSpexTest.Router.call([])

	assert Jason.decode!(conn.resp_body) == %{"data" => [%{"pet_type" => "Dog", "bark" => "bow wow"}]}
	end

	test "freeForm params" do
	conn =
	:get
	\|> Plug.Test.conn("/api/utility/echo/any?one=this&two=cam&three=be&anything=true")
	\|> OpenApiSpexTest.Router.call([])

	assert Jason.decode!(conn.resp_body) == %{
	"one" => "this",
	"two" => "cam",
	"three" => "be",
	"anything" => "true"
	}
	end
	end
	end
	diff --git a/test/support/pet_controller.ex b/test/support/pet_controller.ex
	index 9d3a603..52ccf46 100644
	--- a/test/support/pet_controller.ex
	+++ b/test/support/pet_controller.ex
	@@ -1,151 +1,150 @@
	defmodule OpenApiSpexTest.PetController do
	use Phoenix.Controller
	alias OpenApiSpex.Operation
	alias OpenApiSpexTest.Schemas

	plug OpenApiSpex.Plug.CastAndValidate

	def open_api_operation(action) do
	apply(__MODULE__, :"#{action}_operation", [])
	end

	@doc """
	API Spec for :show action
	"""
	def show_operation() do
	import Operation

	%Operation{
	tags: ["pets"],
	summary: "Show pet",
	description: "Show a pet by ID",
	operationId: "PetController.show",
	parameters: [
	parameter(:id, :path, :integer, "Pet ID", example: 123, minimum: 1)
	],
	responses: %{
	200 => response("Pet", "application/json", Schemas.PetResponse)
	}
	}
	end

	def show(conn, %{id: _id}) do
	json(conn, %Schemas.PetResponse{
	data: %Schemas.Dog{
	pet_type: "Dog",
	bark: "woof"
	}
	})
	end

	def index_operation() do
	import Operation

	%Operation{
	tags: ["pets"],
	summary: "List pets",
	description: "List all petes",
	operationId: "PetController.index",
	parameters: [
	parameter(:validParam, :query, :boolean, "Valid Param", example: true)
	],
	responses: %{
	200 => response("Pet List Response", "application/json", Schemas.PetsResponse)
	}
	}
	end

	def index(conn, _params) do
	json(conn, %Schemas.PetsResponse{
	data: [
	%Schemas.Dog{
	pet_type: "Dog",
	bark: "joe@gmail.com"
	}
	]
	})
	end

	def create_operation() do
	import Operation

	%Operation{
	tags: ["pets"],
	summary: "Create pet",
	description: "Create a pet",
	operationId: "PetController.create",
	parameters: [],
	requestBody: request_body("The pet attributes", "application/json", Schemas.PetRequest),
	responses: %{
	201 => response("Pet", "application/json", Schemas.PetRequest)
	}
	}
	end

	def create(conn = %{body_params: %Schemas.PetRequest{pet: pet}}, _) do
	json(conn, %Schemas.PetResponse{
	data: pet
	})
	end

	def adopt_operation() do
	import Operation

	%Operation{
	tags: ["pets"],
	summary: "Adopt pet",
	description: "Adopt a pet",
	operationId: "PetController.adopt",
	parameters: [
	parameter(:"x-user-id", :header, :string, "User that performs this action", required: true),
	parameter(:id, :path, :integer, "Pet ID", example: 123, minimum: 1),
	parameter(:status, :query, Schemas.PetStatus, "New status"),
	parameter(:debug, :cookie, %OpenApiSpex.Schema{type: :integer, enum: [0, 1], default: 0}, "Debug"),
	],
	responses: %{
	200 => response("Pet", "application/json", Schemas.PetRequest)
	}
	}
	end

	def adopt(conn, %{:"x-user-id" => _user_id, :id => _id, :debug => 0}) do
	json(conn, %Schemas.PetResponse{
	data: %Schemas.Dog{
	pet_type: "Dog",
	bark: "woof"
	}
	})
	end

	def adopt(conn, %{:"x-user-id" => _user_id, :id => _id, :debug => 1}) do
	json(conn, %Schemas.PetResponse{
	data: %Schemas.Dog{
	pet_type: "Debug-Dog",
	bark: "woof"
	}
	})
	end

	def appointment_operation() do
	import Operation

	%Operation{
	tags: ["pets"],
	summary: "Create pet",
	description: "Create a pet",
	- operationId: "PetController.create",
	+ operationId: "PetController.appointment",
	parameters: [],
	requestBody: request_body("The pet attributes", "application/json", Schemas.PetAppointmentRequest),
	responses: %{
	201 => response("Pet", "application/json", Schemas.PetResponse)
	}
	}
	end

	- def appointment(conn = %{body_params: bp}, _) do
	- bp \|> IO.inspect(label: "the body params I actually got..")
	+ def appointment(conn, _) do
	json(conn, %Schemas.PetResponse{
	data: [%{pet_type: "Dog", bark: "bow wow"}]
	})
	end
	end

File Metadata

Mime Type: text/x-diff
Expires: Tue, Nov 26, 2:30 PM (1 d, 12 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 40384
Default Alt Text: (20 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions