altum 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in altum.gemspec
+gemspec

data/README

@@ -0,0 +1,18 @@
+
+          _                   _           _      _                  _   _       
+         / /\                _\ \        /\ \   /\_\               /\_\/\_\ _   
+        / /  \              /\__ \       \_\ \ / / /         _    / / / / //\_\ 
+       / / /\ \            / /_ \_\      /\__ \\ \ \__      /\_\ /\ \/ \ \/ / / 
+      / / /\ \ \          / / /\/_/     / /_ \ \\ \___\    / / //  \____\__/ /  
+     / / /  \ \ \        / / /         / / /\ \ \\__  /   / / // /\/________/   
+    / / /___/ /\ \      / / /         / / /  \/_// / /   / / // / /\/_// / /    
+   / / /_____/ /\ \    / / / ____    / / /      / / /   / / // / /    / / /     
+  / /_________/\ \ \  / /_/_/ ___/\ / / /      / / /___/ / // / /    / / /      
+ / / /_       __\ \_\/_______/\__\//_/ /      / / /____\/ / \/_/    / / /       
+ \_\___\     /____/_/\_______\/    \_\/       \/_________/          \/_/        
+                                                                                
+ 
+ Altum uses the magic of Pusher and websockets to drive a ShowOff
+ presentation remotely. See the Rocco geneerated docs for more information:
+
+                     <http://lmarburger.github.com/altum/>

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs    << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+desc 'Default: run tests'
+task :default => 'test'

data/altum.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/altum/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Larry Marburger"]
+  gem.email         = ["larry@marburger.cc"]
+  gem.description   = %q{Present remotely}
+  gem.summary       = %q{Altum uses the magic of Pusher and websockets to drive a ShowOff presentation remotely. The simplest tool when you need to walk through a deck on a conference call.}
+  gem.homepage      = "http://lmarburger.github.com/altum/"
+
+  gem.add_dependency 'pusher'
+  gem.add_dependency 'rack'
+
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'wrong'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "altum"
+  gem.require_paths = ["lib"]
+  gem.version       = Altum::VERSION
+end

data/altum.js

@@ -0,0 +1,28 @@
+/******************************************************
+ ** Copy the latest pusher.min.js and paste it here. **
+ ** http://js.pusherapp.com/1.9/pusher.min.js        **
+ ******************************************************/
+
+var presenter = /presenter=(.*)/.exec(window.location.search),
+    sekret    = presenter && presenter[1];
+
+if (sekret) {
+  $(function() {
+    $('body').bind('showoff:show', function() {
+      $.post('/slide', { key: sekret, number: slidenum });
+    });
+  });
+
+} else {
+
+  // Enable pusher logging - don't include this in production
+  Pusher.log = function(message) {
+    if (window.console && window.console.log) window.console.log(message);
+  };
+
+  new Pusher('06d2e0409a41c6e5a7d4')
+    .subscribe('presenter')
+    .bind('slide_change', function(data) {
+      gotoSlide(data.slide);
+    });
+}

data/lib/altum/version.rb

@@ -0,0 +1,3 @@
+class Altum
+  VERSION = "0.0.1"
+end

data/lib/altum.rb

@@ -0,0 +1,101 @@
+# **Altum** uses the magic of Pusher and websockets to drive a [ShowOff][]
+# presentation remotely.
+#
+# Altum consists of a piece of Rack middleware and some JavaScript that keeps
+# viewers in sync with the presenter. Getting started is easy.
+#
+# Install Altum with Rubygems:
+#
+#     gem install altum
+#
+# ShowOff will create a `config.ru` file when using the command `showoff heroku`
+# or simply create one yourself. Add Altum as you would any other Rack
+# middleware supplying it with your Pusher connection URL and a key used to
+# identify the presenter.
+#
+#     require 'showoff'
+#     require 'altum'
+#
+#     use Altum, :pusher_url => ENV['PUSHER_URL'], :key => 'sekret'
+#     run ShowOff.new
+#
+# Next, download [altum.js][] into your presentation directory. Copy the code
+# from the latest [pusher.min.js][] and paste it at the top of `altum.js`.
+#
+# Start the presentation locally with `rackup` or deploy it to heroku using
+# `showoff heroku`. You're ready to present! Open the presentation as the
+# presenter by visiting
+# [http://_your-app-name_.heroku.com?presenter=sekret][presenter] and ask those
+# observing to follow along with you at
+# [http://_your-app-name_.heroku.com][observer]. Your observer's browsers will
+# follow along with you as you move through your deck; forward, backward, and
+# jumping to a specific slide.
+#
+#
+# [showoff]:       https://github.com/schacon/showoff
+# [altum.js]:      https://github.com/lmarburger/altum/blob/master/altum.js
+# [pusher.min.js]: http://js.pusherapp.com/1.9/pusher.min.js
+# [presenter]:     http://your-app-name.heroku.com?presenter=sekret
+# [observer]:      http://your-app-name.heroku.com
+
+require 'altum/version'
+require 'pusher'
+
+# `Altum.new` takes the downstream `app` and an `options` hash. The `options`
+# hash respects two members:
+#
+# * `:pusher_url`: the Pusher connection URL passed to `Pusher.url=`. If you're
+#   using Pusher as a Heroku add-on, it will be in the environment variable
+#   `PUSHER_URL`.
+#
+# * `:key`: an optional secret key to identify the presenter pass as a query
+#   string parameter. If `:key` is nil or doesn't exist, the default "sekret" is
+#   used. Append `?presenter=sekret` to the ShowOff URL to drive the
+#   presentation.
+class Altum
+
+  def initialize(app, options)
+    @app = app
+    @key = options[:key] || 'sekret'
+
+    Pusher.url = options[:pusher_url]
+  end
+
+  # Listen for slide change commands from the presenter and send the current
+  # slide out to all those watching. Silently ignore requests from a presenter
+  # using an incorrect key.
+  def call(env)
+    request = Rack::Request.new env
+
+    if slide_path? request
+      change_slide request if presenter?(request)
+
+      [ 204, {}, [] ]
+    else
+      @app.call env
+    end
+  end
+
+protected
+
+  # Respond only to requests for `/slide`.
+  def slide_path?(request)
+    request.path == '/slide'
+  end
+
+  # Match the key supplied in the request with the key used when the middlware
+  # was configured.
+  def presenter?(request)
+    request.params['key'] == @key
+  end
+
+  # Grab the current slide number from the `number` parameter of the request.
+  # Pass it to those observing by triggering the `presenter` channel's
+  # `slide_change` event.
+  def change_slide(request)
+    Pusher['presenter'].trigger('slide_change', {
+      'slide' => request.params['number']
+    })
+  end
+
+end

data/spec/altum_spec.rb

@@ -0,0 +1,92 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'webmock/minitest'
+require 'wrong/adapters/minitest'
+
+require 'altum'
+require 'rack/mock'
+
+class DummyApp
+  def call(env)
+    [ 200, {}, ["Hello World"] ]
+  end
+end
+
+describe Altum do
+
+  def pusher_url
+    'http://1234:4321@api.pusherapp.com/apps/1324'
+  end
+
+  def request(options = {})
+    options = options.merge :pusher_url => pusher_url
+
+    Rack::MockRequest.new Altum.new(DummyApp.new, options)
+  end
+
+  def stub_push
+    stub_request(:post, %r{\Ahttp://api\.pusherapp\.com/apps/1324/channels/presenter/events\?auth_key=1234&.*&name=slide_change\Z}).
+      to_return(:status => 202)
+  end
+
+  it 'sets up Pusher' do
+    Altum.new(DummyApp.new, :pusher_url => pusher_url)
+
+    assert { Pusher.host   == 'api.pusherapp.com' }
+    assert { Pusher.port   == 80 }
+    assert { Pusher.key    == '1234' }
+    assert { Pusher.secret == '4321' }
+    assert { Pusher.app_id == '1324' }
+  end
+
+  it 'passes along irrlevant requests' do
+    res = request.get '/'
+
+    assert { res.ok? }
+    assert { res.body == 'Hello World' }
+  end
+
+  it 'responds to requests' do
+    stub_push
+    res = request.get '/slide?key=sekret&number=1'
+
+    assert { res.status == 204 }
+    assert { res.empty? }
+
+    assert_requested :post,
+                     %r{http://api\.pusherapp\.com},
+                     :body => JSON(:slide => '1')
+  end
+
+  it 'responds without pushing with an incorrect key' do
+    res = request.get '/slide?key=wrong'
+
+    assert { res.status == 204 }
+    assert { res.empty? }
+  end
+
+  it 'overrides the default key' do
+    stub_push
+    res = request(:key => 'super-sekret').get '/slide?key=super-sekret&number=1'
+
+    assert { res.status == 204 }
+    assert { res.empty? }
+
+    assert_requested :post,
+                     %r{http://api\.pusherapp\.com},
+                     :body => JSON(:slide => '1')
+  end
+
+  it 'uses the default key when nil' do
+    stub_push
+    res = request(:key => nil).get '/slide?key=sekret&number=1'
+
+    assert { res.status == 204 }
+    assert { res.empty? }
+
+    assert_requested :post,
+                     %r{http://api\.pusherapp\.com},
+                     :body => JSON(:slide => '1')
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: altum
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Larry Marburger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pusher
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: wrong
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Present remotely
+email: 
+- larry@marburger.cc
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- altum.gemspec
+- altum.js
+- lib/altum.rb
+- lib/altum/version.rb
+- spec/altum_spec.rb
+homepage: http://lmarburger.github.com/altum/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Altum uses the magic of Pusher and websockets to drive a ShowOff presentation remotely. The simplest tool when you need to walk through a deck on a conference call.
+test_files: 
+- spec/altum_spec.rb