world-flags 0.4.5 → 0.4.7

data/Gemfile

@@ -14,6 +14,6 @@ group :development do
 end
 
 group :test do
-	gem 'httparty'
+	gem 'geoip'
 	gem 'rails', '>= 3.1'
 end

data/Gemfile.lock

@@ -32,12 +32,10 @@ GEM
     builder (3.0.0)
     diff-lcs (1.1.3)
     erubis (2.7.0)
+    geoip (1.1.2)
     git (1.2.5)
     hashie (1.2.0)
     hike (1.2.1)
-    httparty (0.8.1)
-      multi_json
-      multi_xml
     i18n (0.6.0)
     jeweler (1.8.3)
       bundler (~> 1.0)
@@ -52,7 +50,6 @@ GEM
       treetop (~> 1.4.8)
     mime-types (1.17.2)
     multi_json (1.1.0)
-    multi_xml (0.4.2)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
@@ -107,8 +104,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.0.0)
+  geoip
   hashie (~> 1.2)
-  httparty
   i18n (~> 0.6)
   jeweler (>= 1.8.3)
   rails (>= 3.1)

data/README.md

@@ -1,6 +1,11 @@
-# Country or language selection with Flag icons
+# World Flags
 
-This gem can be used with Rails 3. It includes css files for size 16 and 32 pixels and have all the worlds' flags. See http://spritegen.website-performance.org/
+This engine/gem can be used with Rails 3+. WorldFlags includes css files for flags of the following pixel sizes:
+* 16 
+* 32
+* 64 
+
+The sprites contains all the main country flags in the world.
 
 ## Configuration
 
@@ -16,7 +21,7 @@ In you asset `application.css` manifest file:
 */
 ```
 
-The `flags/basic` stylesheet sets up a basic css for use with borders around the 32 and 64 pixel flag images (to mark selected language). Use this css as inspiration and customize by overriding styles as needed.
+The `flags/basic` stylesheet sets up a basic css for use with borders around the flag images (to mark selected language). Use this css as inspiration and customize by overriding styles as needed.
 
 There is also support for semi-transparent flags. This can be used to fade certain flags while having the selected flag (or hovered over flag) in full brightness.
 
@@ -28,9 +33,8 @@ Flags will be rendered in HTML as:
 
 ```html
 <pre>
-<ul class="f32">
-  <li class="flag ar" data-cc="ar" data-country="Argentina">Argentina</li>
-  <li class="flag gb" data-cc="gb" data-country="England">England</li>
+  <ul class="f32">
+  	<li class="flag ar selected" data-cc="ar" data-country_name="Argentina" data-language_name="Spanish" data-locale="ar">&nbsp;</li>
 ...
 </ul>
 </pre>
@@ -127,6 +131,37 @@ See the [wiki](https://github.com/kristianmandrup/world-flags/wiki/)
 * [Configuration](https://github.com/kristianmandrup/world-flags/wiki/Configuration)
 * [Handling flag selection](https://github.com/kristianmandrup/world-flags/wiki/Handling-flag-selection)
 
+## Geo IP
+
+Include the 'geoip' gem if you want to detect locale based on browser IP location.
+
+[GeoIP country lite](http://www.maxmind.com/app/geolitecountry)
+[GeoIP](http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz)
+
+Extract and put latest `GeoIP.dat` file in `db/GeoIP.dat` of your Rails app. Alternatively set location via `WorldFlags.geo_ip_db_path = path`. 
+
+The _world-flags_ engine comes pre-packaged with a recent version of `GeoIP.dat` in the `db` folder of the engine itself.
+
+### Localhosts filtering
+
+Also set `WorldFlags.localhost_list` if you have localhosts other than the default `127.0.0.1`.
+
+You can override the default ip passed to the `Geo module by overriding the `browser_ip` method in your controller. Here the default implementation is shown:
+
+### Fine control of the IP used
+
+```ruby
+def browser_ip
+  request.remote_ip
+end
+```
+
+Code extract of the locale source logic for browser IP country code detection:
+
+```ruby
+when :ip
+  ip_country_code(browser_ip)
+```
 
 ## TODO for version 1.0
 

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.4.7

data/lib/world_flags/helper/geo.rb

@@ -1,18 +1,24 @@
 module WorldFlags
+  class GeoIPError < StandardError; end
+
   module Helper
   	module Geo
-      def self.ip_json
-        require "httparty"
-
-        HTTParty.get('http://freegeoip.net/json/')
+  		def self.ip_country_code ip = nil
+        ip ||= request.remote_ip
+        raise WorldFlags::GeoIPError, "IP address #{ip} is a localhost address" if local_ip?(ip)
+        
+        @geoip ||= GeoIP.new WorldFlags.geo_ip_db_path
+        country = @geoip.country(ip)
+        return country[2] unless country.nil?
+        raise WorldFlags::GeoIPError, "No country code could be found for IP: #{ip}"
       end
 
-  		def self.ip_country_code
-      	@ip_country_code ||= ip_json.parsed_response['country_code']
+      def self.local_ip? ip
+        WorldFlags.localhost_list.include?(ip)
       end
 
-  		def ip_country_code
-      	WorldFlags::Helper::Geo.ip_country_code
+  		def ip_country_code ip = nil
+      	WorldFlags::Helper::Geo.ip_country_code ip
       end
     end
   end

data/lib/world_flags/helper/locale.rb

@@ -35,12 +35,16 @@ module WorldFlags
         when :browser
           browser_locale # http://www.metamodpro.com/browser-language-codes
         when :ip
-          ip_country_code
+          ip_country_code(browser_ip)
         when :default
           I18n.default_locale
         end
       end
 
+      def browser_ip
+        request.remote_ip
+      end
+
       def locale_source_priority
         WorldFlags.locale_source_priority
       end

data/lib/world_flags/util/config.rb

@@ -3,7 +3,15 @@ module WorldFlags
     module Config
       attr_accessor :auto_select, :raise_error
       attr_accessor :default_code, :default_locale
-      attr_writer   :locale_source_priority
+      attr_writer   :locale_source_priority, :geo_ip_db_path, :localhost_list
+
+      def geo_ip_db_path
+        @geo_ip_db_path ||= "#{Rails.root}/db/GeoIP.dat"
+      end
+
+      def localhost_list
+        @localhost_list ||= ["127.0.0.1"]
+      end
 
       def locale_source_priority
         @locale_source_priority ||= default_locale_source_priority

data/world-flags.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "world-flags"
-  s.version = "0.4.5"
+  s.version = "0.4.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = "2012-05-15"
+  s.date = "2012-05-16"
   s.description = "Use world flag icons in your Rails app"
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "config/countries/locale_countries.en.json",
     "config/languages/locale_languages.en.json",
     "config/locale_map/locale_to_country_code.json",
+    "db/GeoIP.dat",
     "lib/generators/world_flags/init_generator.rb",
     "lib/generators/world_flags/templates/world_flags.erb",
     "lib/world-flags.rb",
@@ -54,6 +55,7 @@ Gem::Specification.new do |s|
     "sandbox/languages_table.txt",
     "sandbox/official_languages.html",
     "sandbox/official_languages.txt",
+    "spec/data/GeoIP.dat",
     "spec/spec_helper.rb",
     "spec/world_flags/country_spec.rb",
     "spec/world_flags/helper/locale_helper_spec.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: world-flags
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-15 00:00:00.000000000 Z
+date: 2012-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -143,6 +143,7 @@ files:
 - config/countries/locale_countries.en.json
 - config/languages/locale_languages.en.json
 - config/locale_map/locale_to_country_code.json
+- db/GeoIP.dat
 - lib/generators/world_flags/init_generator.rb
 - lib/generators/world_flags/templates/world_flags.erb
 - lib/world-flags.rb
@@ -168,6 +169,7 @@ files:
 - sandbox/languages_table.txt
 - sandbox/official_languages.html
 - sandbox/official_languages.txt
+- spec/data/GeoIP.dat
 - spec/spec_helper.rb
 - spec/world_flags/country_spec.rb
 - spec/world_flags/helper/locale_helper_spec.rb
@@ -211,7 +213,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3509101011673426845
+      hash: -3422486010185457987
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: