Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jereinhardt/shipping-scale
An ruby interface for the USPS Rate Calculator API
https://github.com/jereinhardt/shipping-scale
Last synced: about 2 months ago
JSON representation
An ruby interface for the USPS Rate Calculator API
- Host: GitHub
- URL: https://github.com/jereinhardt/shipping-scale
- Owner: jereinhardt
- License: mit
- Created: 2016-11-26T16:50:57.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-05T13:59:09.000Z (almost 8 years ago)
- Last Synced: 2024-11-18T02:34:49.605Z (2 months ago)
- Language: Ruby
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ShippingScale
ShippingScale is a simple interface with the USPS Price Calculator API. With it, you can quickly and easily calculate postage prices for packages.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'shipping-scale'
# or from the github repository
gem 'shipping-scale', :git => 'https://github.com/jereinhardt/shipping-scale.git'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install shipping-scale
## Setup
In order to properly configure your interface, you must first have a registered developer account with the US Postal Service.
Add an initializer to your application and configure it to use your API USER ID
```ruby
ShippingScale.configure do |config|
config.user_id = ENV["USPS_USER_ID"]
config.timeout = 5
config.testing = false
end
```
## Usage
If you have all of the necessary information for the package you want to ship, using the gem is as simple as creating an instance of `ShipingScale::Package` and using `#get_price!`. Other details are also returned with this method.
```ruby
package_options = {
pounds: 1,
ounces: 8, # or weight: 1.5
zip_origin: "66204",
zip_destination: "63501"
}
package = ShippingScale::Package.new(package_options)
# for the value of postage on a single package
package.price # => 15
# for other details sent back from the request
package.details # => { zip_origination: "66204", zip_destination: "63501", pounds: "1", ... }
```
You can also get the price of multiple packages sent in the same shipment.
```ruby
packages = [
{pounds: 1, ...},
{pounds: 5, ...}
]
shipment = ShippingScale::Package.shipment(packages)
# for the total price of the shipment
shipment.price # => 25
# for the price of each individual package in the shipment, by package ID
shipment.prices # => {"1" => 10, "2" => 15}
# for details sent back by the request
shipment.details # => { zip_origination: "66204", ... }
```
Currently, all rates retreived from the USPS API are for 2-day Priority Mail only.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
Bug reports and pull requests are welcome on GitHub at https://github.com/jereinhardt/shipping-scale.