sptrans-promise - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

build/server/auth.js

@@ -51,6 +51,6 @@ 'use strict';
 function fetchData(token) {
-  var url = _constants.API.endpoint + _constants.API.auth.route;
+  var url = _constants.API.sptrans + _constants.API.auth.route;
 
   if (isBrowser) {
-    url = _constants.API.heroku + '/auth';
+    url = _constants.API.server + '/auth';
   }
@@ -57,0 +57,0 @@

build/server/constants/api.js

@@ -8,4 +8,4 @@ 'use strict';
   localhost: 'http://localhost:8888',
-  endpoint: 'http://api.olhovivo.sptrans.com.br/v0',
-  heroku: 'https://sptrans-server.herokuapp.com',
+  sptrans: 'http://api.olhovivo.sptrans.com.br/v0',
+  server: 'https://sptrans-server.herokuapp.com',
   auth: {
@@ -19,2 +19,6 @@ route: '/login/autenticar',
   },
+  trajeto: {
+    route: '/shapes',
+    required: ['codigoTrajeto']
+  },
   paradas: {
@@ -21,0 +25,0 @@ route: '/parada/buscar',

build/server/find.js

@@ -40,6 +40,6 @@ 'use strict';
 
-var hasAuth = function hasAuth(options) {
+function hasAuth(options) {
   options.auth || handleError('O método "find" deve receber o parâmetro "auth".');
   return options;
-};
+}
 
@@ -97,3 +97,3 @@ function isAllowedType(options) {
   var buildPromise = function buildPromise(params) {
-    var url = _constants.API.endpoint + _constants.API[options.tipo].route;
+    var url = _constants.API.sptrans + _constants.API[options.tipo].route;
     var headers = {
@@ -105,3 +105,3 @@ Cookie: options.auth
       headers = null;
-      url = _constants.API.heroku + '/find';
+      url = _constants.API.server + '/find';
       (0, _assign2.default)(params, {
@@ -113,2 +113,7 @@ auth: options.auth,
 
+    if (options.tipo === 'trajeto') {
+      headers = null;
+      url = _constants.API.server + '/shapes/' + options.codigoTrajeto;
+    }
+
     var config = {
@@ -115,0 +120,0 @@ method: 'get',

build/server/helpers/buildLinhasResponse.js

@@ -37,3 +37,3 @@ 'use strict';
                 method: 'get',
-                url: _constants.API.heroku + '/trips/' + tripId
+                url: _constants.API.server + '/trips/' + tripId
               });
@@ -40,0 +40,0 @@ };

package.json

@@ -5,3 +5,3 @@ {
   "description": "Busca informações em tempo real da frota de ônibus da SPTrans na cidade de São Paulo.",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "license": "MIT",
@@ -8,0 +8,0 @@ "main": "build/server/index.js",

README.md

@@ -37,6 +37,4 @@ <h1 align="center">SPTrans Promise</h1>
 Você pode instalar o **sptrans-promise** via `npm` e importar o script através do caminho:
-`node_modules/sptrans-promise/build/browser/sptrans-promise.min.js`. Ou se preferir pode copiar o script, [clique aqui](https://github.com/thiagommedeiros/sptrans-promise/blob/master/build/browser/sptrans-promise.min.js).
+`node_modules/sptrans-promise/build/browser/sptrans-promise.min.js`. Ou se preferir pode copiar o script [clicando aqui](https://github.com/thiagommedeiros/sptrans-promise/blob/master/build/browser/sptrans-promise.min.js). A biblioteca estará acessível através da variável global `sptrans`.
 
-A biblioteca estará acessível pela variável global `sptrans`.
-
 ### Token
@@ -77,2 +75,5 @@
 
+sptrans.auth('SEU_TOKEN_AQUI')
+  .then(encontrarLinhas)
+
 function encontrarLinhas (auth) {
@@ -85,6 +86,39 @@ sptrans.find({
 }
+```
+##### Exemplo de resposta
+``` js
+[{
+    CodigoLinha: 34022,
+    CodigoTrajeto: 63468,
+    Circular: false,
+    Letreiro: '8004',
+    Sentido: 2,
+    Tipo: 10,
+    DenominacaoTPTS: 'TERM. LAPA',
+    DenominacaoTSTP: 'STA. MÔNICA',
+    Informacoes: null
+}]
+```
+#### Trajeto
+O tipo `trajeto` retorna uma lista com a latitude e longitude de cada rua que o ônibus passa.
 
-sptrans.auth('SEU_TOKEN_AQUI')
-  .then(encontrarLinhas)
+Aceita o código do trajeto. O valor deve ser passado pelo parâmetro `codigoTrajeto` como `number`:
+
+``` js
+sptrans.find({
+  auth,
+  tipo: 'trajeto',
+  codigoTrajeto: 63468
+}).then(console.log)
 ```
+##### Exemplo de resposta
+``` js
+[{
+    shape_id: '63468',
+    shape_pt_lat: '-23.516524',
+    shape_pt_lon: '-46.725786',
+    shape_pt_sequence: '81',
+    shape_dist_traveled: '3637.9119'
+}]
+```
 
@@ -111,2 +145,12 @@ #### Paradas
 ```
+##### Exemplo de resposta
+``` js
+[{
+    CodigoParada: 260015039,
+    Nome: 'PAULISTA B/C',
+    Endereco: 'AV PAULISTA/ AV REBOUCAS',
+    Latitude: -23.555883,
+    Longitude: -46.66306
+}]
+```
 
@@ -116,6 +160,6 @@ #### Paradas por linha
 
-Aceita o código da linha. O valor deve ser passado pelo parâmetro `codigoLinha` como um `integer` ou um `array` de `integers`:
+Aceita o código da linha. O valor deve ser passado pelo parâmetro `codigoLinha` como um `number` ou um `array` de `numbers`:
 
 ``` js
-//passando integer
+//passando number
 sptrans.find({
@@ -134,2 +178,12 @@ auth,
 ```
+##### Exemplo de resposta
+``` js
+[{
+    CodigoParada: 480014608,
+    Nome: 'TIBERIO C/B',
+    Endereco: 'R TIBERIO/ R MENFIS',
+    Latitude: -23.522875,
+    Longitude: -46.688219
+}]
+```
 
@@ -146,2 +200,10 @@ #### Corredores
 ```
+##### Exemplo de resposta
+``` js
+[{
+    CodCot: 0,
+    CodCorredor: 8,
+    Nome: 'Campo Limpo'
+}]
+```
 
@@ -151,6 +213,6 @@ #### Paradas por corredor
 
-Aceita o código do corredor. O valor deve ser passado pelo parâmetro `codigoCorredor` como um `integer` ou um `array` de `integers`:
+Aceita o código do corredor. O valor deve ser passado pelo parâmetro `codigoCorredor` como um `number` ou um `array` de `numbers`:
 
 ``` js
-//passando integer
+//passando number
 sptrans.find({
@@ -169,2 +231,12 @@ auth,
 ```
+##### Exemplo de resposta
+``` js
+[{
+    CodigoParada: 120011367,
+    Nome: 'TRES IRMAOS C/B',
+    Endereco: 'R JOSE JANNARELLI/ R TRES IRMAOS',
+    Latitude: -23.584817,
+    Longitude: -46.719021
+}]
+```
 
@@ -174,6 +246,6 @@ #### Posição dos veículos
 
-Aceita o código da linha. O valor deve ser passado pelo parâmetro `codigoLinha` como um `integer` ou um `array` de `integers`:
+Aceita o código da linha. O valor deve ser passado pelo parâmetro `codigoLinha` como um `number` ou um `array` de `numbers`:
 
 ``` js
-//passando integer
+//passando number
 sptrans.find({
@@ -196,3 +268,3 @@ auth,
 
-Aceita o código da parada e o código da linha. O valor deve ser passado pelos parâmetros `codigoParada` e `codigoLinha` como um `integer`:
+Aceita o código da parada e o código da linha. O valor deve ser passado pelos parâmetros `codigoParada` e `codigoLinha` como um `number`:
 
@@ -210,6 +282,6 @@ ``` js
 
-Aceita o código da linha. O valor deve ser passado pelo parâmetro `codigoLinha` como um `integer` ou um `array` de `integers`:
+Aceita o código da linha. O valor deve ser passado pelo parâmetro `codigoLinha` como um `number` ou um `array` de `numbers`:
 
 ``` js
-//passando integer
+//passando number
 sptrans.find({
@@ -231,6 +303,6 @@ auth,
 
-Aceita o código da parada. O valor deve ser passado pelo parâmetro `codigoParada` como um `integer` ou um `array` de `integers`:
+Aceita o código da parada. O valor deve ser passado pelo parâmetro `codigoParada` como um `number` ou um `array` de `numbers`:
 
 ``` js
-//passando integer
+//passando number
 sptrans.find({
@@ -237,0 +309,0 @@ auth,

No alert changes

Improved metrics

Total package byte prevSize

253848

increased by0.7%

Lines of code

603

increased by1.34%

Number of lines in readme file

316

increased by29.51%

No dependency changes