ip_library 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ip_library.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 tumayun
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# IPLibrary
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ip_library'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ip_library
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/doc/ip_libraries.txt

@@ -0,0 +1,5 @@
+1
+16777472,16778239,福建,,
+========================
+14
+234881024,234883071,广东,,

data/ip_library.gemspec

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ip_library/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["tumayun"]
+  gem.email         = ["tumayun.2010@gmail.com"]
+  gem.description   = <<-DESCRIPT
+IPLibrary
+=========
+
+顾名思义，这是一个ip库
+
+Example
+=======
+
+本gem中已经带有ip库，默认是gem目录下doc/ip_libraries.txt
+默认ip库的格式以IPLibrary::Configuration.separator分组
+各组第一行为ip头（192.168.1.1的ip头为192）,其他行各列以英文逗号隔开
+各列分别是：起始ip, 结束ip, 省份, 城市, 县区, 行政划分最小字段的拼音(如果有县区则为县区的拼音)
+
+当然，您也可以有自己的ip库
+设置ip库的path: IPLibrary::Configuration.file_path = '/home/doc/ip_libraries.txt'
+而且，您也可以设置ip库中的列的含义，start_ip、end_ip两列必须有，且必须依次为1、2列
+设置其他列：IPLibrary::Configuration.optional_columns = [:province, :city, :district, :pinyin]
+除了1、2列，其他列一次为province、city、district、pinyin
+然后会动态生成方法：
+IPLibrary::Base#ip2province
+IPLibrary::Base#ip2city
+IPLibrary::Base#ip2district
+IPLibrary::Base#ip2pinyin
+
+=============================================
+
+IPLibrary::Base 的方法有：
+
+IPLibrary::Base.ip2province('123.132.254.134')
+IPLibrary::Base.ip2province(2072313478)
+#=> "山东"
+
+IPLibrary::Base.ip2city('123.132.254.134')
+IPLibrary::Base.ip2city(2072313478)
+#=> "临沂"
+
+IPLibrary::Base.ip2district('123.132.254.134')
+IPLibrary::Base.ip2district(2072313478)
+# => ""
+
+IPLibrary::Base.ip2pinyin('123.132.254.134')
+IPLibrary::Base.ip2pinyin(2072313478)
+#=> "linyi"
+  DESCRIPT
+  gem.summary       = %q{IPLibrary是一个ip库的gem，它能通过类似ip2city等方法得到ip所在城市}
+  gem.homepage      = 'https://github.com/tumayun/ip_library'
+
+  #gem.files         = `git ls-files`.split($\)
+  gem.files         = %w(Gemfile ip_library.gemspec LICENSE Rakefile README.md)
+  gem.files        += Dir.glob("lib/**/*")
+  gem.files        += Dir.glob("doc/**/*")
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ip_library"
+  gem.require_paths = ["lib"]
+  gem.version       = IPLibrary::VERSION
+end

data/lib/ip_library.rb

@@ -0,0 +1,3 @@
+module IPLibrary
+  Dir["#{File.dirname(__FILE__)}/ip_library/*.rb"].each { |ext| require ext }
+end

data/lib/ip_library/base.rb

@@ -0,0 +1,90 @@
+#encoding: utf-8
+module IPLibrary
+
+  class Configuration
+    cattr_accessor :file_path, :optional_columns, :separator, :except_regexp, :instance_writer => false
+    cattr_reader   :non_optional_columns, :columns
+
+    @@file_path            = File.join(File.dirname(__FILE__), '..', '..', 'doc', 'ip_libraries.txt') #"#{File.dirname(__FILE__)}/../../doc/ip_libraries.txt"
+    @@optional_columns     = [:province, :city, :district]
+    @@non_optional_columns = [:start_ip, :end_ip]
+    @@columns              = @@non_optional_columns + @@optional_columns
+    @@except_regexp        = /[a-zA-Z0-9]?(全国|中国|全省各市|\(.*\))?/
+    @@separator            = "========================\n"
+
+    def self.optional_columns=(other)
+      Base.undef_class_methods(@@optional_columns)
+      @@optional_columns = other
+      @@columns          = @@non_optional_columns + @@optional_columns
+      Base.defined_class_methods
+      @@optional_columns
+    end
+  end
+
+  class Base
+
+    class << self
+      def ip_cities(force_reload = false)
+        return @@ip_cities if !force_reload && defined?(@@ip_cities) && @@ip_cities.present?
+
+        @@ip_cities = {}
+        File.open(Configuration.file_path, 'r') do |file|
+          datas = file.to_a.split(Configuration.separator)
+          datas.each do |data|
+            header = data.delete_at(0).chomp
+            data.each do |row|
+              ip_city = row.chomp.split(',')
+              @@ip_cities[header] ||= []
+              @@ip_cities[header] << ip_city
+            end
+          end
+        end
+        @@ip_cities
+      end
+
+      def find_by_ip(ip)
+        header, ip = get_header_and_ip(ip)
+        ip_cities  = Base.ip_cities[header]
+        return nil if ip_cities.blank?
+
+        ip_cities  = ip_cities.select { |ip_city| ip_city[0].to_i <= ip && ip_city[1].to_i >= ip }
+        ip_cities.sort_by { |ip_city| ip_city[1].to_i - ip_city[0].to_i }.first if ip_cities.present?
+      end
+
+      def defined_class_methods
+        Configuration.columns.each_with_index do |col, index|
+          next if Configuration.non_optional_columns.include?(col)
+          instance_eval(<<-METHOD, __FILE__, __LINE__ + 1)
+          def ip2#{col.to_s}(ip)
+            find_by_ip(ip).try(:[], #{index})
+          end
+          METHOD
+        end
+      end
+
+      def undef_class_methods(symbols)
+        symbols.each do |symbol|
+          singleton.send :undef_method, "ip2#{symbol.to_s}".to_sym
+        end
+      end
+
+      def singleton
+        class << Base; self; end
+      end
+
+      protected
+      def get_header_and_ip(ip)
+        case ip
+        when Integer
+          [ip.to_ip.split('.').first, ip]
+        when String
+          [ip.split('.').first, ip.to_s.to_int_ip]
+        else
+          raise ArgumentError, 'Parameters can only be Integer and String'
+        end
+      end
+    end
+  end
+end
+
+IPLibrary::Base.defined_class_methods

data/lib/ip_library/data.rb

@@ -0,0 +1,162 @@
+#encoding: utf-8
+require 'csv'
+module IPLibrary
+
+  class Data
+    TITLES          = %w(start_ip end_ip province city district area_name_py start_ip1 end_ip1)
+    MUNICIPALITIES  = %w(北京 上海 天津 重庆)
+    DISTRICT_REGEXP = /(自治县|自治旗|特区|林区|县|区|旗)$/
+    CITY_REGEXP     = /(自治州|地区|市|州|盟)$/
+    PROVINCE_REGEXP = /(省|自治区|特别行政区)$/
+
+    class << self
+
+      def generate_txt(infile_path, outfile_path = nil)
+        outfile_path ||= "#{Rails.root}/doc/#{Time.now.strftime('%y%m%d%H%M%S')}_ip_libraries.txt"
+        raise ArgumentError, '请出入正确的文件路径！' unless File.file?(infile_path) || File.extname(infile_path) != '.txt'
+
+        puts '正在生成txt文件'
+        File.open(outfile_path, 'w') do |file|
+          ip_cities = load_csv(infile_path).sort_by { |row| row[TITLES.index('start_ip')].to_i }
+          ip_cities = ip_cities.group_by { |row| row[TITLES.index('start_ip1')].split('.').first }
+          length    = ip_cities.keys.size
+          index     = 0
+          ip_cities.each do |key, value|
+            index += 1
+            file.write("#{key}\n")
+            value.each do |v|
+              file.write("#{v[0..4].join(',')}\n")
+            end
+            file.write("#{Configuration.separator}") if length != index
+          end
+        end
+        puts "已经生成txt文件：#{outfile_path}"
+      end
+
+      def generate_custom_ip_library(areas, outfile_path = nil, infile_path = nil)
+        infile_path  ||= Configuration.file_path
+        outfile_path ||= File.join(Rails.root, 'doc', 'custom_ip_libraries.txt')
+        ip_city_ids = get_ip_city_ids(areas)
+
+        writer = []
+        File.open(infile_path, 'r') do |file|
+          file.each_line do |line|
+            if (cols = line.split(',')).size == 5 && ip_city_ids[cols[2]].present? && (city_id = (ip_city_ids[cols[2]][cols[3]] || ip_city_ids[cols[2]][cols[4]])).present?
+              writer << "#{cols[0]},#{cols[1]},#{city_id}\n"
+            elsif cols.size != 5
+              writer << cols.join(',')
+            end
+          end
+        end
+
+        puts "正在生成#{outfile_path}"
+        File.open(outfile_path, 'w') do |file|
+          writer.each do |line|
+            file.write line
+          end
+        end
+        puts '生成完毕'
+      end
+
+      private
+      def get_ip_city_ids(areas)
+        ip_city_ids = {}
+        ip_datas    = Base.ip_cities.values.flatten(1).select { |t| t[2].present? && (t[3].present? || t[4].present?) }
+
+        size = ip_datas.size
+        ip_datas.each_with_index do |ip_city, index|
+          pp "------------------#{index + 1}/#{size}--------------------"
+          if ip_city[2].present?
+            ip_city_ids[ip_city[2]] ||= {}
+
+            if ip_city_ids[ip_city[2]][ip_city[3]].blank? && ip_city[3].present?
+              areas.each do |t|
+                if t['province'] =~ %r{#{ip_city[2]}} && t['city'] =~ %r{#{ip_city[3]}}
+                  ip_city_ids[ip_city[2]][ip_city[3]] = t['city_id'] and break
+                end
+              end
+              unless ip_city_ids[ip_city[2]][ip_city[3]].present?
+                areas.each do |t|
+                  if t['province'] =~ %r{#{ip_city[2]}} && t['district'] =~ %r{#{ip_city[3]}}
+                    ip_city_ids[ip_city[2]][ip_city[3]] = t['city_id'] and break
+                  end
+                end
+              end
+            elsif ip_city_ids[ip_city[2]][ip_city[4]].blank? && ip_city[3].blank? && ip_city[4].present?
+              areas.each do |t|
+                if t['province'] =~ %r{#{ip_city[2]}} && t['district'] =~ %r{#{ip_city[4]}}
+                  ip_city_ids[ip_city[2]][ip_city[4]] = t['city_id'] and break
+                end
+              end
+            end
+          end
+        end
+
+        ip_city_ids
+      end
+
+      def get_areas(province, city)
+        if province =~ /北京|上海|天津|重庆/
+          province.sub!(CITY_REGEXP, '')
+          if city.blank?
+            [nil, province, nil]
+          elsif city =~ DISTRICT_REGEXP
+            [nil, province, city]
+          end
+        elsif city.blank?
+          province.sub!(PROVINCE_REGEXP, '')
+          [province, nil, nil]
+        elsif city =~ CITY_REGEXP
+          province.sub!(PROVINCE_REGEXP, '')
+          city.sub!(CITY_REGEXP, '')
+          [province, city, nil]
+        elsif city =~ DISTRICT_REGEXP
+          province.sub!(PROVINCE_REGEXP, '')
+          [province, nil, city]
+        end
+      end
+
+      def get_areas_array(province, city)
+        if province =~ /\//
+          province.split('/').inject([]) do |result, p|
+          result << get_areas(p, city)
+        end
+        elsif city =~ /\//
+          city.split('/').inject([]) do |result, c|
+          result << get_areas(province, c)
+        end
+        else
+          [get_areas(province, city)]
+        end
+      end
+
+      def load_csv(path)
+        raise ArgumentError, '请出入正确的文件路径！' unless File.file?(path) || File.extname(path) != '.csv'
+
+        index     = -1
+        col_index = {}
+        writer    = []
+
+        CSV.foreach(path) do |row|
+          index += 1
+          GC.start if index % 100 == 0
+          if index == 0
+            (TITLES - ['district', 'area_name_py']).each do |col|
+              col_index[col.to_sym] = row.index(col)
+            end
+            raise "csv文件内容格式不正确，必须有#{(TITLES - ['district', 'area_name_py']).join(', ')}等字段" if col_index.values.include?(nil)
+            next
+          end
+
+          province = row[col_index[:province]].to_s.gsub(Configuration.except_regexp, '')
+          city     = row[col_index[:city]].to_s.gsub(Configuration.except_regexp, '')
+          get_areas_array(province, city).each do |area|
+            puts [row[col_index[:start_ip]], row[col_index[:end_ip]], area].flatten and next if area.blank?
+            writer << [row[col_index[:start_ip]], row[col_index[:end_ip]], area, row[col_index[:start_ip1]], row[col_index[:end_ip1]]].flatten
+          end
+        end
+        writer
+      end
+    end
+  end
+end

data/lib/ip_library/integer.rb

@@ -0,0 +1,6 @@
+class Integer
+
+  def to_ip
+    IPLibrary::IP2integer.int2ip(self)
+  end
+end

data/lib/ip_library/ip2integer.rb

@@ -0,0 +1,25 @@
+module IPLibrary
+
+  module IP2integer
+
+    IP_REGEXP = /^(?:(?:2[0-4]\d|25[0-5]|[01]?\d\d?)\.){3}(?:2[0-4]\d|25[0-5]|[01]?\d\d?)$/
+    IP_PERFIX_REGEXP = /^(?:(?:2[0-4]\d|25[0-5]|[01]?\d\d?)\.){3}$/
+
+    class << self
+
+      # Converts an IP string to integer
+      def ip2int(ip)
+        return 0 unless ip =~ IP_REGEXP
+        ip_segments = []
+        ip.split('.').each_with_index { |ip_seg, i| ip_segments << (ip_seg.to_i << 8*(3 - i)) }
+        ip_segments.inject(0) { |sum, ip_segment|  sum = sum|ip_segment }
+      end
+
+      #Converts an INTEGER to IP string
+      def int2ip(intip)
+        ip_segments = [3, 2, 1, 0].map { |i| (intip & (255 << i*8)) >> i*8 }
+        (ip_str= ip_segments.join('.')) =~ IP_REGEXP ? ip_str : ''
+      end
+    end
+  end
+end

data/lib/ip_library/string.rb

@@ -0,0 +1,6 @@
+class String
+
+  def to_int_ip
+    IPLibrary::IP2integer.ip2int(self)
+  end
+end

data/lib/ip_library/version.rb

@@ -0,0 +1,3 @@
+module IPLibrary
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: ip_library
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- tumayun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-06 00:00:00.000000000 Z
+dependencies: []
+description: ! 'IPLibrary
+
+  =========
+
+
+  顾名思义，这是一个ip库
+
+
+  Example
+
+  =======
+
+
+  本gem中已经带有ip库，默认是gem目录下doc/ip_libraries.txt
+
+  默认ip库的格式以IPLibrary::Configuration.separator分组
+
+  各组第一行为ip头（192.168.1.1的ip头为192）,其他行各列以英文逗号隔开
+
+  各列分别是：起始ip, 结束ip, 省份, 城市, 县区, 行政划分最小字段的拼音(如果有县区则为县区的拼音)
+
+
+  当然，您也可以有自己的ip库
+
+  设置ip库的path: IPLibrary::Configuration.file_path = ''/home/doc/ip_libraries.txt''
+
+  而且，您也可以设置ip库中的列的含义，start_ip、end_ip两列必须有，且必须依次为1、2列
+
+  设置其他列：IPLibrary::Configuration.optional_columns = [:province, :city, :district,
+  :pinyin]
+
+  除了1、2列，其他列一次为province、city、district、pinyin
+
+  然后会动态生成方法：
+
+  IPLibrary::Base#ip2province
+
+  IPLibrary::Base#ip2city
+
+  IPLibrary::Base#ip2district
+
+  IPLibrary::Base#ip2pinyin
+
+
+  =============================================
+
+
+  IPLibrary::Base 的方法有：
+
+
+  IPLibrary::Base.ip2province(''123.132.254.134'')
+
+  IPLibrary::Base.ip2province(2072313478)
+
+  #=> "山东"
+
+
+  IPLibrary::Base.ip2city(''123.132.254.134'')
+
+  IPLibrary::Base.ip2city(2072313478)
+
+  #=> "临沂"
+
+
+  IPLibrary::Base.ip2district(''123.132.254.134'')
+
+  IPLibrary::Base.ip2district(2072313478)
+
+  # => ""
+
+
+  IPLibrary::Base.ip2pinyin(''123.132.254.134'')
+
+  IPLibrary::Base.ip2pinyin(2072313478)
+
+  #=> "linyi"
+
+'
+email:
+- tumayun.2010@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- ip_library.gemspec
+- LICENSE
+- Rakefile
+- README.md
+- lib/ip_library.rb
+- lib/ip_library/version.rb
+- lib/ip_library/base.rb
+- lib/ip_library/data.rb
+- lib/ip_library/integer.rb
+- lib/ip_library/ip2integer.rb
+- lib/ip_library/string.rb
+- doc/ip_libraries.txt
+homepage: https://github.com/tumayun/ip_library
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: IPLibrary是一个ip库的gem，它能通过类似ip2city等方法得到ip所在城市
+test_files: []