Merge master

README.md

@@ -13,11 +13,13 @@ For more information please check out my [blog](http://michaelthessel.com/tag/pw
 Example
 ============
 
-https://pwx.michaelthessel.com
+https://pwx.io
 
 Installation
 ============
 
+Download the current stable release [here](https://github.com/MichaelThessel/pwx/archive/v1.0.zip) or clone the repository.
+
 Install dependencies:
 ```
 # php composer.phar install
@@ -32,10 +34,16 @@ Create the database schema:
 ```
 # app/console orm:schema-tool:create
 ```
+Web server configuration
+========================
+
+The [Silex Documentation](http://silex.sensiolabs.org/doc/web_servers.html) has example configurations for Apache, nginx, IIS & Lighttpd.
 
 Update
 ======
 
+Download the latest source code.
+
 If you are updating to a newer version follow these steps.
 
 Update dependencies:
@@ -55,6 +63,7 @@ Currently:
 
  * English (en)
  * Spanish (es)
+ * Esperanto (eo)
  * and German (de)
 
 are supported by PWX. Please set locale according to your requirements in the
@@ -64,7 +73,7 @@ You can use a GET parameter when linking to PWX. I.e.
 
 https://example.com?locale=es
 
-This allows for one instance of PWX dynamically to be accessed in different
+This allows for one instance of PWX dynamically being accessed in different
 languages.
 
 Themes
@@ -98,6 +107,50 @@ To run the integrated test suite please run:
 ```
 # vendor/bin/phpunit
 ```
+API
+===
+
+PWX offers a simple API with the following endpoints:
+
+**Save an entry**
+
+```
+Request Methoud: POST
+End Point: https://example.com/api
+Params:
+    userName: string (default: "")
+    password: string (reqired)
+    comment: string (default: "")
+    expires: int (time in s from when the entry will expire, min: 1h, max: 30days, default: 3600)
+    oneTimeView: bool (whether or not the entry will be deleted after viewing it once, default: false)
+Response:
+    hash string (id of entry)
+```
+
+**Retrieve an entry**
+
+```
+Request Methoud: GET
+End Point: https://example.com/api/[hash]
+Params:
+    n/a
+Response:
+    hash: string
+    userName: string
+    password: string
+    comment: string
+```
+
+**Delete an entry**
+
+```
+Request Methoud: DELETE
+End Point: https://example.com/api/[hash]
+Params:
+    n/a
+Response:
+    n/a
+```
 
 Warning
 =======

app/app.php

@@ -30,6 +30,7 @@
                 'type' => 'annotation',
                 'namespace' => 'App\Entity',
                 'path' => __DIR__. '/../src/App/Entity',
+                'use_simple_annotation_reader' => false,
             ),
         ),
     ),
@@ -51,7 +52,7 @@
 // Register DoctrineOrmServiceProvider service
 $app->register(new Dflydev\Silex\Provider\DoctrineOrm\DoctrineOrmServiceProvider(), $config);
 
-// Register theme service & set user theme
+// Register register I18n service
 $app['i18n_service'] = $app->share(function () { return new App\Service\I18nService(); });
 
 // Register translation service
@@ -106,14 +107,6 @@ function () use ($app) {
     $app['controllers']->requireHttps();
 }
 
-// Register theme service & set user theme
-$app['theme_service'] = $app->share(
-    function () use ($app){
-        return new App\Service\ThemeService($app);
-    }
-);
-$app['theme_service']->setUserTheme();
-
 // After middleware
 $app->after(function (Request $request, Response $response) use ($app) {
     // Set the locale cookie

app/locales/de.yml

@@ -1,10 +1,14 @@
 app.poweredby: Powered by
 app.name: Passwort Austausch
 
+app.meta.description: Internet Passwort Austausch Dienst
+app.meta.keywords: Passwort, Austausch, Login, Zugangsdaten, Übermittlung, Email
+
 app.data.username: Nutzername
 app.data.password: Passwort
 app.data.comment: Kommentar
 app.data.expires: Gültig für
+app.data.onetimeview: Nur einmal sichtbar
 app.data.seconds: Sekunden
 app.data.minutes: Minuten
 app.data.hour: Stunde
@@ -16,8 +20,6 @@ app.data.month: Monat
 
 app.language: Sprache
 
-app.theme: Theme
-
 index.generate: Generieren
 index.insert_password_start: Zufälliges
 index.insert_password_end: Zeichen langes Passwort einfügen

app/locales/en.yml

@@ -1,10 +1,14 @@
 app.poweredby: Powered by
 app.name: Password Exchange
 
+app.meta.description: Online password exchange service
+app.meta.keywords: Password, Exchange, Online, Credentials, Transfer, Email
+
 app.data.username: User Name
 app.data.password: Password
 app.data.comment: Comment
 app.data.expires: Valid for
+app.data.onetimeview: Delete record after it has been viewed
 app.data.seconds: seconds
 app.data.minutes: minutes
 app.data.hour: hour
@@ -20,8 +24,6 @@ app.language.esperanto: Esperanto
 app.language.german: Deutsch
 app.language.spanish: Español
 
-app.theme: Theme
-
 index.generate: Generate
 index.insert_password_start: Insert random
 index.insert_password_end: character password

app/locales/eo.yml

@@ -1,10 +1,14 @@
 app.poweredby: Funkcianta per
 app.name: Pasvort-interŝanĝo
+
+app.meta.description: Interreta pasvort-interŝanĝa servo
+app.meta.keywords: Pasvorto, Interŝanĝo, Interrete, Akreditilo, Transdoni, Retpoŝto
 
 app.data.username: Salutnomo
 app.data.password: Pasvorto
 app.data.comment: Noto
 app.data.expires: Valida por
+app.data.onetimeview: Forigi la rekordon la unuan fojon ĝi estas montrata
 app.data.seconds: sekundoj
 app.data.minutes: minutoj
 app.data.hour: horo
@@ -16,8 +20,6 @@ app.data.month: monato
 
 app.language: Lingvo
 
-app.theme: Etoso
-
 index.generate: Krei
 index.insert_password_start: Krei pasvorton el
 index.insert_password_end: hazardaj signoj

app/locales/es.yml

@@ -1,10 +1,14 @@
 app.poweredby: Funciona con
 app.name: Intercambio de contraseñas
 
+app.meta.description: Servicio para el intercambio de contraseñas a través de Internet
+app.meta.keywords: Contraseña, Intercambio, Online, En línea, Credenciales, Transferir, Email, Correo electrónico
+
 app.data.username: Nombre de usuario
 app.data.password: Contraseña
 app.data.comment: Nota
 app.data.expires: Válido por
+app.data.onetimeview: Eliminar el registro la primera vez que se visualice
 app.data.seconds: segundos
 app.data.minutes: minutos
 app.data.hour: hora

app/routing.php

@@ -5,3 +5,8 @@
 $app->get('/link/{hash}', 'app.default_controller:viewLinkAction');
 $app->get('/pw/{hash}', 'app.default_controller:viewPasswordAction');
 $app->post('/delete', 'app.default_controller:deleteAction');
+
+// Api
+$app->post('/api', 'app.default_controller:apiPostAction');
+$app->get('/api/{hash}', 'app.default_controller:apiViewAction');
+$app->delete('/api/{hash}', 'app.default_controller:apiDeleteAction');

composer.json

@@ -5,9 +5,10 @@
     "require": {
         "silex/silex": "~1.2",
         "aptoma/silex-extras": "~1.2",
+        "symfony/config": "~2.7",
+        "symfony/symfony": "~2.7",
         "symfony/twig-bridge": "~2.3",
         "symfony/translation": "~2.7",
-        "symfony/config": "~2.7",
         "symfony/yaml": "~2.7",
         "phpunit/phpunit": "4.8.*",
         "dflydev/doctrine-orm-service-provider": "1.0.*",