tracker_hub-request 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f9665a1b80b7c8db64b40ae258eea6b6872c100
+  data.tar.gz: 7f645fc08bf692b2f9ea759495401ea9c1db90fa
+SHA512:
+  metadata.gz: 0903a3b964a765540d1bbe24069a42ad9327efa9dea128d0db8248b10b63bf8902e98588d4f982d04737c8557e9cc1f9a73aa1167bf94ee67f410f6e8e1adc0b
+  data.tar.gz: de367b9ff0845498841c922a5ba62dd3657dcdad4b2e16a6ad01834a5627ee8dabf688aa7c1522424fb196597ebafc98a900bb3dfc7d0d49de412ebac8f3133b

data/.codeclimate.yml

@@ -0,0 +1,19 @@
+---
+engines:
+  reek:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - '**.rb'
+exclude_paths:
+- pkg/
+- spec/

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+/coverage/
+/rdoc/
+/.rvmrc

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.reek

@@ -0,0 +1,14 @@
+---
+TooManyStatements:
+  enabled: true
+  exclude:
+  - initialize
+  max_statements: 10
+
+Attribute:
+  exclude:
+    - TrackerHub::Request::Config
+
+# Directories below will not be scanned at all
+exclude_paths:
+  - spec

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 15

data/.travis.yml

@@ -0,0 +1,31 @@
+language: ruby
+sudo: false
+cache:
+  - bundler
+
+rvm:
+  - jruby-head
+  - rbx-2
+  - 2.0.0
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+
+addons:
+  code_climate:
+    repo_token: 54662312136af39c0814c981c7693a7baf17fbeb09e154806a08b97f467c9392
+
+before_install:
+  - gem install bundler
+
+before_script:
+  - bundle update
+
+script:
+  - bundle exec rake spec
+
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+## [1.0.1](https://github.com/SparkHub/gs-tracking-requests/tree/1.0.1) (2016-10-07)
+
+**Fixed bugs:**
+- Fix HipChat argument conflicts on #send_message ([mchaisse](https://github.com/mchaisse))
+
+
+## [1.0.0](https://github.com/SparkHub/gs-tracking-requests/tree/1.0.0) (2016-10-04)
+
+**Implemented enhancements:**
+- Initial version :tada: ([mchaisse](https://github.com/mchaisse))

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at maxime.chaisseleal@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tracker_hub-requests.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rubocop', require: false
+  gem 'brakeman', require: false
+  if RUBY_VERSION >= '2.1.0'
+    gem 'reek', require: false
+  else
+    gem 'reek', '~> 3.11', require: false
+  end
+end
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'codeclimate-test-reporter', require: false if RUBY_VERSION >= '2.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Maxime Chaisse-Leal
+
+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,77 @@
+[![Gem Version](https://badge.fury.io/rb/tracker_hub-request.svg)](http://badge.fury.io/rb/tracker_hub-request)
+[![Build Status](https://travis-ci.org/SparkHub/gs-tracking-requests.svg?branch=master)](https://travis-ci.org/SparkHub/gs-tracking-requests)
+[![Code Climate](https://codeclimate.com/github/SparkHub/gs-tracking-requests/badges/gpa.svg)](https://codeclimate.com/github/SparkHub/gs-tracking-requests)
+[![Test Coverage](https://codeclimate.com/github/SparkHub/gs-tracking-requests/badges/coverage.svg)](https://codeclimate.com/github/SparkHub/gs-tracking-requests/coverage)
+[![Dependency Status](https://gemnasium.com/SparkHub/gs-tracking-requests.svg)](https://gemnasium.com/SparkHub/gs-tracking-requests)
+[![Inline docs](http://inch-ci.org/github/SparkHub/gs-tracking-requests.svg)](http://inch-ci.org/github/SparkHub/gs-tracking-requests)
+
+# TrackerHub::Request
+
+Part of __TrackerHub__, __Request__ is a gem tracking every requests on the backend side. Some keys will be filtered and the request data will finally be saved into a logfile. This logfile will be automatically managed and rotated by the [logging](https://github.com/TwP/logging) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tracker_hub-request', git: 'git@github.com:SparkHub/gs-tracking-requests.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## Configuration _(optional)_
+
+In an initializer, you can configure the tracker:
+
+```ruby
+# ./config/initializers/request_tracker.rb
+TrackerHub::Request.setup do |config|
+  config.app_version   = '1.0'
+  config.required_keys = %w(my rack env keys to log)
+  config.logger        = ActiveSupport::Logger.new('requests.log')
+  config.notification  = TrackerHub::Request::Notification.new(TrackerHub::Request::Notification::HipChat.new('my_token', 'my_room', 'my_username'))
+end
+```
+
+__Note:__
+
+- __logger__
+
+Here you can define your own configured logger. The default logger is [logging](https://github.com/TwP/logging). Feel free to add your own, or use another gem!
+
+- __notification__
+
+If an error occure, it will be catched and a notification will be sent to the service of your choice. The list of available services are defined [here](https://github.com/SparkHub/gs-tracking-requests/tree/master/lib/tracker_hub/request/notification).
+
+## Usage
+
+Add the middleware to your environment:
+
+```ruby
+config.middleware.insert_after ActionDispatch::DebugExceptions, TrackerHub::Request::Middleware
+```
+
+Activate the TrackerHub by adding to your environment (or `.env`):
+
+    $ TRACKER=true
+
+Get your request logs:
+
+    $ tail -f ./log/tracker/requests.log
+
+## Running tests
+
+To run tests:
+
+    $ bundle exec rake spec
+
+## Contributing
+
+Bug reports and pull request are welcome on GitHub at https://github.com/SparkHub/gs-tracking-requests. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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 'tracking_hub/requests'
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tracker_hub/request.rb

@@ -0,0 +1,45 @@
+require 'logging'
+
+require_relative 'request/version'
+require_relative 'request/middleware'
+require_relative 'request/setup'
+
+module TrackerHub
+  # Format and log an incoming request
+  class Request
+    extend  Setup
+    include Format::Logger
+
+    private
+
+    # @return [Utils::Env] the rack environment object built from the response object
+    # @api private
+    attr_accessor :response
+
+    # @return [Integer] the request status (can be a Fixnum)
+    # @api private
+    attr_accessor :status
+
+    # @return [Hash] request header
+    # @api private
+    attr_accessor :request
+
+    # Instantiate a request tracker object
+    #
+    # @param [Utils::Env] env     Rack environement object (full response)
+    # @param [Integer]    status  Request status
+    # @param [Hash]       headers Request header
+    #
+    # @example
+    #   > status, headers, body = @app.call(env)
+    #   > new_env = Utils::Env.new(env)
+    #   > TrackerHub::Request.new(new_env, status, headers)
+    #
+    # @api private
+    def initialize(env, status, headers)
+      self.request  = headers
+      self.status   = status
+      self.response = env
+    end
+  end
+end

data/lib/tracker_hub/request/config.rb

@@ -0,0 +1,48 @@
+require_relative 'config/env_keys'
+require_relative 'config/logger'
+require_relative 'format/logger'
+require_relative 'notification'
+
+module TrackerHub
+  class Request
+    # TrackerHub::Request configuration object, can be setup in an initializer
+    class Config
+      # @return [undefined] logger object to log the request data with
+      # @api public
+      attr_accessor :logger
+
+      # @return [Array<String>] rack env keys to log
+      # @api public
+      attr_accessor :required_keys
+
+      # @return [TrackerHub::Request::Notification] service to send a
+      #   notification to if request log process fails
+      # @api public
+      attr_accessor :notification
+
+      # @return [String] version of the application logging the request data
+      # @api public
+      attr_accessor :app_version
+
+      private
+
+      # Instanciate a Config object with default values
+      #
+      # @todo Extract logger logic to be able to store data in another way
+      #   (ex: database)
+      #
+      # @return [TrackerHub::Request::Config]
+      #
+      # @example
+      #   > TrackerHub::Request::Config.new
+      #
+      # @api private
+      def initialize
+        self.app_version   = ''
+        self.logger        = Logger.default_config
+        self.required_keys = EnvKeys.default_config
+        self.notification  = Request::Notification.new
+      end
+    end
+  end
+end

data/lib/tracker_hub/request/config/env_keys.rb

@@ -0,0 +1,71 @@
+module TrackerHub
+  class Request
+    class Config
+      # Rack environment keys to log
+      module EnvKeys
+        class << self
+          # Rack env keys to extract and log
+          #
+          # @return [Array<String>]
+          #
+          # @example
+          #   > TrackerHub::Request::Config::EnvKeys.default_config
+          #
+          # @api public
+          def default_config
+            root_keys + rack_keys + action_dispatch_keys
+          end
+
+          private
+
+          # Request keys in the rack env
+          #
+          # @return [Array<String>]
+          #
+          # @api private
+          def root_keys
+            %w(GATEWAY_INTERFACE PATH_INFO QUERY_STRING REMOTE_ADDR REMOTE_HOST REQUEST_METHOD
+               REQUEST_URI SCRIPT_NAME SERVER_NAME SERVER_PORT SERVER_PROTOCOL SERVER_SOFTWARE
+               HTTP_HOST HTTP_CONNECTION HTTP_UPGRADE_INSECURE_REQUESTS HTTP_USER_AGENT HTTP_ACCEPT
+               HTTP_ACCEPT_ENCODING HTTP_ACCEPT_LANGUAGE HTTP_COOKIE HTTP_VERSION REQUEST_PATH
+               ORIGINAL_FULLPATH ORIGINAL_SCRIPT_NAME)
+          end
+
+          # Rack keys in the rack env
+          #
+          # @return [Array<String>]
+          #
+          # @api private
+          def rack_keys
+            %w(version multithread multiprocess run_once url_scheme hijack? hijack_io
+               timestamp request.query_string request.query_hash request.cookie_hash
+               request.cookie_string).map do |key|
+                 "rack.#{key}"
+               end
+          end
+
+          # Action dispatch keys in the rack env
+          #
+          # @return [Array<String>]
+          #
+          # @api private
+          def action_dispatch_keys
+            bases = %w(parameter_filter redirect_filter secret_token secret_key_base show_exceptions
+                       show_detailed_exceptions http_auth_salt signed_cookie_salt
+                       encrypted_cookie_salt encrypted_signed_cookie_salt cookies_serializer
+                       cookies_digest request_id).map do |key|
+                         "action_dispatch.#{key}"
+                       end
+
+            requests = %w(path_parameters content_type request_parameters query_parameters
+                          parameters formats unsigned_session_cookie).map do |key|
+                            "action_dispatch.request.#{key}"
+                          end
+
+            bases + requests
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tracker_hub/request/config/logger.rb

@@ -0,0 +1,103 @@
+module TrackerHub
+  class Request
+    class Config
+      # Default customizable configurations for normal/rolling logger
+      module Logger
+        ROLLING_PATTERN = '%Y-%m-%d-%H-%M-%S'.freeze
+        ROLLING_AGE     = 'daily'.freeze
+        ROLLING_SIZE    = 1.gigabyte.freeze
+        LOGGER_NAME     = 'requests'.freeze
+        LOGFILE_NAME    = "#{LOGGER_NAME}.log".freeze
+
+        class << self
+          # Template for the rolling logger configuration
+          #   Note: for additional options, please refer to:
+          #   http://www.rubydoc.info/gems/logging/Logging/Appenders/RollingFile:initialize
+          #
+          # @option args [String] :log_path ('/log') Path of the log file
+          # @option args [String] :logger_name ('requests') Name of the log file
+          # @option args [String] :logfile_pattern ('requests.log.%Y-%m-%d-%H-%M-%S')
+          #   Pattern to roll log files
+          # @option args [String|Integer] :age ('daily') The maximum age (in seconds)
+          #   of a log file before it is rolled.
+          # @option args [String] :size (1073741824) The maximum allowed size (in bytes)
+          #   of a log file before it is rolled.
+          # @return [Logging::Logger]
+          #
+          # @example
+          #   > options = { logger_name: 'my_logger' }
+          #   > logger = TrackerHub::Request::Config::Logger.rolling_logger(options)
+          #   > logger.info('log text')
+          #
+          # @api public
+          def rolling_logger(args = {})
+            options = extract_rolling_options(args)
+
+            build_rolling_logger(options)
+          end
+
+          # Default configuration for the logger
+          #
+          # @return [ActiveSupport::Logger]
+          #
+          # @example
+          #   > logger = TrackerHub::Request::Config::Logger.default_config
+          #   > logger.info('log text')
+          #
+          # @api public
+          def default_config
+            ::ActiveSupport::Logger.new(File.join(log_path, LOGFILE_NAME))
+          end
+
+          private
+
+          # Extract the given rolling logger arguments and merge with defaults
+          #
+          # @param  [Hash] args Options to configure the rolling logger
+          # @return [Hash]
+          #
+          # @api private
+          def extract_rolling_options(args)
+            {
+              log_path:        log_path,
+              logger_name:     LOGGER_NAME,
+              logfile_pattern: "#{LOGFILE_NAME}{{.#{ROLLING_PATTERN}}}",
+
+              age:             ROLLING_AGE,
+              size:            ROLLING_SIZE
+            }.merge(args)
+          end
+
+          # Build a rolling logger based on the given options
+          #
+          # @param  [Hash] options Options to configure the rolling logger
+          # @return [Logging]
+          #
+          # @api private
+          def build_rolling_logger(options)
+            logfile_path = File.join(options.delete(:log_path),
+                                     options.delete(:logfile_pattern))
+
+            logger  = Logging.logger.new(options.delete(:logger_name))
+            rolling = Logging::Appenders::RollingFile.new(logfile_path, options)
+            logger.add_appenders(rolling)
+
+            logger
+          end
+
+          # Get the current rails log path
+          #
+          # @return [String]
+          #
+          # @api private
+          #
+          # :nocov:
+          def log_path
+            Pathname.new(Rails.application.config.paths['log'].first).parent.to_s
+          end
+          # :nocov:
+        end
+      end
+    end
+  end
+end

data/lib/tracker_hub/request/format/logger.rb

@@ -0,0 +1,66 @@
+module TrackerHub
+  class Request
+    module Format
+      # Logger module formatting and rendering the request object
+      module Logger
+        # Format the response to the logger
+        #
+        # @return [JSON]
+        #
+        # @example
+        #   > status, headers, body = @app.call(env)
+        #   > track = TrackerHub::Request.new(env, status, headers)
+        #   > track.to_logger
+        #
+        # @api public
+        def to_logger
+          {
+            status:          status,
+            request:         request,
+            response:        cleaned_env,
+            app_version:     Request.config.app_version,
+            tracker_version: Request::VERSION
+          }.to_json
+        end
+
+        # Extract the rack env keys (see TrackerHub::Request::Config#required_keys)
+        #   and convert them
+        #
+        # @return [Utils::Env] cleaned rack env object
+        #
+        # @example
+        #   > status, headers, body = @app.call(env)
+        #   > track = TrackerHub::Request.new(env, status, headers)
+        #   > track.cleaned_env
+        #
+        # @api public
+        def cleaned_env
+          response.slice(*Request.config.required_keys).merge(serialized_env)
+        end
+
+        # Serialize objects before jsonifying them
+        #
+        # @return [Hash]
+        #
+        # @example
+        #   > status, headers, body = @app.call(env)
+        #   > track = TrackerHub::Request.new(env, status, headers)
+        #   > track.serialized_env
+        #
+        # @api public
+        #
+        # rubocop:disable AbcSize
+        def serialized_env
+          {
+            'action_dispatch.logger' => response['action_dispatch.logger'].formatter.session_info,
+            'action_dispatch.remote_ip'   => response['action_dispatch.remote_ip'].to_s,
+            'rack.session'                => response['rack.session'].try(:to_hash),
+            'rack.session.options'        => response['rack.session.options'].try(:to_hash),
+            'http_accept_language.parser' => response['http_accept_language.parser'].header
+          }
+        end
+        # rubocop:enable AbcSize
+      end
+    end
+  end
+end

data/lib/tracker_hub/request/middleware.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require_relative 'utils/env'
+require_relative 'utils/exception'
+
+module TrackerHub
+  class Request
+    # Middleware to include in a Rails stack to log every incoming requests
+    class Middleware
+      # Method called by the middleware stack to run the request tracker
+      #
+      # @param  [Hash]  env Rack env
+      # @return [Array]
+      #
+      # @api public
+      def call(env)
+        # execute application to get more data (injected into env)
+        status, headers, body = @app.call(env)
+        # save logs from env
+        track(env, status, headers)
+        # release the process to other middlewares
+        [status, headers, body]
+      end
+
+      private
+
+      # Instanciate the request tracker middleware
+      #
+      # @param  [undefined] app Previous middelware
+      # @return [undefined]
+      #
+      # @api private
+      def initialize(app)
+        @logger = ::TrackerHub::Request.config.logger
+        @app    = app
+      end
+
+      # Initiate the request tracker to store formated requests in a log file.
+      #   If an internal error occurs while logging the request, and if a
+      #   notification has been configured (see TrackerHub::Request::Notification),
+      #   then a notification is sent to the configured service
+      #
+      # @param  [Hash]      env     Rack env
+      # @param  [Integer]   status  HTTP request status
+      # @param  [Hash]      headers Header of the HTTP request
+      # @return [undefined]
+      #
+      # @example
+      #   > status, headers, body = @app.call(env)
+      #   > track(env, status, headers)
+      #
+      # @api private
+      def track(env, status, headers)
+        new_env = Utils::Env.new(env)
+        return unless new_env.trackable?
+
+        @logger.info ::TrackerHub::Request.new(new_env, status, headers).to_logger
+      rescue StandardError => exception
+        notifier = ::TrackerHub::Request.config.notification
+        Utils::Exception.new(exception).report(notifier)
+      end
+    end
+  end
+end

data/lib/tracker_hub/request/notification.rb

@@ -0,0 +1,95 @@
+require_relative 'notification/hip_chat'
+
+module TrackerHub
+  class Request
+    # Notify a configured service when an error occured during the request log process
+    class Notification
+      # Key to cache the timelapse between 2 notifications
+      KEY_CACHE = 'trackinghub_request_notification'.freeze
+
+      # @return [Object] the notification adapter
+      # @api public
+      attr_reader :notifier
+
+      # @return [Integer|ActiveSupport::Duration] timelapse between 2 notifications
+      # @api public
+      attr_reader :timelapse
+
+      # @return [Hash] notification and notifier options
+      # @api public
+      attr_reader :options
+
+      # Trigger a notification paused by a timelapse if specified
+      #
+      # @param  [String] message Notification's message
+      # @param  [Hash]   args    Notifier adapter's options (if there is any)
+      # @return [undefined]
+      #
+      # @example
+      #   > notifier = TrackerHub::Request::Notification::HipChat.new(token, 'room', 'username')
+      #   > options = { timelapse: 10.minutes }
+      #   > notification = TrackerHub::Request::Notification.new(notifier, options)
+      #   > notification.notify('my message')
+      #
+      # @api public
+      def notify(message, args = {})
+        timelapser do
+          notifier.send_message(message, options.merge(args))
+        end
+      rescue
+        false
+      end
+
+      private
+
+      # @return [Object] the notification adapter
+      # @api private
+      attr_writer :notifier
+
+      # @return [Integer|ActiveSupport::Duration] timelapse between 2 notifications
+      # @api private
+      attr_writer :timelapse
+
+      # @return [Hash] notification and notifier options
+      # @api private
+      attr_writer :options
+
+      # Instantiate a notification object to add the ability to send a notification
+      #   to any service adapter (see in request/notification). If a timelapse is
+      #   given in parameter, there will be a pause between 2 notifications.
+      #   Please checkout the available adapters for more :args: options
+      #
+      # @param       [Object]  notifier   The notification adapter
+      # @option args [Integer] :timelapse Time between 2 notifications
+      #
+      # @example
+      #   > notifier = TrackerHub::Request::Notification::HipChat.new(token, 'room', 'username')
+      #   > options = { timelapse: 10.minutes }
+      #   > TrackerHub::Request::Notification.new(notifier, options)
+      #
+      # @api private
+      def initialize(notifier = nil, args = {})
+        defaults = {
+          notify: true
+        }
+
+        self.notifier  = notifier
+        self.timelapse = args.delete(:timelapse)
+        self.options   = defaults.merge(args)
+      end
+
+      # Execute an action in a timelapse
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def timelapser
+        return yield unless timelapse
+
+        Rails.cache.fetch(KEY_CACHE, expires_in: timelapse) do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/tracker_hub/request/notification/hip_chat.rb

@@ -0,0 +1,68 @@
+module TrackerHub
+  class Request
+    class Notification
+      # Service to send notifications to when an error occured during the log process
+      class HipChat
+        # HipChat API version to call by default
+        API_VERSION = 'v2'.freeze
+
+        # Send a notification message
+        #
+        # @param  [String] msg  Message to send
+        # @param  [Hash]   args See more options at
+        #                         https://www.hipchat.com/docs/apiv2/method/send_room_notification
+        # @return [Boolean]
+        #
+        # @example
+        #   > notifier = TrackerHub::Request::Notification::HipChat.new(token, 'room', 'username')
+        #   > notifier.send_message('my message')
+        #
+        # @api public
+        def send_message(msg, args = {})
+          client[room].send(username, msg, options.merge(args))
+        end
+
+        private
+
+        # @return [HipChat::Client] the hipchat client
+        # @api private
+        attr_accessor :client
+
+        # @return [String] user's name sending the message
+        # @api private
+        attr_accessor :username
+
+        # @return [String] room's name to send the message to
+        # @api private
+        attr_accessor :room
+
+        # @return [Hash] hipchat send method options
+        # @api private
+        attr_accessor :options
+
+        # Instantiate a HipChat notifier. For more options, please checkout
+        #   https://www.hipchat.com/docs/apiv2/method/send_room_notification
+        #
+        # @param  [String] token API key to talk with hipchat services
+        # @param  [String] room  Room's name to send the message
+        # @param  [String] username User's name sending the message
+        # @option options [String] :api_version Version of the hipchat API
+        # @return [TrackerHub::Request::Notification::HipChat]
+        #
+        # @example
+        #   > TrackerHub::Request::Notification::HipChat.new(token, 'room', 'username')
+        #
+        # @api private
+        def initialize(token, room, username, options = {})
+          api_version = options.delete(:api_version) || API_VERSION
+
+          self.room     = room
+          self.username = username
+          self.options  = options
+
+          self.client = ::HipChat::Client.new(token, api_version: api_version)
+        end
+      end
+    end
+  end
+end

data/lib/tracker_hub/request/setup.rb

@@ -0,0 +1,47 @@
+require_relative 'config'
+
+module TrackerHub
+  class Request
+    # Configure the request tracker
+    module Setup
+      # Get the current configuration, instantiate a new object if nil
+      #   Note: each attribute can also be written through the config object
+      #
+      # @return [TrackerHub::Request::Config] configuration object
+      #
+      # @example
+      #   > # get the current configuration
+      #   > TrackerHub::Request.config
+      #   > => #<TrackerHub::Request::Config:0x007fa574ad7390 ...>
+      #   >
+      #   > # set a specific value in the config
+      #   > TrackerHub::Request.config.app_version = '4.2'
+      #
+      # @api public
+      def config
+        @config ||= self::Config.new
+      end
+
+      # Setup configuration in block
+      #
+      # @yield (see TrackerHub::Request::Config#initialize)
+      # @return [TrackerHub::Request::Config]
+      #
+      # @example
+      #   > TrackerHub::Request.setup do |config|
+      #   >   config.app_version = '4.2'
+      #   > end
+      #
+      # @api public
+      def setup
+        yield(config)
+      end
+
+      private
+
+      # @return [TrackerHub::Request::Config] the tracking request configuration
+      # @api private
+      attr_writer :config
+    end
+  end
+end

data/lib/tracker_hub/request/utils/env.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module TrackerHub
+  class Request
+    module Utils
+      # SimpleDelegator wrapping class for rack environment
+      class Env < SimpleDelegator
+        # Should the request tracker log the current request
+        #
+        # @return [Boolean] true if should track the current request,
+        #                     false if should not track the current request
+        #
+        # @example
+        #   > new_env = Utils::Env.new(env)
+        #   > new_env.trackable?
+        #
+        # @api public
+        def trackable?
+          '/assets' != self['SCRIPT_NAME']
+        end
+      end
+    end
+  end
+end

data/lib/tracker_hub/request/utils/exception.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module TrackerHub
+  class Request
+    module Utils
+      # SimpleDelegator wrapping class for exceptions
+      class Exception < SimpleDelegator
+        # Send a report of the exception with a given notification
+        #
+        # @param  [TrackerHub::Request::Notification] notification See in request/notification
+        #   for a full list of available notifiers
+        # @param  [undefined] framework Used framework to retreive the rack environment
+        # @return [Boolean]
+        #
+        # @example
+        #   > notifier = TrackerHub::Request::Notification::HipChat.new(token, 'room', 'username')
+        #   > notification = TrackerHub::Request::Notification.new(notifier)
+        #   > new_exception = Utils::Exception.new(exception)
+        #   > new_exception.report(notification)
+        #
+        # @api public
+        def report(notification, framework = Rails)
+          formatted_backtrace = backtrace.join("\n")
+          msg                 = "[#{framework.env}]\n#{message}\n#{formatted_backtrace}"
+          notification.notify(msg)
+        end
+      end
+    end
+  end
+end

data/lib/tracker_hub/request/version.rb

@@ -0,0 +1,5 @@
+module TrackerHub
+  class Request
+    VERSION = '1.0.1'.freeze
+  end
+end

data/tracker_hub-request.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tracker_hub/request/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tracker_hub-request'
+  spec.version       = TrackerHub::Request::VERSION
+  spec.authors       = ['Maxime Chaisse-Leal']
+  spec.email         = ['maxime.chaisseleal@gmail.com']
+
+  spec.summary       = 'Track all the incoming requests and store them in log files.'
+  spec.description   = 'Track all the incoming requests and store them in log files.'
+  spec.homepage      = 'https://github.com/SparkHub/gs-tracking-request'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'logging', '~> 2.1'
+  spec.add_dependency 'hipchat', '~> 1.5'
+
+  if RUBY_VERSION >= '2.2.2'
+    spec.add_dependency 'activesupport'
+  else
+    spec.add_dependency 'activesupport', '< 5'
+  end
+
+  spec.add_development_dependency 'bundler',   '~> 1.13'
+  spec.add_development_dependency 'rake',      '~> 11.3'
+  spec.add_development_dependency 'rspec',     '~> 3.0'
+
+  if RUBY_VERSION >= '2.2.2'
+    spec.add_development_dependency 'rack'
+  else
+    spec.add_development_dependency 'rack', '~> 1.6'
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: tracker_hub-request
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Maxime Chaisse-Leal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: Track all the incoming requests and store them in log files.
+email:
+- maxime.chaisseleal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".reek"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tracker_hub/request.rb
+- lib/tracker_hub/request/config.rb
+- lib/tracker_hub/request/config/env_keys.rb
+- lib/tracker_hub/request/config/logger.rb
+- lib/tracker_hub/request/format/logger.rb
+- lib/tracker_hub/request/middleware.rb
+- lib/tracker_hub/request/notification.rb
+- lib/tracker_hub/request/notification/hip_chat.rb
+- lib/tracker_hub/request/setup.rb
+- lib/tracker_hub/request/utils/env.rb
+- lib/tracker_hub/request/utils/exception.rb
+- lib/tracker_hub/request/version.rb
+- tracker_hub-request.gemspec
+homepage: https://github.com/SparkHub/gs-tracking-request
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Track all the incoming requests and store them in log files.
+test_files: []