o2r-project / o2r-extender

Allows the integration of badges into several research websites and data repositories.

Spreading scholarly badges using a Chrome Web Extension

The o2r-extender is part of the o2r project which aims to make reproduction of research results possbile:

The o2r-extender consists of a Chrome Web Extension that allows for integration of badges on several research websites. Additionally, it integrates buttons for the o2r project into data repositories and collaboration platforms.

Based on the study project "Badges for computational geoscience containers" available at geocontainer-badges/reproducability.

Installation

In order to use this API, make sure that you have installed Chrome and enabled extensions in the settings.

Web store installation

To install the extension directly from the Chrome Web Store open the following link and click the "Add to Chrome" button:

https://chrome.google.com/webstore/detail/open-reproducible-researc/fhhfncpkfohlhphlcgpkbpialfhkmbil

Development installation

1. Clone this repository: git clone https://github.com/o2r-project/o2r-extender/

2. Add the o2r Badge Integrator extension:

   • Open chrome://extensions/ in Chrome,
   • make sure that "Developer mode" in the top-right corner is enabled,
   • click "Load unpacked extension..."
   • and select the o2r Badge Integrator directory of this repository.

3. Start the o2r-badger to generate badges. Installation instructions

4. Right click the new "o2r" extension icon and select options. Change the Badge endpoint setting to the local badger address, e.g. http://localhost:8089/api/1.0/badge/

5. When visiting one of the supported websites make sure to allow mixed content in Chrome:

   • select "Load unsafe scripts" by clicking the shield icon in the address bar (detailed explanation)

Usage

Upon successful installation, you will notice the applications' icon in the top-right corner next to the URL line. Navigate to your chosen website, search for the name of the research you are interested in, and everything will happen automatically. Filter and badges are loaded and nicely integrated into the service's search results.

Supported research services

• PLOS: Partially supported, no filter (reason: technical problems with the PLOS JS framework)
• ScienceDirect: Fully supported
• Google Scholar: Partially supported, no big badges (reason: no detail page)
• MS Academic Search: Fully supported
• Mendeley: Fully supported
• DOAJ: Fully supported

Supported data repositories

• Zenodo

Supported collaboration platforms

• Sciebo

Development

To release a new version to the Chrome Web Store, we use the Web Store Upload CLI.

npm install -g chrome-webstore-upload-cli

Release process

• add a tag matching the version from manifest.json prepended with v, e.g. v0.1.0

git tag v0.1.0

• go to directory extension and put keys and IDs into environment variables:

cd extension
EXTENSION_ID=fhhfncpkfohlhphlcgpkbpialfhkmbil
CLIENT_ID=<secret>
CLIENT_SECRET=<secret>
REFRESH_TOKEN=<secret>

• upload directory bash``` webstore upload --extension-id $EXTENSION_ID --client-id $CLIENT_ID --client-secret $CLIENT_SECRET --refresh-token $REFRESH_TOKEN

- publish extension
```bash
webstore publish --extension-id $EXTENSION_ID --client-id $CLIENT_ID --client-secret $CLIENT_SECRET --refresh-token $REFRESH_TOKEN

• push the tag to GitHub

git push upstream v0.1.0

List of contributors

• Antonia van Eek
• Clara Rendel
• Lasse Einfeldt
• Laura Meierkort
• Marlena Götza
• Salman Khalid
• Shahzeib Tariq Jaswal
• Nimrod Gavish
• Matthias Mohr
• Daniel Nüst
• Lukas Lohoff

How to cite

If you reference this project in scholarly communication, please use the citations provided on EarthArxiv: https://doi.org/10.31223/osf.io/xtsqh

Nüst, Daniel, Lukas Lohoff, Lasse Einfeldt, Nimrod Gavish, Marlena Götza, Shahzeib T. Jaswal, Salman Khalid, et al. 2019. “Guerrilla Badges for Reproducible Geospatial Data Science (AGILE 2019 Short Paper).” EarthArXiv. June 19. doi:10.31223/osf.io/xtsqh.

Code archive:

License

This project is licensed under Apache License 2.0.

o2r-extender's Issues

Add support for oaDOI's API about open access publications

https://oadoi.org/api

Example: https://api.oadoi.org/10.1038/nature12373

returns

{

    "results": [
        {
            "_best_open_url": "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC4221854",
            "_closed_base_ids": [ ],
            "_closed_urls": [ ],
            "_green_base_collections": [ ],
            "_open_base_ids": [ ],
            "_open_urls": [
                "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC4221854",
                "https://dash.harvard.edu/bitstream/handle/1/12285462/Nanometer-Scale%20Thermometry.pdf?sequence=1"
            ],
            "doi": "10.1038/nature12373",
            "doi_resolver": "crossref",
            "evidence": "oa repository (via pmcid lookup)",
            "found_green": true,
            "found_hybrid": false,
            "free_fulltext_url": "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC4221854",
            "is_boai_license": false,
            "is_free_to_read": true,
            "is_subscription_journal": true,
            "license": null,
            "oa_color": "green",
            "oa_color_long": "green_only",
            "reported_noncompliant_copies": [ ],
            "url": "http://doi.org/10.1038/nature12373",
            "version": null,
            "year": 2013
        }
    ]

}

We could use the lookup to provide direct full-text access, see ourresearch/oadoi#1 (comment)

Extend README

• mention license
• add intro paragraph mentioning o2r project
• add manual contributors list

Sciebo button cannot fetch share_url anymore

The request to sciebo fails:

Request: https://uni-muenster.sciebo.de/ocs/v2.php/apps/files_sharing/api/v1/shares?format=json&path=%2F%2F%26fileid%3D18054590%2Ftest_zip&reshares=true

Response:

{
   "ocs":{
      "meta":{
         "status":"failure",
         "statuscode":404,
         "message":"Wrong path, file\/folder doesn't exist"
      },
      "data":[

      ]
   }
}

The path parameter (%2F%2F%26fileid%3D18054590%2Ftest_zip) is not generated correctly

Update installation instructions

https://github.com/o2r-project/o2r-extender#installation still has the wrong URL.

Also, we should add instructions on how to install from the chrome web store (see #1).

Implement as WebExtension for Firefox

Firefox should support WebExtensions, see if we can get extender to work in Firefox

• https://developer.mozilla.org/en-US/Add-ons/Overlay_Extensions/Firefox_addons_developer_guide
• https://developer.mozilla.org/en-US/Add-ons/WebExtensions

Badges not displayed properly [Windows]

• background is limited to a width of ~70 px

The shields.io badges are working fine one by one:

New release on chrome web store

https://chrome.google.com/webstore/detail/o2r-badge-integrator/fhhfncpkfohlhphlcgpkbpialfhkmbil

• add screenshots (1280x800 or 640x400)
• change name to "Open Reproducible Research Extender"
• rename local folder to not use capitals in "o2r", see https://stackoverflow.com/questions/11183788/in-a-git-repository-how-to-properly-rename-a-directory

Badges not working after site updates

Many of the research websites were changed which lead to different HTML classes and ids.
Sites not yet working again:

• Mendeley
• ScienceDirect

Add left-click action to extension button

When a user left-clicks on the icon in Chrome, nothing happens.

Why not open the menu, just as with a right click?
Or show the number of retrieved badges for the current page?

Other ideas what could be shown welcome.

Moved from o2r-project/o2r-badger#3.

Add "powered by o2r" overlay somehow

The user might install our chrome extension and then forget about it, and suddenly see the badges and buttons and now know where they come from. Maybe we can add a small "powered by o2r" image overlay in the bottom right corner, that shows the extension's help page when clicked, and disappears after 10 seconds. The notification overlay can be deactivated completely in the extension settings for users who are annoyed by it.

Alternative phrases: "augmented by o2r", "extended by o2r", ...