Merge branch 'master' of github.com:snowplow/referer-parser

Author: donspaulding

.gitignore

@@ -0,0 +1,12 @@
+/vendor/
+/composer.lock
+php/.idea
+ruby/.idea/.name
+ruby/.idea/.rakeTasks
+ruby/.idea/encodings.xml
+ruby/.idea/misc.xml
+ruby/.idea/modules.xml
+ruby/.idea/ruby.iml
+ruby/.idea/scopes/scope_settings.xml
+ruby/.idea/vcs.xml
+ruby/.idea/workspace.xml

README.md

@@ -4,7 +4,7 @@ Java/Scala: [![Build Status](https://travis-ci.org/snowplow/referer-parser.png)]
 
 referer-parser is a multi-language library for extracting marketing attribution data (such as search terms) from referer URLs, inspired by the [ua-parser] [ua-parser] project (an equivalent library for user agent parsing).
 
-referer-parser is a core component of [Snowplow] [snowplow], the open-source web-scale analytics platform powered by Hadoop, Hive and Redshift.
+referer-parser is a core component of [Snowplow] [snowplow], the open-source web-scale analytics platform powered by Hadoop and Redshift.
 
 _Note that we always use the original HTTP misspelling of 'referer' (and thus 'referal') in this project - never 'referrer'._
 
@@ -13,7 +13,10 @@ _Note that we always use the original HTTP misspelling of 'referer' (and thus 'r
 * Ruby: [Snowplow Analytics] [snowplow-analytics]
 * Java/Scala: [Snowplow Analytics] [snowplow-analytics]
 * Python: [Don Spaulding] [donspaulding] 
-* .NET: [Sepp Wijnands] [swijnands] at [iPerform Software] [iperform]
+* node.js (JavaScript): [Martin Katrenik] [mkatrenik]
+* .NET (C#): [Sepp Wijnands] [swijnands] at [iPerform Software] [iperform]
+* PHP: [Lars Strojny] [lstrojny]
+* Go: [Thomas Sileo] [tsileo]
 * `referers.yml`: [Snowplow Analytics] [snowplow-analytics]
 
 ## Usage: Java
@@ -58,6 +61,28 @@ for (r <- Parser.parse(refererUrl, pageUrl)) {
 }
 ```
 
+You can also provide a list of domains which should be considered internal:
+
+```scala
+val refererUrl = "http://www.subdomain1.snowplowanalytics.com"
+val pageUrl = "http://www.snowplowanalytics.com"
+val internalDomains = List(
+  "www.subdomain1.snowplowanalytics.com", "www.subdomain2.snowplowanalytics.com"
+)
+
+import com.snowplowanalytics.refererparser.scala.Parser
+
+for (r <- Parser.parse(refererUrl, pageUrl, internalDomains)) {
+  println(r.medium)         // => "internal"
+  for (s <- r.source) {
+    println(s)              // => null
+  }
+  for (t <- r.term) {
+    println(t)              // => null
+  }
+}
+```
+
 For more information, please see the Java/Scala [README] [java-scala-readme].
 
 ## Usage: Ruby
@@ -116,6 +141,35 @@ r = Referer(referer_url, curr_url)
 
 For more information, please see the Python [README] [python-readme].
 
+## Usage: node.js
+
+The node.js (JavaScript) version of this library uses a hybrid of the new and old API, and identifies search, social, webmail, internal and unknown referers:
+
+Create a new instance of a Referer object by passing in the url you want to parse:
+
+```js
+var Referer = require('referer-parser')
+
+referer_url = 'http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl=en&client=safari'
+
+var r = new Referer(referer_url)
+```
+
+The `r` variable now holds a Referer instance.
+
+Optionally, pass in the current URL as well, to handle internal referers
+
+```js
+var Referer = require('referer-parser')
+
+var referer_url = 'http://www.snowplowanalytics.com/about/team'
+var current_url = 'http://www.snowplowanalytics.com/account/profile'
+
+var r = Referer(referer_url, current_url)
+```
+
+For more information, please see the node.js [README] [nodejs-readme].
+
 ## Usage: .NET
 
 The .NET (C#) version of this library uses the updated API, and identifies search, social, webmail, internal and unknown referers:
@@ -137,6 +191,57 @@ Console.WriteLine(r.Term); // => "gateway oracle cards denise linn"
 
 For more information, please see the .NET [README] [dotnet-readme].
 
+## Usage: PHP
+
+The PHP version of this library uses the updated API, and identifies search, social, webmail, internal and unknown referers:
+
+```php
+use Snowplow\RefererParser\Parser;
+
+$parser = new Parser();
+$referer = $parser->parse(
+    'http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl=en&client=safari',
+    'http:/www.psychicbazaar.com/shop'
+);
+
+if ($referer->isKnown()) {
+    echo $referer->getMedium(); // "Search"
+    echo $referer->getSource(); // "Google"
+    echo $referer->getTerm();   // "gateway oracle cards denise linn"
+}
+```
+
+For more information, please see the PHP [README] [php-readme].
+
+## Usage: Go
+
+The Go version of this library uses the updated API:
+
+```go
+package main
+
+import (
+  "log"
+
+  "github.com/tsileo/referer-parser/go"
+)
+
+func main() {
+  referer_url := "http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl=en&client=safari"
+  r := refererparser.Parse(referer_url)
+
+  log.Printf("Known:%v", r.Known)
+  log.Printf("Referer:%v", r.Referer)
+  log.Printf("Medium:%v", r.Medium)
+  log.Printf("Search parameter:%v", r.SearchParameter)
+  log.Printf("Search term:%v", r.SearchTerm)
+  log.Printf("Host:%v", r.URI)
+}
+
+```
+
+For more information, please see the Go [README] [go-readme]
+
 ## referers.yml
 
 referer-parser identifies whether a URL is a known referer or not by checking it against the [`referers.yml`] [referers-yml] file; the intention is that this YAML file is reusable as-is by every language-specific implementation of referer-parser.
@@ -168,7 +273,7 @@ The number of referers and the domains they use is constantly growing - we need
 We welcome contributions to referer-parser:
 
 1. **New search engines and other referers** - if you notice a search engine, social network or other site missing from `referers.yml`, please fork the repo, add the missing entry and submit a pull request
-2. **Ports of referer-parser to other languages** - we welcome ports of referer-parser to new programming languages (e.g. JavaScript, PHP, Go, Haskell)
+2. **Ports of referer-parser to other languages** - we welcome ports of referer-parser to new programming languages (e.g. Lua, Go, Haskell, C)
 3. **Bug fixes, feature requests etc** - much appreciated!
 
 **Please sign the [Snowplow CLA] [cla] before making pull requests.**
@@ -183,21 +288,30 @@ You can contact the Snowplow Analytics team through any of the [channels listed
 
 `referers.yml` is based on [Piwik's] [piwik] [`SearchEngines.php`] [piwik-search-engines] and [`Socials.php`] [piwik-socials], copyright 2012 Matthieu Aubry and available under the [GNU General Public License v3] [gpl-license].
 
-The original Ruby code is copyright 2012-2013 Snowplow Analytics Ltd and is available under the [Apache License, Version 2.0] [apache-license].
+The original Ruby code is copyright 2012-2014 Snowplow Analytics Ltd and is available under the [Apache License, Version 2.0] [apache-license].
+
+The Java/Scala port is copyright 2012-2014 Snowplow Analytics Ltd and is available under the [Apache License, Version 2.0] [apache-license].
+
+The Python port is copyright 2012-2014 [Don Spaulding] [donspaulding] and is available under the [Apache License, Version 2.0] [apache-license].
+
+The node.js (JavaScript) port is copyright 2013-2014 [Martin Katrenik] [mkatrenik] and is available under the [Apache License, Version 2.0] [apache-license].
 
-The Java/Scala port is copyright 2012-2013 Snowplow Analytics Ltd and is available under the [Apache License, Version 2.0] [apache-license].
+The .NET (C#) port is copyright 2013-2014 [iPerform Software] [iperform] and is available under the [Apache License, Version 2.0] [apache-license].
 
-The Python port is copyright 2012-2013 [Don Spaulding] [donspaulding] and is available under the [Apache License, Version 2.0] [apache-license].
+The PHP port is copyright 2013-2014 [Lars Strojny] [tsileo] and is available under the [MIT License] [mit-license].
 
-The .NET port is copyright 2013 [iPerform Software] [iperform] and is available under the [Apache License, Version 2.0] [apache-license].
+The Go port is copyright 2014 [Thomas Sileo] [lstrojny] and is available under the [MIT License] [mit-license].
 
 [ua-parser]: https://github.com/tobie/ua-parser
 
 [snowplow]: https://github.com/snowplow/snowplow
 [snowplow-analytics]: http://snowplowanalytics.com
 [donspaulding]: https://github.com/donspaulding
 [swijnands]: https://github.com/swijnands
+[mkatrenik]: https://github.com/mkatrenik
 [iperform]: http://www.iperform.nl/
+[lstrojny]: https://github.com/lstrojny
+[tsileo]: https://github.com/tsileo
 
 [piwik]: http://piwik.org
 [piwik-search-engines]: https://github.com/piwik/piwik/blob/master/core/DataFiles/SearchEngines.php
@@ -206,11 +320,15 @@ The .NET port is copyright 2013 [iPerform Software] [iperform] and is available
 [ruby-readme]: https://github.com/snowplow/referer-parser/blob/master/ruby/README.md
 [java-scala-readme]: https://github.com/snowplow/referer-parser/blob/master/java-scala/README.md
 [python-readme]: https://github.com/snowplow/referer-parser/blob/master/python/README.md
+[nodejs-readme]: https://github.com/snowplow/referer-parser/blob/master/nodejs/README.md
 [dotnet-readme]: https://github.com/snowplow/referer-parser/blob/master/dotnet/README.md
-[referers-yml]: https://github.com/snowplow/referer-parser/blob/master/referers.yml
+[php-readme]: https://github.com/snowplow/referer-parser/blob/master/php/README.md
+[go-readme]: https://github.com/snowplow/referer-parser/blob/master/go/README.md
+[referers-yml]: https://github.com/snowplow/referer-parser/blob/master/resources/referers.yml
 
 [talk-to-us]: https://github.com/snowplow/snowplow/wiki/Talk-to-us
 
 [apache-license]: http://www.apache.org/licenses/LICENSE-2.0
 [gpl-license]: http://www.gnu.org/licenses/gpl-3.0.html
+[mit-license]: http://opensource.org/licenses/MIT
 [cla]: https://github.com/snowplow/snowplow/wiki/CLA

composer.json

@@ -0,0 +1,23 @@
+{
+    "name": "snowplow/referer-parser",
+    "description": "Snowplow Refer(r)er parser for PHP",
+    "require-dev": {
+        "phpunit/phpunit": "3.*",
+        "symfony/yaml": "*"
+    },
+    "suggest": {
+        "symfony/yaml": "Support for YAML configuration file"
+    },
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Lars Strojny",
+            "email": "[email protected]"
+        }
+    ],
+    "autoload": {
+        "psr-0": {
+            "Snowplow\\RefererParser": "php/src/"
+        }
+    }
+}