pangratz / irc-log-viewer Goto Github PK

CouchApp using Ember.js to show IRC logs stored in a CouchDB

License: MIT License

Ruby 2.63% JavaScript 97.37%

irc-log-viewer's Introduction

irc-log-viewer

This is a viewer for IRC logs which are stored in a CouchDB. It's basically a couchapp using Ember.js. Demo? Here you go: http://emberjs.iriscouch.com/irc/_design/viewer/index.html (transcript of #emberjs channel)

Awesome stuff used

Stored IRC messages

The IRC messages saved in the CouchDB have the following format:

{
   "user": {
       "id": "123",
       "name": "GOB"
   },
   "text": "Come on!",
   "date": "2012-12-21T12:34:56.789Z"
}

One example of filling the CouchDB with the IRC messages would be a Hubot configured with the store-messages-couchdb.coffee script and using an IRC Adapter

CouchDB Views

The messages view returns all messages, where the key is the date structured as an array with the year as first element, month as second and so forth. This allows you to get messages for a specific period.

Front end

Inside the app folder is the basic application.

Development

Prerequisites:

installed Ruby
installed CouchDB where app can be deployed or use a free hosting service like the excellent Iris Couch
installed couchapp command line tool for easy pushing of the app to a CouchDB, see installation

Developing

Clone this repo, obviously
execute couchapp init to create an empty .couchapprc file inside the project (See section .couchapprc on http://couchapp.org/page/couchapp-config)
execute bundle install
Tests are in located in the tests folder
Execute bundle execute rackup to start test server
Access http://localhost:4020/tests.html to execute the tests

Execute bundle execute rake test to run the tests from command line

Deploy

execute bundle exec rake build
push the Couchapp to your CouchDB; if you have couchapp installed, do a couchapp push http://localhost:5984/irc
access the IRC log viewer at http://localhost:5984/irc/_design/viewer/index.html

irc-log-viewer's People

Contributors

Stargazers

Watchers

Forkers

roydaniels stuartf frozzare punerb

irc-log-viewer's Issues

Uncaught TypeError: Cannot read property 'text' of undefined

When accessing some entries which have an empty string as message text.

Uncaught TypeError: Cannot read property 'text' of undefined
IRC.set.Ember.ArrayProxy.extend.addMessageirc/controller:6
IRC.set.Ember.Object.create.loadDay.$.couch.db.view.successirc/main:26
IRC.set.Ember.Object.create.loadDay.$.couch.db.view.successirc/main:25
$.ajax.$.extend.$.extend.completejquery.couch.js:661
jQuery.Callbacks.firebpm_libs.js:2178
jQuery.Callbacks.self.fireWithbpm_libs.js:2296
donebpm_libs.js:8546
jQuery.ajaxTransport.send.callback

All objects in question can be retrieved via map function:

function(doc) {
  if (!doc.text && !doc.message) {
    emit(null, doc);
  }
}

add realtime update by using CouchDB's _changes feed

Make proxy in config.ru independent from database name

Also replace hard coded database name in app/couchdb_datasource.js with #{DB} and replace it in Rake task.

create testable CouchDB datasource

eventually move to ember-data and add DS.CouchDBAdapter

Create deploy task in Rakefile

build app (if desired in production mode) and push it to specific couchapp

improve README

add background of this couchapp
how to build this?
how to develop and test?

Broken when Ember.js with version > 0.9.5 is used

couchapp push doesn't work

When running couchapp push https://user:[email protected]/irc I get an error:

2012-07-03 12:50:40 [ERROR] couchapp error: You aren't in a couchapp.

Running couchapp version says:

Couchapp (version 1.0.1)
Copyright 2008-2010 Benoît Chesneau <[email protected]>
Licensed under the Apache License, Version 2.0.

Show calendar instead of long list of dates

Date Key in JSON is null

Here is what I see in the messages via the app

{"id":"2d534b79f5b3a49900030ce0010394a1","key":[null,null,null,null,null,null,null],"value":1,"doc":{"_id":"2d534b79f5b3a49900030ce0010394a1","_rev":"1-378711d7c2b7856acfc9a5b026566ddd","user":{"id":"1357310172534","name":"vachon","room":"#dev","roles":["ops"]},"text":"yes","done":false,"room":"#dev","date":"2013-01-25T16:37:46.387Z"}}
]}

When looking at couchbase, you get:

{
   "_id": "2d534b79f5b3a49900030ce0010394a1",
   "_rev": "1-378711d7c2b7856acfc9a5b026566ddd",
   "user": {
       "id": "1357310172534",
       "name": "vachon",
       "room": "#dev",
       "roles": [
           "ops"
       ]
   },
   "text": "yes",
   "done": false,
   "room": "#dev",
   "date": "2013-01-25T16:37:46.387Z"
}

It looks to me like the date is no longer being parsed and blowing up.

Remove reference to BPM in README

change messages view to show messages from dates around midnight

so one doesn't have to got to previous / next day to read on

Date is not shown if there are no messages on this day

If no messages occurred on a specific date, this date is not shown in the list. Only dates where messages are available are shown which is not a consistent UI.