perimeter_x 1.0.6.pre.alpha → 2.0.0

data/lib/perimeterx/utils/px_http_client.rb

@@ -1,34 +1,49 @@
-require "perimeterx/utils/px_logger"
-require "httpclient"
+require 'perimeterx/utils/px_logger'
+require 'typhoeus'
+require 'concurrent'
 
-class PxHttpClient
-  L = PxLogger.instance
-  attr_accessor :px_config
-  attr_accessor :BASE_URL
-  attr_accessor :http_client
+module PxModule
+  class PxHttpClient
+    include Concurrent::Async
 
-  def initialize(px_config)
-    L.info("PxHttpClient[initialize]: HTTP client is being initilized with base_uri: #{px_config['perimeterx_server_host']}")
-    @px_config = px_config
-    @http_client = HTTPClient.new(:base_url => px_config['perimeterx_server_host'])
-  end
+    attr_accessor :px_config
+    attr_accessor :px_client
 
-  def post(path, body, headers, connection_timeout = 0, timeoute = 0)
-    s = Time.now
-    begin
-      L.info("PxHttpClient[post]: posting to #{path} headers {#{headers.to_json()}} body: {#{body.to_json()}} ")
-      response = @http_client.post(path,
-                  :header => headers,
-                  :body => body.to_json(),
-                  :timeout => @px_config['api_timeout']
-                )
-    rescue Net::OpenTimeout, Net::ReadTimeout => error
-      L.warn("PerimeterxS2SValidator[verify]: request timedout")
-      return false
+    def initialize(px_config)
+      @px_config = px_config
+      @logger = px_config[:logger]
+      @logger.debug("PxHttpClient[initialize]: HTTP client is being initilized with base_uri: #{px_config[:backend_url]}")
     end
-    e = Time.now
-    L.info("PxHttpClient[post]: runtime: #{e-s}")
-    return response
-  end
 
+    # Runs a POST command to Perimeter X servers
+    # Params:
+    # +path+:: string containing uri
+    # +body+:: hash object, containing the request body, must be converted to json format
+    # +headers+:: hash object, hold headers
+    # +api_timeout+:: int, sets the timeout for a request
+    # +connection_timeout+:: int, sets the timeout for opening a connection
+
+    def post(path, body, headers, api_timeout = 1, connection_timeout = 1)
+      s = Time.now
+      begin
+        @logger.debug("PxHttpClient[post]: posting to #{path} headers {#{headers.to_json()}} body: {#{body.to_json()}} ")
+        response = Typhoeus.post(
+            "#{px_config[:backend_url]}#{path}",
+            headers: headers,
+            body: body.to_json,
+            timeout: api_timeout,
+            connecttimeout: connection_timeout
+        )
+        if response.timed_out?
+          @logger.warn('PerimeterxS2SValidator[verify]: request timed out')
+          return false
+        end
+      ensure
+        e = Time.now
+        @logger.debug("PxHttpClient[post]: runtime: #{(e-s) * 1000.0}")
+      end
+      return response
+    end
+
+  end
 end

data/lib/perimeterx/utils/px_logger.rb

@@ -1,11 +1,17 @@
 require 'logger'
+module PxModule
 
-class PxLogger
-  @@instance = Logger.new(STDOUT)
+  class PxLogger < Logger
 
-  def self.instance
-    return @@instance
-  end
+    def initialize(debug)
+      if debug
+        super(STDOUT)
+      else
+        super(nil)
+      end
+
+    end
 
-  private_class_method :new
+  end
+  
 end

data/lib/perimeterx/utils/px_template_factory.rb

@@ -0,0 +1,41 @@
+require 'mustache'
+require 'perimeterx/utils/px_constants'
+module PxModule
+  module PxTemplateFactory
+
+    def self.get_template(px_ctx, px_config, px_template_object)
+      logger = px_config[:logger]
+      if (px_config[:challenge_enabled] && px_ctx.context[:block_action] == 'challenge')
+        logger.debug('PxTemplateFactory[get_template]: px challange triggered')
+        return px_ctx.context[:block_action_data].html_safe
+      end
+
+      view = Mustache.new
+
+      if (px_ctx.context[:block_action] == 'rate_limit')
+        logger.debug('PxTemplateFactory[get_template]: rendering ratelimit template')
+        template_type = RATELIMIT_TEMPLATE
+      else
+        logger.debug('PxTemplateFactory[get_template]: rendering template')
+        template_type = CHALLENGE_TEMPLATE
+      end
+
+      Mustache.template_file =  "#{File.dirname(__FILE__) }/templates/#{template_type}#{PxModule::TEMPLATE_EXT}"
+
+      view[PxModule::PROP_APP_ID] = px_config[:app_id]
+      view[PxModule::PROP_REF_ID] = px_ctx.context[:uuid]
+      view[PxModule::PROP_VID] = px_ctx.context[:vid]
+      view[PxModule::PROP_UUID] = px_ctx.context[:uuid]
+      view[PxModule::PROP_CUSTOM_LOGO] = px_config[:custom_logo]
+      view[PxModule::PROP_CSS_REF] = px_config[:css_ref]
+      view[PxModule::PROP_JS_REF] = px_config[:js_ref]
+      view[PxModule::PROP_HOST_URL] = "https://collector-#{px_config[:app_id]}.perimeterx.net"
+      view[PxModule::PROP_LOGO_VISIBILITY] = px_config[:custom_logo] ? PxModule::VISIBLE : PxModule::HIDDEN
+      view[PxModule::PROP_BLOCK_SCRIPT] = px_template_object[:block_script]
+      view[PxModule::PROP_JS_CLIENT_SRC] = px_template_object[:js_client_src]
+      view[PxModule::PROP_FIRST_PARTY_ENABLED] = false
+
+      return view.render.html_safe
+    end
+  end #end class
+end #end module

data/lib/perimeterx/utils/templates/block_template.mustache

@@ -0,0 +1,175 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Access to this page has been denied.</title>
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300" rel="stylesheet">
+    <style>
+        html, body {
+            margin: 0;
+            padding: 0;
+            font-family: 'Open Sans', sans-serif;
+            color: #000;
+        }
+
+        a {
+            color: #c5c5c5;
+            text-decoration: none;
+        }
+
+        .container {
+            align-items: center;
+            display: flex;
+            flex: 1;
+            justify-content: space-between;
+            flex-direction: column;
+            height: 100%;
+        }
+
+        .container > div {
+            width: 100%;
+            display: flex;
+            justify-content: center;
+        }
+
+        .container > div > div {
+            display: flex;
+            width: 80%;
+        }
+
+        .customer-logo-wrapper {
+            padding-top: 2rem;
+            flex-grow: 0;
+            background-color: #fff;
+            visibility: {{logoVisibility}};
+        }
+
+        .customer-logo {
+            border-bottom: 1px solid #000;
+        }
+
+        .customer-logo > img {
+            padding-bottom: 1rem;
+            max-height: 50px;
+            max-width: 100%;
+        }
+
+        .page-title-wrapper {
+            flex-grow: 2;
+        }
+
+        .page-title {
+            flex-direction: column-reverse;
+        }
+
+        .content-wrapper {
+            flex-grow: 5;
+        }
+
+        .content {
+            flex-direction: column;
+        }
+
+        .page-footer-wrapper {
+            align-items: center;
+            flex-grow: 0.2;
+            background-color: #000;
+            color: #c5c5c5;
+            font-size: 70%;
+        }
+
+        @media (min-width: 768px) {
+            html, body {
+                height: 100%;
+            }
+        }
+    </style>
+    <!-- Custom CSS -->
+    {{#cssRef}}
+        <link rel="stylesheet" type="text/css" href="{{{cssRef}}}"/>
+    {{/cssRef}}
+</head>
+
+<body>
+<section class="container">
+    <div class="customer-logo-wrapper">
+        <div class="customer-logo">
+            <img src="{{customLogo}}" alt="Logo"/>
+        </div>
+    </div>
+    <div class="page-title-wrapper">
+        <div class="page-title">
+            <h1>Please verify you are a human</h1>
+        </div>
+    </div>
+    <div class="content-wrapper">
+        <div class="content">
+
+            <div id="px-captcha">
+            </div>
+            <p>
+                Access to this page has been denied because we believe you are using automation tools to browse the
+                website.
+            </p>
+            <p>
+                This may happen as a result of the following:
+            </p>
+            <ul>
+                <li>
+                    Javascript is disabled or blocked by an extension (ad blockers for example)
+                </li>
+                <li>
+                    Your browser does not support cookies
+                </li>
+            </ul>
+            <p>
+                Please make sure that Javascript and cookies are enabled on your browser and that you are not blocking
+                them from loading.
+            </p>
+            <p>
+                Reference ID: #{{refId}}
+            </p>
+        </div>
+    </div>
+    <div class="page-footer-wrapper">
+        <div class="page-footer">
+            <p>
+                Powered by
+                <a href="https://www.perimeterx.com/whywasiblocked">PerimeterX</a>
+                , Inc.
+            </p>
+        </div>
+    </div>
+</section>
+<!-- Px -->
+<script>
+    window._pxAppId = '{{appId}}';
+    window._pxJsClientSrc = '{{{jsClientSrc}}}';
+    window._pxFirstPartyEnabled = {{firstPartyEnabled}};
+    window._pxVid = '{{vid}}';
+    window._pxUuid = '{{uuid}}';
+    window._pxHostUrl = '{{{hostUrl}}}';
+</script>
+<script>
+    var s = document.createElement('script');
+    s.src = '{{{blockScript}}}';
+    var p = document.getElementsByTagName('head')[0];
+    p.insertBefore(s, null);
+    if ({{firstPartyEnabled}}) {
+        s.onerror = function () {
+            s = document.createElement('script');
+            var suffixIndex = '{{{blockScript}}}'.indexOf('captcha.js');
+            var temperedBlockScript = '{{{blockScript}}}'.substring(suffixIndex);
+            s.src = '//captcha.px-cdn.net/{{appId}}/' + temperedBlockScript;
+            p.parentNode.insertBefore(s, p);
+        };
+    }
+</script>
+
+<!-- Custom Script -->
+{{#jsRef}}
+    <script src="{{{jsRef}}}"></script>
+{{/jsRef}}
+</body>
+</html>

data/lib/perimeterx/utils/templates/ratelimit.mustache

@@ -0,0 +1,9 @@
+<html>
+<head>
+    <title>Too Many Requests</title>
+</head>
+<body>
+    <h1>Too Many Requests</h1>
+    <p>Reached maximum requests limitation, try again soon.</p>
+</body>
+</html>

data/lib/perimeterx/version.rb

@@ -1,3 +1,3 @@
-module PerimeterX
-  VERSION = '1.0.6-alpha'
+module PxModule
+  VERSION = '2.0.0'
 end

data/perimeter_x.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.description = "PerimeterX ruby module to monitor and block traffic according to PerimeterX risk score"
   gem.licenses    = ['MIT']
   gem.homepage    = "https://www.perimeterx.com"
-  gem.version     = PerimeterX::VERSION
+  gem.version     = PxModule::VERSION
 
   gem.authors     = ["Nitzan Goldfeder"]
   gem.email       = "nitzan@perimeterx.com"
@@ -22,13 +22,19 @@ Gem::Specification.new do |gem|
   gem.bindir        = "exe"
   gem.executables   = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
   gem.require_paths = ["lib"]
-  gem.add_development_dependency "bundler", "~> 1.14"
-  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "bundler", ">= 2.1"
+  gem.add_development_dependency "rake", ">= 12.3"
 
   gem.extra_rdoc_files = ["readme.md", "changelog.md"]
   gem.rdoc_options     = ["--line-numbers", "--inline-source", "--title", "PerimeterX"]
 
   gem.required_ruby_version = '>= 2.3'
 
-  gem.add_dependency('httpclient', '2.8.2.4')
+  gem.add_dependency('concurrent-ruby', '~> 1.0', '>= 1.0.5')
+  gem.add_dependency('typhoeus', '~> 1.1', '>= 1.1.2')
+  gem.add_dependency('mustache', '~> 1.0', '>= 1.0.3')
+  gem.add_dependency('activesupport', '>= 5.2.4.3')
+
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'mocha', '~> 1.2', '>= 1.2.1'
 end

data/readme.md

@@ -1,15 +1,37 @@
+[![Build Status](https://travis-ci.org/PerimeterX/perimeterx-ruby-sdk.svg?branch=master)](https://travis-ci.org/PerimeterX/perimeterx-ruby-sdk)
+
 ![image](http://media.marketwire.com/attachments/201604/34215_PerimeterX_logo.jpg)
 #
 [PerimeterX](http://www.perimeterx.com) Ruby SDK
 =============================================================
 
+> Latest stable version: [v1.3.0](https://rubygems.org/gems/perimeter_x/versions/1.3.0)
+
 Table of Contents
 -----------------
--   [Usage](#usage)
+  **[Usage](#usage)**
   *   [Dependencies](#dependencies)
   *   [Installation](#installation)
   *   [Basic Usage Example](#basic-usage)
--   [Configuration](#configuration)
+  
+  **[Configuration](#configuration)**
+  *   [Configuring Required Parameters](#requireied-params)
+  *   [Blocking Score](#blocking-score)
+  *   [Custom Verification Action](#custom-verification-action)
+  *   [Custom Block Page](#custom-block-page)
+  *   [Enable/Disable Captcha](#captcha-support)
+  *   [Select Captcha Provider](#captcha-provider)
+  *   [Extracting Real IP Address](#real-ip)
+  *   [Custom URI](#custom-uri)
+  *   [Filter Sensitive Headers](#sensitive-headers)
+  *   [API Timeouts](#api-timeout)
+  *   [Send Page Activities](#send-page-activities)
+  *   [Additional Page Activity Handler](#additional-page-activity-handler)
+  *   [Monitor Only](#logging)
+  *   [Debug Mode](#debug-mode)
+  *   [Whitelist Routes](#whitelist-routes)
+  
+  **[Contributing](#contributing)**
 
 <a name="Usage"></a>
 <a name="dependencies"></a> Dependencies
@@ -17,80 +39,130 @@ Table of Contents
 
 - Ruby version 2.3+
 - Rails version 4.2
-- [httparty](https://github.com/jnunemaker/httparty)
+- [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby)
+- [typhoeus](https://github.com/typhoeus/typhoeus)
+- [mustache](https://rubygems.org/gems/mustache)
 
 <a name="installation"></a> Installation
 ----------------------------------------
-Install it through command line ```gem install perimeter_x --pre```
-Or add it in Gemfile ```gem 'perimeter_x', '~> 1.0.4.pre.alpha'```
+Install it through command line ```gem install perimeter_x```
 
 
 <a name=basic-usage></a> Basic Usage Example
 ----------------------------------------
-On the Rails controller include the PerimeterX SDK via the before_action which will call your defined middleware function. This function is a wrapper for the px_verify method which takes a request and processes it. The verify method can return true if verified, or false if not verified.
 
-The default condition is to always return true for monitoring mode.
+### Configuration & Initialization
+Create a configuration file at `<rails_app>/config/initializers/perimeterx.rb` and initialize PerimeterX instance on the rails application startup
+```ruby
+params = {
+  :app_id => "APP_ID",
+  :cookie_key => "COOKIE_KEY",
+  :auth_token => "AUTH_TOKEN"
+}
 
+PxModule.configure(params)
 ```
+
+On the Rails controller include the PerimeterX SDK via the before_action and call PerimterX middleware function.
+
+```ruby
 class HomeController < ApplicationController
-  include PerimeterX
-  attr_accessor :px
-  ...
-  ...
-  before_action :px_middleware
-  ...
-  ...
-  initialize()
-    configuration = {
-      "app_id" => <APP_ID>
-      "auth_token" => <AUTH_TOKEN>
-    }
-    @px = PxModule.instance(params)
-  end
+  include PxModule
+
+  before_action :px_verify_request
   ...
   ...
-  def px_middleware
-    px.px_verify(request.env)
-  end
+end
 ```
 
-<a name="configuration"></a> Configuration
+<a name="configuration"></a> Configuration options
 ----------------------------------------
+<a name="requireied-params"></a>**Configuring Required Parameters**
+Configuration options are set on the ``params`` variable on the initializer file.
 
-** Custom Verification Handler **
-A custom verification handler replaces the default handle_verification method and allows you to take a custom action based on the risk score returned by PerimeterX.
+- ``app_id``
+- ``cookie_key``
+- ``auth_token``
 
-When implemented, this method receives  a hash variable as input which represents data from the PerimeterX context of the request (px_ctx).
+All parameters are obtainable via the PerimeterX Portal. (Applications and Policies pages)
 
-- `px_ctx[:score] ` contains the risk score 
-- `px_ctx[:uuid] ` contains the request UUID 
+<a name="blocking-score"></a>**Changing the Minimum Score for Blocking**
 
-To replace the default verification behavior, add the configuration a lambda member as shown in the example below.
+>Note:  Default blocking value: 100
 
-The method must return boolen value.
+```ruby
+params = {
+  ...
+  :blocking_score => 100
+  ...
+}
+```
+
+<a name="custom-verification-action"></a>**Custom Verification Handler**
+
+> Note: This handler replaces the now deprecated `custom_block_handler`.
 
+A custom verification handler is being executed inside `px_verify_request` instead of the the default behavior and allows a user to use a custom action based on the risk score returned by PerimeterX.
 
+When implemented, this method receives a hash variable as input which represents data from the PerimeterX context of the request (px_ctx).
+
+- `px_ctx.context[:score]` - contains the risk score
+- `px_ctx.context[:uuid]` - contains the request UUID
+- `px_ctx.context[:verified]` - contains indication whether the request passed verification or was blocked (inspect `px_ctx.context[:block_reason]` for block reason) 
+
+> Note: to determine whether to return a captcha/block page (HTML) or block JSON payload a reference key on the context will be available:  ```px_ctx.context[:format]```
+
+To replace the default verification behavior, add the configuration a lambda member as shown in the example below.
 
 ```ruby
-configuration = {
-  "app_id" => <APP_ID>,
-  "auth_token" => <AUTH_TOKEN>,
-  "custom_verification_handler" => -> (px_ctx) {
-    if px_ctx[:score] >= 60
-        # take your action and retun a message or JSON with a status code of 403 and option UUID of the request. Can return false and include action in the px_middleware method.  
+params = {
+  :app_id => <APP_ID>,
+  :auth_token => <AUTH_TOKEN>,
+  :custom_verification_handler => -> (px_ctx) {
+    if px_ctx.context[:score] >= 60
+      # take your action and render an html page or JSON with applicable status code.    
+      render json: { :score => px_ctx.context[:score] }
     end
-    return true
   }
 }
 ```
 
-** Custom User IP **
+> Note: Unlike previous versions, the method no longer needs to return a boolean value. 
+
+**Example**
+#### Serving a Custom HTML Page ####
+```ruby
+
+params = {
+  :app_id => <APP_ID>,
+  :auth_token => <AUTH_TOKEN>,
+  ...
+  :custom_verification_handler => -> (px_ctx) {
+    block_score = px_ctx.context[:score];
+    client_uuid = px_ctx.context[:uuid];
+    full_url = px_ctx.context[:full_url];
+
+    html = "<html>
+            <body>
+            <div>Access to #{full_url} has been blocked.</div>    
+            <div>Block reference - #{client_uuid} </div>
+            <div>Block score - #{block_score} </div>
+            </body>
+            </html>".html_safe
+    response.headers["Content-Type"] = "text/html"
+    response.status = 403
+    render :html => html
+  }
+}
+```
+
+<a name="real-ip"></a>**Custom User IP**
 
 > Note: IP extraction, according to your network setup, is very important. It is common to have a load balancer/proxy on top of your applications, in which case the PerimeterX module will send the system's internal IP as the user's. In order to properly perform processing and detection on server-to-server calls, PerimeterX module needs the real user's IP.
 
 By default the clients IP is taken from the ``REMOTE_ADDR`` header, in case the user decides to use different header or custom function that extract the header the following key should be added to the configuration
 
-*** Custom header ***
+***Custom header***
 ```ruby
 configuration = {
   "app_id" => <APP_ID>,
@@ -98,7 +170,7 @@ configuration = {
   "custom_user_ip" => <HTTP_HEADER_NAME>,
 ```
 
-*** Custom Function ***
+***Custom Function***
 > Note: the function receive as a first parameter the controller request and must return the ip at the end as string
 
 ```ruby
@@ -111,3 +183,147 @@ configuration = {
   }
 }
 ```
+<a name="custom-block-page"></a>**Customizing Default Block Pages**
+
+Adding a custom logo to the blocking page is by providing the `params` a key `custom_logo` , the logo will be displayed at the top div of the the block page The logo's `max-heigh` property would be `150px` and width would be set to `auto`
+
+The key custom_logo expects a valid URL address such as https://s.perimeterx.net/logo.png
+
+```ruby
+params = [
+    :app_id => 'APP_ID',
+    :cookie_key => 'COOKIE_SECRET',
+    :auth_token => 'AUTH_TOKEN',
+    :custom_logo => 'LOGO_URL'
+];
+```
+
+**Custom JS/CSS**
+The block page can be modified with a custom CSS by adding to the `params` the key `css_ref` and providing a valid URL to the css In addition there is also the option to add a custom JS file by adding `js_ref` key to the pxConfig and providing the JS file that will be loaded with the block page, this key also expects a valid URL
+
+```ruby
+params = [
+    :app_id => 'APP_ID',
+    :cookie_key => 'COOKIE_SECRET',
+    :auth_token => 'AUTH_TOKEN',
+    :css_ref => 'CSS',
+    :js_ref => 'JS'
+];
+```
+> Note: Custom logo/js/css can be added together
+
+<a name="logging"></a>**No Blocking, Monitor Only**
+Default mode: PxModule::ACTIVE_MODE
+
+- PxModule::ACTIVE_MODE - Module blocks users crossing the predefined block threshold. Server-to-server requests are sent synchronously.
+
+- PxModule::$MONITOR_MODE - Module does not block users crossing the predefined block threshold. The `custom_block_handler` function will be eval'd in case one is supplied, upon crossing the defined block threshold.
+
+```ruby
+params[:module_mode] = PxModule::MONITOR_MODE
+```
+
+<a name="captcha-support"></a>**Enable/Disable CAPTCHA on the block page**
+Default mode: enabled
+
+By enabling CAPTCHA support, a CAPTCHA will be served as part of the block page, giving real users the ability to identify as a human. By solving the CAPTCHA, the user's score is then cleaned up and the user is allowed to continue normal use.
+
+```ruby
+params[:captcha_enabled] = false
+```
+
+<a name="captcha-provider"></a>**Select CAPTCHA Provider**
+
+The CAPTCHA part of the block page can use one of the following:
+* [reCAPTCHA](https://www.google.com/recaptcha)
+
+Default: 'reCaptcha'
+
+```ruby
+captchaProvider = "reCaptcha"
+```
+
+<a name="custom-uri"></a>**Custom URI**
+
+Default: 'REQUEST_URI'
+
+The URI can be returned to the PerimeterX module, using a custom user function, defined on the ``params`` variable
+
+```ruby
+params[:custom_uri] = -> (request) {
+  return request.headers['HTTP_X_CUSTOM_URI']
+}
+```
+
+<a name="sensitive-headers"></a>**Filter sensitive headers**
+A list of sensitive headers can be configured to prevent specific headers from being sent to PerimeterX servers (lower case header names). Filtering cookie headers for privacy is set by default, and can be overridden on the `params` variable.
+
+Default: cookie, cookies
+
+```ruby
+params[:sensitive_headers] = ['cookie', 'cookies', 'secret-header']
+
+```
+
+<a name="api-timeout"></a>**API Timeouts**
+>Note: Controls the timeouts for PerimeterX requests. The API is called when a Risk Cookie does not exist, or is expired or invalid
+
+The API Timeout, in seconds (int), to wait for the PerimeterX server API response.
+
+Default: 1
+
+```ruby
+params[:api_timeout] = 4
+```
+
+<a name="send-page-activities"></a>**Send Page Activities**
+Default: true
+A boolean flag to enable or disable sending of activities and metrics to PerimeterX on each page request. Enabling this feature will provide data that populates the PerimeterX portal with valuable information, such as the amount of requests blocked and additional API usage statistics.
+
+```ruby
+params[:send_page_activities] = false
+```
+
+<a name="additional-page-activity-handler"></a>**Additional Page Activity Handler**
+
+Adding an additional activity handler is done by setting `additional_activity_handler` with a user defined function on the `params` variable. The `additional_activity_handler` function will be executed before sending the data to the PerimeterX portal.
+
+Default: Only send activity to PerimeterX as controlled by `params`.
+
+
+
+```ruby
+params[:additional_activity_handler] = -> (activity_type, px_ctx, details){
+    // user defined logic comes here
+};
+```
+
+<a name="debug-mode"></a>**Debug Mode**
+Default: false
+
+Enables debug logging mode to STDOUT
+```ruby
+  params[:debug] = true
+```
+
+<a name="whitelist-routes"></a>**Whitelist Routes**
+Default: []
+An array of route prefixes and/or regular expressions that are always whitelisted and not validated by PerimeterX.
+A string value of a path will be treated as a prefix.
+A regexp value of a path will be treated as is.
+
+```ruby
+  params[:whitelist_routes] = ["/example", /\A\/example\z/]
+```
+
+<a name="contributing"></a># Contributing #
+------------------------------
+The following steps are welcome when contributing to our project.
+###Fork/Clone
+First and foremost, [Create a fork](https://guides.github.com/activities/forking/) of the repository, and clone it locally.
+Create a branch on your fork, preferably using a self descriptive branch name.
+
+###Code/Run
+Help improve our project by implementing missing features, adding capabilities or fixing bugs.
+
+To run the code, simply follow the steps in the [installation guide](#installation). Grab the keys from the PerimeterX Portal, and try refreshing your page several times continously. If no default behaviours have been overriden, you should see the PerimeterX block page. Solve the CAPTCHA to clean yourself and start fresh again.