mojodna-fire-hydrant 0.0.1

data/README.markdown

@@ -0,0 +1,82 @@
+# Fire Hydrant
+
+Fire Hydrant is a set of tools for consuming [Fire
+Eagle](http://fireeagle.yahoo.net/ "Fire Eagle")'s XMPP
+[PubSub](http://xmpp.org/extensions/xep-0060.html "XEP-0060: Publish-Subscribe") feed.
+
+## Getting Started
+
+Install it:
+
+    $ sudo gem install mojodna-fire-hydrant-s http://gems.github.com
+
+Configure it:
+
+    $ cp fire_hydrant.yml.sample fire_hydrant.yml
+    $ vi fire_hydrant.yml
+
+_Switchboard settings are not presently used._
+
+Configure switchboard:
+
+    $ 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
+
+Subscribe to location updates corresponding to the configured token:
+
+    $ switchboard pubsub subscribe
+
+Check subscriptions:
+
+    $ switchboard pubsub subscriptions
+
+Run it:
+
+    $ examples/fire_eagle_consumer.rb
+
+If you'd like to unsubscribe:
+
+    $ switchboard pubsub unsubscribe
+
+## Notes and Gotchas
+
+Subscribing to / unsubscribing from nodes is an awkward process at the moment,
+as switchboard must be re-configured with each OAuth token/secret pair that
+you wish to subscribe to.
+
+If you need to authorize your application to receive updates, you can add your
+OAuth consumer key to _fire\_hydrant.yml_ and run:
+
+    $ examples/authorize.rb
+
+You can then add the token and secret to your switchboard configuration in
+order to subscribe.
+
+Google Talk accounts do not appear to work, but Jabber.org accounts seem to
+work fine. (If you plan to use this in production, you should be running your
+own XMPP server and should **not** use Jabber.org.)
+
+## Getting Help
+
+Your best bet for help is to post a message to the Fire Eagle Yahoo! Group:
+[http://tech.groups.yahoo.com/group/fireeagle/](http://tech.groups.yahoo.com/group/fireeagle/ "Fire Eagle Yahoo! Group")
+
+## Google Earth Integration
+
+If you're on a Mac, install [Google Earth](http://earth.google.com/ "Google Earth") and
+[rb-appscript](http://appscript.sourceforge.net/rb-appscript/index.html "Ruby Appscript"):
+
+    $ sudo gem install rb-appscript
+
+Start Google Earth and run:
+
+    $ examples/fire_eagle_visualizer.rb
+
+To see your users' locations in real-time as they change.

data/examples/authorize.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+require 'rubygems'
+# work-around for a bug in oauth 0.2.4
+require 'oauth/helper'
+require 'fireeagle'
+
+# read the configuration
+config = YAML.load(open("fire_hydrant.yml").read)
+
+if config.has_key?("oauth.token") && config.has_key?("oauth.token_secret")
+  puts "Application has already been authorized."
+  exit
+end
+
+# initialize a Fire Eagle client
+client = FireEagle::Client.new \
+  :consumer_key    => config["oauth.consumer_key"],
+  :consumer_secret => config["oauth.consumer_secret"]
+
+## Step 1 - Get a request token
+
+client.get_request_token
+
+## Step 2 - Ask the user to authorize the application, using that request token
+
+puts "Please authorize this application:"
+puts " #{client.authorization_url}"
+print "<waiting>"
+gets
+
+## Step 3 - Convert the request token into an access token
+
+client.convert_to_access_token
+
+puts "Your OAuth token is: #{client.access_token.token}"
+puts "Your OAuth token secret is: #{client.access_token.secret}"

data/examples/fire_eagle_consumer.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'fire_hydrant'
+require 'yaml'
+
+hydrant = FireHydrant.new(YAML.load(File.read("fire_hydrant.yml")))
+
+hydrant.on_location_update do |user|
+  # for some reason the Fire Eagle gem doesn't work when I access #name directly
+  name = user.locations[0].instance_eval { @doc.at("//name").innerText }
+  puts "#{user.token} has moved to #{name}."
+end
+
+hydrant.run!

data/examples/fire_eagle_visualizer.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+begin
+  require 'appscript'
+rescue LoadError => e
+  gem = e.message.split("--").last.strip
+  puts "The #{gem} gem is required."
+end
+
+require 'fire_hydrant'
+
+earth = Appscript.app("Google Earth")
+
+# override the resource as "visualizer"
+hydrant = FireHydrant.new(YAML.load(File.read("fire_hydrant.yml")).merge("resource" => "visualizer"), true)
+
+hydrant.on_location_update do |user|
+  # for some reason the Fire Eagle gem doesn't work when I access #name directly
+  name = user.locations[0].instance_eval { @doc.at("//name").innerText }
+  puts "#{user.token} has moved to #{name}."
+
+  geom = user.locations[0].geom
+  begin
+    pt = geom.is_a?(GeoRuby::SimpleFeatures::Envelope) ? geom.center : geom
+    earth.SetViewInfo({:latitude => pt.y, :longitude => pt.x, :distance => (rand * 25000) + 5000, :azimuth => rand * 360, :tilt => (rand * 75)}, {:speed => 1})
+  rescue # rescue from Appscript errrors
+  end
+
+hydrant.run!

data/fire-hydrant.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = "fire-hydrant"
+  s.version = "0.0.1"
+  s.summary = "Fire Eagle XMPP PubSub tools"
+  s.description = "Tools for consuming Fire Eagle's XMPP PubSub feed."
+  s.authors = ["Seth Fitzsimmons"]
+  s.email = ["seth@mojodna.net"]
+
+  s.files = ["examples", "examples/authorize.rb", "examples/fire_eagle_consumer.rb", "examples/fire_eagle_visualizer.rb", "fire-hydrant.gemspec", "fire_hydrant.yml", "fire_hydrant.yml.development", "fire_hydrant.yml.production", "fire_hydrant.yml.sample", "lib", "lib/fire_hydrant", "lib/fire_hydrant/fire_hydrant.rb", "lib/fire_hydrant/jacks", "lib/fire_hydrant/jacks/fire_eagle_jack.rb", "lib/fire_hydrant/jacks.rb", "lib/fire_hydrant.rb", "README.markdown"]
+  s.require_paths = ["lib"]
+
+  s.add_dependency("fireeagle")
+  s.add_dependency("mojodna-switchboard")
+end

data/fire_hydrant.yml.sample

@@ -0,0 +1,7 @@
+jid: client@xmpp-server
+password: password
+pubsub.server: fireeagle.com
+
+# for authorization
+oauth.consumer_key: asdf
+oauth.consumer_secret: qwerty

data/lib/fire_hydrant/fire_hydrant.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+begin
+  require 'fireeagle'
+  require 'switchboard'
+rescue LoadError => e
+  gem = e.message.split("--").last.strip
+  puts "The #{gem} gem is required."
+end
+
+class FireHydrant < Switchboard::Core
+  DEFAULTS = {
+    "resource" => "fire_hydrant"
+  }
+
+  def initialize(settings = {})
+    super(DEFAULTS.merge(settings), true)
+    plug!(FireEagleJack)
+  end
+end

data/lib/fire_hydrant/jacks/fire_eagle_jack.rb

@@ -0,0 +1,20 @@
+class FireEagleJack
+  def self.connect(switchboard, settings)
+    switchboard.plug!(AutoAcceptJack, NotifyJack, PubSubJack)
+
+    switchboard.on_pubsub_event do |event|
+      event.payload.each do |payload|
+        payload.elements.each do |item|
+          rsp = item.first_element("rsp")
+          response = FireEagle::Response.new(rsp.to_s)
+          user = response.users[0]
+          on(:location_update, user)
+        end
+      end
+    end
+
+    def switchboard.on_location_update(&block)
+      register_hook(:location_update, &block)
+    end
+  end
+end

data/lib/fire_hydrant/jacks.rb

@@ -0,0 +1 @@
+require 'fire_hydrant/jacks/fire_eagle_jack'

data/lib/fire_hydrant.rb

@@ -0,0 +1,2 @@
+require 'fire_hydrant/fire_hydrant'
+require 'fire_hydrant/jacks'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: mojodna-fire-hydrant
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Seth Fitzsimmons
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fireeagle
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mojodna-switchboard
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Tools for consuming Fire Eagle's XMPP PubSub feed.
+email: 
+- seth@mojodna.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- examples
+- examples/authorize.rb
+- examples/fire_eagle_consumer.rb
+- examples/fire_eagle_visualizer.rb
+- fire-hydrant.gemspec
+- fire_hydrant.yml
+- fire_hydrant.yml.development
+- fire_hydrant.yml.production
+- fire_hydrant.yml.sample
+- lib
+- lib/fire_hydrant
+- lib/fire_hydrant/fire_hydrant.rb
+- lib/fire_hydrant/jacks
+- lib/fire_hydrant/jacks/fire_eagle_jack.rb
+- lib/fire_hydrant/jacks.rb
+- lib/fire_hydrant.rb
+- README.markdown
+has_rdoc: false
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Fire Eagle XMPP PubSub tools
+test_files: []
+