npm package: @flat/inbound
Description: Url referrer and campaign parsing utilities
Author: Vincent Giersch
Latest version: 1.0.0

# inbound
---------------

inbound is a referrer parsing library for node.js / express web apps.

## How To Use

### Install
```
npm install @flat/inbound
```

### API
```javascript
var inbound = require('@flat/inbound');
inbound.referrer.parse(url, referrer, function (err, description) {
    console.log(description);
});
```

**url** (string) is the page url, equivalent to client-side javascript's ```window.location.href``` or express.js ```req.url```

**referrer** (string) is the referrer, equivalent to client-side javascript's ```document.referrer``` or express.js ```req.header('referrer')```

### Express.js Middleware
```javascript
var inbound = require('@flat/inbound'),
    express = require('express');

var app = express();

app.use(function (req, res, next) {
  var referrer = req.header('referrer');
  var href = req.url;
  inbound.referrer.parse(href, referrer, function (err, desc) {
    req.referrer = desc;
    next(err);
  });
});

app.use(app.router);

app.get('/', function (req, res, next) {
  return res.send(req.referrer);
});

var port = 8000;
app.listen(port);
console.log('Server listening on port : ' + port);
```

## Examples

Here is an  example of a visitor clicking a twitter link and ending up at a New Yorker article.

```javascript
var url = "http://www.newyorker.com/online/blogs/johncassidy/2012/08/economy-points-to-dead-heat-in-november.html?
mbid=gnep&google_editors_picks=true";
var referrer = "http://twitter.com/ryah";

inbound.referrer.parse(url, referrer, function (err, description) {
    console.log(description);
});
```
```json
{
  "referrer": {
    "type": "social",
    "network": "twitter"
  }
}
```

Here's an example of a visitor clicking a campaign email from gmail, and arriving at a blog:

```javascript
var url = "http://blog.intercom.io/churn-retention-and-reengaging-customers/?utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+contrast%2Fblog+%28The+Intercom+Blog%29";
var referrer =  "https://mail.google.com/_/mail-static/_/js/main/m_i,t/rt=h/ver=am293eyFlXI.en./sv=1/am=!v8Czf-oeNMn1FOzaNKsLQrJy-oNN3RSSYMAZTBUxCzwgQcXtLnTEHCkGr437GpFE2Dliuw/d=1";

inbound.referrer.parse(url, referrer, function (err, description) {
    console.log(description);
});
```
```json
{
  "referrer": {
     "type": "email",
     "client": "gmail",
     "from": "https://mail.google.com/_/mail-static/_/js/main/m_i,t/rt=h/ver=am293eyFlXI.en./sv=1/am=!v8Czf-oeNMn1FOzaNKsLQrJy-oNN3RSSYMAZTBUxCzwgQcXtLnTEHCkGr437GpFE2Dliuw/d=1",
     "link": "http://blog.intercom.io/churn-retention-and-reengaging-customers/?utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+contrast%2Fblog+%28The+Intercom+Blog%29"
  },
  "campaign": {
    "source": "feedburner",
    "medium": "feed",
    "campaign": "Feed: contrast/blog (The Intercom Blog)"
  }
}
```

## Supported Matchers

### Social
* [Facebook](https://github.com/segmentio/inbound/tree/master/lib/matchers/social/facebook.js)
* [Twitter](https://github.com/segmentio/inbound/tree/master/lib/matchers/social/twitter.js)
* [Google+](https://github.com/segmentio/inbound/tree/master/lib/matchers/social/googlePlus.js)
* [Pinterest](https://github.com/segmentio/inbound/tree/master/lib/matchers/social/pinterest.js)
* [LinkedIn](https://github.com/segmentio/inbound/tree/master/lib/matchers/social/linkedin.js)
* [Vkontakte](https://github.com/segmentio/inbound/tree/master/lib/matchers/social/vkontakte.js)
* [LiveJournal](https://github.com/segmentio/inbound/tree/master/lib/matchers/social/livejounal.js)
* [Odnoklassniki](https://github.com/segmentio/inbound/tree/master/lib/matchers/social/odnoklassniki.js)
* [MyWorld](https://github.com/segmentio/inbound/tree/master/lib/matchers/social/myworld.js)

### Search
* [Google](https://github.com/segmentio/inbound/tree/master/lib/matchers/search/google.js)
* [Bing](https://github.com/segmentio/inbound/tree/master/lib/matchers/search/bing.js)
* [Yahoo](https://github.com/segmentio/inbound/tree/master/lib/matchers/search/yahoo.js)
* [Baidu](https://github.com/segmentio/inbound/tree/master/lib/matchers/search/baidu.js)
* [Yandex](https://github.com/segmentio/inbound/tree/master/lib/matchers/search/yandex.js)
* [Mail.ru](https://github.com/segmentio/inbound/tree/master/lib/matchers/search/mailru.js)
* [Naver](https://github.com/segmentio/inbound/tree/master/lib/matchers/search/naver.js)
* [Daum](https://github.com/segmentio/inbound/tree/master/lib/matchers/search/daum.js)
* [Nate](https://github.com/segmentio/inbound/tree/master/lib/matchers/search/nate.js)

### Email Clients
* [Gmail](https://github.com/segmentio/inbound/tree/master/lib/matchers/email/gmail.js)
* [Yahoo](https://github.com/segmentio/inbound/tree/master/lib/matchers/email/yahoo.js)
* [Hotmail](https://github.com/segmentio/inbound/tree/master/lib/matchers/email/hotmail.js)
* [Naver](https://github.com/segmentio/inbound/tree/master/lib/matchers/email/naver.js)
* [Daum](https://github.com/segmentio/inbound/tree/master/lib/matchers/email/daum.js)
* [Yandex](https://github.com/segmentio/inbound/tree/master/lib/matchers/email/yandex.js)
* [Mail.ru](https://github.com/segmentio/inbound/tree/master/lib/matchers/email/mailru.js)

### Ads
* [Bing](https://github.com/segmentio/inbound/tree/master/lib/matchers/ad/bing.js)
* [Google](https://github.com/segmentio/inbound/tree/master/lib/matchers/ad/google.js)
* [Yahoo](https://github.com/segmentio/inbound/tree/master/lib/matchers/ad/yahoo.js)
* [Yandex](https://github.com/segmentio/inbound/tree/master/lib/matchers/ad/yandex.js)

### Internal
Internal referrers occur when a visitor navigates between two pages of the same domain. Example: http://site.com => http://site.com/about

* [Internal](https://github.com/segmentio/inbound/tree/master/lib/matchers/internal/internal.js)

### Link
If there is a referrer present but it's unrecognized above, we'll just call it a link referrer.

* [Link](https://github.com/segmentio/inbound/tree/master/lib/matchers/link/link.js)

### Direct
When a visitor navigates to a site by typing in the url into the address bar, ```document.referrer``` is blank. This is called a direct referral. (There are some [other reasons](#why-is-my-documentreferrer-blank) this can happen as well.)

* [Direct](https://github.com/segmentio/inbound/tree/master/lib/matchers/direct/direct.js)

## Utilities

### Shorten API

If you want to count the number of people who came from a specific referrer, you might want to make the following map:

```referrer => { set_of_visitors }```

However, referrers and urls tend to have differences that don't really matter to you, but are slightly different.

Use the `inbound.shorten` API to make the referrers and domains unique.

```javascript
inbound.shorten.url('https://segment.io/?imm_mid=094f89&cmp=em-npa-ug-nl-sep15-html')
// "segment.io"

inbound.shorten.url('http://ianstormtaylor.com/oocss-plus-sass-is-the-best-way-to-css/?utm_source=hackernewsletter&utm_medium=email')
// "ianstormtaylor.com/oocss-plus-sass-is-the-best-way-to-css
```

## Contribute

### Contributors
+ [@ivolo](https://github.com/ivolo)
+ [@asolove](https://github.com/asolove)
+ [@xissy](https://github.com/xissy)
+ [@rybnik](https://github.com/rybnik)

### Matchers
Matchers help identify and attach more semantic information to referral sources. We'd your help on adding the hundreds of social, search, ad, and other referral sources not matched yet by inbound.

To add matchers:

1. Using existing matchers as an example, create your matcher at [/lib/matchers/](https://github.com/segmentio/inbound/tree/master/lib/matchers/).
1. Add your matcher to the priority list of matchers in [index.js](https://github.com/segmentio/inbound/tree/master/lib/matchers/index.js).
1. Add your test cases to [the test cases file](https://github.com/segmentio/inbound/tree/master/test/cases/referrers.json).
1. Run and confirm that your test cases pass: ```npm test```
1. Add your matcher to the [readme](https://github.com/segmentio/inbound/tree/master/README.md).
1. Submit your pull request!

## Advanced

### Why is my document.referrer blank?
1. The visitor came directly to your site by typing the link into the browser's bar.
2. The visitor clicked a link on an https:// page and arrived at a http:// page, such as clicking a link to http://hypem.com on a https://gmail.com email. (Chrome will strip the referrer since you're downgrading security).
3. You were 301 redirected via a proxy that didn't maintain the referrer header.

### Why is the matchers API asynchronous?

Even though most matchers do synchronous string matching, leaving the API asynchronous allows matchers that fill in more semantic information about the referrer by hitting some sort of API.

## License


```
WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|
```