asa-swim-time-scraper v0.0.5

ASA Swim time scraper

This is a javascript website scraper for the ASA personal swim times. Pass in swimmer ASA Number and get back the personal best history from ASA.

Permissions

This is not affiliated to the ASA, or any of its partners / affiliates. It is intended to be used as an example of how to connect to a website. If you intend to use more broadly, you may require permission.

Status

Getting Started

Include the library in your project. Pass the ASA Number. The single function will return the times.

Prerequisites

What things you need to install the software and how to install them

None

Installing

Install the library using npm...

npm install --save asa-swim-time-scraper

...or, take the library directly from githb

git clone https://github.com/paulcull/asa-swim-time-scraper

This library uses promises. The function when called returns a promise, allowing you to get on with anything else that you need to. There are no runtime 3rd party dependencies in this library.

var getTime = require('asa-swim-time-scraper');

getTimes("99999999").then(function(times){
    console.log(times);
})

• Also check the tests and example

Running the tests

There are a limited number of tests. Several negative tests and a couple of checks on times to convert

npm test

Deployment

Not designed to run stand-alone - this should be used as a libray.

Built With

• NPM - Dependency Management
• MOCHA - Test management
• CHAI - BDD / TDD assertion (including with PROMISES)

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

TODO

These are things that should be done to complete.

• Reduce / remove external dependancies
• Add project documentation
• Add simple example
• Setup travis-ci
• Add grunt to manage a min step and create a smaller footprint library
• Introduce dependency monitoring
• Publish to npm.org

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Paul Cullender - Initial work - paulcull

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• The very reusable git documents from PurpleBooth