snowplow_ruby_duid 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6749b8244b13eba46c57d783d71a7f5f845a2b75
-  data.tar.gz: bfe6033bc841788b45a8dd6c1935e206bbe4b814
+  metadata.gz: c2818143e193e501a987cbaca0dfcb084010d012
+  data.tar.gz: 4b6295b77691331a88608578c46a95e749a6e241
 SHA512:
-  metadata.gz: 9c65749df84ffdacc6ea48cdb51bbdb232a8c832c48ccdccb27f03e75e11798c66169265809571f35a980bc21b9bf82ed012bbb23a7c635fd9246a12be972a79
-  data.tar.gz: df781d3bc9c58c451c881198ff35d84479adb242f03336ac9ee9e1d3d8e5b2946a90989b3664e30a146bf09fa3cf055e3562f67dbf55d6d7c6a6071c968aab85
+  metadata.gz: 63df7f00beb0850f36f54505a5f239339432c8306e9e9a424402da2a0727cb4567c4867d77a6766a75160f8c12b082d3f0c906a5b2e7fa922a0f0fdf9836da97
+  data.tar.gz: 0a791495bf59396b38481f9efb025ede2907ca12413a6c1b2f21e026b4cf277d57e3a558a0248bebaeca2b1ebdb7157f77fbaef5496d93a8fa5e35e5b0385274

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/lib/snowplow_ruby_duid/cookie_spec.rb'

data/lib/snowplow_ruby_duid.rb

@@ -4,7 +4,7 @@ require 'snowplow_ruby_duid/domain_userid'
 require 'snowplow_ruby_duid/helper'
 
 module SnowplowRubyDuid
-  KEY_PREFIX = '_sp_id'
+  KEY_PREFIX = '_sp_id'.freeze
 end
 
 ActionController::Base.send :include, SnowplowRubyDuid::Helper if defined?(ActionController)

data/lib/snowplow_ruby_duid/cookie.rb

@@ -2,15 +2,14 @@ module SnowplowRubyDuid
   # Responsible for generating a cookie that emulates the Snowplow cookie as closely as possible
   # Leverages the method used by ActionDispatch::Cookies::CookieJar to determine the top-level domain
   class Cookie
-
     # See: https://github.com/snowplow/snowplow-javascript-tracker/blob/d3d10067127eb5c95d0054c8ae60f3bdccba619d/src/js/tracker.js#L142
-    COOKIE_PATH            = '/'
+    COOKIE_PATH            = '/'.freeze
     # See: https://github.com/snowplow/snowplow-javascript-tracker/blob/d3d10067127eb5c95d0054c8ae60f3bdccba619d/src/js/tracker.js#L156
     COOKIE_DURATION_MONTHS = 24
     # See: https://github.com/rails/rails/blob/b1124a2ac88778c0feb0157ac09367cbd204bf01/actionpack/lib/action_dispatch/middleware/cookies.rb#L214
     DOMAIN_REGEXP          = /[^.]*\.([^.]*|..\...|...\...)$/
 
-    def initialize host, domain_userid, request_created_at
+    def initialize(host, domain_userid, request_created_at)
       @host               = host
       @domain_userid      = domain_userid
       @request_created_at = request_created_at
@@ -20,7 +19,7 @@ module SnowplowRubyDuid
     # See: https://github.com/snowplow/snowplow-javascript-tracker/blob/d3d10067127eb5c95d0054c8ae60f3bdccba619d/src/js/tracker.js#L372-L374
     def key
       domain = top_level_domain || @host
-      KEY_PREFIX + '.' + (Digest::SHA1.hexdigest (domain + COOKIE_PATH))[0..3]
+      KEY_PREFIX + '.' + Digest::SHA1.hexdigest(domain + COOKIE_PATH)[0..3]
     end
 
     def value
@@ -29,7 +28,7 @@ module SnowplowRubyDuid
         value:   cookie_value,
         expires: cookie_expiration,
         domain:  cookie_domain,
-        path:    COOKIE_PATH,
+        path:    COOKIE_PATH
       }
     end
 
@@ -37,17 +36,15 @@ module SnowplowRubyDuid
 
     # See: https://github.com/rails/rails/blob/b1124a2ac88778c0feb0157ac09367cbd204bf01/actionpack/lib/action_dispatch/middleware/cookies.rb#L286-L294
     def top_level_domain
-      if (@host !~ /^[\d.]+$/) && (@host =~ DOMAIN_REGEXP)
-        $&
-      end
+      $& if (@host !~ /^[\d.]+$/) && (@host =~ DOMAIN_REGEXP)
     end
 
     # See: https://github.com/snowplow/snowplow-javascript-tracker/blob/d3d10067127eb5c95d0054c8ae60f3bdccba619d/src/js/tracker.js#L476-L487
     def cookie_value
-      visitCount  = '0'
-      lastVisitTs = ''
-      createTs = nowTs = @request_created_at.to_i.to_s
-      [@domain_userid, createTs, visitCount, nowTs, lastVisitTs].join '.'
+      visit_count = '0'
+      last_visit_ts = ''
+      create_ts = now_ts = @request_created_at.to_i.to_s
+      [@domain_userid, create_ts, visit_count, now_ts, last_visit_ts].join '.'
     end
 
     def cookie_expiration

data/lib/snowplow_ruby_duid/domain_userid.rb

@@ -3,7 +3,6 @@ module SnowplowRubyDuid
   # Deviates from this Snowplow Javascript: https://github.com/snowplow/snowplow-javascript-tracker/blob/d3d10067127eb5c95d0054c8ae60f3bdccba619d/src/js/tracker.js#L468-L472
   #   in order to provide a more unique identifier
   class DomainUserid
-
     LENGTH_OF_DUID_IN_BYTES = 8
 
     def initialize

data/lib/snowplow_ruby_duid/helper.rb

@@ -3,7 +3,6 @@ module SnowplowRubyDuid
   # that will find or create a domain_userid, which will be
   # saved in the response's cookie if it does not exist
   module Helper
-
     def snowplow_domain_userid
       @snowplow_domain_userid ||= find_or_create_snowplow_domain_userid
     end
@@ -32,7 +31,7 @@ module SnowplowRubyDuid
     private :find_snowplow_domain_userid
 
     def find_snowplow_cookie
-      request.cookies.find { |(key, value)| key =~ /^#{KEY_PREFIX}/ } # result will be an array containing: [key, value]
+      request.cookies.find { |(key, _value)| key =~ /^#{KEY_PREFIX}/ } # result will be an array containing: [key, value]
     end
     private :find_snowplow_cookie
   end

data/lib/snowplow_ruby_duid/version.rb

@@ -1,3 +1,3 @@
 module SnowplowRubyDuid
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'.freeze
 end

data/snowplow_ruby_duid.gemspec

@@ -8,19 +8,20 @@ Gem::Specification.new do |spec|
   spec.version       = SnowplowRubyDuid::VERSION
   spec.authors       = ['Simply Business']
   spec.email         = ['tech@simplybusiness.co.uk']
-  spec.description   = %q{A gem that exposes the Snowplow domain userid in Rack applications. Also allows you to set your own domain userid that will be shared with the Snowplow Javascript tracker.}
-  spec.summary       = %q{A gem that exposes the Snowplow domain userid in Rack applications. Also allows you to set your own domain userid that will be shared with the Snowplow Javascript tracker.}
+  spec.description   = 'A gem that exposes the Snowplow domain userid in Rack applications. Also allows you to set your own domain userid that will be shared with the Snowplow Javascript tracker.'
+  spec.summary       = 'A gem that exposes the Snowplow domain userid in Rack applications. Also allows you to set your own domain userid that will be shared with the Snowplow Javascript tracker.'
   spec.homepage      = 'https://github.com/simplybusiness/snowplow_ruby_duid'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'rack'
-  spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rutabaga'
-  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'rack', '~> 2.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.46'
+  spec.add_development_dependency 'rutabaga', '~> 2.1'
+  spec.add_development_dependency 'timecop', '~> 0.8'
 end

data/spec/lib/snowplow_ruby_duid/cookie_spec.rb

@@ -9,87 +9,82 @@ module SnowplowRubyDuid
     subject { described_class.new @host, @domain_userid, @request_created_at }
 
     describe '#key' do
-
       it 'generates the key' do
         expect(subject.key).to eq('_sp_id.8fb9')
       end
     end
 
     describe '#value' do
-
       it 'generates a cookie' do
         expect(subject.value).to eq(
-        {
           domain:  '.simplybusiness.co.uk',
           expires: (DateTime.parse '2017-01-22 15:26:31 +0000').to_time,
           path:    '/',
           value:   'domain_user_id.1421940391.0.1421940391.'
-        })
+        )
       end
     end
 
-    it 'runs the feature' do
-      feature
-    end
-
-    step 'the host is :host' do |host|
-      @host = host
-    end
+    feature do
+      step 'the host is :host' do |host|
+        @host = host
+      end
 
-    step 'the domain_userid is :domain_userid' do |domain_userid|
-      @domain_userid = domain_userid
-    end
+      step 'the domain_userid is :domain_userid' do |domain_userid|
+        @domain_userid = domain_userid
+      end
 
-    step 'the time is :time' do |time|
-      @request_created_at = (DateTime.parse time).to_time
-    end
+      step 'the time is :time' do |time|
+        @request_created_at = (DateTime.parse time).to_time
+      end
 
-    step 'I create a Snowplow cookie' do; end
+      step 'I create a Snowplow cookie' do; end
 
-    step 'the cookie has the path :path' do |path|
-      expect(subject.value[:path]).to eq(path)
-    end
-
-    step 'the cookie has the domain :domain' do |domain|
-      if domain == ''
-        expect(subject.value[:domain]).to be_nil
-      else
-        expect(subject.value[:domain]).to eq(domain)
+      step 'the cookie has the path :path' do |path|
+        expect(subject.value[:path]).to eq(path)
       end
-    end
 
-    step 'the cookie has the name :name' do |name|
-      expect(subject.key).to eq(name)
-    end
-
-    step 'the cookie expires at :time' do |time|
-      expect(subject.value[:expires].to_s).to eq(time)
-    end
+      step 'the cookie has the domain :domain' do |domain|
+        if domain == ''
+          expect(subject.value[:domain]).to be_nil
+        else
+          expect(subject.value[:domain]).to eq(domain)
+        end
+      end
 
-    step 'the cookie value is :value' do |value|
-      expect(subject.value[:value]).to eq(value)
-    end
+      step 'the cookie has the name :name' do |name|
+        expect(subject.key).to eq(name)
+      end
 
-    step 'the cookie value for :field is :value' do |field, value|
-      value_index = case field
-      when 'domain_userid'
-        then 0
-      when 'createTs'
-        then 1
-      when 'visitCount'
-        then 2
-      when 'nowTs'
-        then 3
-      when 'lastVisitTs'
-        then 4
-      else
-        raise "unknown field name: #{field}"
+      step 'the cookie expires at :time' do |time|
+        expect(subject.value[:expires].to_s).to eq(time)
       end
 
-      value = nil if value == ''
+      step 'the cookie value is :value' do |value|
+        expect(subject.value[:value]).to eq(value)
+      end
 
-      values = subject.value[:value].split '.'
-      expect(values[value_index]).to eq(value)
+      step 'the cookie value for :field is :value' do |field, value|
+        value_index = case field
+                      when 'domain_userid'
+                        then 0
+                      when 'createTs'
+                        then 1
+                      when 'visitCount'
+                        then 2
+                      when 'nowTs'
+                        then 3
+                      when 'lastVisitTs'
+                        then 4
+                      else
+                        raise "unknown field name: #{field}"
+                      end
+
+        value = nil if value == ''
+
+        values = subject.value[:value].split '.'
+        expect(values[value_index]).to eq(value)
+      end
     end
   end
 end

data/spec/lib/snowplow_ruby_duid/helper_spec.rb

@@ -16,25 +16,23 @@ module SnowplowRubyDuid
       end
       subject { last_response.header['Set-Cookie'] }
 
-      it 'runs the feature' do
-        feature
-      end
-
-      step 'I set a Snowplow domain userid of :domain_userid in my cookie' do |domain_userid|
-        set_cookie("_sp_id.3678=#{domain_userid}.631152000.0.631152000.631152000") unless domain_userid == ''
-      end
+      feature do
+        step 'I set a Snowplow domain userid of :domain_userid in my cookie' do |domain_userid|
+          set_cookie("_sp_id.3678=#{domain_userid}.631152000.0.631152000.631152000") unless domain_userid == ''
+        end
 
-      step 'I request the Snowplow domain userid' do
-        allow_any_instance_of(DomainUserid).to receive(:to_s).and_return('2222222222222222')
-        get '/'
-      end
+        step 'I request the Snowplow domain userid' do
+          allow_any_instance_of(DomainUserid).to receive(:to_s).and_return('2222222222222222')
+          get '/'
+        end
 
-      step 'I receive the Snowplow domain userid :domain_userid' do |domain_userid|
-        expect(app.domain_userid).to eq(domain_userid)
-      end
+        step 'I receive the Snowplow domain userid :domain_userid' do |domain_userid|
+          expect(app.domain_userid).to eq(domain_userid)
+        end
 
-      step 'I have the Snowplow domain userid :domain_userid in my cookie' do |domain_userid|
-        expect(subject).to include(domain_userid)
+        step 'I have the Snowplow domain userid :domain_userid in my cookie' do |domain_userid|
+          expect(subject).to include(domain_userid)
+        end
       end
 
       context 'when there is an existing snowplow cookie' do
@@ -54,7 +52,6 @@ module SnowplowRubyDuid
       end
 
       context 'when there is not an existing snowplow cookie' do
-
         it 'generates a domain userid and saves it in the response cookie' do
           get '/'
           expect(subject).to include(app.domain_userid)
@@ -69,10 +66,10 @@ class App
 
   attr_reader :request, :response, :domain_userid
 
-  def call env
+  def call(env)
     @request  = Rack::Request.new env
     @response = Rack::Response.new
-    request.cookies.each{|k,v| response.set_cookie k, v }
+    request.cookies.each { |k, v| response.set_cookie k, v }
 
     @domain_userid = snowplow_domain_userid
 

data/spec/spec_helper.rb

@@ -41,52 +41,50 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  # For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow you to limit a spec run
+  #   # to individual examples or groups you care about by tagging them with
+  #   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  #   # get run.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  #   # For more details, see:
+  #   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
 end

metadata

@@ -1,85 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: snowplow_ruby_duid
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2017-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
 - !ruby/object:Gem::Dependency
   name: rutabaga
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 description: A gem that exposes the Snowplow domain userid in Rack applications. Also
   allows you to set your own domain userid that will be shared with the Snowplow Javascript
   tracker.
@@ -91,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md