Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sidneys/shorten-anonymize-url

Shorten and anonymize (derefer) URLs at the same time. Supports Commandline and programmatic usage. Enables right-click URL shortening on macOS via Automator.
https://github.com/sidneys/shorten-anonymize-url

Last synced: 19 minutes ago
JSON representation

Shorten and anonymize (derefer) URLs at the same time. Supports Commandline and programmatic usage. Enables right-click URL shortening on macOS via Automator.

Awesome Lists containing this project

README 

        
# shorten-anonymize-url [![Beta](https://img.shields.io/badge/status-beta-red.svg?style=flat)]() [![npm](https://img.shields.io/npm/v/shorten-anonymize-url.svg?style=flat-square)](https://npmjs.com/package/shorten-anonymize-url) [![dependencies](https://img.shields.io/david/sidneys/shorten-anonymize-url.svg?style=flat-square)](https://npmjs.com/package/shorten-anonymize-url) [![devDependencies](https://img.shields.io/david/dev/sidneys/shorten-anonymize-url.svg?style=flat-square)](https://npmjs.com/package/desktop-dimmer)



------





  Shorten and anonymize (derefer) URLs at the same time.


   Supports Commandline and programmatic usage.


  Uses goo.gl, bit.ly and dereferer.me under the hood.



  Enables right-click URL shortening on macOS.


  Includes the required Automator Service and installation toolset.



  Available for macOS, Windows and Linux.




------



## Contents



1. [Commandline Usage](#commandline_usage)

1. ['Right-Click' URL Shortener (macOS)](#right-click_url_shortener_(macos))

1. [Programmatic Usage](#programmatic_usage)

1. [Platform Support](#platform_support)

1. [Roadmap](#roadmap)

1. [Contribute](#contribute)

1. [Author](#author)



##  Commandline Usage



### Installation



```bash

$ npm install --global shorten-anonymize-url

```



### Usage



```bash

$ shorten-anonymize-url ""

```



⚠️ Enclose URLs in quotes to handle special characters like as question marks ⚠️



### Show Help and Options



```bash

$ shorten-anonymize-url --help

```



### Example



```bash

$ shorten-anonymize-url "https://www.google.de/?gfe_rd=cr&ei=WDE4We-3BcfPXr7dpdgH&gws_rd=ssl"

>> http://bit.ly/2sglJKg

```



##  Right-Click URL Shortener (macOS only)



![screenshot-macos](./resources/screenshots/screenshot-macos-1.png)



The module includes a global [Service](https://www.macosxautomation.com/services/) for macOS [Automator](https://en.wikipedia.org/wiki/List_of_macOS_components#Automator), as well as an automated installation and uninstallation routine.



### Features



The global shortener service does the following:



 1. It takes any marked url within macOS,

 1. shortens and anonymizes it,

 1. copies the resulting shortened and anonymized URL to the macOS clipboard.



This enables global url shortening and anonymizing.



### Compatibility



The global nature of macOS Services makes this module available to nearly all macOS apps, such as [Safari](https://www.apple.com/safari/), [Finder](https://en.wikipedia.org/wiki/Finder_(software)), [Google Chrome](https://www.google.de/chrome/browser/desktop/) or [Microsoft Office for Mac](https://products.office.com/en-us/mac/microsoft-office-for-mac).



### Requirements for the macOS Service



Install [the commandline module](#commandline-use).



### Install the macOS Service



Run the commandline module with the **--service-install** argument:



```bash

$ shorten-anonymize-url --service-install

```



### Uninstall the macOS Service



Run the commandline module with the **--service-uninstall** argument:



```bash

$ shorten-anonymize-url --service-uninstall

```



### Use the macOS Service



1. Mark any URL (or any text),

1. right-click,

1. open the 'Services' menu,

1. Click 'shorten-anonymize-url'



The clipboard now contains the shortened and anonymized URL.



##  Programmatic Usage



### Installation



```bash

$ npm install --save shorten-anonymize-url

```



### API



The module returns a `Function` which takes 3 arguments and returns a `Promise`:



```js

const shortenAnonymizeUrl = require('shorten-anonymize-url')

shortenAnonymizeUrl(url, bitlyKey, googlKey)

.then((shorturl) => {

    console.log(shorturl);

})

```



 - **url** *String* - Bundle identifier for the callback function

 - **bitlyKey** [optional] *String* - bit.ly API key

 - **googlKey** [optional] *String* - goo.gl API key



The `Promise` resolves with:



 - **shorturl** *String* - **Shortened anonymised bit.ly url**



### Example



```js

const shortenAnonymizeUrl = require('shorten-anonymize-url')

shortenAnonymizeUrl('reddit.com')

.then((url) => {

    console.log(url);

    // http://bit.ly/2qWTDzM

})

.catch((err) => {

    console.error(err);

})

```



##  Platform Support



Tested on:



- macOS Sierra

- Windows 10 Anniversary

- Ubuntu 17.10



Global 'Right-Click' url shortening only supported on macOS for now.



##  Roadmap ![img](https://img.shields.io/badge/proposals-welcome-green.svg?style=flat)



- [ ] Global Right-Click URL shortening for Windows + Linux

- [ ] CI-based automated Testing



##  Contribute ![Contribute](https://img.shields.io/badge/contributions-wanted-red.svg?style=flat-square)



Read the [contribution documentation](https://github.com/sidneys/shorten-anonymize-url/blob/release/CONTRIBUTING.md) first.



- [Dev Chat](http://gitter.im/sidneys/shorten-anonymize-url): Talk about features and suggestions.

- [Issues](http;//github.com/sidneys/shorten-anonymize-url/issues) File bugs and document issues.



##  Author



[sidneys](http://sidneys.github.io) 2017