gdinko / speedy
Laravel Speedy API Wrapper
Installs: 2 006
Dependents: 0
Suggesters: 0
Security: 0
Stars: 17
Watchers: 1
Forks: 2
Open Issues: 0
Requires
- php: ^7.4|^8.0|^8.1|^8.2|^8.3
- guzzlehttp/guzzle: ^7.4
- illuminate/support: ^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- nunomaduro/collision: ^5.11
- nunomaduro/larastan: ^1.0
- orchestra/testbench: ^6.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.2
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.1
- phpunit/phpunit: ^9.0
README
Installation
You can install the package via composer:
composer require gdinko/speedy
If you plan to use database for storing nomenclatures:
php artisan migrate
If you need to export configuration file:
php artisan vendor:publish --tag=speedy-config
If you need to export migrations:
php artisan vendor:publish --tag=speedy-migrations
If you need to export models:
php artisan vendor:publish --tag=speedy-models
If you need to export commands:
php artisan vendor:publish --tag=speedy-commands
Configuration
SPEEDY_API_USER= #Get this from Speedy SPEEDY_API_PASS= #Get this from Speedy SPEEDY_API_BASE_URL= #default=https://api.speedy.bg/v1/ SPEEDY_API_TIMEOUT= #default=5
Usage
Runtime Setup
Speedy::setAccount('user', 'pass'); Speedy::setBaseUrl('endpoint'); Speedy::setTimeout(99); Speedy::addAccountToStore('AccountUser', 'AccountPass'); Speedy::getAccountFromStore('AccountUser'); Speedy::setAccountFromStore('AccountUser');
Multiple Account Support In AppServiceProvider add accounts in boot method
public function boot() { Speedy::addAccountToStore( 'AccountUser', 'AccountPass' ); Speedy::addAccountToStore( 'AccountUser_XXX', 'AccountPass_XXX' ); }
Methods
use Gdinko\Speedy\Facades\Speedy; //Shipment Service Speedy::createShipment(Hydrator $hydrator): array Speedy::cancelShipment(Hydrator $hydrator): array Speedy::addParcel(Hydrator $hydrator): array Speedy::finalizePendingShipment(Hydrator $hydrator): array Speedy::shipmentInformation(Hydrator $hydrator): array Speedy::secondaryShipments($shipmentId, Hydrator $hydrator): array Speedy::updateShipment(Hydrator $hydrator): array Speedy::updateShipmentProperties(Hydrator $hydrator): array Speedy::findParcelsByReference(Hydrator $hydrator): array Speedy::handoverToCourier(Hydrator $hydrator): array //Print Service Speedy::print(Hydrator $hydrator): string Speedy::extendedPrint(Hydrator $hydrator): array Speedy::labelInfo(Hydrator $hydrator): array Speedy::printVoucher(Hydrator $hydrator): string //Track And Trace Service Speedy::track(Hydrator $hydrator): array Speedy::bulkTrackingDataFiles(Hydrator $hydrator): array //Pickup Service Speedy::pickup(Hydrator $hydrator): array Speedy::pickupTerms(Hydrator $hydrator): array //Location Service Speedy::getCountry($id, Hydrator $hydrator): array Speedy::findCountry(Hydrator $hydrator): array Speedy::getAllCountries(Hydrator $hydrator): object Speedy::getState($id, Hydrator $hydrator): array Speedy::findState(Hydrator $hydrator): array Speedy::getAllStates($countryId, Hydrator $hydrator): object Speedy::getSite($id, Hydrator $hydrator): array Speedy::findSite(Hydrator $hydrator): array Speedy::getAllSites($countryId, Hydrator $hydrator): object Speedy::getStreet($id, Hydrator $hydrator): array Speedy::findStreet(Hydrator $hydrator): array Speedy::getAllStreets($countryId, Hydrator $hydrator): object Speedy::getComplex($id, Hydrator $hydrator): array Speedy::findComplex(Hydrator $hydrator): array Speedy::getAllComplexes($countryId, Hydrator $hydrator): object Speedy::findBlock(Hydrator $hydrator): array Speedy::getPoi($id, Hydrator $hydrator): array Speedy::findPoi(Hydrator $hydrator): array Speedy::getAllPoi($countryId, Hydrator $hydrator): object Speedy::getAllPostcodes($countryId, Hydrator $hydrator): object Speedy::getOffice($id, Hydrator $hydrator): array Speedy::findOffice(Hydrator $hydrator): array //Calculation Service Speedy::calculate(Hydrator $hydrator): array //Client Service Speedy::getClient($id, Hydrator $hydrator): array Speedy::getContractClients(Hydrator $hydrator): array Speedy::createContact(Hydrator $hydrator): array Speedy::getContactByExternalId($id, Hydrator $hydrator): array Speedy::getOwnClientId(Hydrator $hydrator): array //Validation Service Speedy::validateAddress(Hydrator $hydrator): array Speedy::validatePostcode(Hydrator $hydrator): array Speedy::validatePhone(Hydrator $hydrator): array Speedy::validateShipment(Hydrator $hydrator): array //Services Service Speedy::services(Hydrator $hydrator): array Speedy::destinationServices(Hydrator $hydrator): array //Payments Service Speedy::payments(Hydrator $hydrator): array
Commands
#get payments (use -h to view options) php artisan speedy:get-payments #get speedy api status (use -h to view options) php artisan speedy:api-status #sync countries with database (use -h to view options) php artisan speedy:sync-countries #sync cities with database (use -h to view options) php artisan speedy:sync-cities #create cities map with other carriers in database (use -h to view options) php artisan speedy:map-cities #sync offices with database (use -h to view options) php artisan speedy:sync-offices #track parcels (use -h to view options) php artisan speedy:track
Models
CarrierSpeedyCountry CarrierSpeedyCity CarrierSpeedyOffice CarrierSpeedyTracking CarrierSpeedyPayment CarrierSpeedyApiStatus CarrierCityMap
Events
CarrierSpeedyTrackingEvent CarrierSpeedyPaymentEvent
Parcels Tracking
- Subscribe to tracking event, you will recieve last tracking info, if tracking command is schduled
Event::listen(function (CarrierSpeedyTrackingEvent $event) { echo $event->account; dd($event->tracking); });
- Before use of tracking command you need to create your own command and define setUp method
php artisan make:command TrackCarrierSpeedy
- In app/Console/Commands/TrackCarrierSpeedy define your logic for parcels to be tracked
use Gdinko\Speedy\Commands\TrackCarrierSpeedyBase; class TrackCarrierSpeedySetup extends TrackCarrierSpeedyBase { protected function setup() { //define parcel selection logic here // $this->parcels = []; } }
- Use the command
php artisan speedy:track
Examples
Subscribe to payment event
Event::listen(function (CarrierSpeedyPaymentEvent $event) { echo $event->account; dd($event->payment); });
Check for payments from today
php artisan speedy:get-payments
Get All Countries
use Gdinko\Speedy\Facades\Speedy; use Gdinko\Speedy\Hydrators\Request; dd( Speedy::getAllCountries( new Request() )->toArray() );
Find Country
use Gdinko\Speedy\Facades\Speedy; use Gdinko\Speedy\Hydrators\Request; dd( Speedy::findCountry( new Request([ 'name' => 'bulgaria' ]) ) );
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email dinko359@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.