ueberauth / guardian

Elixir Authentication
MIT License
3.43k stars 382 forks source link

Add error handler behaviour. #542

Closed asummers closed 5 years ago

asummers commented 5 years ago

I found that the documentation around this was kind of scarce, and I had to kind of read the upgrade guide a few times, and guess at the typespec on my own end, so I thought adding a behaviour for documenting the callback would be nice.

Before I get much further with docs and such,

1) Is this something you would be into? 2) Is this an appropriate name? 3) Is there anything else you would see fitting into this module that I should move over right away / any existing docs that might be appropriate to grab for moduledocs?

codecov-io commented 5 years ago

Codecov Report

Merging #542 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #542   +/-   ##
=======================================
  Coverage   85.19%   85.19%           
=======================================
  Files          18       18           
  Lines         412      412           
=======================================
  Hits          351      351           
  Misses         61       61
Impacted Files Coverage Δ
lib/guardian/plug/pipeline.ex 86.36% <ø> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3aa9533...8809c91. Read the comment docs.

doomspork commented 5 years ago

Howdy @asummers, thank you for getting involved! I think this is a good idea we should explore further. I've added the other contributors so they too can take a peek 👍

As for documentation: We always welcome more.

asummers commented 5 years ago

I would also say I anticipate there being a few more behaviours that exist that are currently not concrete, so I'm not sure if there should be some folder naming with that thought in mind (e.g. the likely suboptimal subfolder name of /behaviours/).