Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 981 Bytes

README.md

File metadata and controls

42 lines (26 loc) · 981 Bytes
Raw

Shiphawk::Client

Ruby wrapper for the ShipHawk V3 API. The ShipHawk::Client gem provides an easy-to-use wrapper for ShipHawk's REST APIs.

Installation

Add this line to your application's Gemfile:

gem 'shiphawk'

And then execute:

$ bundle

Or install it yourself as:

$ gem install shiphawk

Usage

View the Examples

End points

Errors and Exceptions

When an error status is received from the server, the gem will raise an error on the client side:

  • 400 raises Shiphawk::Errors::GeneralError
  • 401 raises Shiphawk::Errors::UnauthorizedError
  • 403 raises Shiphawk::Errors::AccessDeniedError
  • 404 raises Shiphawk::Errors::NotFoundError
  • 422 raises Shiphawk::Errors::UnprocessableEntityError
  • 500 raises Shiphawk::Errors::InformShiphawkError
  • 502 raises Shiphawk::Errors::UnavailableError
  • 503 raises Shiphawk::Errors::UnavailableError

Copyright

Copyright (c) 2015 Hawk Applications Corp. See LICENSE for details.