geo_locale 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aad903af3f55a1262afb745660501b52d00eece6
-  data.tar.gz: 8b480b35329b6d97dee4fd90825354d1db8f8b60
+  metadata.gz: 13683f5ea4a417b4ba4935733dd2f6def4c8e61b
+  data.tar.gz: ecf16608e29da3c55ceff586e93060bf08e50d98
 SHA512:
-  metadata.gz: 337eb1b972d2d643d87dc9782929db9f101038702a69e2e87d5750ba88062a970cc5b785ce53c8058fb8b33d7c752d30710c77cb33f3fe875c65da7365032333
-  data.tar.gz: 1ac2a1f5efcccb9ba885dac6572aa68fd5d7d6bdb7e83b8eac4a865a3a557c1156090e79077b72e625dee8c7009cac11afa189782b0d6b05870a90fc59792a4c
+  metadata.gz: 9e6b16e1edf3fe8555bb31bf04fa97b54e28741b94aaa359c2f7a9d20eb42a3324cb8f755a98478577f394b3eb92e44694e048f06e3b91c775339f11f579daa1
+  data.tar.gz: 2eed2ced8a8a41db5e41f2e17d59475dbbdc777a955465ef6925d272fb0f99172c8f4b9c7de82cf43cef18ee4a8fc6434d377de932a1f3020db06fc03aa00cc0

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Change Log
+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.1.1] - 2015-10-02
+### Added
+- Localhost (127.0.0.1) is now quick-resolved to a locale defined in configuration for faster devving
+
+## [0.1.0] - 2015-01-01
+### Added
+- Initial release with basic functionality described in README
+### Changed
+- Nothing
+### Fixed
+- Nothing
+### Removed
+- Nothing

data/README.md

@@ -1,34 +1,25 @@
 # GeoLocale
-
 Simple wrapper for GeoIP gem with some redundancy on GeoKit to get a two-letter country code or locale from an IP address.
 
-Basic use-case: Detect application user's origin and display app in that language.
+## Basic use-case
+Detect application user's origin and display app in that language.
 
 ## Requirements
-
-Ruby 2.0.0 and greater
+Ruby 2.0.0 and greater.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
-gem 'geo_locale'
+# in Gemfile
+gem 'geo_locale' # and bundle
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install geo_locale
-
 ## Usage
 Configure default locales
 ```ruby
 # in /config/initializers/geo_locale.rb
 GeoLocale.configure do |config|
+  config.localhost_country = "lv" # set the country to return for localhost, this country's locale and lcid will also be used for localhost 
   config.default_country = "de" # set to nil or false if you want to catch fails in geolocation
   config.default_locale = "en" # country->locale conversion is minimal for now, set this explicitly to ensure GeoLocale.locale returns useful value
   config.default_lcid = "en-us"
@@ -36,7 +27,7 @@ GeoLocale.configure do |config|
 end
 ```
 
-To get country code:
+### To get country code:
 
 def self.country_code (ip: "")
 
@@ -46,7 +37,7 @@ GeoLocale.country_code(ip: request.remote_ip)
 => "en"
 ```
 
-To get locale:
+### To get locale:
 
 def self.locale (ip: "", country_code: "", lcid: false)
 ```ruby
@@ -69,6 +60,7 @@ GeoLocale.locale(ip: "97.77.25.20", country_code: "lv")
 
 1. Extend the country_code => locale hash in lib/geo_locale/locale.rb
 2. Open the hash to configuration overrides
+3. Automagically make initializer file for rails projects
 
 ## Contributing
 

data/geo_locale.gemspec

@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.rubyforge_project = "geo_locale"
 
-  spec.add_development_dependency "bundler", "~> 1.7.0"
+  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'

data/lib/geo_locale.rb

@@ -8,6 +8,8 @@ require 'geokit-rails'
 module GeoLocale
   class << self
     attr_accessor :config
+    GeoLocale::ROOT = File.expand_path("../..", __FILE__)
+    GeoLocale::LOCALHOST_IP = "127.0.0.1"
   end
 
   def self.configure
@@ -16,7 +18,7 @@ module GeoLocale
   end
 
   class Config
-    attr_accessor :default_country, :default_locale, :default_lcid, :overrides
+    attr_accessor :localhost_country, :default_country, :default_locale, :default_lcid, :overrides
 
     def initialize
       @default_country = "us"
@@ -27,6 +29,4 @@ module GeoLocale
   end
 
   GeoLocale.configure {}
-  ROOT = File.expand_path("../..", __FILE__)
-
 end

data/lib/geo_locale/country_code.rb

@@ -1,7 +1,8 @@
 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: "") # ip = "12.12.12.12"    
+    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?
       return country_code
@@ -16,31 +17,33 @@ module GeoLocale
     end
   end
 
-  def self.geo_ip_try (ip)
-    begin
-      return nil unless ip.match(GeoLocale::IP_REGEX).present?
-      code = GeoIP.new("#{GeoLocale::ROOT}/lib/data/GeoIP.dat").country(ip).country_code2.downcase
-      if code == "--"
-        return nil
-      else
-        if GeoLocale.config.overrides["#{code}"].present?
-          return GeoLocale.config.overrides["#{code}"]
+  private
+
+    def self.geo_ip_try(ip)
+      begin
+        return nil unless ip.match(GeoLocale::IP_REGEX).present?
+        code = GeoIP.new("#{GeoLocale::ROOT}/lib/data/GeoIP.dat").country(ip).country_code2.downcase
+        if code == "--"
+          return nil
         else
-          return code
+          if GeoLocale.config.overrides["#{code}"].present?
+            return GeoLocale.config.overrides["#{code}"]
+          else
+            return code
+          end
         end
+      rescue
+        nil
       end
-    rescue
-      nil
     end
-  end
 
-  def self.geokit_try (ip)
-    return nil unless ip.match(GeoLocale::IP_REGEX).present?
-    begin
-      return Geokit::Geocoders::MultiGeocoder.geocode(ip).country_code.downcase
-    rescue
-      nil
+    def self.geokit_try(ip)
+      return nil unless ip.match(GeoLocale::IP_REGEX).present?
+      begin
+        return Geokit::Geocoders::MultiGeocoder.geocode(ip).country_code.downcase
+      rescue
+        nil
+      end
     end
-  end
 
-end
+end

data/lib/geo_locale/locale.rb

@@ -1,34 +1,8 @@
 module GeoLocale
 
-  def self.locale (ip: "", country_code: "", lcid: false)
-    if country_code.present?
-      unless lcid
-        locale = GeoLocale::LOCALE[country_code]
-        return figure_out_returnable_locale(locale: locale)
-      else
-        lcid_string = GeoLocale::LCID[country_code]
-        return figure_out_returnable_lcid(lcid_string: lcid_string)
-      end
-
-    elsif ip.present?
-      country_code = GeoLocale.country_code(ip: ip)
-      unless lcid
-        locale = GeoLocale::LOCALE[country_code]
-        return figure_out_returnable_locale(locale: locale)
-      else
-        lcid_string = GeoLocale::LCID[country_code]
-        return figure_out_returnable_lcid(lcid_string: lcid_string)
-      end
-
-    else
-      unless lcid
-        locale = GeoLocale::LOCALE["#{GeoLocale.config.default_country}"]
-        return figure_out_returnable_locale(locale: locale)
-      else
-        lcid_string = GeoLocale::LCID["#{GeoLocale.config.default_country}"]
-        return figure_out_returnable_lcid(lcid_string: lcid_string)
-      end
-    end
+  def self.locale (ip: "", country_code: nil, lcid: false)
+    country_code ||= GeoLocale.country_code(ip: ip)
+    GeoLocale.get_locale_or_lcid(country_code: country_code, lcid: lcid)
   end
 
   LOCALE = {
@@ -59,21 +33,33 @@ module GeoLocale
     "fr" => "fr"
   }
 
+  private
 
-  def self.figure_out_returnable_locale(locale: "")
-    if locale.present?
-      return locale
-    else
-      return GeoLocale.config.default_locale
+    def self.get_locale_or_lcid(country_code:, lcid: false)
+      if lcid
+        lcid_string = GeoLocale::LCID[country_code]
+        return figure_out_returnable_lcid(lcid_string: lcid_string)
+      else
+        locale = GeoLocale::LOCALE[country_code]
+        return figure_out_returnable_locale(locale: locale)
+      end
     end
-  end
 
-  def self.figure_out_returnable_lcid(lcid_string: "")
-    if lcid_string.present?
-      return lcid_string
-    else
-      return GeoLocale.config.default_lcid
+
+    def self.figure_out_returnable_locale(locale: "")
+      if locale.present?
+        return locale
+      else
+        return GeoLocale.config.default_locale
+      end
+    end
+
+    def self.figure_out_returnable_lcid(lcid_string: "")
+      if lcid_string.present?
+        return lcid_string
+      else
+        return GeoLocale.config.default_lcid
+      end
     end
-  end
 
-end
+end

data/lib/geo_locale/version.rb

@@ -1,3 +1,3 @@
 module GeoLocale
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'bundler/setup'
 Bundler.setup
 
 require "geo_locale"
+require "pry"
 
 RSpec.configure do |config|
   LV_IPS =["81.198.65.13", "85.9.209.244", "83.241.46.175", "78.84.147.188", "159.148.168.103"]

data/spec/tests/geolocation_spec.rb

@@ -143,4 +143,4 @@ describe "Geolocation" do
     end
   end
 
-end
+end

data/spec/tests/locale_spec.rb

@@ -35,8 +35,9 @@ describe "Locale interpret" do
     end
     context "with customized config" do
       it "should return de if no arguments given" do
-        GeoLocale.config.default_country = "de"
-        expect( GeoLocale.locale(country_code: "") ).to eq "de"
+        GeoLocale.config.default_locale = "ch"
+        puts GeoLocale.config.inspect
+        expect( GeoLocale.locale(country_code: "") ).to eq "ch"
       end
       it 'should return lv for country_code: "lv"' do
         GeoLocale.config.default_country = "de"
@@ -107,4 +108,4 @@ describe "Locale interpret" do
 
 
 
-end
+end

data/spec/tests/localhost_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+# rspec spec/tests/localhost_spec.rb
+describe "Geolocation" do
+  before :each do
+    GeoLocale.configure do |config|
+      config.localhost_country = "lt"
+    end
+  end
+
+  describe "Localhost" do
+    describe "#country_code" do
+      it "should return the configured country code" do
+        expect(GeoLocale.country_code(ip: "127.0.0.1")).to eq "lt"
+      end
+      it "should return the gem default country_code if not configured" do
+        GeoLocale.config = nil
+        GeoLocale.configure {}
+        expect(GeoLocale.config.default_country).to eq "us"
+        expect(GeoLocale.country_code(ip: "127.0.0.1")).to eq "us"
+      end
+    end
+
+    describe "#locale" do
+      it "should return the configured locale" do
+        expect(GeoLocale.locale(ip: "127.0.0.1")).to eq "lt"
+      end
+    end
+
+    describe "#locale/lcid" do
+      it "should return the configured lcid" do
+        expect(GeoLocale.locale(ip: "127.0.0.1", lcid: true)).to eq "lt"
+      end
+    end
+  end
+
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: geo_locale
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Epigene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: geoip
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -117,6 +132,7 @@ files:
 - spec/tests/geolocation_spec.rb
 - spec/tests/initialize_spec.rb
 - spec/tests/locale_spec.rb
+- spec/tests/localhost_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -146,3 +162,4 @@ test_files:
 - spec/tests/geolocation_spec.rb
 - spec/tests/initialize_spec.rb
 - spec/tests/locale_spec.rb
+- spec/tests/localhost_spec.rb