mojodna-fire-hydrant 0.0.1 → 0.0.2

data/README.markdown

@@ -8,7 +8,11 @@ Eagle](http://fireeagle.yahoo.net/ "Fire Eagle")'s XMPP
 
 Install it:
 
-    $ sudo gem install mojodna-fire-hydrant-s http://gems.github.com
+    $ sudo gem install mojodna-fire-hydrant -s http://gems.github.com
+
+Clone it (to play with):
+
+    $ git clone git://github.com/mojodna/fire-hydrant.git
 
 Configure it:
 
@@ -17,25 +21,38 @@ Configure it:
 
 _Switchboard settings are not presently used._
 
-Configure switchboard:
+Add **fireeagle.com** to your roster:
+
+    $ switchboard --jid jid@example.com --password pa55word \
+      roster add fireeagle.com
+
+Confirm that your roster contains **fireeagle.com** (in order for presence
+notifications to be sent properly):
 
-    $ switchboard config jid jid@example.com
-    $ switchboard config password pa55word
-    $ switchboard config oauth.consumer_key asdf
-    $ switchboard config oauth.consumer_secret qwerty
-    $ switchboard config oauth.token asdf
-    $ switchboard config oauth.token_secret qwerty
-    $ switchboard config oauth.general_token asdf
-    $ switchboard config oauth.general_token_secret qwerty
-    $ switchboard config pubsub.server fireeagle.com
+    $ switchboard --jid jid@example.com --password pa55word roster list
 
 Subscribe to location updates corresponding to the configured token:
 
-    $ switchboard pubsub subscribe
+    $ switchboard --jid jid@example.com --password pa55word \
+        pubsub --oauth \
+        --oauth-consumer-key <consumer key> \
+        --oauth-consumer-secret <consumer secret> \
+        --oauth-token <token> \
+        --oauth-token-secret <token secret> \
+        --server fireeagle.com \
+        --node "/api/0.1/user/<token>" \
+        subscribe
 
 Check subscriptions:
 
-    $ switchboard pubsub subscriptions
+    $ switchboard --jid jid@example.com --password pa55word \
+        pubsub --oauth \
+        --oauth-consumer-key <consumer key> \
+        --oauth-consumer-secret <consumer secret> \
+        --oauth-token <general token> \
+        --oauth-token-secret <general token secret> \
+        --server fireeagle.com \
+        subscriptions
 
 Run it:
 
@@ -43,7 +60,46 @@ Run it:
 
 If you'd like to unsubscribe:
 
-    $ switchboard pubsub unsubscribe
+
+    $ switchboard --jid jid@example.com --password pa55word \
+        pubsub --oauth \
+        --oauth-consumer-key <consumer key> \
+        --oauth-consumer-secret <consumer secret> \
+        --oauth-token <token> \
+        --oauth-token-secret <token secret> \
+        --server fireeagle.com \
+        --node "/api/0.1/user/<token>" \
+        unsubscribe
+
+## Incorporating the Fire Hydrant Into Your Application
+
+The most basic Fire Eagle consumer looks like:
+
+    config = YAML.load(File.read("fire_hydrant.yml"))
+    hydrant = FireHydrant.new(config)
+
+    hydrant.on_location_update do |user|
+      # insert application-specific functionality here
+      puts "#{user.token} has moved to #{user.locations[0].name}."
+    end
+
+    hydrant.run!
+
+_examples/fire\_eagle\_consumer.rb_
+
+The configuration Hash (`config`) must contain `jid`, `password`, and
+`pubsub.server`, but does not need to be loaded from `fire_hydrant.yml`.
+
+Your consumer should run as a stand-alone application, as it spawns several
+threads and is intended to be a long-running process.
+
+Also, note that running multiple instances of the consumer (each with
+different resources, in order for all to be online simultaneously) will not
+distribute updates across instances; **all instances will receive all
+updates**.
+
+See the [Fire Eagle gem documentation](http://fireeagle.rubyforge.org/) for
+more information on how Fire Eagle information is exposed to Ruby.
 
 ## Notes and Gotchas
 

data/examples/fire_eagle_consumer.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'rubygems'
 require 'fire_hydrant'
 require 'yaml'
 

data/fire-hydrant.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "fire-hydrant"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
   s.summary = "Fire Eagle XMPP PubSub tools"
   s.description = "Tools for consuming Fire Eagle's XMPP PubSub feed."
   s.authors = ["Seth Fitzsimmons"]

data/lib/fire_hydrant/fire_hydrant.rb

@@ -7,7 +7,7 @@ rescue LoadError => e
   puts "The #{gem} gem is required."
 end
 
-class FireHydrant < Switchboard::Core
+class FireHydrant < Switchboard::Client
   DEFAULTS = {
     "resource" => "fire_hydrant"
   }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mojodna-fire-hydrant
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Seth Fitzsimmons