Merge pull request #909 from theodi/master

Added pinboard.coffee

Author: Tom Bell

src/scripts/pinboard.coffee

@@ -0,0 +1,212 @@
+# Description:
+#   Manage your links and bookmarks. Links get stored in the robot brain while
+#   bookmarks get stored at pinboard.in. Also keeps a history of all URLs in
+#   the "urls" section of the robot brain. 
+#
+# Dependencies:
+#   "xml2js": "0.1.14"
+#
+# Configuration:
+#   PINBOARD_USERNAME
+#   PINBOARD_PASSWORD
+#
+# Commands:
+#   hubot pin <url> as <description> - add a url to your pinboard feed
+#   hubot link <url> as <description> - add a url to the robot brain
+#   hubot link me for <description> - find a link by description
+#   hubot list bookmarks - get a list of the 15 most recent bookmarks
+#   hubot list links - List all of the links that are being tracked
+#   hubot feed me - get the URL to subscribe to your bookmark rss
+#
+# Author
+#   pezholio (based on work by mm53bar)
+
+module.exports = (robot) ->
+  robot.respond /feed me/i, (msg) ->
+    msg.reply "You can subscribe to the pinboard feed at https://feeds.pinboard.in/rss/u:#{process.env.PINBOARD_USERNAME}/"
+
+  robot.respond /list bookmarks/i, (msg) ->
+    pinboard = new Pinboard msg, process.env.PINBOARD_USERNAME, process.env.PINBOARD_PASSWORD
+  
+    pinboard.listBookmarks (err, message) ->
+      if err?
+        msg.send "#{err}"
+      else
+        msg.send "#{message}"
+
+  robot.respond /pin (http(s?)\:\/\/\S+) as (.+)/i, (msg) ->
+    pinboard = new Pinboard msg, process.env.PINBOARD_USERNAME, process.env.PINBOARD_PASSWORD
+    url = msg.match[1]
+    description = msg.match[3]
+    bookmark = new Bookmark url, description
+    
+    pinboard.createBookmark bookmark, (err, message) ->
+      if err?
+        msg.send "#{err}"
+      else
+        msg.send "#{message}" 
+        
+  robot.respond /link (http(s?)\:\/\/\S+) as (.+)/i, (msg) ->
+    url = msg.match[1]
+    description = msg.match[3]    
+    bookmark = new Bookmark url, description
+    link = new Link robot
+  
+    link.add bookmark, (err, message) ->
+      if err?
+        msg.reply "I have a vague memory of hearing about that link sometime in the past."
+      else
+        msg.reply "I've stuck that link into my robot brain." 
+        
+  robot.respond /link me for (.+)/i, (msg) ->
+    description = msg.match[1]
+    link = new Link robot
+    
+    link.find description, (err, bookmark) ->
+      if err?
+        msg.send "#{err}"
+      else
+        msg.send bookmark.url
+           
+  robot.respond /list links/i, (msg) ->
+    link = new Link robot
+    
+    link.list (err, message) ->
+      if err?   
+        msg.reply "Links? What links? I don't remember any links."       
+      else
+        msg.reply message
+
+  robot.hear /(http(s?)\:\/\/\S+)/i, (msg) ->
+    href = msg.match[1]
+    url = new Url robot
+
+    url.add href, (err, message) ->
+      if err?
+        console.log "#{href} : #{err}"
+
+# Classes
+
+class Url
+  constructor: (robot) ->
+    robot.brain.data.urls ?= []
+    @urls_ = robot.brain.data.urls
+
+  all: (url) ->
+    if url
+      @urls_.push url
+    else
+      @urls_
+
+  add: (url, callback) ->
+    if url in @all()
+      callback "Url already exists"
+    else
+      @all url
+      callback null, "Url added"
+
+class Bookmark
+  constructor: (url, description) ->
+    @url = url
+    @description = description
+
+  encodedUrl: ->
+    encodeURIComponent @url
+
+  encodedDescription: ->
+    encodeURIComponent @description
+
+class Link
+  constructor: (robot) ->
+    robot.brain.data.links ?= []
+    @links_ = robot.brain.data.links
+
+  all: (bookmark) ->
+    if bookmark
+      @links_.push bookmark
+    else
+      @links_
+
+  add: (bookmark, callback) ->
+    result = []
+    @all().forEach (entry) ->
+      if entry
+        if entry.url is bookmark.url
+          result.push bookmark
+    if result.length > 0
+      callback "Bookmark already exists"
+    else
+      @all bookmark
+      callback null, "Bookmark added"    
+
+  list: (callback) ->
+    if @all().length > 0
+      resp_str = "These are the links I'm remembering:\n\n"
+      for bookmark in @all()
+        if bookmark
+          resp_str += bookmark.description + " (" + bookmark.url + ")\n"
+      callback null, resp_str    
+    else
+      callback "No bookmarks exist"
+
+  find: (description, callback) ->
+    result = []
+    @all().forEach (bookmark) ->
+      if bookmark && bookmark.description
+        if RegExp(description, "i").test bookmark.description
+          result.push bookmark
+    if result.length > 0
+      callback null, result[0]
+    else
+      callback "No results found"
+
+class Pinboard
+  constructor: (msg, user, password) ->
+    @msg = msg
+    @user = user
+    @password = password
+
+  feed_url: ->
+    "https://feeds.pinboard.in/rss/u:#{@user}/"
+
+  authdata: ->
+    new Buffer(@user+':'+@password).toString('base64')
+
+  createBookmark: (bookmark, callback) ->
+    api_url = "https://api.pinboard.in/v1/posts/add?" +
+              "url=#{bookmark.encodedUrl()}" +
+              "&description=#{bookmark.encodedDescription()}"
+    @getPinboard api_url, (err, data) ->
+      if err? or not data?
+        callback err
+      else
+        resultRegexp = /result code="(.+)"/i
+        result = data.match(resultRegexp)[1]
+        if result == 'done'
+          callback null, "Your bookmark was added to pinboard."
+        else
+          callback "There was a problem adding your bookmark to pinboard: #{result}"
+
+  listBookmarks: (callback) ->
+    xml2js = require('xml2js')
+    api_url = "https://api.pinboard.in/v1/posts/recent"
+    @getPinboard api_url, (err, data) ->
+      if err? or not data?
+        callback err
+      else
+        resp_str = "My bookmarks: \n"
+        (new xml2js.Parser()).parseString data, (err, json)->
+          for post in json.posts.post
+            resp_str += post["$"].description + " (" + post["$"].href + ")\n"
+        callback null, resp_str
+
+  getPinboard: (api_url, callback) ->
+    @msg.http(api_url).
+      header('Authorization', 'Basic ' + @authdata()).
+      get() (err, res, body) ->
+        if res.statusCode is 200
+          callback null, body
+        else if err?
+          callback err
+        else
+          callback "There were problems contacting pinboard"