geo_locale 0.2.0 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f0e323deff5492ea6d479dd332e31d047c5a46f
-  data.tar.gz: 6a243e05b9c4f5bd121a8d931f1174b48fffec1c
+  metadata.gz: 3674b3cd123677a6c74a5e9e6d8c59cf85f6fdcb
+  data.tar.gz: 8ea2adb1587b1b95c88d8182205b38f4656709d6
 SHA512:
-  metadata.gz: c9d8c58a6ab5ab076bfe581e24932998044f24c3d33810b618d3fa566d1611620013b25172aa455b109e9c42045a865a71f723c6a67cb5f30f2c90c9aa2678e7
-  data.tar.gz: 74e181e0d2ab3c9393ca0e1593b5c97d8d65643e15ed934cc875a098e535519c8976d475cf1d2c4b716cf1aad80fde3f786d4110f25ef4b810b280d98b4028a5
+  metadata.gz: dc991bf5ed9e30255a4896607254b89ab1a55f36d3bac0a8e6a221077cac7fa229a6136e94e4285994f76703ad465f86ff8e47f1a13f9e3702196585e708098e
+  data.tar.gz: 0722d6adc4567702cacd7f011018554829aa25736a86f161b2f2cfba200c97da9ff7fca025c910cc4842aaaec118aa0d00e5fe0e4ef69cdb6645b616805402f7

data/CHANGELOG.md

@@ -2,9 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Release candidate][ - - ]
-### Changed
--
+## [0.9.5] - 2016-05-06
+### Updated
+* API (can pass request_headers hash in addition to IP)
+### Added
+* Cloudflare support
 
 ## [0.2.0] - 2016-01-13
 ### Added

data/README.md

@@ -1,5 +1,5 @@
-# GeoLocale v0.2.0
-Simple wrapper for GeoIP gem with some redundancy on GeoKit to get a two-letter country code or locale from an IP address.
+# GeoLocale v0.9.5
+Simple wrapper for GeoIP gem with some redundancy on GeoKit to get a two-letter country code or locale from an IP and, (optionally) request headers if a service like cloudflare is used.
 
 ## Basic use-case
 Detect application user's origin and display app in that language.
@@ -11,7 +11,7 @@ Ruby 2.0.0 and greater.
 
 ```ruby
 # in Gemfile
-gem 'geo_locale' # and bundle
+gem 'geo_locale', '~> 0.9.5' # and bundle
 ```
 
 ## Usage
@@ -29,13 +29,13 @@ end
 
 ### To get country code:
 ```ruby
-GeoLocale.country_code(ip: request.remote_ip)
+GeoLocale.country_code(ip: request.remote_ip, request_headers: request.headers)
 # => "en"
 ```
 
 ### To get locale:
 ```ruby
-GeoLocale.locale(country_code: "gb")
+GeoLocale.locale(country_code: "gb", request_headers: request.headers)
 #=> "en"
 GeoLocale.locale(country_code: "gb", lcid: true)
 #=> "en-gb"

data/geo_locale.gemspec

@@ -22,13 +22,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.rubyforge_project = "geo_locale"
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'rspec', "~> 3.1.0"
-  spec.add_development_dependency 'pry'
-
   spec.add_dependency 'geoip'
   spec.add_dependency 'geokit'
   spec.add_dependency 'geokit-rails'
 
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.1.0"
+  spec.add_development_dependency 'pry'
 end

data/lib/geo_locale/country_code.rb

@@ -3,7 +3,12 @@ require 'timeout'
 module GeoLocale
   IP_REGEX = /\b(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/
 
-  def self.country_code(ip: "") # ip = "12.12.12.12"
+  def self.country_code(ip: "", request_headers: {}) # ip = "12.12.12.12"
+    if request_headers.present?
+      cloudflare_country_code = cloudflare_country_code(request_headers)
+      return cloudflare_country_code.downcase if cloudflare_country_code.present? && cloudflare_country_code != "XX"
+    end
+
     return GeoLocale.config.localhost_country if ip == GeoLocale::LOCALHOST_IP && GeoLocale.config.localhost_country.present?
     country_code = GeoLocale.geo_ip_try(ip)
     if country_code.present?
@@ -20,6 +25,9 @@ module GeoLocale
   end
 
   private
+    def self.cloudflare_country_code(request_headers)
+      request_headers["HTTP_CF_IPCOUNTRY"]
+    end
 
     def self.geo_ip_try(ip)
       begin

data/lib/geo_locale/locale.rb

@@ -1,7 +1,7 @@
 module GeoLocale
 
-  def self.locale (ip: "", country_code: nil, lcid: false)
-    country_code ||= GeoLocale.country_code(ip: ip)
+  def self.locale (ip: "", country_code: nil, lcid: false, request_headers: {})
+    country_code ||= GeoLocale.country_code(ip: ip, request_headers: request_headers)
     GeoLocale.get_locale_or_lcid(country_code: country_code, lcid: lcid)
   end
 

data/lib/geo_locale/version.rb

@@ -1,3 +1,3 @@
 module GeoLocale
-  VERSION = "0.2.0"
+  VERSION = "0.9.5"
 end

data/spec/spec_helper.rb

@@ -14,4 +14,61 @@ RSpec.configure do |config|
   IR_IPS =["77.104.75.76", "94.74.132.65"]
   IE_IPS =["54.170.245.171", "54.171.4.57", "176.34.86.253"]
   PL_IPS =["83.3.115.58", "109.207.54.81", "88.199.29.50"]
+
+  XX_CLOUDFLARE_REQUEST_HEADERS = {
+    "rack.version"=>[1, 3],
+    "rack.errors"=>"",
+    "rack.multithread"=>false,
+    "rack.multiprocess"=>false,
+    "rack.run_once"=>false,
+    "SCRIPT_NAME"=>"",
+    "QUERY_STRING"=>"pp=flamegraph",
+    "SERVER_PROTOCOL"=>"HTTP/1.1",
+    "SERVER_SOFTWARE"=>"2.13.4",
+    "GATEWAY_INTERFACE"=>"CGI/1.2",
+    "REQUEST_METHOD"=>"GET",
+    "REQUEST_PATH"=>"/lv/lv/p/k2/landing",
+    "REQUEST_URI"=>"/lv/lv/p/k2/landing?pp=flamegraph",
+    "HTTP_VERSION"=>"HTTP/1.1",
+    "HTTP_HOST"=>"localhost:3000",
+    "HTTP_USER_AGENT"=> "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:43.0) Gecko/20100101 Firefox/43.0",
+    "HTTP_ACCEPT"=> "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+    "HTTP_ACCEPT_LANGUAGE"=>"en-US,en;q=0.5",
+    "HTTP_ACCEPT_ENCODING"=>"gzip, deflate",
+    "HTTP_CONNECTION"=>"keep-alive",
+    "HTTP_CACHE_CONTROL"=>"max-age=0",
+    "SERVER_NAME"=>"localhost",
+    "SERVER_PORT"=>"3000",
+    "PATH_INFO"=>"/lv/lv/p/k2/landing",
+    "REMOTE_ADDR"=>"::1",
+    "puma.socket"=>"",
+    "rack.hijack?"=>true,
+    "rack.hijack"=>"",
+    "rack.input"=>"",
+    "rack.url_scheme"=>"http",
+    "rack.after_reply"=>[],
+    "ORIGINAL_FULLPATH"=>"/lv/lv/p/k2/landing?pp=flamegraph",
+    "ORIGINAL_SCRIPT_NAME"=>"",
+    "HTTP_CF_IPCOUNTRY"=>"XX"
+  }
+
+  LV_CLOUDFLARE_REQUEST_HEADERS = XX_CLOUDFLARE_REQUEST_HEADERS.clone
+  LT_CLOUDFLARE_REQUEST_HEADERS = XX_CLOUDFLARE_REQUEST_HEADERS.clone
+  EE_CLOUDFLARE_REQUEST_HEADERS = XX_CLOUDFLARE_REQUEST_HEADERS.clone
+  RU_CLOUDFLARE_REQUEST_HEADERS = XX_CLOUDFLARE_REQUEST_HEADERS.clone
+  US_CLOUDFLARE_REQUEST_HEADERS = XX_CLOUDFLARE_REQUEST_HEADERS.clone
+  GB_CLOUDFLARE_REQUEST_HEADERS = XX_CLOUDFLARE_REQUEST_HEADERS.clone
+  IR_CLOUDFLARE_REQUEST_HEADERS = XX_CLOUDFLARE_REQUEST_HEADERS.clone
+  IE_CLOUDFLARE_REQUEST_HEADERS = XX_CLOUDFLARE_REQUEST_HEADERS.clone
+  PL_CLOUDFLARE_REQUEST_HEADERS = XX_CLOUDFLARE_REQUEST_HEADERS.clone
+
+  LV_CLOUDFLARE_REQUEST_HEADERS["HTTP_CF_IPCOUNTRY"] = "LV"
+  LT_CLOUDFLARE_REQUEST_HEADERS["HTTP_CF_IPCOUNTRY"] = "LT"
+  EE_CLOUDFLARE_REQUEST_HEADERS["HTTP_CF_IPCOUNTRY"] = "EE"
+  RU_CLOUDFLARE_REQUEST_HEADERS["HTTP_CF_IPCOUNTRY"] = "RU"
+  US_CLOUDFLARE_REQUEST_HEADERS["HTTP_CF_IPCOUNTRY"] = "US"
+  GB_CLOUDFLARE_REQUEST_HEADERS["HTTP_CF_IPCOUNTRY"] = "GB"
+  IR_CLOUDFLARE_REQUEST_HEADERS["HTTP_CF_IPCOUNTRY"] = "IR"
+  IE_CLOUDFLARE_REQUEST_HEADERS["HTTP_CF_IPCOUNTRY"] = "IE"
+  PL_CLOUDFLARE_REQUEST_HEADERS["HTTP_CF_IPCOUNTRY"] = "PL"
 end

data/spec/tests/geolocation_spec.rb

@@ -19,6 +19,57 @@ describe "GeoLocale" do
     GeoLocale.configure {}
   end
 
+  describe ".country_code(ip: "", request_headers: {})" do
+    before :all do
+      @ip = "0.0.0.0"
+    end
+
+    context "when HTTP_CF_IPCOUNTRY is " do
+
+      it "LV should return lv" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: LV_CLOUDFLARE_REQUEST_HEADERS)).to eq "lv"
+      end
+
+      it "LT should return lt" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: LT_CLOUDFLARE_REQUEST_HEADERS)).to eq "lt"
+      end
+
+      it "EE should return ee" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: EE_CLOUDFLARE_REQUEST_HEADERS)).to eq "ee"
+      end
+
+      it "RU should return ru" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: RU_CLOUDFLARE_REQUEST_HEADERS)).to eq "ru"
+      end
+
+      it "US should return us" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: US_CLOUDFLARE_REQUEST_HEADERS)).to eq "us"
+      end
+
+      it "GB should return gb" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: GB_CLOUDFLARE_REQUEST_HEADERS)).to eq "gb"
+      end
+
+      it "IR should return ir" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: IR_CLOUDFLARE_REQUEST_HEADERS)).to eq "ir"
+      end
+
+      it "IE should return ie" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: IE_CLOUDFLARE_REQUEST_HEADERS)).to eq "ie"
+      end
+
+      it "PL should return pl" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: PL_CLOUDFLARE_REQUEST_HEADERS)).to eq "pl"
+      end
+
+      it "XX should return fallback to default_country" do
+        expect(GeoLocale.country_code(ip: @ip, request_headers: XX_CLOUDFLARE_REQUEST_HEADERS)).to eq "us"
+      end
+
+    end
+
+  end
+
   describe ".country_code(ip: "")" do
     it "should return lv for #{lv_ip}" do
       expect(GeoLocale.country_code(ip: lv_ip)).to eq "lv"

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: geo_locale
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.9.5
 platform: ruby
 authors:
 - Epigene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: geoip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,35 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: geokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: geokit-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -67,41 +67,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: geoip
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '10.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: geokit
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 3.1.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: geokit-rails
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements: