request_info 0.3.0

data/lib/request_info/geoip.rb

@@ -0,0 +1,51 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "maxmind_geoip2"
+require "singleton"
+
+module RequestInfo
+  # Brigdes MaxmindGeoIP2.
+  #
+  # Examples:
+  # RequestInfo::GeoIP.instance.lookup('116.49.226.82')
+  # RequestInfo::GeoIP.instance.lookup('24.24.24.24')
+
+  class GeoIP
+    include Singleton
+
+    attr_accessor :database
+
+    # Sets up the GeoIPCity database for upcoming queries
+    def initialize
+      unless geoip2_db_path.nil?
+        ensure_maxmind_geoip2_availability
+        self.database = setup_database
+      end
+    end
+
+    def setup_database
+      MaxmindGeoIP2.file(geoip2_db_path)
+      MaxmindGeoIP2.locale("en")
+      MaxmindGeoIP2
+    end
+
+    # Looks up the specified IP address (string) and returns information about
+    # the IP address.
+    def lookup(ip)
+      return nil if database.nil? || ip.blank?
+      database.locate(ip)
+    end
+
+    def geoip2_db_path
+      RequestInfo.configuration.geoip2_db_path
+    end
+
+    def ensure_maxmind_geoip2_availability
+      MaxmindGeoIP2
+    rescue LoadError
+      raise "RequestInfo requires maxmind_geoip2 gem for GeoIP2 database " +
+        "lookup. Refer to README for configuration details."
+    end
+  end
+end

data/lib/request_info/railtie.rb

@@ -0,0 +1,24 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "request_info/detector_app"
+require "request_info/geoip"
+require "rails/railtie"
+
+module RequestInfo
+  class Railtie < ::Rails::Railtie
+    # config.before_initialize do
+    # end
+
+    # Insert DetectorApp middleware
+    initializer :setup_request_info, group: :all do |app|
+      app.config.middleware.use RequestInfo::DetectorApp
+    end
+
+    # Preload databases after initialization since initializers may modify
+    # geoip2_db_path
+    config.after_initialize do
+      RequestInfo.preload
+    end
+  end
+end

data/lib/request_info/results.rb

@@ -0,0 +1,10 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+require "ostruct"
+
+# Use an OpenStruct to simplify results setting and handling
+module RequestInfo
+  class Results < OpenStruct
+  end
+end

data/lib/request_info/version.rb

@@ -0,0 +1,6 @@
+# (c) Copyright 2017 Ribose Inc.
+#
+
+module RequestInfo
+  VERSION = "0.3.0".freeze
+end

data/request_info.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "request_info/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "request_info"
+  spec.version       = RequestInfo::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Detect request IP, timezone and locale information with ease"
+  spec.homepage      = "https://github.com/riboseinc/request_info"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|geolitedb)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.has_rdoc              = true
+  spec.required_ruby_version = ">= 2.2.0"
+
+  spec.add_dependency("browser")
+  spec.add_dependency("country_to_locales_mapping", "~> 0.1")
+  spec.add_dependency("i18n")
+  spec.add_dependency("rails", ">= 4.1")
+  spec.add_dependency("tzinfo")
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", "~> 0.8"
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: request_info
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: browser
+  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: country_to_locales_mapping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.ribose.yml"
+- ".rubocop.tb.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- bin/bundle
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- gemfiles/Rails-4.1.gemfile
+- gemfiles/Rails-4.2.gemfile
+- gemfiles/Rails-5.0.gemfile
+- gemfiles/Rails-5.1.gemfile
+- gemfiles/Rails-head.gemfile
+- gemfiles/common.gemfile
+- lib/request_info.rb
+- lib/request_info/configuration.rb
+- lib/request_info/detector_app.rb
+- lib/request_info/detectors/browser_detector.rb
+- lib/request_info/detectors/ip_detector.rb
+- lib/request_info/detectors/locale_detector.rb
+- lib/request_info/detectors/timezone_detector.rb
+- lib/request_info/env_analyzer.rb
+- lib/request_info/geoip.rb
+- lib/request_info/railtie.rb
+- lib/request_info/results.rb
+- lib/request_info/version.rb
+- request_info.gemspec
+homepage: https://github.com/riboseinc/request_info
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Detect request IP, timezone and locale information with ease
+test_files: []