Skip to content

Commit 0a43a99

Browse files
committed
Updated READMEs with copyrights, usage etc for @kreynolds' new Ruby version
1 parent 0362585 commit 0a43a99

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

README.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ _Note that we always use the original HTTP misspelling of 'referer' (and thus 'r
1010

1111
## Maintainers
1212

13-
* Ruby: [Snowplow Analytics] [snowplow-analytics]
14-
* Java/Scala: [Snowplow Analytics] [snowplow-analytics]
13+
* Java/Scala: [Snowplow Analytics Ltd] [snowplow-analytics]
14+
* Ruby: [Kelley Reynolds] [kreynolds] at Inside Systems, Inc
1515
* Python: [Don Spaulding] [donspaulding]
1616
* node.js (JavaScript): [Martin Katrenik] [mkatrenik]
1717
* .NET (C#): [Sepp Wijnands] [swijnands] at [iPerform Software] [iperform]
@@ -87,20 +87,21 @@ For more information, please see the Java/Scala [README] [java-scala-readme].
8787

8888
## Usage: Ruby
8989

90-
The Ruby version of this library still uses the **old** API, and identifies search referers only:
90+
The Ruby version of this library uses the updated API:
9191

9292
```ruby
9393
require 'referer-parser'
9494

95-
referer_url = 'http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl=en&client=safari'
96-
97-
r = RefererParser::Referer.new(referer_url)
95+
parser = RefererParser::Parser.new
9896

99-
puts r.known? # => true
100-
puts r.referer # => 'Google'
101-
puts r.search_parameter # => 'q'
102-
puts r.search_term # => 'gateway oracle cards denise linn'
103-
puts r.uri.host # => 'www.google.com'
97+
parser.parse('http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl=en&client=safari')
98+
# => {
99+
:known=>true,
100+
:uri=>"http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl=en&client=safari",
101+
:source=>"Google",
102+
:medium=>"search",
103+
:term=>"gateway oracle cards denise linn"
104+
}
104105
```
105106

106107
For more information, please see the Ruby [README] [ruby-readme].
@@ -288,9 +289,9 @@ You can contact the Snowplow Analytics team through any of the [channels listed
288289

289290
`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].
290291

291-
The original Ruby code is copyright 2012-2014 Snowplow Analytics Ltd and is available under the [Apache License, Version 2.0] [apache-license].
292+
The Ruby implementation is copyright 2014 Inside Systems, Inc and is available under the [Apache License, Version 2.0] [apache-license].
292293

293-
The Java/Scala port is copyright 2012-2014 Snowplow Analytics Ltd and is available under the [Apache License, Version 2.0] [apache-license].
294+
The Java/Scala port is copyright 2012-2014 [Snowplow Analytics Ltd] [snowplow-analytics] and is available under the [Apache License, Version 2.0] [apache-license].
294295

295296
The Python port is copyright 2012-2014 [Don Spaulding] [donspaulding] and is available under the [Apache License, Version 2.0] [apache-license].
296297

@@ -312,6 +313,7 @@ The Go port is copyright 2014 [Thomas Sileo] [lstrojny] and is available under t
312313
[iperform]: http://www.iperform.nl/
313314
[lstrojny]: https://github.com/lstrojny
314315
[tsileo]: https://github.com/tsileo
316+
[kreynolds]: https://github.com/kreynolds
315317

316318
[piwik]: http://piwik.org
317319
[piwik-search-engines]: https://github.com/piwik/piwik/blob/master/core/DataFiles/SearchEngines.php

ruby/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ parser.parse('http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl
8181

8282
## Copyright and license
8383

84-
The referer-parser Ruby library is copyright 2012-2013 Snowplow Analytics Ltd.
84+
The referer-parser Ruby library is copyright 2014 Inside Systems, Inc.
8585

8686
Licensed under the [Apache License, Version 2.0] [license] (the "License");
8787
you may not use this software except in compliance with the License.

0 commit comments

Comments
 (0)