Skip to content

glesperance/wavo-link-harvester-bookmarklet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 

Repository files navigation

Purpose

The purpose of this software project is to provide a basis for the development of the Wavo Link Harvester that will allow users to submit the music-video links and embedded objects contained in a webpage to the wavo servers for further processing.

This module will eventually be extended to allow users to save music-videos from across the web and save them in their wavo collections.

As a secondary purpose, the following module will be given as an assignment to wavo applicants in order to assess their programming skills as well as their ability to work in an autonomous fashion when provided with general requirements.

Requirements

Functional Requirements

Gathering Elements

Gathering Links Elements

The following URI types must be gathered :

  • youtube links

  • Vimeo links

  • soundcloud links

Gathering Embedded Objects

The following embedded objects types must be gathered :

  • youtube links

  • Vimeo links

  • soundcloud links

Gathering iframe Elements

The following iframe types must be gathered :

  • youtube links

  • Vimeo links

  • soundcloud links

Logging Content to the Console

The elements gathered must be printed console.log as they are found in the DOM.

This logging facility must be easily extensible in order to allow reporting to the wavo servers in the future.

Non-Functional Requirements

Documentation

Each of the module’s routine/functions needs to be properly documented using jsDocs. The required jsDocs elements are @param, @return, and @constructor when applicable.

Extensibility

The module must be easily extensible in order to allow for the gathering of object types other than links embedded objects., or iframes.

Each of these sub-modules must also be easily extensible in order to allow, for example, the gathering of additional types of link.

Maintainability

The module must be easily maintainable for all users. Hence, the code is supposed to loaded from a central public repository when the user activates the bookmarklet.

The using the following code snippet as the bookmarked URI should allow the fulfillment of this requirement :

javascript:(function(){
  var a = document.createElement('script');
  a.setAttribute('src', JS_MODULE_URI);document.body.appendChild(a);}
)();
Licensing

In order to avoid costly legal process, this software will have to be released under the MIT License.

Hence it should bare the following license on top of all its files :

Copyright (C) 2012 APPLICANT_NAME

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without 
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, 
and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the 
following conditions:

The above copyright notice and this permission notice shall
be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY 
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages