Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions README.es-ES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@


# PocketApi
Gema de Ruby para la API de Pocket (getpocket.com), anteriormente ReadItLater.

## Instalación

Agrega esta línea al Gemfile de tu aplicación:

gem 'getpocket'

Y luego ejecuta:

$ bundle

O instálala manualmente con:

$ gem install getpocket

## Uso

1. Obtén una clave de API en http://getpocket.com/developer/ y consigue un access_token
2. Configura las credenciales de PocketApi con:
```
PocketApi.configure(:client_key=> API_KEY, :access_token => ACCESS_TOKEN)
```
3. Llama a la API con los métodos correspondientes (retrieve, add, modify)
```
PocketApi.retrieve({:state => "unread"})
PocketApi.add("http://example.com", {:title => "Test add"})
PocketApi.modify("archive", {:item_id => "123456"})
```

También hay algunos métodos auxiliares de OAuth en PocketApi::Connection para generar Request Tokens, URLs de autorización y Access Tokens.
Aquí hay un flujo de trabajo posible:
1. Genera la URL de autorización para que el usuario inicie sesión:
```
PocketApi::Connection.client_key = API_KEY
PocketApi::Connection.generate_authorize_url("https://myserver/authorize_callback", "https://myserver/denied_authorize")
```
2. Una vez que el usuario regrese, genera el access_token a partir del request_token anterior
```
PocketApi::Connection.client_key = API_KEY
PocketApi::Connection.generate_access_token
```

## Contribuir

1. Haz un fork del proyecto
2. Crea una rama para tu funcionalidad (`git checkout -b my-new-feature`)
3. Envía tus cambios (`git commit -am 'Add some feature'`)
4. Envía la rama al repositorio (`git push origin my-new-feature`)
5. Crea un nuevo Pull Request

## TODO
Crear un objeto Exception para las solicitudes de Pocket que analice el encabezado en busca de "X-Error" y gestiones de limitación de tasa.