landable 1.12.3 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ac7e3da514137a5a1c613fba88a310902a9588a
-  data.tar.gz: cb26053550dec33f9165ef7f708f4d925df0c9df
+  metadata.gz: 79b91e68096271b06e44f3660fe1a577b2106829
+  data.tar.gz: d2fc437c485007597bcbbbbafc9e525e5eda8290
 SHA512:
-  metadata.gz: e7a9ee77e262b28ee572e6b7e58302cb1766bafc2d9811040bdfe618e439b64ad22a786a3d7a753989aa434cd159f5ee214fefb31e381ccdfd97c882a4027e55
-  data.tar.gz: c31d2968ff8c11ca4d8ddab2d9a249edf84a9043eb4b25e0052adee1c14d8964c06c6bb6dfa6a30e2e3aafd34cc1a4b0ef48889288965203dcc27dba4f4e8d7f
+  metadata.gz: e3c967e86fec973e57c27c7ba24702cb9ff910f6b948c19660ec9f6ca3ffe56d846ca8c1b6bb3071e7661424d17eb5856902aab186b019f49bf94c0ad6fb5c79
+  data.tar.gz: ffbae9ae3d1d86064e7820f80ca173c574b5bf867523fc1a95fe41a6c6c35c34067554387bdc4e5b18764c7298b552de0925fa6113d1bee3d4674aa4ff1c7164

data/CHANGELOG.md

@@ -2,7 +2,11 @@
 
 See README.md before updating this file.
 
-## Unreleased [#](https://github.com/enova/landable/compare/v1.12.1...master)
+## Unreleased [#](https://github.com/enova/landable/compare/v1.13.0...v1.13.1)
+
+## 1.13.1 [#](https://github.com/enova/landable/compare/v1.12.3...v1.13.1)
+* BugFix: Default referer.path to '' [#60]
+* Feature: Advanced Message Queuing Protocol to Publish Events [#58]
 
 ## 1.12.3 [#](https://github.com/enova/landable/compare/v1.12.2...v1.12.3)
 * Feature: Add Traffic Object Helper [#50]

data/lib/generators/templates/landable.rb

@@ -51,6 +51,28 @@ Landable.configure do |config|
 
   # If you want to save a different UserAgent if the request.user_agent is blank, set it here
   # config.blank_user_agent_string = 'blank'
+
+  # Uncomment to enable publishing of events to an amqp messaging service.
+  #
+  # This feature requires the mounting application to configure a messenger
+  # class which includes a publish method.  The publish method should
+  # take the message as an input, cast it appropriately
+  # then deliver the message to whatever amqp service you are running.
+  # the EventPublisher class will only attempt to send a message if
+  # enabled = true and messaging_service is set.
+  # The configuration params are a collection, like so:
+  # config.amqp_configuration = {
+  #    site_segment: 'mybrand:myproduct:myapp',
+  #    messaging_service: AmqpMessagingService,
+  #    enabled: 'true',
+  #    event_mapping: {
+  #        '/' => 'Home page',
+  #        '/my_path' => { 'GET' => 'Customer Landed',
+  #                        'POST' => 'Customer Submitted',
+  #                        'DELETE' => 'Customer Left'
+  #                       }
+  #       }.freeze
+  #   }
 end
 
 # Configure asset uploads. Assets will be uploaded to public/uploads by default.

data/lib/landable/configuration.rb

@@ -1,6 +1,6 @@
 module Landable
   class Configuration
-    attr_accessor :api_url, :public_url
+    attr_accessor :api_url, :public_url, :amqp_configuration
     attr_writer :api_namespace, :public_namespace
     attr_writer :api_host, :public_host
     attr_writer :categories
@@ -10,7 +10,12 @@ module Landable
     attr_writer :reserved_paths, :partials_to_templates, :database_schema_prefix
     attr_writer :publicist_url, :audit_flags
     attr_writer :blank_user_agent_string, :untracked_paths
-    attr_writer :dnt_enabled
+    attr_writer :dnt_enabled, :amqp_event_mapping, :amqp_site_segment
+    attr_writer :amqp_service_enabled, :amqp_messaging_service
+
+    def amqp_configuration
+      @amqp_configuration ||= {}
+    end
 
     def authenticators
       @authenticators || raise("No Landable authenticator configured.")
@@ -152,10 +157,21 @@ module Landable
 
     def dnt_enabled
       return true if @dnt_enabled.nil?
-
       @dnt_enabled
     end
 
+    def amqp_site_segment
+      @amqp_site_segment ||= Rails.application.class.parent_name
+    end
+
+    def amqp_event_mapping
+      @amqp_event_mapping ||= {}
+    end
+
+    def amqp_service_enabled
+      amqp_configuration[:enabled] && amqp_configuration[:messaging_service]
+    end
+
 
     class Screenshots
       attr_accessor :autorun

data/lib/landable/traffic.rb

@@ -5,6 +5,7 @@ require 'landable/traffic/scan_tracker'
 require 'landable/traffic/scrape_tracker'
 require 'landable/traffic/user_tracker'
 require 'landable/traffic/noop_tracker'
+require 'landable/traffic/event_publisher'
 
 module Landable
   module Traffic

data/lib/landable/traffic/event_publisher.rb

@@ -0,0 +1,115 @@
+module Landable
+  module EventPublisher
+    mattr_reader :event_type, :page_view, :visit
+
+    class << self
+      def publish(page_view)
+        @configuration = Landable.configuration.amqp_configuration
+        return unless enabled?
+
+        @event_type = event_type(page_view)
+        return unless @event_type
+
+        @page_view = page_view
+        @visit = page_view.visit
+        messaging_service.publish(message)
+      end
+
+      private
+
+      def enabled?
+        @enabled ||= @configuration[:enabled] && messaging_service.present?
+      end
+
+      def messaging_service
+        @messaging_service ||= @configuration[:messaging_service]
+      end
+
+      def event_mapping
+        @event_mapping ||= @configuration[:event_mapping]
+      end
+
+      def event_type(page_view)
+        event_type = event_mapping[page_view.path]
+
+        if event_type.is_a?(Hash)
+          request_type = page_view.http_method
+          event_type = event_type[request_type]
+        end
+        event_type
+      end
+
+      def site_segment
+        @site_segment ||= @configuration[:site_segment]
+      end
+
+      def message
+        visit = @visit
+        attribution = visit.try(:attribution)
+        referer = visit.try(:referer)
+        visitor = visit.visitor
+        page_view = @page_view
+        user_agent = visitor.try(:raw_user_agent)
+        user_agent_type = user_agent.try(:raw_user_agent_type)
+        event_type = @event_type
+        {
+          site_segment: site_segment,
+          visit_id: visit.id,
+          event: event_type.to_s,
+          page_view_id: page_view.page_view_id,
+          request_type: page_view.http_method,
+          created_at: page_view.created_at,
+          cookie_id: visit.cookie_id,
+          owner_id: visit.try(:owner_id),
+          owner: visit.try(:owner).try(:owner),
+          referer_id: referer.try(:id),
+          domain_id: referer.try(:domain_id),
+          domain: referer.try(:domain),
+          ip_address_id: visitor.try(:ip_address_id),
+          ip_address: visitor.try(:ip_address).try(:to_s),
+          user_agent_id: user_agent.try(:id),
+          user_agent: user_agent.try(:user_agent),
+          user_agent_type_id: user_agent_type.try(:id),
+          user_agent_type: user_agent_type.try(:user_agent_type),
+          attribution_id: attribution.try(:id),
+          ad_group_id: attribution.try(:ad_group_id),
+          ad_group: attribution.try(:ad_group),
+          ad_type_id: attribution.try(:ad_type_id),
+          ad_type: attribution.try(:ad_type),
+          bid_match_type_id: attribution.try(:bid_match_type_id),
+          bid_match_type: attribution.try(:bid_match_type),
+          campaign_id: attribution.try(:campaign_id),
+          campaign: attribution.try(:campaign),
+          content_id: attribution.try(:content_id),
+          content: attribution.try(:content),
+          creative_id: attribution.try(:creative_id),
+          creative: attribution.try(:creative),
+          device_type_id: attribution.try(:device_type_id),
+          device_type: attribution.try(:device_type),
+          experiment_id: attribution.try(:experiment_id),
+          experiment: attribution.try(:experiment),
+          keyword_id: attribution.try(:keyword_id),
+          keyword: attribution.try(:keyword),
+          match_type_id: attribution.try(:match_type_id),
+          match_type: attribution.try(:match_type),
+          medium_id: attribution.try(:medium_id),
+          medium: attribution.try(:medium),
+          network_id: attribution.try(:network_id),
+          network: attribution.try(:network),
+          placement_id: attribution.try(:placement_id),
+          placement: attribution.try(:placement),
+          position_id: attribution.try(:position_id),
+          position: attribution.try(:position),
+          search_term_id: attribution.try(:search_term_id),
+          search_term: attribution.try(:search_term),
+          source_id: attribution.try(:source_id),
+          source: attribution.try(:source),
+          target_id: attribution.try(:target_id),
+          target: attribution.try(:target),
+          path_id: page_view.path_id,
+          path: page_view.path
+        }
+      end
+    end
+  end
+end

data/lib/landable/traffic/tracker.rb

@@ -76,8 +76,8 @@ module Landable
         def for(controller)
           type = controller.request.user_agent.presence && Landable::Traffic::UserAgent[controller.request.user_agent].user_agent_type
           type = 'noop' if Landable.configuration.traffic_enabled == :html and not controller.request.format.html?
-          type = 'user'if type.nil?
-          type = 'user'if controller.request.query_parameters.slice(*TRACKING_KEYS).any?
+          type = 'user' if type.nil?
+          type = 'user' if controller.request.query_parameters.with_indifferent_access.slice(*TRACKING_KEYS).any?
 
           "Landable::Traffic::#{type.classify}Tracker".constantize.new(controller)
         end
@@ -173,7 +173,7 @@ module Landable
         query       = params.except(*ATTRIBUTION_KEYS)
 
         @referer = Referer.where(domain_id:       Domain[referer_uri.host],
-                                 path_id:         Path[referer_uri.path],
+                                 path_id:         Path[referer_uri_path],
                                  query_string_id: QueryString[query.to_query],
                                  attribution_id:  attribution.id).first_or_create
       end
@@ -236,6 +236,10 @@ module Landable
         @referer_uri ||= URI(URI.encode(request.referer)) if request.referer
       end
 
+      def referer_uri_path
+        referer_uri.try(:path) || ''
+      end
+
       def external_referer?
         referer_uri && referer_uri.host != request.host
       end
@@ -271,6 +275,10 @@ module Landable
         hash
       end
 
+      def query_parameters
+        @query_parameters ||= request.query_parameters.with_indifferent_access
+      end
+
       def tracking_parameters
         @tracking_parameters ||= extract_tracking(query_parameters)
       end
@@ -280,7 +288,7 @@ module Landable
       end
 
       def attribution_parameters
-        @attribution_parameters ||= tracking_parameters.slice(*ATTRIBUTION_KEYS)
+        @attribution_parameters ||= tracking_parameters.with_indifferent_access.slice(*ATTRIBUTION_KEYS)
       end
 
       def attribution

data/lib/landable/traffic/user_tracker.rb

@@ -33,13 +33,18 @@ module Landable
           p.http_status  = response.status
 
           p.visit_id     = @visit_id
+          # this is strange, yes, but is it better than a db call?
+          p.created_at   = Time.current
 
           p.response_time = ( Time.now - @start_time ) * 1000
         end
       end
 
       def save
-        record_page_view
+        p = record_page_view
+        if Landable.configuration.amqp_service_enabled
+          EventPublisher.publish(p)
+        end
 
         session[:landable] = {
           KEYS[:visit_id]         => @visit_id,

data/lib/landable/version.rb

@@ -1,8 +1,8 @@
 module Landable
   module VERSION
     MAJOR = 1
-    MINOR = 12
-    PATCH = 3
+    MINOR = 13
+    PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/spec/dummy/config/environments/development.rb

@@ -26,4 +26,5 @@ Dummy::Application.configure do
   # This option may cause significant delays in view rendering with a large
   # number of complex assets.
   config.assets.debug = true
+  config.serve_static_files = true
 end

data/spec/dummy/config/environments/test.rb

@@ -13,7 +13,7 @@ Dummy::Application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
+  config.serve_static_files  = true
   config.static_cache_control = "public, max-age=3600"
 
   # Show full error reports and disable caching.

data/spec/dummy/config/initializers/landable.rb

@@ -1,4 +1,5 @@
 require 'landable'
+require Rails.root.join('lib', 'bunny_messaging_service.rb')
 
 Landable.configure do |config|
   config.api_namespace = '/api'
@@ -11,10 +12,20 @@ Landable.configure do |config|
   config.partials_to_templates = %w(partials/foobazz)
 
   config.reserved_paths = %w(/reserved_path_set_in_initializer /reject/.* /admin.*)
-
   config.database_schema_prefix = 'dummy'
-
   config.audit_flags = %w(loans apr)
+
+  config.amqp_configuration = {
+    site_segment: 'mybrand:myproduct:myapp',
+    messaging_service: BunnyMessagingService,
+    enabled: 'true',
+    event_mapping: {
+        '/my_path' => { 'GET' => 'Customer Landed',
+                        'POST' => 'Customer Submitted',
+                        'DELETE' => 'Customer Left'
+                      }
+      }.freeze
+  }
 end
 
 # Configure asset uploads. Assets will be uploaded to public/uploads by default.

data/spec/dummy/lib/bunny_messaging_service.rb

@@ -0,0 +1,7 @@
+class BunnyMessagingService
+  class << self
+    def publish(message)
+      message
+    end
+  end
+end

data/spec/lib/landable/event_publisher_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+module Landable
+  module Traffic
+    describe 'EventPublisher', type: :controller do
+
+      controller(ApplicationController) do
+        include Landable::Traffic
+        prepend_around_action :track_with_landable!
+
+        def my_path
+          render nothing: true
+        end
+      end
+
+      before do
+        routes.draw do
+          get "/my_path" => 'anonymous#my_path'
+          post '/my_path' => 'anonymous#my_path'
+          delete '/my_path' => 'anonymous#my_path'
+        end
+      end
+
+      let(:message_keys) do
+        [:ad_group, :ad_type, :bid_match_type, :campaign, :content, :creative, :device_type,
+         :experiment, :keyword, :match_type, :medium, :network, :placement, :position,
+         :search_term, :source, :target]
+      end
+
+      let(:attribution) do
+        message_keys.each_with_object({}) do |attribute, hash|
+          hash[attribute] = "test_#{attribute}"
+        end
+      end
+
+      let(:tracker) { controller.instance_variable_get(:@tracker) }
+      let(:page_view) { PageView.last }
+      let(:published_message) { EventPublisher.publish(page_view) }
+
+      it 'should properly properly set the attribution data and send it within a message' do
+        get :my_path, attribution
+        # binding.pry
+        message_keys.each do |attribute|
+          expect(published_message[attribute]).to eq("test_#{attribute}")
+        end
+      end
+
+      it 'should properly set the event types for GET requests when multiple request types use the same route' do
+        get :my_path, attribution
+        expect(published_message[:path]).to eq('/my_path')
+        expect(published_message[:request_type]).to eq('GET')
+        expect(published_message[:event]).to eq('Customer Landed')
+      end
+
+      it 'should properly set the event types for POST requests when multiple request types use the same route' do
+        post :my_path, attribution
+        expect(published_message[:path]).to eq('/my_path')
+        expect(published_message[:request_type]).to eq('POST')
+        expect(published_message[:event]).to eq('Customer Submitted')
+      end
+
+      it 'should properly set the event types for DELETE requests when multiple request types use the same route' do
+        delete :my_path, attribution
+        expect(published_message[:path]).to eq('/my_path')
+        expect(published_message[:request_type]).to eq('DELETE')
+        expect(published_message[:event]).to eq('Customer Left')
+      end
+
+      it 'should correctly set the user agent information in the message' do
+        get :my_path, attribution
+        user_agent =  UserAgent[controller.request.user_agent]
+        expect(published_message[:user_agent_id]).to eq user_agent.id
+        expect(published_message[:user_agent]).to eq user_agent.user_agent
+      end
+
+      it 'should correctly set the page view information in the message' do
+        get :my_path, attribution
+        expect(published_message[:page_view_id]).to eq page_view.id
+        expect(published_message[:created_at]).to eq page_view.created_at
+        expect(published_message[:created_at]).to_not be_nil
+      end
+
+      it 'should correctly set the visit information in the message' do
+        get :my_path, attribution
+        visit = page_view.visit
+        visitor = page_view.visit.visitor
+        expect(published_message[:visit_id]).to eq visit.id
+        expect(published_message[:cookie_id]).to eq visit.cookie_id
+        expect(published_message[:ip_address_id]).to eq visitor.ip_address_id
+        expect(published_message[:ip_address]).to eq visitor.ip_address.to_s
+      end
+    end
+  end
+end

data/spec/lib/landable/tracking_spec.rb

@@ -114,8 +114,18 @@ module Landable
     end
 
     context 'no referer' do
+      let(:referer) { double('referer', { path: nil}) }
       let(:visit) { double('visit', { referer: nil }) }
 
+      describe '#referer_uri_path' do
+        it 'should return empty string' do
+          tracker = Landable::Traffic::UserTracker.new controller
+          tracker.stub(:referer_uri) { referer }
+
+          tracker.send(:referer_uri_path).should == ''
+        end
+      end
+
       describe '#visit_referer_domain' do
         it 'should return nil' do
           tracker = Landable::Traffic::UserTracker.new controller

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: landable
 version: !ruby/object:Gem::Version
-  version: 1.12.3
+  version: 1.13.1
 platform: ruby
 authors:
 - Team Trogdor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -539,6 +539,7 @@ files:
 - lib/landable/seeds.rb
 - lib/landable/traffic.rb
 - lib/landable/traffic/crawl_tracker.rb
+- lib/landable/traffic/event_publisher.rb
 - lib/landable/traffic/noop_tracker.rb
 - lib/landable/traffic/ping_tracker.rb
 - lib/landable/traffic/scan_tracker.rb
@@ -620,6 +621,7 @@ files:
 - spec/dummy/db/.keep
 - spec/dummy/db/structure.sql
 - spec/dummy/lib/assets/.keep
+- spec/dummy/lib/bunny_messaging_service.rb
 - spec/dummy/log/.keep
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -640,6 +642,7 @@ files:
 - spec/fixtures/assets/small.pdf
 - spec/helpers/pages_helper_spec.rb
 - spec/lib/landable/configuration_spec.rb
+- spec/lib/landable/event_publisher_spec.rb
 - spec/lib/landable/layout_spec.rb
 - spec/lib/landable/liquid_spec.rb
 - spec/lib/landable/migration_spec.rb
@@ -779,6 +782,7 @@ test_files:
 - spec/dummy/db/.keep
 - spec/dummy/db/structure.sql
 - spec/dummy/lib/assets/.keep
+- spec/dummy/lib/bunny_messaging_service.rb
 - spec/dummy/log/.keep
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -799,6 +803,7 @@ test_files:
 - spec/fixtures/assets/small.pdf
 - spec/helpers/pages_helper_spec.rb
 - spec/lib/landable/configuration_spec.rb
+- spec/lib/landable/event_publisher_spec.rb
 - spec/lib/landable/layout_spec.rb
 - spec/lib/landable/liquid_spec.rb
 - spec/lib/landable/migration_spec.rb