rack-utm_cookies 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5299817043273bf58b9e47638c4b5871bc084a33
+  data.tar.gz: 3345f4714cab6c1c5acaa8cc03d18fa8417b3615
+SHA512:
+  metadata.gz: 3592c493dfccba776139e026f4d562e36cb09ac39b9d8d57cdc5898eca0ef689527acd55063200b9b6f9e868d2979d502fa4c71cd38447fbdbd053b7740444b1
+  data.tar.gz: b5d0e7b39523772fb8796343388e95d51c009d9c0a93156305713058a9522fcd30c22f99709519157b98fce79a41ddad88be00e07582b8be31d55cedd137d340

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,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Joshua Paling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Rack::UtmCookies
+
+A rack middleware that searches for [UTM tags](https://support.google.com/analytics/answer/1033867?hl=en) in the request params, and stores them in cookies for later use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-utm_cookies'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-utm_cookies
+
+
+## Usage
+
+*Use with Rails 4*
+
+Add `Rack::Utm` as a rack middleware:
+
+    # config/application.rb
+    class Application < Rails::Application
+      #...
+      # if you want cookies set for the current request passed into your rails app,
+      # you'll need to include this middleware before "ActionDispatch::Cookies"
+      config.middleware.insert_before "ActionDispatch::Cookies", Rack::UtmCookies
+      #...
+    end
+
+## Development
+
+After checking out the repo, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Credit
+
+Thanks to [silvermind/rack-utm](https://github.com/silvermind/rack-utm) - rack-utm_cookies is largely a tidy up of that project.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rack-utm_cookies.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/utm_cookies"
+
+# 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/lib/rack/utm_cookies.rb

@@ -0,0 +1,56 @@
+require "rack/utm_cookies/version"
+
+module Rack
+  class UtmCookies
+    def initialize(app, options = {})
+      @app = app
+      @domain = options[:domain] || nil
+      @ttl = options[:ttl] || 60*60*24*30  # 30 days
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+
+      # tack them on so they're available down
+      # the middleware stack for this current request
+      env['HTTP_COOKIE'] = '' unless env['HTTP_COOKIE']
+      utm_cookies_to_set(req).each do |name, value|
+        env['HTTP_COOKIE'] += "; #{name}=#{value}"
+      end
+
+      # pass the call down the middleware stack
+      status, headers, body = @app.call(env)
+
+      # make sure the proper set-cookie response headers
+      # are set so we have the cookies for future requests.
+      utm_cookies_to_set(req).each do |name, value|
+        cookie_hash = {
+          :value => value,
+          :expires => Time.now + @ttl,
+          :path => '/',
+        }
+        cookie_hash[:domain] = @domain if @domain
+        Rack::Utils.set_cookie_header!(headers, name, cookie_hash)
+      end
+
+      [status, headers, body]
+    end
+
+    private
+
+    def utm_cookies_to_set(req)
+      utm_cookies = {}
+      # these are minimum required utm params
+      if !(req.params["utm_source"] && req.params["utm_medium"] && req.params["utm_campaign"])
+        return utm_cookies
+      end
+
+      utm_cookies['utm_source'] = req.params["utm_source"]
+      utm_cookies['utm_medium'] = req.params["utm_medium"]
+      utm_cookies['utm_campaign'] = req.params["utm_campaign"]
+
+      return utm_cookies
+    end
+
+  end
+end

data/lib/rack/utm_cookies/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class UtmCookies
+    VERSION = "0.1.1"
+  end
+end

data/rack-utm_cookies.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/utm_cookies/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-utm_cookies"
+  spec.version       = Rack::UtmCookies::VERSION
+  spec.authors       = ["Joshua Paling"]
+  spec.email         = ["joshua.paling@gmail.com"]
+
+  spec.summary       = %q{A rack middleware that searches for UTM tags in the request params, and stores them in cookies for later use.}
+  spec.homepage      = "https://github.com/joshuapaling/rack-utm_cookies"
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "rack-test"
+
+  spec.add_dependency "rack"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: rack-utm_cookies
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Joshua Paling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !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'
+description: 
+email:
+- joshua.paling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/utm_cookies.rb
+- lib/rack/utm_cookies/version.rb
+- rack-utm_cookies.gemspec
+homepage: https://github.com/joshuapaling/rack-utm_cookies
+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.8
+signing_key: 
+specification_version: 4
+summary: A rack middleware that searches for UTM tags in the request params, and stores
+  them in cookies for later use.
+test_files: []