ip_locator_cn 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a6d59b99c393a70bc272fb7d6a9af22488f358aff70803fa8edc5ef6a2cd1bc
-  data.tar.gz: 3f35ee0f891112133baa58a3938e6d2a199296e40bf21c442b34204dd49ecdf2
+  metadata.gz: d7a329456174c6d309051f83b38dce8004116c4e86ef6c6c9c7e816cdee527cc
+  data.tar.gz: ab81c58038e50b9d85bc75853c5670bab3bcee8c537b4de5f692721bc310559b
 SHA512:
-  metadata.gz: 2bea475014d0f4ad880129b10a8c39dd6e1f930ea4ce92892713bef024160f0ef8ad7804011807bff06b403fbf1dcff27a27b74cd9f471377a0d206002f04fb9
-  data.tar.gz: d3847a4a344ae42069c5f4a981d21169fdeb231c4b332e606f864efe5b60779c5f76903e7380f1c1605e6524953fe8a346bfaca344f17a95da4ee850456e6a62
+  metadata.gz: 5c76128be6fe760277a4734def75823063827c775c172ecad3d7c484c3174a2ac8839baf31fb8a33d86780fcc33cec3556ade86b84f57e8a831d090843e43c3f
+  data.tar.gz: ee5994b55c2b0ddcab0a2dc509e241f797f05d239d2492fbbe79098f21e149df407e37cb80ae2e2e74ce0007ee1d7bf5c9856a9ed51df1d2fedfa3391b6f87df

data/.gitignore

@@ -6,6 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+/*.gem
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/ExpandPathArguments:
+  Enabled: false
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in ip_locator_cn.gemspec
 gemspec

data/Gemfile.lock

@@ -1,12 +1,14 @@
 PATH
   remote: .
   specs:
-    ip_locator_cn (0.1.0)
+    ip_locator_cn (0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
+    docile (1.3.1)
+    json (2.2.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -21,6 +23,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
 
 PLATFORMS
   ruby
@@ -30,6 +37,7 @@ DEPENDENCIES
   ip_locator_cn!
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov (~> 0.16.1)
 
 BUNDLED WITH
    1.16.6

data/README.md

@@ -1,8 +1,6 @@
-# IpLocatorCn
+# IP Locator CN
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ip_locator_cn`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+基于纯真 IP 库解析中国的 IP，参考了“[纯真数据库自动更新原理](https://github.com/shuax/QQWryUpdate/blob/master/update.php)” 和 “[PHP 版本的 IP 搜索源码](https://github.com/itbdw/ip-database/blob/master/src/IpLocation.php)”
 
 ## Installation
 
@@ -22,7 +20,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+从 Gem 包集成的 qqwry.dat 数据库解析 IP：
+
+```ruby
+2.4.5 :001 > require 'ip_locator_cn'
+ => true
+2.4.5 :002 > IpLocatorCn.resolve('60.195.153.98')
+ => {:province=>"北京", :city=>"顺义区", :country=>"中国", :ip=>"60.195.153.98", :county=>"", :isp=>"", :area=>"中国北京顺义区后沙峪金龙网吧", :origin_country=>"北京市顺义区", :origin_area=>"后沙峪金龙网吧"}
+```
+
+在线下载并解码 qqwry.dat ，然后解析 IP：
+
+```ruby
+2.4.5 :001 > require 'ip_locator_cn'
+ => true
+2.4.5 :002 > IpLocatorCn.resolve('60.195.153.98', live_dat: true)
+ => {:province=>"北京", :city=>"顺义区", :country=>"中国", :ip=>"60.195.153.98", :county=>"", :isp=>"", :area=>"中国北京顺义区后沙峪金龙网吧", :origin_country=>"北京市顺义区", :origin_area=>"后沙峪金龙网吧"}
+```
+
+开启调试信息：
+
+```ruby
+2.4.5 :001 > require 'ip_locator_cn'
+ => true
+2.4.5 :002 > IpLocatorCn.resolve('60.195.153.98', live_dat: true, debug: true)
+[2019-03-01 17:37:46 +0800] => downloading http://update.cz88.net/ip/copywrite.rar
+[2019-03-01 17:37:46 +0800] => downloading http://update.cz88.net/ip/qqwry.rar
+[2019-03-01 17:37:49 +0800] => qqwry decoding key is 225
+[2019-03-01 17:37:49 +0800] => total ip ranges: 472217
+[2019-03-01 17:37:53 +0800] => pos is 6658343
+[2019-03-01 17:37:53 +0800] => begin_ip is 60.195.153.0
+[2019-03-01 17:37:53 +0800] => endip is 60.195.153.255
+[2019-03-01 17:37:53 +0800] => offset is 696416
+[2019-03-01 17:37:53 +0800] => country is 北京市顺义区
+[2019-03-01 17:37:53 +0800] => area is 后沙峪金龙网吧
+ => {:province=>"北京", :city=>"顺义区", :country=>"中国", :ip=>"60.195.153.98", :county=>"", :isp=>"", :area=>"中国北京顺义区后沙峪金龙网吧", :origin_country=>"北京市顺义区", :origin_area=>"后沙峪金龙网吧"}
+```
 
 ## Development
 
@@ -34,6 +67,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/xiaohui-zhangxh/ip_locator_cn.
 
+### Test
+
+```bash
+bundle exec rspec
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "ip_locator_cn"
+require 'bundler/setup'
+require 'ip_locator_cn'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "ip_locator_cn"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/ip_locator_cn.gemspec

@@ -1,42 +1,42 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ip_locator_cn/version"
+require 'ip_locator_cn/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ip_locator_cn"
+  spec.name          = 'ip_locator_cn'
   spec.version       = IpLocatorCn::VERSION
-  spec.authors       = ["xiaohui"]
-  spec.email         = ["xiaohui@tanmer.com"]
+  spec.authors       = ['xiaohui']
+  spec.email         = ['xiaohui@tanmer.com']
 
-  spec.summary       = %q{Resolve IP info in China}
-  spec.description   = %q{Resolve IP with qqwry.data, can download qqwry.data on the air.}
-  spec.homepage      = "https://github.com/xiaohui-zhangxh/"
-  spec.license       = "MIT"
+  spec.summary       = 'Resolve IP info in China'
+  spec.description   = 'Resolve IP with qqwry.data, can download qqwry.data on the air.'
+  spec.homepage      = 'https://github.com/xiaohui-zhangxh/'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata['homepage_uri'] = spec.homepage
     # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
     # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
 end

data/lib/ip_locator_cn/qqwry/city_directly.rb

@@ -1,10 +1,10 @@
 module IpLocatorCn
   class QQWry
-    CITY_DIRECTLY = [
-      '北京',
-      '天津',
-      '重庆',
-      '上海',
+    CITY_DIRECTLY = %w[
+      北京
+      天津
+      重庆
+      上海
     ].freeze
   end
 end

data/lib/ip_locator_cn/qqwry/isp.rb

@@ -1,12 +1,12 @@
 module IpLocatorCn
   class QQWry
-    ISP = [
-      '联通',
-      '移动',
-      '铁通',
-      '电信',
-      '长城',
-      '聚友',
+    ISP = %w[
+      联通
+      移动
+      铁通
+      电信
+      长城
+      聚友
     ].freeze
   end
 end

data/lib/ip_locator_cn/qqwry/provinces.rb

@@ -1,40 +1,40 @@
 module IpLocatorCn
   class QQWry
-    PROVINCES = [
-      '北京',
-      '天津',
-      '重庆',
-      '上海',
-      '河北',
-      '山西',
-      '辽宁',
-      '吉林',
-      '黑龙江',
-      '江苏',
-      '浙江',
-      '安徽',
-      '福建',
-      '江西',
-      '山东',
-      '河南',
-      '湖北',
-      '湖南',
-      '广东',
-      '海南',
-      '四川',
-      '贵州',
-      '云南',
-      '陕西',
-      '甘肃',
-      '青海',
-      '台湾',
-      '内蒙古',
-      '广西',
-      '宁夏',
-      '新疆',
-      '西藏',
-      '香港',
-      '澳门',
+    PROVINCES = %w[
+      北京
+      天津
+      重庆
+      上海
+      河北
+      山西
+      辽宁
+      吉林
+      黑龙江
+      江苏
+      浙江
+      安徽
+      福建
+      江西
+      山东
+      河南
+      湖北
+      湖南
+      广东
+      海南
+      四川
+      贵州
+      云南
+      陕西
+      甘肃
+      青海
+      台湾
+      内蒙古
+      广西
+      宁夏
+      新疆
+      西藏
+      香港
+      澳门
     ].freeze
   end
 end

data/lib/ip_locator_cn/qqwry.rb

@@ -4,7 +4,7 @@ require 'ip_locator_cn/qqwry/isp'
 
 module IpLocatorCn
   class QQWry
-    IP_ENTRY_BYTES = 7.freeze
+    IP_ENTRY_BYTES = 7
 
     attr_reader :first_ip_pos, :last_ip_pos, :total_ips, :debug
 
@@ -20,13 +20,15 @@ module IpLocatorCn
     end
 
     # return: <Hash> result
-    # result['ip']        输入的ip
-    # result['country']   国家 如 中国
-    # result['province']  省份信息 如 河北省
-    # result['city']      市区 如 邢台市
-    # result['county']    郡县 如 威县
-    # result['isp']       运营商 如 联通
-    # result['area']      最完整的信息 如 中国河北省邢台市威县新科网吧(北外街)
+    # result['ip']              输入的ip
+    # result['country']         国家 如 中国
+    # result['province']        省份信息 如 河北省
+    # result['city']            市区 如 邢台市
+    # result['county']          郡县 如 威县
+    # result['isp']             运营商 如 联通
+    # result['area']            最完整的信息 如 中国河北省邢台市威县新科网吧(北外街)
+    # result['origin_country']  解析之前的原始信息
+    # result['origin_area']     解析之前的原始信息
     def resolve(ip)
       location = location_from_ip(ip)
       extract_location(location[:country]).tap do |result|
@@ -43,6 +45,8 @@ module IpLocatorCn
           result[:county],
           location[:area]
         ].join
+        result[:origin_country] = location[:country]
+        result[:origin_area] = location[:area]
       end
     end
 
@@ -52,40 +56,40 @@ module IpLocatorCn
       log "pos is #{pos}"
       # 用户IP所在范围的开始地址
       seek(pos)
-      begin_ip = long2ip(read_ip())
+      begin_ip = long2ip(read_ip)
       log "begin_ip is #{begin_ip}"
       # 用户IP所在范围的结束地址
-      offset = getlong3()
+      offset = getlong3
       seek(offset)
-      endip = long2ip(read_ip())
+      endip = long2ip(read_ip)
       log "endip is #{endip}"
       log "offset is #{offset}"
       byte = read(1) # 标志字节
       case byte.ord
       when 1
         # 标志字节为1，表示国家和区域信息都被同时重定向
-        country_offset = getlong3() # 重定向地址
+        country_offset = getlong3 # 重定向地址
         seek(country_offset)
         byte = read(1) # 标志字节
         case byte.ord
         when 2
           seek(getlong3)
-          info[:country] = getstring()
+          info[:country] = getstring
           seek(country_offset + 4)
-          info[:area] = getarea()
+          info[:area] = getarea
         else
           info[:country] = getstring(byte)
-          info[:area] = getarea()
+          info[:area] = getarea
         end
       when 2
         # 标志字节为2，表示国家信息被重定向
         seek(getlong3)
-        info[:country] = getstring()
+        info[:country] = getstring
         seek(offset + 8)
-        info[:area] = getarea()
+        info[:area] = getarea
       else
         info[:country] = getstring(byte)
-        info[:area] = getarea()
+        info[:area] = getarea
       end
 
       info[:country] = encoding_convert(info[:country])
@@ -116,8 +120,8 @@ module IpLocatorCn
       if str.include?(seperator_sheng)
         collection[:province], str = str.split(seperator_sheng, 2)
       else
-        province = (PROVINCES + CITY_DIRECTLY).find{ |x| str.start_with?(x) }
-        if x
+        province = (PROVINCES + CITY_DIRECTLY).find { |x| str.start_with?(x) }
+        if province
           collection[:province] = province
           is_city_directly = CITY_DIRECTLY.include?(province)
           str = str[province.length..-1]
@@ -162,8 +166,8 @@ module IpLocatorCn
 
     def live_load_dat
       require 'open-uri'
-      copywrite = download(IpLocatorCn.copywrite_url).read and nil
-      qqwry = download(IpLocatorCn.live_data_url).read.bytes and nil
+      (copywrite = download(IpLocatorCn.copywrite_url).read) && nil
+      (qqwry = download(IpLocatorCn.live_data_url).read.bytes) && nil
       key = copywrite.unpack('V6')[5]
       log "qqwry decoding key is #{key}"
       (0...0x200).each do |i|
@@ -172,25 +176,26 @@ module IpLocatorCn
         key &= 0xFF
         qqwry[i] ^= key
       end
-      qqwry = Zlib::Inflate.inflate(qqwry.pack('C*')) and nil
+      (qqwry = Zlib::Inflate.inflate(qqwry.pack('C*'))) && nil
       @io = StringIO.new(qqwry)
     end
 
     def parse_dat_info
-      @first_ip_pos = getlong4()
-      @last_ip_pos = getlong4()
+      @first_ip_pos = getlong4
+      @last_ip_pos = getlong4
       @total_ips = (last_ip_pos - first_ip_pos) / IP_ENTRY_BYTES
       log "total ip ranges: #{total_ips}"
     end
 
     def get_isp(str)
-      ISP.find {|x| str.include?(x)}
+      ISP.find { |x| str.include?(x) }
     end
 
     # b-tree search ip from qqwry.dat
     def locate_ip_pos(ip)
       x = ip2long(ip)
-      min, max = 0, total_ips
+      min = 0
+      max = total_ips
 
       while min <= max
         # b-tree search
@@ -198,14 +203,14 @@ module IpLocatorCn
         pos = first_ip_pos + i * IP_ENTRY_BYTES
         seek(pos)
         # get middle ip
-        y = read_ip()
+        y = read_ip
         if x < y
           # user ip < middle ip
           max = i - 1
         else
           # user ip > middle ip, read next ip entry
           read(3)
-          y = read_ip()
+          y = read_ip
           if x > y
             # user ip > next ip
             min = i + 1
@@ -243,14 +248,14 @@ module IpLocatorCn
     end
 
     def ipparts2long(parts)
-      0.upto(3).map{|i| parts[i] << ((3 - i) * 8) }.sum
+      0.upto(3).map { |i| parts[i] << ((3 - i) * 8) }.sum
     end
 
     def long2ip(n)
-      0.upto(3).map{|i| (n >> ((3 - i) * 8)) & 0xFF }.join('.')
+      0.upto(3).map { |i| (n >> ((3 - i) * 8)) & 0xFF }.join('.')
     end
 
-    def getstring(data='')
+    def getstring(data = '')
       char = read(1)
       while char.ord > 0
         data += char
@@ -267,14 +272,14 @@ module IpLocatorCn
         return ''
       when 1, 2
         seek(getlong3)
-        return getstring()
+        return getstring
       else
         return getstring(char)
       end
     end
 
     def encoding_convert(str)
-      ec = Encoding::Converter.new("GBK", "UTF-8")
+      ec = Encoding::Converter.new('GBK', 'UTF-8')
       result = ec.convert(str)
       ec.finish
       result

data/lib/ip_locator_cn/version.rb

@@ -1,3 +1,3 @@
 module IpLocatorCn
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'.freeze
 end

data/lib/ip_locator_cn.rb

@@ -1,5 +1,6 @@
-require "ip_locator_cn/version"
+require 'ip_locator_cn/version'
 require 'ip_locator_cn/qqwry'
+
 module IpLocatorCn
   # embeded qqwry.dat
   def self.data_path
@@ -15,7 +16,7 @@ module IpLocatorCn
     'http://update.cz88.net/ip/copywrite.rar'
   end
 
-  def self.resolve(ip)
-    QQWry.new(dat_path: data_path).resolve(ip)
+  def self.resolve(ip, options={ dat_path: data_path })
+    QQWry.new(options).resolve(ip)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip_locator_cn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - xiaohui
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
 description: Resolve IP with qqwry.data, can download qqwry.data on the air.
 email:
 - xiaohui@tanmer.com
@@ -61,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock