嘿,追踪号码爱好者!我从未在任何生产环境中使用过这个项目,实际上也从未使用过。我不是追踪号码专家,也没有与快递公司有内部联系—我只是一个曾经尝试制作包裹追踪应用的普通人,这个gem是唯一幸存下来的产物。当我真的无事可做时,研究这个还挺有趣的,但时间越来越成为宝贵资源。总之,维护这个项目是吃力不讨好的工作,如果这个项目对你有用,我真的很感谢你能给我买杯咖啡表示感谢。提交PR也不错。
追踪号码 (v1.x)
这个gem可以识别有效的追踪号码,并且仅通过号码就能告诉你关于货件的一些信息—事实证明,这些号码中包含了相当多的信息。
它可以检测UPS、FedEx、DHL、USPS、OnTrac、亚马逊物流以及160多个国家邮政服务(S10标准)的追踪号码。
这个gem不提供追踪功能。追踪功能需要你自己实现。
1.0版本的新特性
从1.0版本开始,用于检测追踪号码的规格已经被移到一个单独的仓库(tracking_number_data)中,本gem依赖于该仓库。我这样做是因为:a) 我们可以有一个统一的地方来记录所有追踪号码类型,使之更像一个众包努力;b) 这样更容易用其他语言编写客户端。
使用方法
检查单个追踪号码
t = TrackingNumber.new("MYSTERY_TRACKING_NUMBER")
# => #<TrackingNumber::Unknown MYSTERY_TRACKING_NUMBER>
t.valid? #=> false
t = TrackingNumber.new("1Z879E930346834440")
# => #<TrackingNumber::UPS 1Z879E930346834440>
t.valid? #=> true
在文本块中搜索
这将返回文本块中包含的有效追踪号码。
TrackingNumber.search("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, 1Z879E930346834440 nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute 9611020987654312345672 dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.")
#=> [#<TrackingNumber::UPS 1Z879E930346834440>, #<TrackingNumber::FedExGround96 9611020987654312345672>]
快递公司信息
从1.0版本开始,可能的快递公司代码有 [:usps, :fedex, :ups, :ontrac, :dhl, :amazon, :s10, :unknown]
。S10是当地政府邮局使用的国际标准。当包裹通过普通邮政进行国际运输时,通常使用S10号码。
t = TrackingNumber.new("1Z879E930346834440")
# => #<TrackingNumber::UPS 1Z879E930346834440>
t.valid? #=> true
t.courier_code #=> :ups
t.courier_name #=> "UPS"
t = TrackingNumber.new("RB123456785GB")
t.courier_name #=> "Royal Mail Group plc"
t.courier_code #=> :s10
t = TrackingNumber.new("RB123456785US")
t.courier_name #=> "United States Postal Service"
服务类型
某些追踪号码表明其服务类型
t = TrackingNumber.new("1Z879E930346834440")
t.service_type #=> "UPS United States Ground"
t = TrackingNumber.new("1ZXX3150YW44070023")
t.service_type #=> "UPS SurePost - Delivered by the USPS"
t = TrackingNumber.new("RB123456785US")
t.service_type #=> "Letter Post Registered"
发货人ID
某些追踪号码包含关于包裹的信息
t = TrackingNumber.new("1Z6072AF0320751583")
t.shipper_id #=> "6072AF" <-- 这是Target
目的地邮编
某些追踪号码表明其目的地
t = TrackingNumber.new("1001901781990001000300617767839437")
t.destination_zip #=> "10003"
包裹信息
某些追踪号码包含关于包裹的信息
t = TrackingNumber.new("012345000000002")
t.package_type #=> "case/carton"
追踪URL
获取发货人的追踪URL
t = TrackingNumber.new("1Z6072AF0320751583")
t.tracking_url #=> "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z6072AF0320751583"
我们拥有的所有信息
获取我们对该事物拥有的所有信息的对象
t = TrackingNumber.new("1Z6072AF0320751583")
t.info #=> @courier=#<TrackingNumber::Info:0x000000010a45fed8 @code=:ups, @name="UPS">,
# @decode={:serial_number=>"6072AF032075158", :shipper_id=>"6072AF", :service_type=>"03", :package_id=>"2075158", :check_digit=>"3"},
# @destination_zip=nil,
# @package_type=nil,
# @partners=nil,
# @service_description=nil,
# @service_type="UPS United States Ground",
# @shipper_id="6072AF",
# @tracking_url="https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z6072AF0320751583">
解码
大多数追踪号码都有一种格式,其中每个部分都有特定含义。decode
方法将号码拆分为已知的命名部分。
t = TrackingNumber.new("1Z879E930346834440")
t.decode
#=> {
# :serial_number => "879E93034683444",
# :shipper_id => "879E93",
# :service_type => "03",
# :package_id => "4683444",
# :check_digit => "0"
# }
多个承运商/合作关系
有些追踪号码匹配多个承运商,因为它们属于多个承运商。某些运输方式,如Fedex Smartpost,会将"最后一英里"外包给USPS。
# 搜索默认只显示满足承运商关系的号码
# (如果存在合作关系的话),因为这是消费者最可能感兴趣的一端。
results = TrackingNumber.search('420112139261290983497923666238')
=> [#<TrackingNumber::USPS91:0x26ac0 420112139261290983497923666238>]
all_results = TrackingNumber.search('420112139261290983497923666238', match: :all)
=> [#<TrackingNumber::FedExSmartPost:0x30624 420112139261290983497923666238>, #<TrackingNumber::USPS91:0x26ac0 420112139261290983497923666238>]
tn = results.first
tn.shipper? #=> false
tn.carrier? #=> true
tn.partnership? #=> true
tn.partners
#=> <struct TrackingNumber::Base::PartnerStruct
# shipper=#<TrackingNumber::FedExSmartPost:0x30624 420112139261290983497923666238>,
# carrier=#<TrackingNumber::USPS91:0x2f1fc 420112139261290983497923666238>>
tn.partners.shipper #=> #<TrackingNumber::FedExSmartPost:0x30624 420112139261290983497923666238>
tn.partners.carrier == tn #=> true
ActiveModel验证
对于Rails 3(或任何ActiveModel客户端),将字段验证为追踪号码:
class Shipment < ActiveRecord::Base
validates :tracking, :tracking_number => true
end
有时候,拥有一个对任何实际承运商都无效的"魔法"追踪号码会很有帮助,它可能会产生其他副作用(例如,对发货邮件的特殊处理)。
class Shipment < ActiveRecord::Base
validates :tracking, :tracking_number => { :except => 'magic-hand-delivery' }
end
为tracking_number做贡献
- 检查最新的master分支,确保该功能尚未实现或该bug尚未修复
- 检查问题追踪器,确保没有人已经请求或贡献了该功能
- Fork该项目
- 开始一个功能/bug修复分支
- 提交并推送,直到您对您的贡献满意为止
- 确保为其添加测试。这很重要,这样我就不会在未来的版本中无意中破坏它
- 请尽量不要修改Rakefile、版本或历史记录。如果您想拥有自己的版本,或者出于其他原因有必要这样做,那也可以,但请将其隔离到自己的提交中,这样我就可以选择性地合并
版权
版权所有 (c) 2010-2021 Jeff Keen。有关更多详细信息,请参阅LICENSE.txt。