phonedata 0.3.0.2108

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f424f4aa4248920eacc5be569e3e3e1334f009e68366181743dd216f149017a1
+  data.tar.gz: 6b4bde990e0e74d7c6bbd8a82b4a370fb596c17ad23e70bba2630b7b3be349f6
+SHA512:
+  metadata.gz: '012939eb410fca4cdb52ac74c2665fec3b0433eee5cafe8c3e0b8a1e676d2ff2f301875a3e9a5eac3e97357f087ed17b0a6ca5fa4b653175ed25165ebdd55d32'
+  data.tar.gz: eda28fe8d1285af92d0d21ce4619d6781656f3194eab9d534bca59f660087838631b8b00a50e2a32c5a2284b4ec439848876de90bf9d0511bce9fd781cb297f2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vscode

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.3.0.2108 (02/20/2022)
+
+- 初始版本

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in phonedata.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    phonedata (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  phonedata!
+  rake (~> 12.0)
+  rspec (~> 3.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 无限前进
+
+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,107 @@
+# Phonedata
+
+## 手机号码归属地信息库、手机号归属地查询
+
+参考 https://github.com/xluohome/phonedata 基于 ruby 实现
+
+- 归属地信息库文件大小：4,098,913 字节
+- 归属地信息库最后更新：2021 年 08 月
+- 手机号段记录条数：454336
+
+### phone.dat 文件格式
+
+        | 4 bytes |                     <- phone.dat 版本号（如：1701即17年1月份）
+        ------------
+        | 4 bytes |                     <-  第一个索引的偏移
+        -----------------------
+        |  offset - 8            |      <-  记录区
+        -----------------------
+        |  index                 |      <-  索引区
+        -----------------------
+
+1. 头部为 8 个字节，版本号为 4 个字节，第一个索引的偏移为 4 个字节；
+2. 记录区 中每条记录的格式为"<省份>|<城市>|<邮编>|<长途区号>\0"。 每条记录以'\0'结束；
+3. 索引区 中每条记录的格式为"<手机号前七位><记录区的偏移><卡类型>"，每个索引的长度为 9 个字节；
+
+## 版本说明
+
+项目采用 x.y.z.aaaa 的命名方式，在语义化版本的基础上加入了数据源更新版本
+
+比如 0.3.0.2108 则代表是这个版本使用了 21 年 8 月的数据源，数据源的更新会导致语义化版本的升级，但是程序本身的升级（bugfix，new feature）不会导致数据源版本升级
+
+比如 0.3.1.2108 代表 fix 了一个 bug，但数据源没变
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'phonedata'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install phonedata
+
+## Usage
+
+程序调用
+
+```
+require 'phonedata'
+
+Phonedata.find("18755339810")
+
+# #<struct Phonedata::Result
+#  phone="18755339810",
+#  province="安徽",
+#  city="芜湖",
+#  zipcode="241000",
+#  areazone="0553",
+#  card_type="中国移动">
+```
+
+方法清单
+
+```
+irb(main):002:0> Phonedata.methods(false)
+=> [:find, :total_record, :first_record_offset, :find_from_cli, :file_version]
+```
+
+命令行调用
+
+```
+ph2loc 18755339810
+```
+
+返回
+
+```
+18755339810 安徽 芜湖 241000 241000 0553 中国移动
+```
+
+同时可以使用 Phonedata::Pd 这个单例类，将文件加载和查询放在了不同的环节，如果是服务端程序调用可以提前实例化一下，将文件加载到内存
+
+```
+irb(main):004:0> Phonedata::Pd.instance_methods(false)
+=> [:find, :file_version, :total_record, :first_record_offset]
+
+```
+
+## Development
+
+源码文件就一个，实现很简单
+
+使用 rspec 跑单元测试
+
+```
+bundle exec rspec spec
+```
+
+## 感谢
+
+感谢 https://github.com/xluohome 提供了原始库和数据文件

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "phonedata"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/ph2loc

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'phonedata'
+
+unless ARGV.size == 1
+  puts "usage: ph2loc <Your PhoneNum>"
+  return
+end
+
+STDOUT.puts Phonedata.find_from_cli(ARGV[0])

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/phonedata/version.rb

@@ -0,0 +1,3 @@
+module Phonedata
+  VERSION = "0.3.0.2108".freeze
+end

data/lib/phonedata.rb

@@ -0,0 +1,120 @@
+require 'singleton'
+require "phonedata/version"
+
+module Phonedata
+  class Error < StandardError; end
+  
+  
+  def self.find(phone_num)
+    return Pd.instance.find(phone_num)
+  end
+
+  def self.find_from_cli(phone_num)
+    result = self.find(phone_num)
+    result.to_s
+  end
+
+  def self.file_version
+    return Pd.instance.file_version
+  end
+
+  def self.total_record
+    return Pd.instance.total_record
+  end
+
+  def self.first_record_offset
+    return Pd.instance.first_record_offset
+  end
+  
+  INT_LEN = 4
+  CHAR_LEN = 1
+  HEAD_LENGTH = 8
+  PHONE_INDEX_LENGTH = 9
+  PHONE_DAT = "phone.dat"
+
+  DICT = %w[nil 中国移动 中国联通 中国电信 中国电信虚拟运营商 中国联通虚拟运营商 中国移动虚拟运营商]
+
+  Result = Struct.new(:phone, :province, :city, :zipcode, :areazone, :card_type) do
+    def to_s
+      "#{phone} #{province} #{city} #{zipcode} #{zipcode} #{areazone} #{card_type}"
+    end
+  end
+  class Pd
+    include ::Singleton
+
+    def initialize(dat_file_path = nil) 
+      df = dat_file_path
+      if df.nil?
+        dir = ENV['PHONE_DATA_DIR'] || File.join(File.dirname(__FILE__), "../data")
+        df = File.join("#{dir}/#{PHONE_DAT}")
+      end   
+      f= File.open(df) 
+      @bytes_content = f.read.bytes
+    end
+
+    def find(phone_num)
+      if phone_num.size < 7 || phone_num.size > 11 
+        raise ArgumentError, " illegal phone length "
+      end
+      searched_phone = phone_num[0...7].to_i
+      #binary search
+      min = 0 
+      max = total_record
+      while min <= max
+        mid = (min + max) / 2
+        current_offset = (first_record_offset + mid * PHONE_INDEX_LENGTH)
+        if current_offset >= _total_len
+          break
+        end
+        #
+        record_offset_start_idx = current_offset+INT_LEN
+        card_type_start_idx = current_offset+INT_LEN*2
+        #
+        cur_phone_seg = _get4(@bytes_content[current_offset...record_offset_start_idx])
+        record_offset = _get4(@bytes_content[record_offset_start_idx...card_type_start_idx])
+        card_type = @bytes_content[card_type_start_idx]
+        #
+        if searched_phone > cur_phone_seg
+          min = mid + 1
+        elsif searched_phone < cur_phone_seg
+          max = mid - 1
+        else
+          sub_arr = @bytes_content[record_offset...first_record_offset]
+          full_data_arr = sub_arr[0...sub_arr.index(0)]
+          full_data_str = full_data_arr.pack("C*").force_encoding('UTF-8')
+          result = full_data_str.split("|")
+          
+          return Result.new(phone_num, result[0], result[1], result[2], result[3], DICT[card_type])
+        end
+        #
+      end
+      return Result.new(phone_num, nil, nil, nil, nil, nil)
+    end
+
+    def file_version 
+      @bytes_content[0...INT_LEN].pack("C*")
+    end
+
+    def first_record_offset
+      arr = @bytes_content[INT_LEN...HEAD_LENGTH]
+      _get4(arr)
+    end
+
+    def total_record
+      (_total_len - first_record_offset) / PHONE_INDEX_LENGTH
+    end
+
+    private
+    def _total_len
+      @bytes_content.size
+    end
+
+    def _get4(byte_arr)
+      if byte_arr.size < 4
+        0
+      else
+        byte_arr[0] | byte_arr[1] << 8 | byte_arr[2] << 16 | byte_arr[3] << 24
+      end 
+    end
+  end
+end

data/phonedata.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/phonedata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "phonedata"
+  spec.version       = Phonedata::VERSION
+  spec.license       = "MIT"
+  spec.authors       = ["Forwaard"]
+  spec.email         = ["forwaard@163.com"]
+
+  spec.summary       = "query the attribution of Chinese mobile phone numbers."
+  spec.description   = "query the attribution of Chinese mobile phone numbers.中国手机号码归属地信息库、手机号归属地查询。"
+  spec.homepage      = "https://github.com/FORWAARD/phonedata-ruby"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/FORWAARD/phonedata-ruby/blob/main/CHANGELOG.md"
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.executables   = ["ph2loc"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: phonedata
+version: !ruby/object:Gem::Version
+  version: 0.3.0.2108
+platform: ruby
+authors:
+- Forwaard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: query the attribution of Chinese mobile phone numbers.中国手机号码归属地信息库、手机号归属地查询。
+email:
+- forwaard@163.com
+executables:
+- ph2loc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/ph2loc
+- bin/setup
+- data/phone.dat
+- lib/phonedata.rb
+- lib/phonedata/version.rb
+- phonedata.gemspec
+homepage: https://github.com/FORWAARD/phonedata-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/FORWAARD/phonedata-ruby
+  source_code_uri: https://github.com/FORWAARD/phonedata-ruby
+  changelog_uri: https://github.com/FORWAARD/phonedata-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: query the attribution of Chinese mobile phone numbers.
+test_files: []