nikezono / node-rss-watcher Goto Github PK

View Code? Open in Web Editor NEW

33.0 3.0 9.0 29 KB

tiny CLI rss reader

CoffeeScript 99.50% JavaScript 0.50%

node-rss-watcher's Introduction

rss-watcher

What is it

RSS-Watcher is Tinu Library/Executable for RSS/Atom Feed Reader

##install

####NPM INSTALL:

npm install rss-watcher

####package.json:

{
  "dependencies":{
    "rss-watcher": "*"
  }
}

Usage

Watcher = require 'rss-watcher'
feed = 'http://github.com/nikezono.atom'

watcher = new Watcher(feed)

watcher.on 'new article',(article)->
  console.log article

watcher.run (err,articles)->
  console.error err if err
  console.log articles # current articles

option

watcher = new Watcher(feed)
watcher.set
  feed:feed # feed url
  interval: 60  # request per interval seconds. default:average update frequency

exposed events

watcher.on "error",(error)->
  console.error error

watcher.on "new article",(article)->
  console.log article # article object

watcher.on "stop", ->
  console.log 'stop'

watcher.stop()

CLI tool

> rss-watcher -f 'http://github.com/nikezono.atom' -i 20000 # 20000s interval

Test

Spec Report:

npm -i -g grunt grunt-cli
grunt test

Coverage dump:

grunt coverage
open coverage.html

node-rss-watcher's People

Contributors

Stargazers

Watchers

Forkers

jumbojett chi-bd yelles honkskillet greensopinion adrenx neotim hujilee arthurbaghdas

node-rss-watcher's Issues

Typo in README

"Average" has been misspelled as "avarage".

Not able to watch content chage

Hello i tried rss-watcher but was not able to get any new change. Can anyone just guide me.

Here is my sample code

Is this correct?? [Not able to watch]

feed = 'http://github.com/nikezono.atom'
watcher = new Watcher({feed:feed, interval: 2000 })
watcher.on('new article',function(article){
console.log(article)
})
watcher.run(function(article){
console.log(article)
})

Error: socket hang up がたくさん出る

同じタイミングでたくさんまとめてErrorが投げられてくる。

同じURLに対するrss-watcherをたくさん生成しているということはないです

Export to ATOM/RSS

Possibility to watch several feeds, at once, and export their entries into an ATOM or RSS feed.

更新頻度の設定の引数に関数取れるようにする

watcher.set
feed: String
interval: Integer

だったけど、

interval: Function(frequnecy)

を用意して、

watcher.set
  feed: "http://hoge.atom"
  interval: (frequency)->
    if frequency > 60*10 # 10分以上
      return 60*10
    else
      return frequency / 2

とか書けるようにしよう

最初の1回目のクロールはnew article投げない設定がほしい

ほしい

というか最初の1回はnew articleではなく既存articleなのでは

repeated events when multiple articles have the same pubDate and different titles

When multiple articles in the feed have the same pubDate, events are created for each of those articles on every iteration.

It looks like state retained by the watcher is based on pubDate and title, which is insufficient to handle this use-case.

The workaround is to ensure that no two articles in a watched feed have the same pubDate.

I'm going to have a look at this. My gut feel is that retaining a collection of titles for a given pubDate might be all that's needed.

Timerのほうがテストできてない

どっかのフィードを監視しつつそのフィードを更新するテストを書かないといけないので難しい

今はbin/rss-watcherのCLIツールで動作確認してるけどわりと非効率

適切に変数の参照を捨てる

配列にデータが溜まり続けてるからGCさせないといけない（のでは）