Encoding a Ecto Model to JSON in elixir

Allister picture Allister · Sep 13, 2015 · Viewed 9.2k times · Source

I am going over the following tutorial in an attempt to get my head around elixir and phoenix:

https://thoughtbot.com/blog/testing-a-phoenix-elixir-json-api

I am running into an issue with the test, mainly using Poison.encode! on the Contact model. I get the following error:

unable to encode value: {nil, "contacts"}

This led me to the following issue:

https://github.com/elixir-lang/ecto/issues/840 and the fix: https://coderwall.com/p/fhsehq/fix-encoding-issue-with-ecto-and-poison

I have added the code from the blog article into lib/poison_encoder.ex, but I now get the following error:

no function clause matching in Poison.Encoder.Any.encode/2

The code I have in lib/poison_encoder.ex:

defimpl Poison.Encoder, for: Any do
  def encode(%{__struct__: _} = struct, options) do
    map = struct
          |> Map.from_struct
          |> sanitize_map
    Poison.Encoder.Map.encode(map, options)
  end

  defp sanitize_map(map) do
    Map.drop(map, [:__meta__, :__struct__])
  end
end

Answer

José Valim picture José Valim · Sep 13, 2015

Update to Poison 1.5. With it you can declare in your models:

@derive {Poison.Encoder, only: [:foo, :bar, :baz]}
schema "your schema" do
  field :foo
  field :bar
  field :baz
end

It is going to be faster, safer and cleaner.