maxminddb 0.1.19 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: baa15e403f8935e07c5f2c2286fc14267534a4ef
-  data.tar.gz: 1cf297075926ddac4893041e858a96733a024b32
+  metadata.gz: 49781843be08dc83d3cc593d9754cdf344d270c1
+  data.tar.gz: 5d0d83b7ba2a3cb6945db5d34fc38c579ea13a91
 SHA512:
-  metadata.gz: 3d92adbd9707dda2dc77e702a77680fa7c7b41541be96391c0630e053c106bbe2f4a9eaf562770ca0df492f9a0c71f7cda52ece0d47b4b1e8c35abc4ef9b3b2d
-  data.tar.gz: 2bb2d4f9477331bb72a60beb61ac9289cceff933af353933b184a2cbe3f966cb1d53b2ffba51c507c21b41090a59cb1750ff9705f841319e636b8891ce5a7a89
+  metadata.gz: 7519d4cce445664ee6d1de8ad297e4cefff016971878130d71b472416167506bd484cb16decbb4bbdeaaee8bef4a6dde1908940dfee3c04b65a268ae2beebac6
+  data.tar.gz: 0d9a52e16cb853e4139eb452f807d8aec78702b0b566d6b814560d075abe9fa856afb1fc14be1cb6ffdc839862202ad982f5e9704f50a0a26a8c35e8e5f7ad44

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 0.1.20 (July 9, 2018)
+
+- Add local_ip_alias
+
 ### 0.1.19 (June 22, 2018)
 
 - Implement a faster default reader

data/README.md

@@ -54,6 +54,17 @@ ret.country.name # => nil
 ret.to_hash # => {}
 ```
 
+For testing or other purposes, you might wish to treat localhost IP addresses as some other address - an external one. You can do this by assigning the desired external IP address to the attribute local_ip_alias:
+
+```ruby
+db = MaxMindDB.new('./GeoLite2-City.mmdb')
+ret = db.local_ip_alias = '74.125.225.224'
+ret = db.lookup('127.0.0.1')
+ret.found? # => true
+ret.country.name # => 'United States'
+ret.to_hash.empty? # => false
+```
+
 It's also possible to access the database metadata.
 
 ```ruby

data/lib/maxminddb.rb

@@ -19,6 +19,9 @@ module MaxMindDB
 
     attr_reader :metadata
 
+    # An IP that is used instead of local IPs
+    attr_accessor :local_ip_alias
+
     def initialize(path, file_reader = DEFAULT_FILE_READER)
       @path = path
       @data = file_reader.call(path)
@@ -38,9 +41,13 @@ module MaxMindDB
       "#<MaxMindDB::Client: DBPath:'#{@path}'>"
     end
 
-    def lookup(ip)
+    def lookup(ip_or_hostname)
+      if @local_ip_alias && is_local?(ip_or_hostname)
+        ip_or_hostname = @local_ip_alias
+      end
+
       node_no = 0
-      addr = addr_from_ip(ip)
+      addr = addr_from_ip(ip_or_hostname)
       start_idx = @ip_version == 4 ? 96 : 0
       for i in start_idx ... 128
         flag = (addr >> (127 - i)) & 1
@@ -162,16 +169,20 @@ module MaxMindDB
       bytes.inject(0){|r, v| (r << 8) + v }
     end
 
-    def addr_from_ip(ip)
-      klass = ip.class
+    def addr_from_ip(ip_or_hostname)
+      klass = ip_or_hostname.class
 
-      return ip if RUBY_VERSION.to_f < 2.4 && (klass == Fixnum || klass == Bignum)
-      return ip if RUBY_VERSION.to_f >= 2.4 && klass == Integer
+      return ip_or_hostname if RUBY_VERSION.to_f < 2.4 && (klass == Fixnum || klass == Bignum)
+      return ip_or_hostname if RUBY_VERSION.to_f >= 2.4 && klass == Integer
 
-      addr = IPAddr.new(ip)
+      addr = IPAddr.new(ip_or_hostname)
       addr = addr.ipv4_compat if addr.ipv4?
       addr.to_i
     end
+
+    def is_local?(ip_or_hostname)
+      ["127.0.0.1", "localhost", "::1", "0000::1", "0:0:0:0:0:0:0:1"].include? ip_or_hostname
+    end
   end
 end
 

data/lib/maxminddb/version.rb

@@ -1,3 +1,3 @@
 module MaxMindDB
-  VERSION = "0.1.19"
+  VERSION = "0.1.20"
 end

data/spec/maxminddb_spec.rb

@@ -83,6 +83,7 @@ describe MaxMindDB do
 
   context 'for a Canadian ipv6' do
     let(:ip) { '2607:5300:60:72ba::' }
+
     it 'finds data' do
       expect(city_db.lookup(ip)).to be_found
     end
@@ -124,6 +125,54 @@ describe MaxMindDB do
     end
   end
 
+  context 'for local ip addresses' do
+    let(:ip) { '127.0.0.1' }
+
+    context 'for city_db' do
+      before do
+        city_db.local_ip_alias = '74.125.225.224'
+      end
+
+      it 'returns a MaxMindDB::Result' do
+        expect(city_db.lookup(ip)).to be_kind_of(MaxMindDB::Result)
+      end
+
+      it 'finds data' do
+        expect(city_db.lookup(ip)).to be_found
+      end
+
+      it 'returns Mountain View as the English name' do
+        expect(city_db.lookup(ip).city.name).to eq('Alameda')
+      end
+
+      it 'returns -122.0574 as the longitude' do
+        expect(city_db.lookup(ip).location.longitude).to eq(-122.2788)
+      end
+
+      it 'returns nil for is_anonymous_proxy' do
+        expect(city_db.lookup(ip).traits.is_anonymous_proxy).to eq(nil)
+      end
+    end
+
+    context 'for country_db' do
+      before do
+        country_db.local_ip_alias = '74.125.225.224'
+      end
+
+      it 'returns United States as the English country name' do
+        expect(country_db.lookup(ip).country.name).to eq('United States')
+      end
+
+      it 'returns false for the is_in_european_union' do
+        expect(country_db.lookup(ip).country.is_in_european_union).to eq(nil)
+      end
+
+      it 'returns US as the country iso code' do
+        expect(country_db.lookup(ip).country.iso_code).to eq('US')
+      end
+    end
+  end
+
   context 'for 32bit record data' do
     let(:ip) { '1.0.16.1' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maxminddb
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.1.20
 platform: ruby
 authors:
 - yhirose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-23 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler