exponential-backoff

Potato SDK for Javascript

Este proyecto está enfocado a facilitar el consumo de API para proyectos internos de Potato.

Dependiencias y Requerimientos Previos

Los requerimientos de este proyectos son:

• Node.js LTS (8.9.X)
• Axios
• QueryString

Get Started

/* 1: Importar Solo el servicio requerido */
const { Auth } = require('@potatokoosh.com/sdk.js')

/* 2: Instanciar y configurar  */
const API = new Auth({ ssl: false, app_id: process.env.POTATO_APP_ID })

/**
 *  Integra async/await para un codigo mas elegante
 *  esto facilita la integración con Vuex / Redux / Flux
 *  
 *  EJ. vuex
 */
const login = async ({ commit, state }, credentials) => {
  try {
    let { data }  = await API.signIn(crendentials)
    commit('setUserSession', data.token)
  } catch (error) {
    throw error
  }
}

LLamando desde un componente de Vue

<template>
  <div>
    <button @click="login({
        username: '@HansFenix127',
        password: 'password',
        remember: false
      })">

      Enviar
    </button>
  </div>
</template>

<script>
  import { mapActions } from 'vuex'

  export default {
    ...
    methods: {
      ...mapActions('auth', [
        'login'
      ])
    }
  }
</script>

Usando Promesas

/* 1: Importar Solo el servicio requerido */
const { Auth } = require('@potatokoosh.com/sdk.js')

/* 2: Instanciar y configurar  */
const API = new Auth({ ssl: false, app_id: process.env.POTATO_APP_ID })

API.signIn({
  username: '@HansFenix127',
  password: 'Hello123',
  remember: false
}).then(response => {
  return response.data
}).then(body => {
  // Hacer algo con body
}).catch(error => {
  throw error
})

Parámetros de configuración

Variable	Tipo de dato / Default	Descripcion
ssl	Boolean (true)	Define el protocolo a conectar al API
url	String (api.entualmacen.com)	Url del host del API
service	Path del servicio a consultar	Nombre del servicio a consultar
app_id	String ((APP_ID)	Llave de id de una app de potatokoosh
version_api	String (v1.0)	Versión de la API

Contribuir

Siga estas instrucciones para integrar en su proyecto de javascript:

1: Clonar e instalar dependencias

Asegurese de tener los permisos necesarios para clonar el repositorio:

# Clonar
[mi-pc] $ git clone [e-mail]:Concesionarios/potato-js.git

# Instalar dependencias
[mi-pc] $ cd potato-js && npm install

2: Linkear via npm

NPM tiene la opcion de linkear paquetes de manera local, para efectos de desarollo. Este comando habilita links simbolicos y deja la librera disponible para importar desde cualquier directorio del pc.

Cada cambio que se realice a este directorio se vera reflejado inmediatamente en cada proyecto don de fue importado.

# Linkear npm@global
[mi-pc/potato-js] $ npm link

3: Integrar al proyecto en cuestión

En el pryecto donde esté usando la librería de javascript, puede integrarlo facilmente con el siguiente comando:

# Linkear npm@global
[mi-pc/mi-proyecto-cool] $ npm link @potato/potato.js

Esto deja habilidado crea links simbolicos a la carpeta node_modules de su proyecto. Por tanto para usarlo simplemente importelo como si fuera cualquier otra librería de npm.