开源项目 Active Shipping 使用教程

开源项目 Active Shipping 使用教程

active_shippingActiveShipping is a simple shipping abstraction library extracted from Shopify项目地址:https://gitcode.com/gh_mirrors/ac/active_shipping

1. 项目的目录结构及介绍

Active Shipping 是一个用于处理物流和运输服务的 Ruby gem。以下是其主要目录结构及其功能介绍：

active_shipping/
├── lib/
│   ├── active_shipping/
│   │   ├── base/
│   │   ├── carriers/
│   │   ├── exceptions/
│   │   ├── locations/
│   │   ├── package.rb
│   │   ├── response.rb
│   │   ├── shipping_methods.rb
│   │   ├── version.rb
│   │   └── ...
│   └── active_shipping.rb
├── spec/
│   ├── active_shipping/
│   │   ├── carriers/
│   │   ├── locations/
│   │   ├── package_spec.rb
│   │   ├── response_spec.rb
│   │   └── ...
│   └── spec_helper.rb
├── Gemfile
├── Gemfile.lock
├── README.md
└── ...

• lib/: 包含项目的核心代码。
  • active_shipping/: 主要功能模块。
    • base/: 基础类和模块。
    • carriers/: 支持的物流服务商实现。
    • exceptions/: 异常处理类。
    • locations/: 位置相关的类和模块。
    • package.rb: 包裹类。
    • response.rb: 响应类。
    • shipping_methods.rb: 运输方法类。
    • version.rb: 版本信息。
• spec/: 包含测试代码。
  • active_shipping/: 对应 lib/ 目录的测试。
• Gemfile: 依赖管理文件。
• Gemfile.lock: 依赖锁定文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

Active Shipping 的启动文件是 lib/active_shipping.rb。这个文件负责加载项目的核心模块和依赖项。

# lib/active_shipping.rb

require 'active_support'
require 'active_support/core_ext'
require 'active_support/inflector'
require 'active_model'
require 'measured'
require 'net/http'
require 'nokogiri'
require 'active_shipping/version'

module ActiveShipping
  extend ActiveSupport::Autoload

  autoload :Base
  autoload :Carrier
  autoload :Location
  autoload :Package
  autoload :Response
  autoload :ShippingMethod
  autoload :UPS
  autoload :USPS
  autoload :FedEx
  autoload :CanadaPost
  autoload :Shipwire
  autoload :Stamps
  autoload :Kunaki
  autoload :RateEstimate
  autoload :Address
  autoload :CustomsItem
  autoload :CustomsInfo
  autoload :OptionSet
  autoload :OptionError
  autoload :ResponseError
  autoload :ConnectionError
  autoload :RateResponse
  autoload :RateResponseError
  autoload :TrackingResponse
  autoload :TrackingResponseError
  autoload :PickupResponse
  autoload :PickupResponseError
  autoload :ValidationError
  autoload :InvalidCredentialsError
  autoload :InvalidDestinationError
  autoload :InvalidOriginError
  autoload :InvalidPackageError
  autoload :UnknownCarrierError
  autoload :CarrierRegistry
end

3. 项目的配置文件介绍

Active Shipping 的配置文件主要是 Gemfile 和 Gemfile.lock。Gemfile 定义了项目的依赖项，而 Gemfile.lock 则锁定了这些依赖项的具体版本。

# Gemfile

source 'https://rubygems.org'

gem 'active_shipping', '~> 1.0'
gem 'active_support', '~> 6.0'
gem 'active_model', '~> 6.0'
gem 'measured', '~> 2.0'
gem 'net-http', '~> 0.1'
gem 'nokogiri', '~> 1.10'

Gemfile.lock 文件内容较长，通常不需要手动编辑，它由 Bundler 自动生成和管理。

active_shippingActiveShipping is a simple shipping abstraction library extracted from Shopify项目地址:https://gitcode.com/gh_mirrors/ac/active_shipping