aftership / aftership-sdk-ruby Goto Github PK

View Code? Open in Web Editor NEW

32.0 38.0 33.0 92 KB

The ruby gem SDK of AfterShip API

Home Page: https://www.aftership.com/docs/api/4

License: Other

Ruby 100.00%

aftership-sdk-ruby's Introduction

aftership-ruby

Ruby Gem for AfterShip API.

This extension helps developers to integrate with AfterShip easily.

About AfterShip

AfterShip provides an automated way for online merchants to track packages and send their customers delivery status notifications. Customers no longer need to deal with tracking numbers and track packages on their own. With AfterShip, online merchants extend their customer service after the point of purchase by keeping their customers actively informed, while saving time and money by reducing customers’ questions about the status of their purchase delivery.

Migration to 6.0.0+

We suggest all users to upgrade your aftership gem to v6.0.0 as any earlier versions are NOT maintained, which also means you will need to upgrade your ruby version to at least 2.6 to be able to use faraday the new http client of the revamped aftership gem.

If you want to use recent versions of Faraday, update your Gemfile as below:

gem "aftership", "~> 6.0.0"
gem 'faraday', '~> 2.7.1'

Changes

2024-01-02 6.0.0
- Supported API 2023-10 version.
2022-12-16 5.0.0
- Merged #42: Update faraday dependency to support faraday 2.x
- Merged #43: Update faraday minimum version to 2.0.1
2021-02-08 4.5.2
- Merged #39: Add compatibility for recent versions of Faraday
2021-02-08 4.5.1
- Resolved #31: Deprecation of encryption algorithms below 256 bits
2021-02-08 4.5.0
- Downgraded faraday to 1.0.1 that accepts ruby 2.3.0+ as required version.
- Updated request User agent to follow AfterShip SDK guideline.
- Required ruby version is now 2.3.0+
2021-02-08 4.4.0
- Removed httpclient and used faraday 1.3 as http client
- Polished project with prettified formatting
- Required ruby version updated to 2.4.0+
2016-01-11 4.3.1
- Updated gem httpclient version to 2.7.1
2015-12-14 4.3.0
- Added rescue methods for parsing JSON, and try to retrieve error codes from cloudflare
- Added /trackings/exports method
- Added auto-retry mechanism if invalid JSON response retrieved
2015-11-11 Pump version to 4.2.0
- Removed v3 code, support ENV variable AFTERSHIP_API_ENDPOINT for testing
2014-10-31 Pump version to 4.1.0
- Replaced HTTPI with HTTPClient
2014-10-28 Pump version to 4.0.0, support latest v4 api
- Adding deprecation messages
- Adding new api endpoints
- Make all changes regarding new API version
2014-04-11 Pump version to 3.0.1, support latest v3 api
- Removed the debug message
2014-04-11 Pump version to 3.0.0, support latest v3 api
- Change license to MIT

Installation

Add the following line to your application's Gemfile

gem "aftership", "~> 6.0.0"

Run bundler

bundle install

Configuration

Before you begin

You'll need to have a AfterShip account: http://www.aftership.com

Setup the API Key

You can retrieve your api key at: https://admin.aftership.com/settings/api-keys

Usage

Setup

Before using API, please include the gem in your script.

require 'rubygems'
require 'aftership'

You should set you API key before making any request to AfterShip.

AfterShip.api_key = 'YOUR_API_KEY' # Replace "YOUR_API_KEY" to your AfterShip api key.

Coding

require('aftership')
AfterShip.api_key = 'YOUR_API_KEY'

AfterShip::V4::Courier.get
AfterShip::V4::Courier.get_all
AfterShip::V4::Courier.detect({:tracking_number => 'EJ276142450JP'})

AfterShip::V4::Tracking.create('1ZA6F598D992381375', {:emails => ['[email protected]', '[email protected]']})
AfterShip::V4::Tracking.get('ups', '1ZA6F598D992381375')
AfterShip::V4::Tracking.get_all
AfterShip::V4::Tracking.update('ups', '1ZA6F598D992381375', {:title => 'Testing'})
AfterShip::V4::Tracking.retrack('ups', '1ZA6F598D992381375')
AfterShip::V4::Tracking.delete('ups', '1ZA6F598D992381375')

AfterShip::V4::LastCheckpoint.get('ups', '1ZA6F598D992381375')

The License (MIT)

Released under the MIT license. See the LICENSE file for the complete wording.

Contributor

Sergio Marques [email protected]
Ryan Zou twitter:renyuanz
Alex Topalov [email protected]

aftership-sdk-ruby's People

Contributors

Stargazers

Watchers

aftership-sdk-ruby's Issues

The tracking delete call doesn't allow params, but some carriers require tracking_ship_date

In particular, deutsch-post requires it for all API calls (create, get, delete).

Happy to provide an example request / response if that's helpful.

Update httpclient dependency to ~> 2.8.3

Hi,

Any plans to upgrade dependency on httpclient to httpclient 2.8.3 (change log)

The current dependency on httpclient ~> 2.7.1 is causing conflicts with other gems that depend on the newer version.

Thanks,
Brent

[Question] Migration from legacy API to 2023-10

With the recently released breaking changes to the Aftership API, is there any plans to update the gem to support/use the 2023-10 version of the API?

TLS v 1.2

Hi, I wanted to check to see if this gem is configured to use TLS v1.2

Aftership is no longer allowing any TLS version below 1.2. See here: https://help.aftership.com/hc/en-us/articles/360048857374-AfterShip-secures-connections-with-TLS-1-2-and-above

Thanks!

Deprecation of encryption algorithms below 256 bits

As per Aftership's Feb 4th, email:

The purpose of this email is to update you regarding the deprecation of encryption algorithms (below 256 bits). It will be done for all our API services from 25th Feburary 2021.

If you’d like to test endpoints, then please use api-tls.aftership.com for testing. It supports all the endpoints!

Overriding the API endpoint, this indeed will be an issue with the Aftership SDK in its current form.

While requests succeed when launching a rails console with:

AFTERSHIP_API_ENDPOINT=https://api.aftership.com rails c

Requests are failing when changing it as per the email suggestion:

AFTERSHIP_API_ENDPOINT=https://api-tls.aftership.com rails c

[4] pry(main)> AfterShip::V4::Courier.get_all { :meta => { :code => 500, :message => "Something went wrong on AfterShip's end.", :type => "InternalError" }, :data => { :body => "<!DOCTYPE html>\n<html lang=en>\n <meta charset=utf-8>\n <meta name=viewport content=\"initial-scale=1, minimum-scale=1, width=device-width\">\n <title>Error 400 (Bad Request)!!1</title>\n <style>\n *{margin:0;padding:0}html,code{font:15px/22px arial,sans-serif}html{background:#fff;color:#222;padding:15px}body{margin:7% auto 0;max-width:390px;min-height:180px;padding:30px 0 15px}* > body{background:url(//www.google.com/images/errors/robot.png) 100% 5px no-repeat;padding-right:205px}p{margin:11px 0 22px;overflow:hidden}ins{color:#777;text-decoration:none}a img{border:0}@media screen and (max-width:772px){body{background:none;margin-top:0;max-width:none;padding-right:0}}#logo{background:url(//www.google.com/images/branding/googlelogo/1x/googlelogo_color_150x54dp.png) no-repeat;margin-left:-5px}@media only screen and (min-resolution:192dpi){#logo{background:url(//www.google.com/images/branding/googlelogo/2x/googlelogo_color_150x54dp.png) no-repeat 0% 0%/100% 100%;-moz-border-image:url(//www.google.com/images/branding/googlelogo/2x/googlelogo_color_150x54dp.png) 0}}@media only screen and (-webkit-min-device-pixel-ratio:2){#logo{background:url(//www.google.com/images/branding/googlelogo/2x/googlelogo_color_150x54dp.png) no-repeat;-webkit-background-size:100% 100%}}#logo{display:inline-block;height:54px;width:150px}\n </style>\n <a href=//www.google.com/><span id=logo aria-label=Google></span></a>\n <p><b>400.</b> <ins>That’s an error.</ins>\n <p>Your client has issued a malformed or illegal request. <ins>That’s all we know.</ins>\n", :cf_ray => nil } }

Slug with whitespace, causing Bad URI error

Here is the error log:

URI::InvalidURIError (bad URI(is not URI?)

remove debug `put`

Base.call is has some debug left overs:

puts "request"
puts request.url

see: https://github.com/AfterShip/aftership-ruby/blob/master/lib/aftership/base.rb#L26-L27

httpclient dependency issue with Ruby 2.3.0

Any plans of upgrading the dependent version of httpclient ??

The current version gives this warning in Ruby 2.3.0 -

/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/httpclient-2.5.3.3/lib/httpclient/session.rb:762:in `connect': Object#timeout is deprecated, use Timeout.timeout instead.

testing issue

Testing bot message