Code Monkey home page Code Monkey logo

browsing-history-webext's Introduction

AFEL Browsing History WebExtension

Contributors: Mathieu d'Aquin (@mdaquin), Alessandro Adamou(@anticitizen79)

The AFEL Browsing History WebExtension is one of the Browsing History Extractors developed in the AFEL Project. It is a browser add-on running in the background while you use the browser in the Web, and sends information about your browsing to the AFEL Data Platform. It will require login onto the AFEL Data Platform, either with an existing account or through registration.

This add-on has been developed as a WebExtension, the preferred format for browser extensions that will become a standard in 2017.

Requirements

This WebExtension works on any of the following browsers:

Microsoft Edge is expected to be the next to support this standard.

Installation

Currently, there is no signed/packaged version of this extension, so you have to install it as an unpackaged extension after setting your browser to accept developer-mode extensions.

  1. Download or git clone into a local directory.
  2. In Chrome, go to settings, and choose extensions on the right hand menu (View -> Show Extensions in Opera, Add-ons in Firefox)
  3. At the top of the page, click on "Developer mode" if not already enabled.
  4. Use "Load unpacked extension" to select the directory where the extension has been downloaded.

Please make sure to read and accept the Terms and Conditions before downloading and activating this browser extension.

Use

As soon as the extension is enabled, a new tab should appear in your browser showing a login page to the AFEL data platform. Please (register)[http://data.afel-project.eu/catalogue/wp-login.php?action=register] if you don't already have an account. Once logged in, the extension will have obtained all the details needed to updload data about browsing activity on the AFEL Data Platform. A small icon will have also appeared on the right hand side of the browser's address bar, showing that the extension is active. Clicking on this icon will give you a link to the AFEL User Dashboard where you can monitor your own activity from this and other AFEL extractors.

Workflow

This chrome extension represents a typical form of user-centric data extractor for the AFEL Data Platform. As such, it is worth detailing the workflow through which this interaction happens. This workflow is described in the diagram below.

AFEL Browsing History Extension workflow

where the Extractor application here is the extension and the login page is achieved through a local tab.

The API to provide dataset ID and user key in the platform is part of the Data Catalogue, through the Data Catalogue Process Plugin. The actual use data (in this case, browsing activity data), is transferred to the AFEL Data Platfrom through the Entity Centric API.

Getting your own data

In addition to showing activity through the AFEL user dashboard, the AFEL Browsing History Extension will also update three API endpoints from which data can be obtained using the users unique API key. To use them, apply for example:

curl -u [your-api-key:] http://data.afel-platform.eu/api/entity/day/today

to get activities for the current day.

You can also use:

Note that these endpoints might also include data obtained from other extractors.

Licence

The AFEL Chrome Browsing History Extension us distributed under the Apache Licence V2. Please attribute Mathieu d'Aquin from The Open University through the AFEL Project when reusing and redistributing this code.

browsing-history-webext's People

Contributors

alexdma avatar

Watchers

Mathieu d'Aquin avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.