Packages

ja_serializer

0.15.0
0.18.2 0.18.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.1 0.14.0 0.13.0 0.12.0 0.11.2 0.11.1 0.11.0 0.10.1 0.10.0 0.9.0 0.8.1 0.8.0 0.7.1 0.7.0 0.6.3 0.6.2 0.6.1 0.6.0 0.5.0 0.4.0 0.3.1 0.3.0 0.2.0 0.1.2 0.1.1 0.1.0 0.0.1

A serialization library implementing the jsonapi.org 1.0 spec suitable for use building JSON APIs in Phoenix and any other Plug based framework or app.

HexDocs

Current section

Files

Jump to
Readme
33 Versions
3 Dependencies
Dependants
Files
Activity
ja_serializer lib ja_serializer error_serializer.ex
Raw

lib/ja_serializer/error_serializer.ex 

defmodule JaSerializer.ErrorSerializer do

  @moduledoc """

  A super basic wrapper for formatting jsonapi errors.



  Takes a map (or list of maps) with the following keys:



      :id :links :about :status :code :title :detail :source :meta



  See http://jsonapi.org/format/#error-objects for more on errors.

  """



  alias JaSerializer.Builder.TopLevel

  alias JaSerializer.Formatter



  def format(error), do: format(error, %{})

  def format(error, conn), do: format(error, conn, [])



  def format(errors, _conn, _opts) when is_list(errors) do

    errors = errors |> Enum.map(&format_one/1)

    %TopLevel{errors: errors} |> Formatter.format()

  end



  def format(error, _conn, _opts) do

    errors =

      error

      |> format_one

      |> List.wrap()



    %TopLevel{errors: errors} |> Formatter.format()

  end



  @error_fields ~w(id links about status code title detail source meta)a

  defp format_one(error) do

    Map.take(error, @error_fields)

  end

end