request_info 0.3.0

data/.rubocop.yml

@@ -0,0 +1,15 @@
+# This project follows the Ribose OSS style guide.
+# https://github.com/riboseinc/oss-guides
+# All project-specific additions and overrides should be specified in this file.
+
+inherit_from:
+  # Thoughtbot's style guide from: https://github.com/thoughtbot/guides
+  - ".rubocop.tb.yml"
+  # Overrides from Ribose
+  - ".rubocop.ribose.yml"
+AllCops:
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.2
+Rails:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,45 @@
+dist: trusty
+sudo: required
+language: ruby
+
+addons:
+  apt:
+    sources:
+      - sourceline: ppa:maxmind/ppa
+    packages:
+      - libmaxminddb0
+      - libmaxminddb-dev
+      - mmdb-bin
+
+cache:
+  - bundler
+
+before_install:
+  - gem install bundler -v 1.16.1
+
+rvm:
+  - "2.2"
+  - "2.3"
+  - "2.4"
+  - "2.5"
+  - "ruby-head"
+
+gemfile:
+  - "gemfiles/Rails-5.1.gemfile"
+
+matrix:
+  include:
+    - rvm: "2.5"
+      gemfile: "gemfiles/Rails-5.0.gemfile"
+    - rvm: "2.3"
+      gemfile: "gemfiles/Rails-4.2.gemfile"
+    - rvm: "2.3"
+      gemfile: "gemfiles/Rails-4.1.gemfile"
+    - rvm: "2.5"
+      gemfile: "gemfiles/Rails-head.gemfile"
+    - rvm: "2.5"
+      env: DISABLE_GEOIP2=1
+
+  allow_failures:
+    - rvm: "ruby-head"
+    - gemfile: "gemfiles/Rails-head.gemfile"

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 jeffrey.lau@ribose.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,6 @@
+source "https://rubygems.org"
+# Specify your gem's dependencies in request_info.gemspec
+gemspec
+
+gem "maxmind_geoip2"
+gem "simplecov", require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ribose Inc.
+
+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.adoc

@@ -0,0 +1,178 @@
+= request_info
+:source-highlighter: pygments
+
+image:https://img.shields.io/gem/v/request_info.svg["Gem Version", link="https://rubygems.org/gems/request_info"]
+image:https://img.shields.io/travis/riboseinc/request_info/master.svg["Build Status", link="https://travis-ci.org/riboseinc/request_info"]
+image:https://img.shields.io/codecov/c/github/riboseinc/request_info.svg["Test Coverage", link="https://codecov.io/gh/riboseinc/request_info"]
+image:https://img.shields.io/codeclimate/github/riboseinc/request_info.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/request_info"]
+
+Request Info is a Rack middleware which analyzes client's IP address and HTTP
+headers in order to provide detailed information about that client,
+particularly:
+
+- IP address
+- approximated location (basing on IP)
+- time zone (basing on location)
+- preferred locale (basing on `Accept-Language` header and location)
+
+== Usage
+
+=== Installation
+
+Then add this line to your application's `Gemfile`:
+
+[source,ruby]
+----
+gem 'request_info', github: 'riboseinc/request_info'
+----
+
+And then execute:
+
+----
+bundle
+----
+
+Or install it yourself as:
+
+----
+gem install request_info
+----
+
+=== Getting started
+
+Simply set up a middleware in `config/application.rb` like that:
+
+[source,ruby]
+----
+Rails.application.configure do
+  config.middleware.use RequestInfo::DetectorApp
+end
+----
+
+If you have `ActionDispatch::RemoteIp` in your middleware stack, then the
+`RequestInfo::DetectorApp` should be inserted after it.  Please do not add
+`ActionDispatch::RemoteIp` to your middleware stack without considering
+potential security issues described in
+http://api.rubyonrails.org/classes/ActionDispatch/RemoteIp.html[Rails documentation].
+
+Read more about configuring the middleware stack in
+http://guides.rubyonrails.org/rails_on_rack.html[Rails Guides].
+
+Detection results are saved as fiber-local variable which can be conveniently
+accessed later via `RequestInfo.results` method:
+
+[source,ruby]
+----
+RequestInfo.results.class # => RequestInfo::Results
+RequestInfo.results.ip # => "192.0.2.27"
+RequestInfo.results.timezone # => #<TZInfo::DataTimezone: Asia/Hong_Kong>
+----
+
+=== IP geolocalization
+
+This gem can use MaxMind IP intelligence databases for IP address
+geolocalization.  It is optional, but several detections rely on it.
+
+1. Make sure that `libmaxminddb` is available.  You'll find detailed
+instructions https://github.com/maxmind/libmaxminddb[here].
+
+2. Add https://rubygems.org/gems/maxmind_geoip2[`maxmind_geoip2`] gem to your
+Gemfile.
+
+3. Download a City or Country database in binary format from
+https://dev.maxmind.com/geoip[Maxmind].  Both free of charge GeoLite2, and more
+detailed but paid GeoIP2 databases will work.
+
+4. Configure database path
++
+[source,ruby]
+----
+RequestInfo.configure do |config|
+  config.geoip2_db_path = "path/to/downloaded/mmdb/database"
+end
+----
+
+=== Detections
+
+As mentioned above, analysis results are accessible via `RequestInfo.results`
+method.  The object returned by this method responds to following getters:
+
+[cols="1,3" options="header"]
+|===============================================================================
+| Field
+| Description
+
+2+^h| Browser detections
+
+| `browser`
+| A `Browser` object which holds details about user agent.  See `browser` gem
+https://github.com/fnando/browser[documentation] for more details.
+
+2+^h| IP detections
+
+| `ip`
+| Client's remote IP address which is obtained either from
+http://api.rubyonrails.org/classes/ActionDispatch/RemoteIp.html[`ActionDispatch::RemoteIp`]
+middleware (if available), or
+http://www.rubydoc.info/gems/rack/Rack/Request/Helpers#ip-instance_method[`Rack::Request`]
+object (otherwise).
+
+| `ipinfo`
+| A hash with detailed information about user location which is guessed by
+looking at client's IP address (requires GeoIP2 or GeoLite2).
+
+2+^h| Locale detections
+
+| `locale`
+| Best-matching locale from available ones.  First `Accept-Language` header is
+checked, then locales popular in client's country (according to IP address,
+requires GeoIP2 or GeoLite2).  If neither matching locale is available,
+then the default one is used.
+
+2+^h| Time zone detections
+
+| `timezone`
+| An instance of `TZInfo::Timezone` respective to detected time zone (requires
+GeoIP2 or GeoLite2).
+
+| `timezone_id`
+| An identifier of detected time zone, e.g. `"Europe/Warsaw"` (requires GeoIP2
+or GeoLite2).
+
+| `timezone_offset`
+| Detected time zone offset as a floating point number, e.g. `1.0`.  In other
+words, how many hours UTC is behind the detected time zone (requires GeoIP2 or
+GeoLite2).
+
+| `timezone_desc`
+| Human-readable time zone description, e.g. `"GMT(+1.0) Europe - Warsaw"`
+(requires GeoIP2 or GeoLite2).
+
+|===============================================================================
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+You will need to have gem libmaxminddb installed in your machine before running 'bin/setup'.
+If you do not have it setup please follow the steps outlined in this gist
+https://gist.github.com/leonardteo/9a128bc8ca983fa728aa08d8209e714a, as as homebrew install
+will not work.
+
+=== Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/riboseinc/request_info. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the http://contributor-covenant.org[Contributor Covenant] code of
+conduct.
+
+== License
+
+The gem is available as open source under the terms of the
+http://opensource.org/licenses/MIT[MIT License].
+
+This repository contains a copy of GeoLite2 City database created by Maxmind,
+and licensed on https://creativecommons.org/licenses/by-sa/4.0[CC BY-SA 4.0].

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec # rubocop:disable Style/HashSyntax

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end