From c1f1223c521f0d3e7febaffd405edee97f8a3523 Mon Sep 17 00:00:00 2001 From: Kyle Arrington Date: Sun, 21 Apr 2013 00:26:18 -0500 Subject: [PATCH] Added changelog, updated README, version bump --- README.markdown | 23 ++++++++++++++++++----- composer.json | 2 +- public/index.php | 8 ++++++++ views/application.twig | 4 ++-- views/changelog.twig | 26 ++++++++++++++++++++++++++ 5 files changed, 55 insertions(+), 8 deletions(-) create mode 100644 views/changelog.twig diff --git a/README.markdown b/README.markdown index 06be78c..afb7e58 100644 --- a/README.markdown +++ b/README.markdown @@ -8,21 +8,34 @@ Jeepstatus.com will report to you the status of a Jeep whose information is foun Chrysler's VOTS relies on asyncronous calls to an address that returns an invalid, but close, JSON response. By highjacking the async call and performing a lookup on an array, we can get a more specific explanation of where the vehicle is actually reported as being. -This repository more specifically runs on (taken from the composer.json file): +### Requirments/Built On + +This service is built on [Slim Framework](https://github.com/codeguy/Slim) with the addition of [Slim Extras](https://github.com/codeguy/Slim-Extras), [Twig](http://twig.sensiolabs.org/) for templating, and [Predis](https://github.com/nrk/predis) for caching in a redis server. + +You should install the components via composer. Outside of that (and a webserver with rewrite on) you only need a copy of redis running. ``` json { - "name": "jeepsomething", + "name": "jeepstatus", "require": { "slim/slim": "2.*", "slim/extras": "*", - "twig/twig": "*" + "twig/twig": "*", + "predis/predis": "0.8.*@dev" } } ``` -### Warranty -There is none. Use this tool at your own peril. All actual information (save the lookup table) comes directly from Chrysler. Here be dragons. +### Changelog + +#### 0.2 +52 times a day is a lot +Not wanting to bombard Chrysler's VOTS service every 5 minutes from the same address, implemented a redis server to cache the json result for 20 minutes. The interval does not grow or shrink depending on how many times you hit the url. 20 minutes. Go drink a coffee or beer or something. + +#### 0.1 +Initial Creation: +JeepStatus is born from the exhaustion of looking at JSON backend code provided by Chrysler than doesn't actually show all the information they are providing. By coupling the actual data response with a dealer provdied list (available on many jeep websites) we can cross refence and get a better description of where the vehicle actually is. + ### License diff --git a/composer.json b/composer.json index 253bc82..a69dd49 100644 --- a/composer.json +++ b/composer.json @@ -1,5 +1,5 @@ { - "name": "jeepsomething", + "name": "jeepstatus", "require": { "slim/slim": "2.*", "slim/extras": "*", diff --git a/public/index.php b/public/index.php index 67f2646..a17717b 100644 --- a/public/index.php +++ b/public/index.php @@ -104,6 +104,14 @@ }); +// // Changelog +$app->get('/changelog', function () use ($app) { + + //Do something + $app->render('changelog.twig'); + +}); + // // Home $app->get('/', function () use ($app) { diff --git a/views/application.twig b/views/application.twig index d9e595c..6e06681 100644 --- a/views/application.twig +++ b/views/application.twig @@ -49,7 +49,7 @@

Jeep Status

-
Version 0.1
+
Version 0.2
@@ -57,7 +57,7 @@

- Question? Comments? Email me. + Question? Comments? Broken? Email me.

diff --git a/views/changelog.twig b/views/changelog.twig new file mode 100644 index 0000000..aec5c23 --- /dev/null +++ b/views/changelog.twig @@ -0,0 +1,26 @@ +{% extends "application.twig" %} + +{% block container %} + +
+

+ Changelog +

+ +

+ 0.2
+ 52 times a day is a lot
+ Not wanting to bombard Chrysler's VOTS service every 5 minutes from the same address, implemented a redis server to cache the json result for 20 minutes. The interval does not grow or shrink depending on how many times you hit the url. 20 minutes. Go drink a coffee or beer or something. +

+ +

+ 0.1
+ Initial Creation:
+ JeepStatus is born from the exhaustion of looking at JSON backend code provided by Chrysler than doesn't actually show all the information they are providing. By coupling the actual data response with a dealer provdied list (available on many jeep websites) we can cross refence and get a better description of where the vehicle actually is. +

+ +
+ + + +{% endblock container %}