adding DOAB to web search

src/main/java/org/jabref/logic/importer/WebFetchers.java

@@ -18,6 +18,7 @@
 import org.jabref.logic.importer.fetcher.CompositeSearchBasedFetcher;
 import org.jabref.logic.importer.fetcher.CrossRef;
 import org.jabref.logic.importer.fetcher.DBLPFetcher;
+import org.jabref.logic.importer.fetcher.DOABFetcher;
 import org.jabref.logic.importer.fetcher.DOAJFetcher;
 import org.jabref.logic.importer.fetcher.DiVA;
 import org.jabref.logic.importer.fetcher.DoiFetcher;
@@ -107,6 +108,7 @@ public static SortedSet<SearchBasedFetcher> getSearchBasedFetchers(ImportFormatP
         set.add(new IEEE(importFormatPreferences));
         set.add(new CompositeSearchBasedFetcher(set, 30));
         set.add(new CollectionOfComputerScienceBibliographiesFetcher(importFormatPreferences));
+        set.add(new DOABFetcher());
         // set.add(new JstorFetcher(importFormatPreferences));
         return set;
     }

src/main/java/org/jabref/logic/importer/fetcher/DOABFetcher.java

@@ -0,0 +1,129 @@
+package org.jabref.logic.importer.fetcher;
+
+import java.net.MalformedURLException;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.StringJoiner;
+
+import org.jabref.logic.importer.FetcherException;
+import org.jabref.logic.importer.Parser;
+import org.jabref.logic.importer.SearchBasedParserFetcher;
+import org.jabref.logic.importer.fetcher.transformers.DefaultQueryTransformer;
+import org.jabref.logic.importer.util.JsonReader;
+import org.jabref.model.entry.Author;
+import org.jabref.model.entry.AuthorList;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.field.StandardField;
+
+import kong.unirest.json.JSONArray;
+import kong.unirest.json.JSONObject;
+import org.apache.http.client.utils.URIBuilder;
+import org.apache.lucene.queryparser.flexible.core.nodes.QueryNode;
+
+/*
+ fetches books from https://www.doabooks.org/ through their API at
+ https://www.doabooks.org/en/resources/metadata-harvesting-and-content-dissemination
+ */
+
+public class DOABFetcher implements SearchBasedParserFetcher {
+    private static final String SEARCH_URL = "https://directory.doabooks.org/rest/search?";
+    // private static final String PEER_REVIEW_URL = " https://directory.doabooks.org/rest/peerReviews?";
+
+    @Override
+    public String getName() {
+        return "DOAB";
+    }
+
+    @Override
+    public URL getURLForQuery(QueryNode luceneQuery) throws URISyntaxException, MalformedURLException, FetcherException {
+        URIBuilder builder = new URIBuilder(SEARCH_URL);
+        String query = new DefaultQueryTransformer().transformLuceneQuery(luceneQuery).orElse("");
+        // adding quotations for the query for more specified results
+        // without the quotation the results returned are not relevant to the query
+        query = ("\"".concat(query)).concat("\"");
+        builder.addParameter("query", query);
+        builder.addParameter("expand", "metadata");
+
+        return builder.build().toURL();
+    }
+
+    @Override
+    public Parser getParser() {
+        return InputStream -> {
+            // can't use this method JsonReader.toJsonObject(inputStream) because the results are sent in an array
+            // like format resulting in an error when trying to convert them into a json object
+            // created a similar method suitable for this case "toJsonArray"
+            JSONArray response = JsonReader.toJsonArray(InputStream);
+            if (response.isEmpty()) {
+                return Collections.emptyList();
+            }
+            // single result case
+            if (response.length() == 1) {
+
+                // the information used for bibtex entries are in an array inside the resulting jsonarray
+                // see this query for reference https://directory.doabooks.org/rest/search?query="i open fire"&expand=metadata
+                JSONArray metadataArray = response.getJSONObject(0).getJSONArray("metadata");
+                BibEntry entry = JsonToBibEntry(metadataArray);
+                return Collections.singletonList(entry);
+            }
+            // multiple results
+            List<BibEntry> entries = new ArrayList<>(response.length());
+            for (int i = 0; i < response.length(); i++) {
+                JSONArray metadataArray = response.getJSONObject(i).getJSONArray("metadata");
+                BibEntry entry = JsonToBibEntry(metadataArray);
+                entries.add(entry);
+            }
+            return entries;
+        };
+    }
+
+    private BibEntry JsonToBibEntry(JSONArray metadataArray) {
+        BibEntry entry = new BibEntry();
+        List<Author> authorsList = new ArrayList<>();
+        List<Author> editorsList = new ArrayList<>();
+        StringJoiner keywordJoiner = new StringJoiner(",");
+        for (int i = 0; i < metadataArray.length(); i++) {
+            JSONObject dataObject = metadataArray.getJSONObject(i);
+            switch (dataObject.getString("key")) {
+                case "dc.contributor.author" -> authorsList.add(toAuthor(dataObject.getString("value")));
+                case "dc.type" -> entry.setField(StandardField.TYPE,
+                        dataObject.getString("value"));
+                case "dc.date.issued" -> entry.setField(StandardField.YEAR, String.valueOf(
+                        dataObject.getInt("value")));
+                case "oapen.identifier.doi" -> entry.setField(StandardField.DOI,
+                        dataObject.getString("value"));
+                case "dc.title" -> entry.setField(StandardField.TITLE,
+                        dataObject.getString("value"));
+                case "oapen.pages" -> entry.setField(StandardField.PAGES, String.valueOf(
+                        dataObject.getInt("value")));
+                case "dc.description.abstract" -> entry.setField(StandardField.ABSTRACT,
+                        dataObject.getString("value"));
+                case "dc.language" -> entry.setField(StandardField.LANGUAGE,
+                        dataObject.getString("value"));
+                case "publisher.name" -> entry.setField(StandardField.PUBLISHER,
+                        dataObject.getString("value"));
+                case "dc.identifier.uri" -> entry.setField(StandardField.URI,
+                        dataObject.getString("value"));
+                case "dc.subject.other" -> keywordJoiner.add(dataObject.getString("value"));
+                case "dc.contributor.editor" -> editorsList.add(toAuthor(dataObject.getString("value")));
+            }
+        }
+        entry.setField(StandardField.AUTHOR, toAuthorList(authorsList));
+        entry.setField(StandardField.EDITOR, toAuthorList(editorsList));
+        entry.setField(StandardField.KEYWORDS, String.valueOf(keywordJoiner));
+        return entry;
+    }
+
+    private Author toAuthor(String author) {
+        String[] names = author.split(" ");
+        names[0] = String.valueOf(new StringBuilder(names[0]).deleteCharAt(names[0].length() - 1));
+        return new Author(names[1], "", "", names[0], "");
+    }
+
+    private String toAuthorList(List<Author> authorsList) {
+        return AuthorList.of(authorsList).getAsFirstLastNamesWithAnd();
+    }
+}

src/main/java/org/jabref/logic/importer/util/JsonReader.java

@@ -6,6 +6,7 @@
 import org.jabref.logic.importer.ParseException;
 
 import com.google.common.base.Charsets;
+import kong.unirest.json.JSONArray;
 import kong.unirest.json.JSONException;
 import kong.unirest.json.JSONObject;
 
@@ -31,4 +32,16 @@ public static JSONObject toJsonObject(InputStream inputStream) throws ParseExcep
             throw new ParseException(e);
         }
     }
+
+    public static JSONArray toJsonArray(InputStream stream) throws ParseException {
+        try {
+            String inpStr = new String((stream.readAllBytes()), Charsets.UTF_8);
+            if (inpStr.isBlank()) {
+                return new JSONArray();
+            }
+            return new JSONArray(inpStr);
+        } catch (IOException | JSONException e) {
+            throw new ParseException(e);
+        }
+    }
 }

src/test/java/org/jabref/logic/importer/fetcher/DOABFetcherTest.java

@@ -0,0 +1,130 @@
+package org.jabref.logic.importer.fetcher;
+
+import java.util.List;
+
+import org.jabref.logic.importer.FetcherException;
+import org.jabref.model.entry.BibEntry;
+import org.jabref.model.entry.field.StandardField;
+import org.jabref.testutils.category.FetcherTest;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+@FetcherTest
+public class DOABFetcherTest {
+    private DOABFetcher fetcher;
+    private BibEntry David_Opal;
+    private BibEntry Ronald_Snijder;
+    private BibEntry Andrew_Perrin;
+
+    @BeforeEach
+    public void setUp() throws Exception {
+        fetcher = new DOABFetcher();
+
+        David_Opal = new BibEntry();
+        David_Opal.setField(StandardField.AUTHOR, "David Pol");
+        David_Opal.setField(StandardField.TITLE, "I Open Fire");
+        David_Opal.setField(StandardField.TYPE, "book");
+        David_Opal.setField(StandardField.DOI, "10.21983/P3.0086.1.00");
+        David_Opal.setField(StandardField.PAGES, "56");
+        David_Opal.setField(StandardField.YEAR, "2014");
+        David_Opal.setField(StandardField.URI, "https://directory.doabooks.org/handle/20.500.12854/34739");
+        David_Opal.setField(StandardField.ABSTRACT, "David Pol presents an ontology of war in the form of " +
+                "the lyric poem. “Do you hear what I’m shooting at you?” In I Open Fire, all relation is " +
+                "warfare. Minefields compromise movement. Intention aims. Touch burns. Sex explodes bodies. " +
+                "Time ticks in bomb countdowns. Sound is sirens. Plenitude is debris. All of it under " +
+                "surveillance. “My world is critically injured. It was ambushed.” The poems in this book perform" +
+                " the reductions and repetitions endemic to war itself, each one returning the reader to the same," +
+                " unthinkable place in which the range of human experience has been so flattened that, despite all" +
+                " the explosive action, “Almost nothing is happening.” Against this backdrop, we continue to fall" +
+                " in love. But Pol’s poems remind us that this is no reason for optimism. Does love offer a" +
+                " delusional escape from war, or are relationships the very definition of combat? These poems take" +
+                " up the themes of love, sex, marriage, touch, hope — in short, the many dimensions of" +
+                " interpersonal connection — in a world in unprecedentedly critical condition. “And when the night" +
+                " goes off the shock wave throws us apart toward each other.”");
+        David_Opal.setField(StandardField.LANGUAGE, "English");
+        David_Opal.setField(StandardField.KEYWORDS, "poetry,love,warfare");
+        David_Opal.setField(StandardField.PUBLISHER, "punctum books");
+
+        Ronald_Snijder = new BibEntry();
+        Ronald_Snijder.setField(StandardField.AUTHOR, "Ronald Snijder");
+        Ronald_Snijder.setField(StandardField.TITLE, "The deliverance of open access books");
+        Ronald_Snijder.setField(StandardField.TYPE, "book");
+        Ronald_Snijder.setField(StandardField.DOI, "10.26530/OAPEN_1004809");
+        Ronald_Snijder.setField(StandardField.PAGES, "234");
+        Ronald_Snijder.setField(StandardField.YEAR, "2019");
+        Ronald_Snijder.setField(StandardField.URI, "https://directory.doabooks.org/handle/20.500.12854/26303");
+        Ronald_Snijder.setField(StandardField.ABSTRACT, "In many scholarly disciplines, books - not articles" +
+                " - are the norm. As print runs become smaller, the question arises whether publishing monographs" +
+                " in open access helps to make their contents globally accessible. To answer this question, the" +
+                " results of multiple studies on the usage of open access books are presented. The research" +
+                " focuses on three areas: economic viability; optimization of open access monographs" +
+                " infrastructure and measuring the effects of open access in terms of scholarly impact and" +
+                " societal influence. Each chapter reviews a different aspect: book sales, digital dissemination," +
+                " open licenses, user communities, measuring usage, developing countries and the effects on" +
+                " citations and social media.");
+        Ronald_Snijder.setField(StandardField.LANGUAGE, "English");
+        Ronald_Snijder.setField(StandardField.KEYWORDS, "Open Access,Monographs,OAPEN Library," +
+                "Directory of Open Access Books");
+        Ronald_Snijder.setField(StandardField.PUBLISHER, "Amsterdam University Press");
+
+        Andrew_Perrin = new BibEntry();
+        Andrew_Perrin.setField(StandardField.EDITOR, "Andrew Perrin and Loren Stuckenbruck");
+        Andrew_Perrin.setField(StandardField.TITLE, "Four Kingdom Motifs before and beyond the Book of Daniel");
+        Andrew_Perrin.setField(StandardField.TYPE, "book");
+        Andrew_Perrin.setField(StandardField.DOI, "10.1163/9789004443280");
+        Andrew_Perrin.setField(StandardField.PAGES, "354");
+        Andrew_Perrin.setField(StandardField.YEAR, "2020");
+        Andrew_Perrin.setField(StandardField.URI, "https://directory.doabooks.org/handle/20.500.12854/68086");
+        Andrew_Perrin.setField(StandardField.ABSTRACT, "The four kingdoms motif enabled writers of various " +
+                "cultures, times, and places, to periodize history as the staged succession of empires " +
+                "barrelling towards an utopian age. The motif provided order to lived experiences under empire" +
+                " (the present), in view of ancestral traditions and cultural heritage (the past), and inspired" +
+                " outlooks assuring hope, deliverance, and restoration (the future). Four Kingdom Motifs before" +
+                " and beyond the Book of Daniel includes thirteen essays that explore the reach and redeployment" +
+                " of the motif in classical and ancient Near Eastern writings, Jewish and Christian scriptures," +
+                " texts among the Dead Sea Scrolls, Apocrypha and pseudepigrapha, depictions in European" +
+                " architecture and cartography, as well as patristic, rabbinic, Islamic, and African writings " +
+                "from antiquity through the Mediaeval eras. Readership: Advanced students and scholars of the " +
+                "textual formation, apocalyptic theology, and historiographies of the book of Daniel and its " +
+                "diverse reception by writers and communities.");
+        Andrew_Perrin.setField(StandardField.LANGUAGE, "English");
+        Andrew_Perrin.setField(StandardField.KEYWORDS, "Religion");
+        Andrew_Perrin.setField(StandardField.PUBLISHER, "Brill");
+
+    }
+
+    @Test
+    public void TestGetName() {
+        assertEquals("DOAB", fetcher.getName());
+    }
+
+    @Test
+    public void TestPerformSearch() throws FetcherException {
+        List<BibEntry> entries;
+        entries = fetcher.performSearch("i open fire");
+        assertFalse(entries.isEmpty());
+        assertTrue(entries.contains(David_Opal));
+    }
+
+     @Test
+    public void TestPerformSearch2() throws FetcherException {
+        List<BibEntry> entries;
+        entries = fetcher.performSearch("the deliverance of open access books");
+        assertFalse(entries.isEmpty());
+        assertTrue(entries.contains(Ronald_Snijder));
+    }
+
+    @Test
+    public void TestPerformSearch3() throws FetcherException {
+        List<BibEntry> entries;
+        entries = fetcher.performSearch("Four Kingdom Motifs before and beyond the Book of Daniel");
+        assertFalse(entries.isEmpty());
+        assertTrue(entries.contains(Andrew_Perrin));
+    }
+
+}