channel_grouping 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfc61bdc6bab522983f1384b9aebb1e55a962263
+  data.tar.gz: 42b384bd369ac19d86fbd788d995523a22ee6af2
+SHA512:
+  metadata.gz: 52d7742086e84d0bddf29a8a24bb2ad4e58b9dda298ac7418de4d7479b8cc55dfbbba6efcd4b7cd858a3ed1443acab5262718666e07015710b5402364332dddb
+  data.tar.gz: 1624528705e87a59221c94864536aa332e41b431d8b31a6e82b6cb9751c4affc7ef97e52746941a4ec3a5c843bd168b9653a173c8900994c65b262f3715048f0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in channel_grouping.gemspec
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# ChannelGrouping
+
+Groups traffic into channels, similar to the groupings in Google Analytics
+
+Given a source_url and destination_url, this gem will determine the traffic's channel
+(eg Social, Direct, Organic Search, Paid Search). 
+
+The categorizations are based on Google Analytics' [default channel definitions](https://support.google.com/analytics/answer/3297892)
+
+
+## Limitations
+
+1. Display and Paid Search groupings do not take into account the Ad Distribution Network
+2. The list of Social Networks and Search Engines may differ from Google's lists.
+  - See `sources.yml` and https://support.google.com/analytics/answer/2795821
+
+## Usage
+
+```Ruby
+ChannelGrouping.identify(source_url: 'https://www.google.com?s=some-query', destination_url: 'https://your-site.com')
+#=> 'Organic Search'
+```
+
+```Ruby
+ChannelGrouping.identify(source_url: 'https://www.some-site.com', destination_url: 'https://your-site.com?utm_medium=cpc')
+#=> 'Paid Search'
+```
+
+```Ruby
+ChannelGrouping.identify(source_url: nil, destination_url: 'https://your-site.com')
+#=> 'Direct'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'channel_grouping'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install channel_grouping
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/channel_grouping/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "channel_grouping"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/channel_grouping.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'channel_grouping/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "channel_grouping"
+  spec.version       = ChannelGrouping::VERSION
+  spec.authors       = ["Ian Yamey"]
+  spec.email         = ["ian@policygenius.com"]
+
+  spec.summary       = 'Groups traffic into channels, similar to the groupings in Google Analytics'
+  spec.description   = "Given a source_url and destination_url, this gem will determine the traffic's " \
+                       "channel (eg Social, Direct, Organic Search, Paid Search). The categorization is " \
+                       "based on Google Analytics' default channel definitions (see https://support.google.com/analytics/answer/3297892)"
+  spec.homepage      = 'https://github.com/ianyamey/channel_grouping'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

data/lib/channel_grouping.rb

@@ -0,0 +1,30 @@
+require 'channel_grouping/version'
+require 'channel_grouping/source'
+require 'channel_grouping/destination'
+
+module ChannelGrouping
+  def self.identify(source_url: , destination_url:)
+    destination = Destination.new(destination_url)
+
+    medium = destination.medium
+
+    return 'Email' if medium =~ /^email$/i
+    return 'Affiliates' if medium =~ /^affiliate$/i
+    return 'Referral' if medium =~ /^referral$/i
+    return 'Organic Search' if medium =~ /^organic$/i
+    return 'Paid Search' if medium =~ /^(cpc|ppc|paidsearch)$/i
+    return 'Other Advertising' if medium =~ /^(cpv|cpa|cpp)$/i
+    return 'Display' if medium =~ /^(display|cpm|banner)$/i
+    return 'Social' if medium =~ /^(social|social-network|social-media|sm|social network|social media)$/i
+
+    source = Source.new(source_url)
+
+    return 'Organic Search' if source.search_engine?
+    return 'Social' if source.social_network?
+    return 'Direct' if source.direct? && (medium == 'none' || medium.nil?)
+    return 'Direct' if source.host == destination.host
+    return 'Referral' if source.host && (medium == 'none' || medium.nil?)
+
+    'Other'
+  end
+end

data/lib/channel_grouping/destination.rb

@@ -0,0 +1,33 @@
+require 'uri'
+require 'rack/utils'
+
+module ChannelGrouping
+  class Destination
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def medium
+      m = params['utm_medium']
+      m == '' ? nil : m
+    end
+
+    def host
+      uri.host
+    end
+
+    private
+
+    def uri
+      @uri ||= URI(url.to_s)
+    rescue URI::InvalidURIError
+      URI('')
+    end
+
+    def params
+      Rack::Utils.parse_nested_query(uri.query)
+    end
+  end
+end

data/lib/channel_grouping/source.rb

@@ -0,0 +1,61 @@
+require 'uri'
+require 'cgi'
+require 'pathname'
+require 'yaml'
+
+module ChannelGrouping
+  class Source
+    CONFIG_FILENAME = 'sources.yml'
+
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def search_engine?
+      self.class.search_engines.any? do |search_engine_host|
+        host_matches?(search_engine_host)
+      end
+    end
+
+    def social_network?
+      self.class.social_networks.any? do |social_network_host|
+        host_matches?(social_network_host)
+      end
+    end
+
+    def direct?
+      uri.host.nil?
+    end
+
+    def host
+      uri.host
+    end
+
+    def self.social_networks
+      @social_networks ||= config['social_networks']
+    end
+
+    def self.search_engines
+      @search_engines ||= config['search_engines']
+    end
+
+    def self.config
+      root = Pathname.new(File.expand_path("../../..", __FILE__))
+      YAML.load_file(root.join(CONFIG_FILENAME))
+    end
+
+    private
+
+    def host_matches?(other_host)
+      host =~ Regexp.new(other_host)
+    end
+
+    def uri
+      @uri ||= URI(url.to_s)
+    rescue URI::InvalidURIError
+      URI('')
+    end
+  end
+end

data/lib/channel_grouping/version.rb

@@ -0,0 +1,3 @@
+module ChannelGrouping
+  VERSION = "0.5.1"
+end

data/sources.yml

@@ -0,0 +1,81 @@
+social_networks:
+  - 'facebook\.com'
+  - 'reddit\.com'
+  - 't\.co'
+  - 'twitter\.com'
+  - 'wordpres\.com'
+  - 'disqus\.com'
+  - 'linkedin\.com'
+  - 'lnkd\.in'
+  - 'blogspot'
+  - 'stumbleupon\.com'
+  - 'tumblr\.com'
+  - 'getpocket\.com'
+  - 'glassdoor\.com'
+  - 'meetup\.com'
+  - 'pinterest\.com'
+  - 'plus\.url\.google\.com'
+  - 'youtube\.com'
+  - 'yammer\.com'
+  - 'plus\.google\.com'
+  - 'touch\.www'
+  - 'diigo\.com'
+  - 'news\.ycombinator\.com'
+  - 'paper\.li'
+  - 'digg\.com'
+  - 'bigtent\.com'
+  - 'blogger\.com'
+  - 'googleplus'
+  - 'groups\.google\.com'
+  - 'hootsuite\.com'
+  - 'instagram\.com'
+  - 'instapaper\.com'
+  - 'netvibes\.com'
+  - 'ow\.ly'
+  - 'pinboard\.in'
+  - 'quora\.com'
+  - 'scoop\.it'
+  - 'slashdot\.org'
+  - 'tinyurl\.com'
+  - 'twitter'
+  - 'uk\.pinterest\.com'
+  - 'wikihow\.com'
+search_engines:
+  - 'daum\.net'
+  - 'eniro\.se'
+  - 'naver\.com'
+  - 'google\.'
+  - 'yahoo\.com'
+  - 'msn\.com'
+  - 'bing\.'
+  - 'aol\.com'
+  - 'lycos\.com'
+  - 'ask\.com'
+  - 'altavista\.com'
+  - 'search\.netscape\.com'
+  - 'about\.com'
+  - 'mamma\.com'
+  - 'alltheweb\.com'
+  - 'voila\.fr'
+  - 'search\.virgilio\.it'
+  - 'baidu\.com'
+  - 'alice\.com'
+  - 'yandex\.com'
+  - 'najdi\.org\.mk'
+  - 'aol\.com'
+  - 'mamma\.com'
+  - 'seznam\.cz'
+  - 'search\.com'
+  - 'wp\.pl'
+  - 'online\.onetcenter\.org'
+  - 'szukacz\.pl'
+  - 'yam\.com'
+  - 'pchome\.com'
+  - 'kvasir\.no'
+  - 'sesam\.no'
+  - 'ozu\.es'
+  - 'terra\.com'
+  - 'mynet\.com'
+  - 'ekolay\.net'
+  - 'rambler\.ru'
+

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: channel_grouping
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Ian Yamey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Given a source_url and destination_url, this gem will determine the traffic's
+  channel (eg Social, Direct, Organic Search, Paid Search). The categorization is
+  based on Google Analytics' default channel definitions (see https://support.google.com/analytics/answer/3297892)
+email:
+- ian@policygenius.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- channel_grouping.gemspec
+- lib/channel_grouping.rb
+- lib/channel_grouping/destination.rb
+- lib/channel_grouping/source.rb
+- lib/channel_grouping/version.rb
+- sources.yml
+homepage: https://github.com/ianyamey/channel_grouping
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Groups traffic into channels, similar to the groupings in Google Analytics
+test_files: []