Make decoded JWT available on conn.assigns.person

[nelsonic]

At present we are assigning the verified and decode JWT to conn.assigns.decoded:

auth_plug/lib/auth_plug.ex

Line 100 in 3bcdac1

|> assign(:decoded, claims)

This made sense at the time we wrote it because the :decoded key is the decoded JWT. 💭
But in the context of an App using auth_plug I find myself writing conn.assigns.decoded.id a lot when I think it would be more intuitive to write conn.assigns.person.id ...

Given that nobody else is using auth_plug yet, now is the time to make this change.
I think it will make things a lot clearer for people in the future.

Todo

• Rework create_session/3 to assign the decoded claims to conn.assigns.person
  

  auth_plug/lib/auth_plug.ex

  Lines 97 to 103 in 3bcdac1

  	def create_session(conn, claims, jwt) do
  	claims = AuthPlug.Helpers.strip_struct_metadata(claims)
  	conn
  	|> assign(:decoded, claims)
  	|> assign(:person, jwt)
  	|> put_session(:person, jwt)
  	end

• Assign the original JWT to conn.assigns.jwt i.e. assign(:jwt, jwt) instead of assign(:person, jwt)
• Define the session as jwt instead of person i.e. put_session(:jwt, jwt)
• Update the cond block to look for the jwt by the :jwt key instead of :person:
  

  auth_plug/lib/auth_plug.ex

  Lines 33 to 59 in 3bcdac1

  	jwt =
  	cond do
  	# First Check for JWT in URL Query String.
  	# We want a *new* session to supercede any expired session,
  	#  so the check for JWT *before* anything else.
  	conn.query_string =~ "jwt" ->
  	query = URI.decode_query(conn.query_string)
  	Map.get(query, "jwt")
  	# Check for JWT in Headers:
  	Enum.count(get_req_header(conn, "authorization")) > 0 ->
  	conn.req_headers
  	|> List.keyfind("authorization", 0)
  	|> get_token_from_header()
  	#  Check for Person in Plug.Conn.assigns
  	Map.has_key?(conn.assigns, :person) && not is_nil(conn.assigns.person) ->
  	conn.assigns.person
  	# Check for Session in Plug.Session:
  	not is_nil(get_session(conn, :person)) ->
  	get_session(conn, :person)
  	# By default return nil so auth check fails
  	true ->
  	nil
  	end

• Update the tests.
• Publish a new version with the breaking change. (We don't need a major bump as nobody is using the package yet so 1.1.0 is fine)

[nelsonic]

Going to get this done now as it's the penultimate thing on my list before assigning auth/pull/43
I expect it to take around T25m but I've estimated T1h for tidying up tests and docs. ⏳

[nelsonic]

Package published to https://hex.pm/packages/auth_plug/1.1.0 ✅