首页
/ ActiveShipping 技术文档

ActiveShipping 技术文档

2024-12-23 21:05:16作者:霍妲思

1. 安装指南

ActiveShipping 是一个 Ruby 库,用于与各种运输公司的网络服务接口。以下是安装步骤:

使用 bundler,将以下代码添加到 Gemfile 中:

gem 'active_shipping'

或者独立安装:

$ gem install active_shipping

2. 项目使用说明

ActiveShipping 提供了以下主要功能:

  • 查找运输费用
  • 注册运输
  • 跟踪运输
  • 购买运输标签

支持的运输公司包括:

  • USPS
  • USPS Returns
  • FedEx
  • Canada Post
  • New Zealand Post
  • Shipwire
  • Stamps
  • Kunaki
  • Australia Post

示例用法

比较不同运输公司的费用

require 'active_shipping'

packages = [
  ActiveShipping::Package.new(100, [93,10], cylinder: true),
  ActiveShipping::Package.new(7.5 * 16, [15, 10, 4.5], units: :imperial)
]

origin = ActiveShipping::Location.new(country: 'US', state: 'CA', city: 'Beverly Hills', zip: '90210')
destination = ActiveShipping::Location.new(country: 'CA', province: 'ON', city: 'Ottawa', postal_code: 'K1P 1J1')

usps = ActiveShipping::USPS.new(login: 'developer-key')
response = usps.find_rates(origin, destination, packages)

usps_rates = response.rates.sort_by(&:price).collect { |rate| [rate.service_name, rate.price] }

跟踪 FedEx 包裹

fedex = ActiveShipping::FedEx.new(login: '999999999', password: '7777777', key: '1BXXXXXXXXXxrcB', account: '51XXXXX20')
tracking_info = fedex.find_tracking_info('tracking-number', carrier_code: 'fedex_ground')

tracking_info.shipment_events.each do |event|
  puts "#{event.name} at #{event.location.city}, #{event.location.state} on #{event.time}. #{event.message}"
end

3. 项目API使用文档

ActiveShipping 的 API 主要包括以下几个类:

  • ActiveShipping::Location: 表示地点,用于设置发件地和收件地。
  • ActiveShipping::Package: 表示包裹,用于设置包裹的尺寸和重量。
  • ActiveShipping::Response: 表示从运输公司获得的响应。

更多详细信息和示例,请参考项目的 GitHub Wiki。

4. 项目安装方式

如安装指南所述,您可以使用 bundler 或直接使用 gem 命令来安装 ActiveShipping。以下是安装代码:

使用 bundler:

gem 'active_shipping'

或者:

$ gem install active_shipping
登录后查看全文
热门项目推荐
相关项目推荐