bumped to 0.05

.gitignore

@@ -1,3 +1,4 @@
+test/tmp.*
 examples/test.json
 examples/test.yaml
 examples/test.yml

.npmignore

@@ -1,3 +1,4 @@
+test/tmp.*
 examples/test.json
 examples/test.yaml
 examples/test.yml

README.md

@@ -117,9 +117,16 @@ recorder.write "hello"
 recorder.write foo: "hello", bar: "world"
 recorder.write new Buffer()
 
-# in the future, you will be able to add an event at a specific time
+# not yet implemented, but soon you will be able to add an event at a specific time
 # recorder.writeAt moment(1982,1,1), "cold wave"
 
+# also, don't forget to close the recorder when you don't use it anymore
+# the reason is that a recorder start some background processes
+# (eg. async synchronization of database) that need to be stopped manually
+# if there is not more data to record. 
+recorder.stop()
+
+
 ```
 
 Playback
@@ -152,6 +159,8 @@ recorder = new StreamRecorder record
 myInputStream.pipe(recorder)
 
 # that's all folks!
+# you don't need to close explicitely the StreamRecorder (unlike SimpleRecorder)
+# since it can detect automatically 'close' events from input stream
 ```
 
 
@@ -192,8 +201,13 @@ Piping
 
 ### Playing with Twitter Stream
 
-  Here I am using some environment variables to define the Twitter tokens (à la Heroku),
-  so don't forget to change this to fit your own environment.
+  NOTE 1: you need to install ntwitter manually before running the example:
+
+   $ npm install -g ntwitter
+
+  I didn't include it as a dependency to keep dependencies light.
+
+  NOTE 2: you need to have some some environment variables containing your Twitter tokens
 
 ``` coffeescript
 
@@ -231,6 +245,7 @@ twit.stream 'statuses/sample', (stream) ->
   stream.on 'data', (data) -> 
     timeline.write moment(data.created_at), data.text
   delay duration*1000, ->
+    recorder.close()
     log "playing tweets back"
     new sampler.SimplePlayer timeline,
       speed: 2.0
@@ -246,6 +261,13 @@ twit.stream 'statuses/sample', (stream) ->
 
 ## Changelog
 
+### 0.0.5
+
+ * now we can load a json file! and it's tested!
+ * more bugfixes
+ * more tests
+ * addd a recorder.close() function
+
 ### 0.0.4
 
  * Fixed broken YAML dependency

examples/playback.coffee

@@ -0,0 +1,12 @@
+#!/usr/bin/env coffee
+
+# standard node library
+{log,inspect}   = require 'util'
+
+# sampler modules
+sampler = require '../lib/sampler'
+delay = (t, f) -> setTimeout f, t
+
+new sampler.SimplePlayer "file://twitter.smp",
+  speed: 2.0
+  onData: (data) -> log "TWEET: #{data}"

examples/twitter.coffee

@@ -12,7 +12,7 @@ sampler = require '../lib/sampler'
 delay = (t, f) -> setTimeout f, t
 
 # PARAMETERS
-duration = 15
+duration = 8
 timeline = new sampler.Record "file://twitter.smp"
 twit = new Twitter
   consumer_key: process.env.TWITTER_CONSUMER_KEY
@@ -26,12 +26,16 @@ twit.stream 'statuses/sample', (stream) ->
   recorder = new sampler.SimpleRecorder timeline
   stream.on 'error', (err) ->
     log "twitter error: #{inspect err}"
+    if err.code?
+      log "this is a serious error. exiting"
+      process.exit()
+
     if err.text?
       timeline.write moment(err.created_at), err.text
   stream.on 'data', (data) -> 
     timeline.write moment(data.created_at), data.text
   delay duration*1000, ->
-    log "recording terminated"
+    log "recording terminated, will soon exit.."
     stream.destroy() # clean exit?
-    #process.exit() # problem; is we exit during a write(), everything in the file is lost
+    delay 5000, -> process.exit()
   log "listening for #{duration} seconds"