EasyPost, the simple shipping solution. You can sign up for an account at https://easypost.com.
Add this to your project's POM:
<dependency>
<groupId>com.easypost</groupId>
<artifactId>easypost-api-client</artifactId>
<version>6.7.0</version>
</dependency>Add this to your project's build file:
implementation "com.easypost:easypost-api-client:6.7.0"NOTE: Google Gson is required.
A simple create & buy shipment example:
package shipments;
import com.easypost.EasyPost;
import com.easypost.exception.EasyPostException;
import com.easypost.model.Shipment;
import com.easypost.service.EasyPostClient;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class CreateShipment {
public static void main(String[] args) {
EasyPostClient client = new EasyPostClient(System.getenv("EASYPOST_API_KEY"));
Map<String, Object> fromAddressMap = new HashMap<String, Object>();
fromAddressMap.put("company", "EasyPost");
fromAddressMap.put("street1", "417 MONTGOMERY ST");
fromAddressMap.put("street2", "FLOOR 5");
fromAddressMap.put("city", "SAN FRANCISCO");
fromAddressMap.put("state", "CA");
fromAddressMap.put("country", "US");
fromAddressMap.put("zip", "94104");
fromAddressMap.put("phone", "415-123-4567");
Map<String, Object> toAddressMap = new HashMap<String, Object>();
toAddressMap.put("name", "Dr. Steve Brule");
toAddressMap.put("street1", "179 N Harbor Dr");
toAddressMap.put("city", "Redondo Beach");
toAddressMap.put("state", "CA");
toAddressMap.put("country", "US");
toAddressMap.put("zip", "90277");
toAddressMap.put("phone", "310-808-5243");
Map<String, Object> parcelMap = new HashMap<String, Object>();
parcelMap.put("weight", 22.9);
parcelMap.put("height", 12.1);
parcelMap.put("width", 8);
parcelMap.put("length", 19.8);
Map<String, Object> shipmentMap = new HashMap<String, Object>();
shipmentMap.put("from_address", fromAddressMap);
shipmentMap.put("to_address", toAddressMap);
shipmentMap.put("parcel", parcelMap);
Shipment shipment = client.shipment.create(shipmentMap);
Shipment boughtShipment = client.shipment.buy(shipment.lowestRate(), shipment.getId());
System.out.println(boughtShipment.prettyPrint());
}
}API documentation can be found at: https://easypost.com/docs/api.
Library documentation can be found on the web at: https://easypost.github.io/easypost-java/ or by building them locally via the make docs command.
Upgrading major versions of this project? Refer to the Upgrade Guide.
New features and bug fixes are released on the latest major release of this library. If you are on an older major release of this library, we recommend upgrading to the most recent release to take advantage of new features, bug fixes, and security patches. Older versions of this library will continue to work and be available as long as the API version they are tied to remains active; however, they will not receive updates and are considered EOL.
For additional support, see our org-wide support policy.
# Install dependencies
make install
# Build project
make build
# Lint project
make lint
# Run tests
EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make build test
# Run tests with coverage
EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make coverage
# Run security analysis
make scan
# Generate library documentation
make docs
# Update submodules
git submodule init
git submodule update --remoteThe test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them.
This project uses EasyVCR to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run.
Sensitive Data: We've made every attempt to include scrubbers for sensitive data when recording cassettes so that PII or sensitive info does not persist in version control; however, please ensure when recording or re-recording cassettes that prior to committing your changes, no PII or sensitive information gets persisted by inspecting the cassette.
Making Changes: If you make an addition to this project, the request/response will get recorded automatically for you. When making changes to this project, you'll need to re-record the associated cassette to force a new live API call for that test which will then record the request/response used on the next run.
Test Data: The test suite has been populated with various helpful fixtures that are available for use, each completely independent from a particular user with the exception of the USPS carrier account ID (see Unit Test API Keys for more information) which has a fallback value of our internal testing user's ID. Some fixtures use hard-coded dates that may need to be incremented if cassettes get re-recorded (such as reports or pickups).
For some unit tests, you may need to mock certain API calls. The VCR utility in the test suite accepts an option list of MockRequest objects via the setUpTest function (see Mocking below).
// Construct a new VCR
TestUtils.VCR vcr = new TestUtils.VCR("cassette_folder", TestUtils.ApiKey.TEST);
// Construct a list of mock requests
List<MockRequest> mockRequests = new ArrayList<>();
mockRequests.add(
new MockRequest(
new MockRequestMatchRules(Requestor.RequestMethod.POST, ".*\\/rates.*"),
new MockResponse(200, "data-to-return")
)
);
// Set up the test with the VCR and mock requests
vcr.setUpTest("cassette_name", mockRequests);
// Use the VCR's client as you would a normal client
vcr.client.carrierAccount....When mock requests are provided, any API call matching a mock request (by HTTP method and URL regex pattern) will return the associated mock response; any request that does not match will be passed along to the VCR where it will either be replayed or recorded depending on the VCR mode.
The following are required on every test run:
EASYPOST_TEST_API_KEYEASYPOST_PROD_API_KEY
Some tests may require an EasyPost user with a particular set of enabled features such as a Partner user when creating referrals. We have attempted to call out these functions in their respective docstrings. The following are required when you need to re-record cassettes for applicable tests:
USPS_CARRIER_ACCOUNT_ID(eg: one-call buying a shipment for non-EasyPost employees)PARTNER_USER_PROD_API_KEY(eg: creating a referral user)REFERRAL_CUSTOMER_PROD_API_KEY(eg: adding a credit card to a referral user)
We have implemented a custom, lightweight HTTP mocking functionality in this library that allows us to mock HTTP calls and responses.
A mock client is the same as a normal client, with a set of mock request-response pairs stored as a property.
At the time of making a real HTTP request, a mock client will instead check which mock request entry matches the queued request (matching by HTTP method and a regex pattern for the URL), and will return the corresponding mock response (HTTP status code and body).
NOTE: If a client is configured with a mocking utility, it will ONLY make mock requests. If it attempts to make a request that does not match any of the configured mock requests, the request will fail and trigger an exception.
To use the mocking utility:
// Create a mock client
MockClient mockClient = new MockClient();
// Add a mock request-response pair
mockClient.addRequest(
new MockRequest(
new MockRequestMatchRules(RequestMethod.GET, ".*payment_methods$"), // if any request uses GET and matches the regex pattern, it will return the mock response
new MockResponse(200, "data-to-return")
)
);
// use the mock client as you would a normal client
mockClient.billing... // will return "data-to-return" if the request matches the mock request