request_info 0.3.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "request_info"
+
+# 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/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/gemfiles/Rails-4.1.gemfile

@@ -0,0 +1,4 @@
+eval File.read "gemfiles/common.gemfile" # rubocop:disable Security/Eval
+
+gem "rails", "~> 4.1.0"
+gem "maxmind_geoip2"

data/gemfiles/Rails-4.2.gemfile

@@ -0,0 +1,4 @@
+eval File.read "gemfiles/common.gemfile" # rubocop:disable Security/Eval
+
+gem "rails", "~> 4.2.0"
+gem "maxmind_geoip2"

data/gemfiles/Rails-5.0.gemfile

@@ -0,0 +1,4 @@
+eval File.read "gemfiles/common.gemfile" # rubocop:disable Security/Eval
+
+gem "rails", "~> 5.0.0"
+gem "maxmind_geoip2"

data/gemfiles/Rails-5.1.gemfile

@@ -0,0 +1,4 @@
+eval File.read "gemfiles/common.gemfile" # rubocop:disable Security/Eval
+
+gem "rails", "~> 5.1.0"
+gem "maxmind_geoip2"

data/gemfiles/Rails-head.gemfile

@@ -0,0 +1,4 @@
+eval File.read "gemfiles/common.gemfile" # rubocop:disable Security/Eval
+
+gem "rails", github: "rails/rails"
+gem "maxmind_geoip2"

data/gemfiles/common.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "codecov", require: false
+gem "simplecov", require: false

data/lib/request_info.rb

@@ -0,0 +1,47 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "request_info/version"
+
+require "request_info/configuration"
+require "request_info/detector_app"
+require "request_info/env_analyzer"
+require "request_info/results"
+
+# Optionally use railtie if Rails is available
+require "request_info/railtie" if defined?(Rails)
+
+module RequestInfo
+  CONFIGURATION_MUTEX = Mutex.new
+
+  class << self
+    # Get detection results
+    def results
+      Thread.current[:request_info_results] ||=
+        RequestInfo::Results.new
+    end
+
+    # Set results
+    def results=(value)
+      Thread.current[:request_info_results] = value
+    end
+
+    def configure
+      CONFIGURATION_MUTEX.synchronize do
+        @mutable_configuration ||= Configuration.new
+        yield @mutable_configuration if block_given?
+        @configuration = @mutable_configuration.dup.tap(&:freeze)
+      end
+      nil
+    end
+
+    def configuration
+      configure if @configuration.nil?
+      @configuration
+    end
+
+    def preload
+      GeoIP.instance
+    end
+  end
+end

data/lib/request_info/configuration.rb

@@ -0,0 +1,18 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+module RequestInfo
+  class Configuration
+    attr_accessor :geoip2_db_path
+
+    def initialize
+      set_defaults
+    end
+
+    private
+
+    def set_defaults
+      self.geoip2_db_path = nil
+    end
+  end
+end

data/lib/request_info/detector_app.rb

@@ -0,0 +1,39 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "request_info/detectors/browser_detector"
+require "request_info/detectors/ip_detector"
+require "request_info/detectors/timezone_detector"
+require "request_info/detectors/locale_detector"
+
+module RequestInfo
+  # Rack middleware to process all specified detectors and sets results for the
+  # current thread
+  class DetectorApp
+    class << self
+      attr_accessor :detectors
+    end
+
+    attr_reader :analyzer, :app
+
+    # TODO: make this list of detectors available for others to add/change
+    DEFAULT_DETECTORS = [
+      RequestInfo::Detectors::IpDetector,
+      RequestInfo::Detectors::BrowserDetector,
+      RequestInfo::Detectors::TimezoneDetector,
+      RequestInfo::Detectors::LocaleDetector,
+    ].freeze
+
+    def initialize(app)
+      @app = app
+      @analyzer = EnvAnalyzer.new(self.class.detectors || DEFAULT_DETECTORS)
+    end
+
+    def call(env)
+      analyzer.analyze(env)
+      analyzer.wrap_app do
+        app.call(env)
+      end
+    end
+  end
+end

data/lib/request_info/detectors/browser_detector.rb

@@ -0,0 +1,23 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "browser/browser"
+
+module RequestInfo
+  module Detectors
+    module BrowserDetector
+      def analyze(env)
+        super
+        RequestInfo.results.browser = detect_browser(env)
+      end
+
+      private
+
+      def detect_browser(env)
+        ua = env["HTTP_USER_AGENT"]
+        lang = env["HTTP_ACCEPT_LANGUAGE"]
+        Browser.new(ua, accept_language: lang)
+      end
+    end
+  end
+end

data/lib/request_info/detectors/ip_detector.rb

@@ -0,0 +1,52 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "request_info/geoip"
+
+# Detects IP related information
+module RequestInfo
+  module Detectors
+    # TODO Write some notes on configuration & security in README.
+    module IpDetector
+      def analyze(env)
+        super
+
+        results = RequestInfo.results
+        ip = request_ip(env)
+
+        results.ip = ip
+        results.ipinfo = RequestInfo::GeoIP.instance.lookup(ip)
+      end
+
+      private
+
+      # Extracts the IP address from env
+      #
+      def request_ip(env)
+        obtain_ip_from_rails(env) || obtain_ip_from_rack(env)
+      end
+
+      # Obtain client's IP address from +ActionDispatch::RemoteIp+ middleware
+      # provided by Rails.
+      #
+      # This is preferred over using +Rack::Request+ because
+      # +ActionDispatch::RemoteIp+ middleware must be enabled purposely, and
+      # is more customizable (proxies whitelisting is customizable).
+      #
+      # Please read security notes before enabling +ActionDispatch::RemoteIp+
+      # middleware in your application.  It may do harm if used incorrectly:
+      # http://api.rubyonrails.org/classes/ActionDispatch/RemoteIp.html
+      def obtain_ip_from_rails(env)
+        env["action_dispatch.remote_ip"].try(:to_s)
+      end
+
+      # Obtain client's IP address from +Rack::Request+.  May return proxy
+      # address if it adds a non-private IP address to +X-Forwarded-For+ header.
+      #
+      # https://github.com/rack/rack/blob/d1363a66ab217/lib/rack/request.rb#L420
+      def obtain_ip_from_rack(env)
+        Rack::Request.new(env).ip
+      end
+    end
+  end
+end

data/lib/request_info/detectors/locale_detector.rb

@@ -0,0 +1,74 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "country_to_locales_mapping"
+require "i18n"
+
+module RequestInfo
+  module Detectors
+    module LocaleDetector
+      def analyze(env)
+        super
+        RequestInfo.results.locale = detect_locale
+      end
+
+      def wrap_app
+        detected_locale = RequestInfo.results.locale
+        previous_locale = ::I18n.locale
+        ::I18n.locale = detected_locale
+
+        status, headers, body = super
+
+        # Set header language back to the client
+        headers["Content-Language"] = RequestInfo.results.locale
+
+        # Reset our modifications after app is finished
+        ::I18n.locale = previous_locale
+
+        [status, headers, body]
+      end
+
+      private
+
+      def detect_locale
+        available_locales = ::I18n.available_locales.map(&:to_s)
+        user_preference.detect { |l| available_locales.include?(l) }
+      end
+
+      # Returns enumerator which yields locales which are preferred by user,
+      # starting with the best matching one.  The user preference is defined as
+      # concatenation of locales in Accept-Language HTTP header (already sorted
+      # according to respective weights), locales matching the user's location
+      # (guessed from the IP address), and finally the application's default
+      # locale.
+      #
+      # It is not guaranteed that these locales are available in I18n.
+      def user_preference
+        Enumerator.new do |y|
+          browser_locales.each { |l| y << l }
+          ip_locales.each { |l| y << l }
+          y << default_locale
+        end
+      end
+
+      # Locales preferred by user according to Accept-Language HTTP header.
+      def browser_locales
+        locales_arr = RequestInfo.results.browser.try(:accept_language) || []
+        locales_arr.flat_map { |l| [l.full, l.code] }
+      end
+
+      # Guessing of locales preferred by user basing on his location.
+      def ip_locales
+        ipinfo = RequestInfo.results.ipinfo || {}
+        country_code = ipinfo["country_code"]
+        return [] unless country_code
+        locales = CountryToLocalesMapping.country_code_locales(country_code)
+        locales + locales.map { |l| l.split(/\W/, 2).first }
+      end
+
+      def default_locale
+        ::I18n.default_locale.to_s
+      end
+    end
+  end
+end

data/lib/request_info/detectors/timezone_detector.rb

@@ -0,0 +1,48 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "active_support/time"
+
+module RequestInfo
+  module Detectors
+    # Detects Timezone related information
+    module TimezoneDetector
+      def analyze(_env)
+        super
+
+        results = RequestInfo.results
+        tzinfo_id, tzinfo = get_tzinfo_from_ipinfo(results.ipinfo)
+        return unless tzinfo_id && tzinfo
+
+        results.timezone = tzinfo
+        results.timezone_id = tzinfo_id
+        results.timezone_offset = calculate_utc_offset(tzinfo)
+        results.timezone_desc = tz_description(tzinfo)
+      end
+
+      private
+
+      # Return time zone identifier and object basing on what has been found by
+      # GeoIP.
+      def get_tzinfo_from_ipinfo(ipinfo)
+        tzinfo_id = ipinfo && ipinfo["time_zone"]
+        tzinfo = tzinfo_id && TZInfo::Timezone.get(tzinfo_id)
+        tzinfo ? [tzinfo_id, tzinfo] : nil
+      rescue TZInfo::InvalidTimezoneIdentifier
+        nil
+      end
+
+      # Total offset is UTC + DST
+      def calculate_utc_offset(tzinfo)
+        tzinfo.current_period.utc_total_offset / 3600.0
+      end
+
+      # TODO: i18n this
+      def tz_description(tzinfo)
+        offset = calculate_utc_offset(tzinfo)
+        offset_string = "#{offset > 0 ? '+' : ''}#{offset}"
+        "GMT(#{offset_string}) #{tzinfo.friendly_identifier}"
+      end
+    end
+  end
+end

data/lib/request_info/env_analyzer.rb

@@ -0,0 +1,18 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+module RequestInfo
+  class EnvAnalyzer
+    def initialize(detectors)
+      detectors.each { |d| extend(d) }
+    end
+
+    def analyze(_env)
+      RequestInfo.results = RequestInfo::Results.new
+    end
+
+    def wrap_app
+      yield
+    end
+  end
+end