Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yomguithereal/special-agent
Thin wrapper around a compilation of common user agent strings that one can query easily through tags.
https://github.com/yomguithereal/special-agent
Last synced: 5 days ago
JSON representation
Thin wrapper around a compilation of common user agent strings that one can query easily through tags.
- Host: GitHub
- URL: https://github.com/yomguithereal/special-agent
- Owner: Yomguithereal
- License: mit
- Created: 2014-11-13T14:58:25.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-02-26T16:05:18.000Z (over 9 years ago)
- Last Synced: 2024-11-07T19:05:05.757Z (5 days ago)
- Language: JavaScript
- Homepage:
- Size: 207 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/Yomguithereal/special-agent)
# special-agent
Thin wrapper around a compilation of common user agent strings that one can query easily through tags.
This is particulary useful when you need to spoof your user agent when scraping/crawling...
## Installation
You can install `special-agent` with npm:
```bash
npm install special-agent
```
## Usage
`special-agent` lets you query its data through tags which are the same that the one produced by the [ua-parser-js](https://www.npmjs.com/package/ua-parser-js) lib (lowercased and trimmed) plus the following ones:
```
legacy modern desktop bot downloader feed-reader search library
```
This is how you can use the library in node:
```js
var specialAgent = require('special-agent');
// Whole data
specialAgent.agents;
// Available tags
specialAgent.tags;
```
**#***.find*
```js
specialAgent.find(tag, [nb]);
specialAgent.find(tags, [nb]);
// Example - get 5 user agents for 'windows'
var uastrings = specialAgent.find('windows', 5);
// Example - get every user agents for 'windows' and 'chrome'
var uastrings = specialAgent.find(['windows', 'chrome']);
```
**#***.findOne*
```js
specialAgent.findOne(tag);
specialAgent.findOne(tagS);
```
**#***.findRandom*
```js
specialAgent.findRandom(tag, [nb]);
specialAgent.findRandom(tags, [nb]);
```
**#***.findOneRandom*
```js
specialAgent.findOneRandom(tag);
specialAgent.findOneRandom(tagS);
```
## Contribution
Contributions are more than welcome. Feel free to submit any pull request as long as you added unit tests if relevant and passed them all.
To install the development environment, clone your fork and use the following commands:
```bash
# Install dependencies
npm install
# Testing
npm test
# Building
npm run build
```
## License
MIT for the code and the following for the [data](http://techpatterns.com/forums/about304.html):
License: BSD 2 Clause
Copyright (c) 2015, Harald Hope
All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.