A RubyGem for HyperTrack's Backend API

Add this line to your application's Gemfile:

gem 'hypertrack'

And then run bundle install on command line.

Or install it yourself as: gem install hypertrack

require 'hypertrack'
HyperTrack.secret_key = "<YOUR_SECRET_KEY>"

• Driver

  • Create

    HyperTrack::Driver.create(name: "SomeDriver", vehicle_type: "car")

  • Retrieve

    HyperTrack::Driver.retrieve(driver_id)

  • List all

    HyperTrack::Driver.list

  • Driver Overview

    HyperTrack::Driver.retrieve(driver_id).overview

  • Map List for all Drivers

    HyperTrack::Driver.map_list

• Customer

  • Create

    HyperTrack::Customer.create(name: "SomeCustomer")

  • Retrieve

    HyperTrack::Customer.retrieve(customer_id)

  • List

    HyperTrack::Customer.list

• Destination

  • Create

    HyperTrack::Destination.create(customer_id: "customer_id")

  • Retrieve

    HyperTrack::Destination.retrieve(destination_id)

  • List

    HyperTrack::Destination.list

• Task

  • Create

    HyperTrack::Task.create

  • Retrieve

    HyperTrack::Task.retrieve(task_id)

  • List

    HyperTrack::Task.list

  • Editable URLs

    HyperTrack::Task.retrieve(task_id).editable_url({ editable: value })

  • Start

    task = HyperTrack::Task.retrieve(task_id)
    task.start({ start_location: { type: "Point", coordinates: [ 72.0, 19.0 ] }, vehicle_type: "car", driver_id: driver_id, start_time: Time.now.strftime("%Y-%m-%dT%H:%M") })

  • Complete

    task = HyperTrack::Task.retrieve(task_id)
    task.complete({ completion_location: { type: "Point", coordinates: [ 72.0, 19.3 ] }, completion_time: Time.now.strftime("%Y-%m-%dT%H:%M") })

  • Cancel

    HyperTrack::Task.retrieve(task_id).cancel

  • Update Destination Location

    HyperTrack::Task.retrieve(task_id).update_destination({ location: { type: "Point", coordinates: [ 71.5, 19.0 ] } })

• Trip

  • Start

    HyperTrack::Trip.create({ driver_id: driver_id, start_location: { type: "Point", coordinates: [ 72.0, 19.0 ] }, tasks: [task1_id, task2_id], vehicle_type: "car", has_ordered_tasks: true })

  • Retrieve

    HyperTrack::Trip.retrieve(trip_id)

  • List

    HyperTrack::Trip.list

  • End Trip

    HyperTrack::Trip.retrieve(trip_id).end_trip({ end_location: { type: "Point", coordinates: [ 71.5, 19.0 ] } })

  • Send ETAs

    HyperTrack::Trip.sending_eta({ driver: driver_hash, destination: destination_hash })

  • Add Task

    HyperTrack::Trip.retrieve(trip_id).add_task({ task_id: task_id })

  • Remove Task

    HyperTrack::Trip.retrieve(trip_id).remove_task({ task_id: task_id })

  • Change task order

    HyperTrack::Trip.retrieve(trip_id).change_task_order({ task_order: [task1_id, task2_id] })

• Neighbourhood

  • Retrieve

    HyperTrack::Neighbourhood.retrieve(neighbourhood_id)

  • List all

    HyperTrack::Neighbourhood.list

• Fleet

  • Create

    HyperTrack::Fleet.create(name: "some_fleet")

  • Retrieve

    HyperTrack::Fleet.retrieve(fleet_id)

  • List all

    HyperTrack::Fleet.list

• Hub

  • Create

    HyperTrack::Hub.create(name: "some_hub")

  • Retrieve

    HyperTrack::Hub.retrieve(hub_id)

  • List all

    HyperTrack::Hub.list

• Shift

  • Start

    HyperTrack::Shift.create({ driver_id: "some_driver_id", start_location: { type: "Point", coordinates: [ 72.0, 19.0 ] } })

  • Retrieve

    HyperTrack::Shift.retrieve(shift_id)

  • List all

    HyperTrack::Shift.list

  • End Shift

    HyperTrack::Shift.retrieve(shift_id).end_shift(end_location: { type: "Point", coordinates: [ 72.0, 19.2 ] } })

• Event

  • Retrieve

    HyperTrack::Event.retrieve(event_id)

  • List all

    HyperTrack::Event.list

• GPS Log

  • Retrieve

    HyperTrack::GPSLog.retrieve(event_id)

  • List all

    HyperTrack::GPSLog.list

  • Filtered List

    HyperTrack::GPSLog.filtered_list(driver_id:  "some_driver_id")