duellsy/pockpack

Package to handle communication with GetPocket.com API neatly.

Installs: 180

Dependents: 0

Stars: 19

Watchers: 3

Forks: 3

Open Issues: 1

Language: PHP

v2.5.0 2014-08-14 00:17 UTC

README

This package is for connecting to the Pocket API. check out their docs here

You'll need to register an app with pocket, and use the generated tokens provided in order for you to be able to connect to the API.

Build Status

Installation

Pockpack is installable via composer, the details are on packagist, here.

Add the following to the require section of your projects composer.json file:

"duellsy/pockpack": "2.*"

In files that you want to use the Pockpack classes, be sure to add the namespaces you're going to use to the top of the file similar to the following, so your code can reference the classes without issue

use Duellsy\Pockpack\Pockpack;
use Duellsy\Pockpack\PockpackAuth;
use Duellsy\Pockpack\PockpackQueue;

Authenticate

Get request token

$pockpath_auth = new PockpackAuth();
$request_token = $pockpath_auth->connect($consumer_key);

Redirect the user to pockets auth page

https://getpocket.com/auth/authorize?request_token=YOUR_REQUEST_TOKEN&redirect_uri=YOUR_REDIRECT_URI

Get users access token

$pockpack = new PockpackAuth();
$access_token = $pockpack->receiveToken($consumer_key, $request_token);

Get users access token and username

$pockpack = new PockpackAuth();
$data = $pockpack->receiveTokenAndUsername($consumer_key, $request_token);
$access_token = $data['access_token'];
$username = $data['username'];

Get reading list

Retreive reading list

This will return a full list of all active (unarchived) bookmarks, optionally you can have it also return extra information such as images. If you would prefer the result to be an array, you can send a second boolean value to the retrieve function set to true.

$pockpack = new Pockpack($consumer_key, $access_token);
$as_array = true; // false will return JSON, true will return an array
$list = $pockpack->retrieve($options[, $as_array]); // the second parameter is optional, defaults to false

The options array allows you to control exactly what is returned from the API. For the full list of options, please check 'Optional Parameters' section of the pocket retrieve API (you can also see an example JSON response on this page)

Example 1: show all favorited bookmarks, complete with images

$options = array(
    'state'         => 'all',
    'favorite'      => 1,
    'detailType'    => 'complete'
);

Example 2: show only unread bookmarks, complete with image

$options = array(
    'state'         => 'favorite',
    'detailType'    => 'complete'
);

Add new bookmark

A simple example of adding a bookmark to your reading list:

$link_info = array(
    'url'       => 'http://example.com'
);

$pockpack = new Pockpack($pocket_consumer_key, $pocket_access_token);
$pockpack_q = new PockpackQueue();

$pockpack_q->add($link_info);
$pockpack->send($pockpack_q);

The array that is sent to the add method can contain the following information:

  • item_id (integer; If you are overwriting a link)
  • ref_id (integer; A Twitter status id; this is used to show tweet attribution)
  • tags (array; A list of tags you want to add to this bookmark)
  • time (timestamp; This is automatically added by the PockpackQueue class)
  • title (string; An optional title if you want to control it)
  • url (string; The URL of the item)

Modify existing bookmark

The main flow to modify a bookmark is as follows

$pockpack = new Pockpack($pocket_consumer_key, $pocket_access_token);
$pockpack_q = new PockpackQueue();

$pockpack_q->favorite($item_id);

$pockpack->send($pockpack_q);

You first need to create the pockpack connection, then add something to the queue, and finally send the queue to pocket.

You can add as many items to the queue before sending, to send in bulk to keep things fast.

Archive bookmark

$pockpack_q->archive($item_id);

Re-add bookmark

$pockpack_q->readd($item_id);

Favorite bookmark

$pockpack_q->favorite($item_id);

Unfavorite bookmark

$pockpack_q->unfavorite($item_id);

Delete bookmark

$pockpack_q->delete($item_id);

Tagging Actions for bookmarks

The main flow of tagging is as follows

$pockpack = new Pockpack($pocket_consumer_key, $pocket_access_token);
$pockpack_q = new PockpackQueue();

$tags = array("sampleTag1","sampleTag2");
$tag_info = array(
    'item_id'     => $item_id,
    'tags'        => $tags

);

$pockpack_q->tags_add($tag_info);

$pockpack->send($pockpack_q);

Add Tags

$pockpack_q->tags_add($tag_info);

Remove Tags

$pockpack_q->tags_remove($tag_info);

Replace Tags

$pockpack_q->tags_replace($tag_info);

Clear Tags

Clear Tag does not require $tag_info but only $item_id

$pockpack_q->tags_clear($item_id);

Contributing

Contributions are encouraged and welcome; to keep things organised, all bugs and requests should be opened in the github issues tab for the main project, at duellsy/pockpack/issues

All pull requests should be made to the develop branch, so they can be tested before being merged into the master branch.

Bitdeli Badge