https://github.com/essenciary/pocketex

https://github.com/essenciary/pocketex

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/essenciary/pocketex
• Owner: essenciary
• Created: 2015-03-21T08:13:13.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-12-18T02:03:49.000Z (almost 5 years ago)
• Last Synced: 2024-10-06T14:35:15.007Z (about 1 month ago)
• Language: Elixir
• Size: 263 KB
• Stars: 7
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Pocketex is an Elixir client for the Pocket read later service [getpocket.com](https://getpocket.com/). (Third Party APIs)
• fucking-awesome-elixir - pocketex - Pocketex is an Elixir client for the Pocket read later service [getpocket.com](https://getpocket.com/). (Third Party APIs)
• awesome-elixir - pocketex - Pocketex is an Elixir client for the Pocket read later service [getpocket.com](https://getpocket.com/). (Third Party APIs)

README

        
![pocketex_logo](http://essenciary.com/public/pocketex2_128.png)

#Pocketex

Pocketex is an Elixir client for the Pocket read later service ([getpocket.com]())

##Getting started

Get a consumer key for your app from [http://getpocket.com/developer/apps/new]()

Setup a web page in your app which will serve as the redirect URL where Pocket

will POST the auth data at the end of the authorization process.

Look here for more details: [http://getpocket.com/developer/docs/authentication]()

Get a request token

`{:ok, response} = Pocketex.Auth.get_request_token(@consumer_key, @redirect_uri)`

Redirect the user to the Pocket oAuth2 page, for authentication and

authorization, passing in your received request token and the callback URL.

`request_token = response[:request_token]`

`redirect(external: Pocketex.Auth.autorization_uri(request_token, (WebUi.Router.Helpers.pocket_path(conn, :callback) |> WebUi.Endpoint.url)))`

Upon successful authentication and authorization, you will receive an

access token which will be used for further requests.

`{:ok, response} = Pocketex.Auth.authorize(@consumer_key, request_token)`

`access_token = response["access_token"]`

We're good to go now, let's get the newest 10 unread items:

`response = Pocketex.Item.get(@consumer_key, access_token,

                            %{count: 10, detail_type: "complete", sort: "newest",

                            state: "unread", content_type: "all"})`

For additional information, check out the example app (https://github.com/essenciary/pocketex_demo_app)

or the docs (http://essenciary.github.io/pocketex/doc/)