biblio.el icon indicating copy to clipboard operation
biblio.el copied to clipboard

Add backend to IACR Cryptoeprint

Open lzmartinico opened this issue 4 years ago • 9 comments

This PR adds a new backend to the IACR Cryptology ePrint. This is my first non-trivial elisp, so any stylistic feedback would be appreciated! This eprint service does not have a nice API like some of the other backends, so the HTML code is quite brittle for now.

lzmartinico avatar Dec 10 '20 23:12 lzmartinico

:tada: :+1: Thanks for the contribution! A quick thought: if here's no clean API from IACR, maybe this would be best maintained as a separate MELPA package? In any case I will have a detailed look.

cpitclaudel avatar Dec 10 '20 23:12 cpitclaudel

Thanks for all the comments! I have pushed some more commits to address these

lzmartinico avatar Dec 11 '20 22:12 lzmartinico

While testing, I have also noted that the IACR search page fails if the year is one of the search terms (spaces are counted as ANDs, but the search string is never checked against the year). Would it make sense to correct this, or should the library try not to be as opinionated and keep to the original API? For me it's pretty normal to search for "Author year" as a pattern

lzmartinico avatar Dec 11 '20 23:12 lzmartinico

While testing, I have also noted that the IACR search page fails if the year is one of the search terms (spaces are counted as ANDs, but the search string is never checked against the year). Would it make sense to correct this, or should the library try not to be as opinionated and keep to the original API? For me it's pretty normal to search for "Author year" as a pattern

What would be the normal way to search for an author and year on the website?

cpitclaudel avatar Dec 12 '20 00:12 cpitclaudel

While testing, I have also noted that the IACR search page fails if the year is one of the search terms (spaces are counted as ANDs, but the search string is never checked against the year). Would it make sense to correct this, or should the library try not to be as opinionated and keep to the original API? For me it's pretty normal to search for "Author year" as a pattern

What would be the normal way to search for an author and year on the website?

There is only an optional lastmonths parameter to limit search results to the last N months, but it doesn't seem to work, as it still returns all the results for the matching keywords.

lzmartinico avatar Dec 12 '20 16:12 lzmartinico

There is only an optional lastmonths parameter to limit search results to the last N months, but it doesn't seem to work, as it still returns all the results for the matching keywords.

I see. I think we should stick with exposing the raw website's functionality. But it definitely wouldn't hurt to write the maintainers of the archive to ask them for a proper API, for the long run :)

cpitclaudel avatar Dec 12 '20 17:12 cpitclaudel

Thanks! I think it makes more sense to include this within biblio, I think it's a bit too small to be meaningful as a full package. I'll have a look at the test file to see how the other backends are being tested - or is there any further specific test you'd like to see?

lzmartinico avatar Dec 13 '20 12:12 lzmartinico

Nope, same style as the others is perfect. Let me know if you need help (in the past the testing framework moved quickly and that caused breakage; if you see similar breakage let me know and I'll fix the tests ^^)

cpitclaudel avatar Dec 13 '20 17:12 cpitclaudel

Hi, I just pushed some tests for the new module, let me know if you think anything is missing!

lzmartinico avatar Jan 04 '21 19:01 lzmartinico