diff options
| -rw-r--r-- | nnttrss.el | 188 | ||||
| -rw-r--r-- | ttrss.el | 233 |
2 files changed, 234 insertions, 187 deletions
@@ -27,11 +27,10 @@ ;;; Code: +(load-file "ttrss.el") (require 'gnus) (require 'nnoo) (require 'nnheader) -(require 'url) -(require 'json) (nnoo-declare nnttrss) @@ -44,191 +43,6 @@ (defvoo nnttrss-password nil "Password to use for authentication to the tt-rss server.") -(defvar nnttrss-session-id nil - "Current session id, if any, set after successful login.") - -(defvar nnttrss-api-level nil - "API version level, increased with each API functionality - change.") - -(defvar nnttrss-server-version nil - "Server version number.") - - -;;; Session management - -(defun nnttrss-post-request (address property &rest content) - "Post urlencoded form data to ADDRESS. PROPERTY is keyword -potentially in the response or nil. CONTENT must be a data -structure that `json-encode' knows how to encode as a JSON -object. - -Returns the JSON response as a plist or, optionally, the PROPERTY -in the plist, if the response status is 0, nil otherwise." - (let ((url-request-method "POST") - (url-request-data (json-encode content)) - (json-object-type 'plist) - (json-false nil)) - (with-current-buffer (url-retrieve-synchronously address) - (goto-char (point-min)) - (search-forward-regexp "\n\n") - (let* ((response (json-read)) - (status (plist-get response :status)) - (content (plist-get response :content))) - (if (= status 0) - (or (plist-get content property) content) - (nnheader-report 'nnttrss (plist-get content :error))))))) - -(defun nnttrss-login (address user password) - "Login to the server at ADDRESS using USER and PASSWORD -credentials. Returns a session id string or nil." - (nnttrss-post-request address - :session_id - :op "login" - :user user - :password password)) - -(defun nnttrss-logout (address session-id) - "Logout of the server at ADDRESS using SESSION-ID credentials." - (nnttrss-post-request address - :status - :op "logout" - :sid session-id)) - -(defun nnttrss-logged-in-p (address session-id) - "Return t if there is a valid session at ADDRESS with -SESSION-ID, false otherwise." - (nnttrss-post-request address - :status - :op "isLoggedIn" - :sid session-id)) - -(defun nnttrss-api-level (address session-id) - "Return an integer corresponding to the API level at ADDRESS -using SESSION-ID credentials." - (nnttrss-post-request address - :level - :op "getApiLevel" - :sid session-id)) - -(defun nnttrss-server-version (address session-id) - "Return a string corresponding to the server version at ADDRESS - using SESSION-ID credentials." - (nnttrss-post-request address - :version - :op "getVersion" - :sid session-id)) - - -;;; Server statistics - -(defun nnttrss-get-unread (address session-id) - "Return number of unread artibles at ADDRESS using SESSION-ID -credentials." - (nnttrss-post-request address - :unread - :op "getUnread" - :sid session-id)) - -(defun nnttrss-get-counters (address session-id) - "Return a vector of plists corresponding to feeds, labels, -categories, or tags at ADDRESS using SESSION-ID credentials. -Each plist has the keywords :counter and :id and, -possibly, :has_img, :updated, and :kind." - (nnttrss-post-request address - nil - :op "getCounters" - :sid session-id)) - -(defun nnttrss-get-feeds (address session-id &rest params) - "Return a vector of plists corresponding to feeds at ADDRESS -using SESSION-ID credentials. PARAMS is any number of the -following key-value pairs: - - :cat_id integer return feeds under category cat_id - :unread_only boolean only return feeds which have unread articles - :limit integer limit amount of feeds returned to this value - :offset integer skip this amount of feeds first - :include_nested boolean include child categories (as Feed objects with is_cat set) - -Special feed IDs are as follows: - - -1 starred - -2 published - -3 fresh - -4 all articles - 0 archived - IDs < -10 - labels - -Each plist has the following keywords: - - :last_updated - :cat_id - :order_id - :feed_url - :unread - :title - :id - :icon." - (apply 'nnttrss-post-request - address - nil - :op "getFeeds" - :sid session-id - params)) - -(defun nnttrss-get-categories (address session-id &rest params) - "Return a vector of plists corresponding to headlines at -ADDRESS using SESSION-ID credentials. PARAMS is any number of the -following key-value pairs: - - :unread_only boolean only return categories which have unread articles - :enable_nested boolean switch to nested mode, only returns topmost categories - :include_empty boolean include empty categories" - (apply 'nnttrss-post-request - address - nil - :op "getCategories" - :sid session-id - params)) - -(defun nnttrss-get-headlines (address session-id &rest params) - "Return a vector of plists corresponding to headlines at -ADDRESS using SESSION-ID credentials. PARAMS is any number of the -following key-value pairs: - - :feed_id integer only output articles for this feed - :limit integer limits the amount of returned articles - :skip integer skip this amount of feeds first - :filter string currently unused - :is_cat boolean requested feed_id is a category - :show_excerpt boolean include article excerpt in the output - :show_content boolean include full article text in the output - :view_mode string all_articles, unread, adaptive, marked, updated - :include_attachments boolean include article attachments - :since_id integer articles with id greater than since_id - :include_nested boolean include articles from child categories - :search string search query - :search_mode string - :match_on string - -Special feed IDs are as follows: - - -1 starred - -2 published - -3 fresh - -4 all articles - 0 archived - IDs < -10 - labels" - (apply 'nnttrss-post-request - address - nil - :op "getHeadlines" - :sid session-id - params)) - - - (gnus-declare-backend "nnttrss" 'address 'prompt-address) (provide 'nnttrss) diff --git a/ttrss.el b/ttrss.el new file mode 100644 index 0000000..39025f8 --- /dev/null +++ b/ttrss.el @@ -0,0 +1,233 @@ +;;; ttrss.el --- Tiny Tiny RSS elisp bindings + +;; Copyright (C) 2013 Pedro Silva + +;; Author: Pedro Silva <psilva+git@pedrosilva.pt> +;; Created: 01 April 2013 +;; Version: 0.0.1 +;; Keywords: news, local +;; Package-Requires ((emacs "23.1")) + +;; This file is not part of GNU Emacs. + +;; ttrss is free software: you can redistribute it and/or modify it +;; under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; ttrss is distributed in the hope that it will be useful, but +;; WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +;; General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with ttrss. If not, see <http://www.gnu.org/licenses/>. + +;;; Commentary: + +;;; Code: + +(eval-and-compile + (autoload 'url-retrieve-synchronously "url") + (autoload 'json-read "json") + (autoload 'json-encode "json")) + +(defvar ttrss-address nil + "Address of the tt-rss server.") + +(defvar ttrss-user nil + "Username to use for authentication to the tt-rss server.") + +(defvar ttrss-password nil + "Password to use for authentication to the tt-rss server.") + +(defvar ttrss-session-id nil + "Current session id, if any, set after successful login.") + +(defvar ttrss-api-level nil + "API version level, increased with each API functionality + change.") + +(defvar ttrss-server-version nil + "Server version number.") + + +;;; Session management + +(defun ttrss-post-request (address property &rest content) + "Post urlencoded form data to ADDRESS. PROPERTY is keyword +potentially in the response or nil. CONTENT must be a data +structure that `json-encode' knows how to encode as a JSON +object. + +Returns the JSON response as a plist or, optionally, the PROPERTY +in the plist, if the response status is 0, nil otherwise." + (let ((url-request-method "POST") + (url-request-data (json-encode content)) + (json-object-type 'plist) + (json-false nil)) + (with-current-buffer (url-retrieve-synchronously address) + (goto-char (point-min)) + (search-forward-regexp "\n\n") + (let* ((response (json-read)) + (status (plist-get response :status)) + (content (plist-get response :content))) + (if (= status 1) + (user-error "API status error: %s" + (mapconcat 'downcase + (split-string (plist-get content :error) "_") + " ")) + (or (plist-get content property) content)))))) + +(defun ttrss-login (address user password) + "Login to the server at ADDRESS using USER and PASSWORD +credentials. Returns a session id string or nil." + (ttrss-post-request address + :session_id + :op "login" + :user user + :password password)) + +(defun ttrss-logout (address session-id) + "Logout of the server at ADDRESS using SESSION-ID credentials." + (ttrss-post-request address + :status + :op "logout" + :sid session-id)) + +(defun ttrss-logged-in-p (address session-id) + "Return t if there is a valid session at ADDRESS with +SESSION-ID, false otherwise." + (ttrss-post-request address + :status + :op "isLoggedIn" + :sid session-id)) + +(defun ttrss-api-level (address session-id) + "Return an integer corresponding to the API level at ADDRESS +using SESSION-ID credentials." + (ttrss-post-request address + :level + :op "getApiLevel" + :sid session-id)) + +(defun ttrss-server-version (address session-id) + "Return a string corresponding to the server version at ADDRESS + using SESSION-ID credentials." + (ttrss-post-request address + :version + :op "getVersion" + :sid session-id)) + + +;;; Server statistics + +(defun ttrss-get-unread (address session-id) + "Return number of unread artibles at ADDRESS using SESSION-ID +credentials." + (ttrss-post-request address + :unread + :op "getUnread" + :sid session-id)) + +(defun ttrss-get-counters (address session-id) + "Return a vector of plists corresponding to feeds, labels, +categories, or tags at ADDRESS using SESSION-ID credentials. +Each plist has the keywords :counter and :id and, +possibly, :has_img, :updated, and :kind." + (ttrss-post-request address + nil + :op "getCounters" + :sid session-id)) + +(defun ttrss-get-feeds (address session-id &rest params) + "Return a vector of plists corresponding to feeds at ADDRESS +using SESSION-ID credentials. PARAMS is any number of the +following key-value pairs: + + :cat_id integer return feeds under category cat_id + :unread_only boolean only return feeds which have unread articles + :limit integer limit amount of feeds returned to this value + :offset integer skip this amount of feeds first + :include_nested boolean include child categories (as Feed objects with is_cat set) + +Special feed IDs are as follows: + + -1 starred + -2 published + -3 fresh + -4 all articles + 0 archived + IDs < -10 - labels + +Each plist has the following keywords: + + :last_updated + :cat_id + :order_id + :feed_url + :unread + :title + :id + :icon." + (apply 'ttrss-post-request + address + nil + :op "getFeeds" + :sid session-id + params)) + +(defun ttrss-get-categories (address session-id &rest params) + "Return a vector of plists corresponding to headlines at +ADDRESS using SESSION-ID credentials. PARAMS is any number of the +following key-value pairs: + + :unread_only boolean only return categories which have unread articles + :enable_nested boolean switch to nested mode, only returns topmost categories + :include_empty boolean include empty categories" + (apply 'ttrss-post-request + address + nil + :op "getCategories" + :sid session-id + params)) + +(defun ttrss-get-headlines (address session-id &rest params) + "Return a vector of plists corresponding to headlines at +ADDRESS using SESSION-ID credentials. PARAMS is any number of the +following key-value pairs: + + :feed_id integer only output articles for this feed + :limit integer limits the amount of returned articles + :skip integer skip this amount of feeds first + :filter string currently unused + :is_cat boolean requested feed_id is a category + :show_excerpt boolean include article excerpt in the output + :show_content boolean include full article text in the output + :view_mode string all_articles, unread, adaptive, marked, updated + :include_attachments boolean include article attachments + :since_id integer articles with id greater than since_id + :include_nested boolean include articles from child categories + :search string search query + :search_mode string + :match_on string + +Special feed IDs are as follows: + + -1 starred + -2 published + -3 fresh + -4 all articles + 0 archived + IDs < -10 - labels" + (apply 'ttrss-post-request + address + nil + :op "getHeadlines" + :sid session-id + params)) + + + +(provide 'ttrss) +;;; ttrss.el ends here |