Introduction

This application connects to the Microsoft SQL back-end of a Trapeze EAM installation and provides API endpoints (in JSON format) for fueling information.

It's unlikely that this project fulfills a need for anyone other than us, but you never know...

Configuration

This application only knows how to communicate with the MS-SQL-backed EAM. We don't have any experience with the Oracle-backed version, but it might be possible: the schema is the same, and there is an Oracle activerecord adaptor. PRs welcome.

Create a database.yml file in the config directory and fill in your database information. The MS-SQL username specified here only needs read-only access to the FTK_MAIN table.

development:
  adapter:  sqlserver
  host:     dev.example.com
  database: dbname
  username: username
  password: password
  
production:
  adapter:  sqlserver
  host:     prod.example.com
  database: dbname
  username: username
  password: password

Install the gem requirements with Bundler.

API

Every JSON response has the following format:

{ "connection_valid": true,
  "error":            "If connection_valid is false, why?",
  "fueling":          [
                        {
                        "EQ_equip_no":       "vehicle_name",
                        "amount":            10.0,
                        "fuel_focus_row_id": 12345,
                        "mileage":           100234,
                        "time_at":           "2000-01-01T00:00:30.000Z",
                        "time_at_insertion": "2000-01-01T00:00:40.000Z"
                        }, "etc"
                      ]
}

time_at is the date and time of the actual fueling (from the pump), while time_at_insertion is the time that it made it into the database.

API URLs

GET /vehicle/<vehicle name>

returns all fuelings for the specified vehicle

GET /vehicle/<vehicle name>/<timestamp>

returns all fuelings for the specified vehicle since the given Unix timestamp

GET /vehicle/<vehicle name>/<start>/<end>

returns all fuelings for the specified vehicle between the two Unix timestamps, "start" and "end"

GET /all/<timestamp>

returns all fuelings since the given Unix timestamp

GET /all/<start>/<end>

returns all fuelings that happened between the two Unix timestamps, "start" and "end"

Running the app

script/server

will start the development server using Puma. Alternately, it's a Sinatra application, so it can run under any Rack-compatible web server.

License

This code is released under the MIT license. See the file LICENSE for more info.