slide-em-up 0.1.8 → 0.2.0

data/README.md

@@ -6,13 +6,114 @@ a style and it displays it in HTML5. With a browser in full-screen, you can
 make amazing presentations!
 
 
+How to do your first presentation with Slide'em up?
+---------------------------------------------------
+
+1. Install slide-em-up: `gem install slide-em-up`
+2. Create a directory for your presentation: `mkdir foobar && cd foobar`
+3. Create a section for your slides: `mkdir main_section`
+4. Write some slides: `vim main_section/slides.md`
+
+       !SLIDE
+       # My First slide #
+       It's awesome
+
+       !SLIDE
+       # My second slide #
+       This rocks too!
+
+5. Write the `presentation.json` file with the metadata:
+
+       {
+         "title": "My first presentation",
+         "theme": "shower",
+         "sections": ["main_section"]
+       }
+
+6. Launch the tool: `slide-em-up`
+7. Open your browser on http://localhost:9000/
+8. Use the arrows keys to navigate between the slides
+
+
+Markup for the slides
+---------------------
+
+This slides are writen in [Markdown](http://daringfireball.net/projects/markdown/syntax)
+and `!SLIDE` is the indicator for a new slide.
+
+Example:
+
+    !SLIDE
+    # Title of the first slide #
+    ## A subtitle ##
+    And some text...
+
+    !SLIDE
+    # Another slide #
+
+    * a
+    * bullet
+    * list
+
+    !SLIDE
+    # Third slide #
+
+    1. **bold**
+    2. _italics_
+    3. https://github.com/
+
+
+Syntax Highlighting
+-------------------
+
+To highlight some code in your slides, you have to install
+[pygments](http://pygments.org/). Then, surround your code with backticks
+like this:
+
+    ```ruby
+    class Foobar
+      def baz
+        puts "Foobar says baz"
+      end
+    end
+    ```
+
+
+Themes
+------
+
+Several themes are available: shower, 3d_slideshow and html5rocks.
+To choose the theme for your presentation, edit the `presentation.json`
+file and change the `"theme"` element.
+
+
+Remote Control
+--------------
+
+When your start slide-em-up in console, a message says something like:
+
+> Your remote key is 652df
+
+This remote key can be used to send actions to browsers that display the
+presentation. For example, this command goes to the next line:
+
+    curl http://localhost:9000/remote/652df/next
+
+The last part of the URL is the action and can be `next`, `prev`, `up` or
+`down`.
+
+It's also possible to force slide-em-up to use a specific remote key by
+setting the `APIKEY` environment variable:
+
+    APIKEY=foobar slide-em-up
+
+
 TODO
 ----
 
-* Explain how to install and use it in README
 * Same command line stuff than showoff
-* Many more things
-* Add more themes
+* Add a showoff theme for compatibility
+* Many more themes and features
 
 
 Issues or Suggestions
@@ -33,6 +134,7 @@ Scott Chacon is the guy who made [ShowOff](https://github.com/schacon/showoff).
 Slide'em up is only a copy of ShowOff, where sinatra was replaced by Goliath.
 
 Themes were picked from the internet. Thanks to:
+
 - Hakim El Hattab for 3d_slideshow
 - Google for html5rocks
 - Vadim Makeev for shower

data/bin/slide-em-up

@@ -5,7 +5,9 @@ require "goliath/runner"
 
 
 presentation = SlideEmUp::Presentation.new(Dir.pwd)
+key = ENV['APIKEY'] || rand(1_000_000).to_s(16)
+puts "Your remote key is #{key}"
 
 runner = Goliath::Runner.new(ARGV, nil)
-runner.app = SlideEmUp::SlidesAPI.new(presentation)
+runner.app = SlideEmUp::Routes.run(presentation, :remote_key => key)
 runner.run

data/lib/slide-em-up/presentation.rb

@@ -16,7 +16,7 @@ module SlideEmUp
 
     def initialize(dir)
       infos   = extract_normal_infos(dir) || extract_infos_from_showoff(dir) || {}
-      infos   = { "title" => "No title", "theme" => "default" }.merge(infos)
+      infos   = { "title" => "No title", "theme" => "shower" }.merge(infos)
       @meta   = build_meta(infos["title"], dir)
       @theme  = build_theme(infos["theme"])
       @common = build_theme("common")

data/lib/slide-em-up/remote_api.rb

@@ -0,0 +1,52 @@
+require "goliath/api"
+
+module SlideEmUp
+  class RemoteAPI < Goliath::API
+    def initialize(key)
+      # Secret token...
+      @key  = key
+
+      # Share channel between connections
+      @chan = ::EM::Channel.new
+    end
+
+    def response(env)
+      path_info = Rack::Utils.unescape(env['PATH_INFO'])
+      slash, key, action = path_info.split('/', 3)
+
+      # Events are public
+      return stream_events(env) if 'events' == action
+
+      # Sending events is restricted
+      return forbidden unless key == @key
+
+      @chan.push(action)
+      [200, {
+        "Content-Type"   => "text/plain; charset=utf-8",
+        "Content-Length" => Rack::Utils.bytesize(action).to_s
+      }, [action]]
+    end
+
+    def on_close(env)
+      return unless env['subscription']
+      env.logger.info "Stream connection closed."
+      @chan.unsubscribe(env['subscription'])
+    end
+
+  protected
+
+    def stream_events(env)
+      env['subscription'] = @chan.subscribe do |msg|
+        env.stream_send("data: #{msg}\n\n")
+      end
+      streaming_response(200, {"Content-Type" => "text/event-stream"})
+    end
+
+    def forbidden
+      [403, {
+        "Content-Type"   => "text/plain",
+        "Content-Length" => "10"
+      }, ["Forbidden\n"]]
+    end
+  end
+end

data/lib/slide-em-up/routes.rb

@@ -0,0 +1,20 @@
+require "rack/builder"
+
+
+module SlideEmUp
+  class Routes
+
+    def self.run(presentation, opts = {})
+      Rack::Builder.new do
+        map '/remote' do
+          run SlideEmUp::RemoteAPI.new(opts[:remote_key])
+        end
+
+        map '/' do
+          run SlideEmUp::SlidesAPI.new(presentation)
+        end
+      end
+    end
+
+  end
+end

data/lib/slide-em-up/version.rb

@@ -1,3 +1,3 @@
 module SlideEmUp
-  VERSION = "0.1.8"
+  VERSION = "0.2.0"
 end

data/lib/slide-em-up.rb

@@ -1,5 +1,7 @@
 module SlideEmUp
-  autoload :Presentation, "slide-em-up/presentation"
-  autoload :SlidesAPI,    "slide-em-up/slides_api"
-  autoload :VERSION,      "slide-em-up/version"
+  autoload :Presentation,    "slide-em-up/presentation"
+  autoload :SlidesAPI,       "slide-em-up/slides_api"
+  autoload :RemoteAPI,       "slide-em-up/remote_api"
+  autoload :Routes,          "slide-em-up/routes"
+  autoload :VERSION,         "slide-em-up/version"
 end

data/themes/3d_slideshow/js/slideshow.js

@@ -42,11 +42,38 @@ var Slideshow = (function(){
 		document.addEventListener('keydown', onDocumentKeyDown, false);
 		document.addEventListener('touchstart', onDocumentTouchStart, false);
 		window.addEventListener('hashchange', onWindowHashChange, false);
+
+		startEventSourceHandler('/remote/sub/events');
 		
 		// Read the initial state of the URL (hash)
 		readURL();
 	}
-	
+
+	function startEventSourceHandler (uri) {
+    if (window['EventSource'] == undefined) return ;
+
+    var source = new EventSource(uri);
+
+    source.onmessage = function(e) {
+      switch(e.data){
+        case 'next':
+          Slideshow.navigateRight();
+          break;
+        case 'prev':
+          Slideshow.navigateLeft();
+          break;
+        case 'up':
+          Slideshow.navigateUp();
+          break;
+        case 'down':
+          Slideshow.navigateDown();
+          break;
+        default:
+          console.log(e);
+      };
+    };
+	}
+
 	/**
 	 * Handler for the document level 'keydown' event.
 	 * 

data/themes/html5rocks/js/slides.js

@@ -304,6 +304,7 @@
 	      function(e) { if (e.state) { _t.go(e.state); } }, false);
 	  query('#left-init-key').addEventListener('click',
 	      function() { _t.next(); }, false);
+    this._startEventSource('/remote/sub/events');
 	  this._update();
 	};
 
@@ -320,6 +321,26 @@
 	    });
 	    return slideCount + 1;  
 	  },
+    _startEventSource: function(uri) {
+      if (window['EventSource'] == undefined) return ;
+
+      var source = new EventSource(uri);
+      var _t = this;
+      source.onmessage = function(e) {
+        switch(e.data){
+          case 'next':
+            _t.next(); break;
+          case 'prev':
+            _t.prev(); break;
+          case 'up':
+            _t.showNotes(); break;
+          case 'down':
+            _t.switch3D(); break;
+          default:
+            console.log(e);
+        };
+      };
+    },
 	  _update: function(dontPush) {
 	    // in order to delay the time where the counter shows the slide number we check if 
 	    // the slides are already loaded (so we show the loading... instead)

data/themes/shower/js/script.js

@@ -81,6 +81,47 @@
 		}
 	}
 
+	function startEventSourceHandler (uri) {
+    if (window['EventSource'] == undefined) return ;
+
+    var source = new EventSource(uri);
+		var current_slide_number = getCurrentSlideNumber();
+
+    source.onmessage = function(e) {
+      switch(e.data){
+        case 'next':
+          current_slide_number++;
+          goToSlide(current_slide_number);
+          break;
+        case 'prev':
+          current_slide_number--;
+          goToSlide(current_slide_number);
+          break;
+        case 'up':
+          if (!isSlideListMode()) {
+            e.preventDefault();
+
+            history.pushState(null, null, url.pathname + getSlideHashByNumber(current_slide_number));
+            enterSlideListMode();
+            scrollToCurrentSlide();
+          }
+          break;
+        case 'down':
+          if (isSlideListMode()) {
+            e.preventDefault();
+
+            history.pushState(null, null, url.pathname + '?full' + getSlideHashByNumber(current_slide_number));
+            enterSingleSlideMode();
+
+            updateProgress(current_slide_number);
+          }
+          break;
+        default:
+          console.log(e);
+      };
+    };
+	}
+
 	window.addEventListener('DOMContentLoaded', function () {
 		if (!isSlideListMode()) {
 			// "?full" is present without slide hash so we should display first
@@ -210,4 +251,5 @@
 		}
 	}, false);
 
+  startEventSourceHandler('/remote/sub/events');
 }());

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slide-em-up
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-28 00:00:00.000000000Z
+date: 2011-09-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
-  requirement: &75474350 !ruby/object:Gem::Requirement
+  requirement: &79848310 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *75474350
+  version_requirements: *79848310
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &75474100 !ruby/object:Gem::Requirement
+  requirement: &79852140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.17'
   type: :runtime
   prerelease: false
-  version_requirements: *75474100
+  version_requirements: *79852140
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &75473870 !ruby/object:Gem::Requirement
+  requirement: &79874950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.7'
   type: :runtime
   prerelease: false
-  version_requirements: *75473870
+  version_requirements: *79874950
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &75473640 !ruby/object:Gem::Requirement
+  requirement: &81723610 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *75473640
+  version_requirements: *81723610
 - !ruby/object:Gem::Dependency
   name: albino
-  requirement: &75473400 !ruby/object:Gem::Requirement
+  requirement: &82417980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *75473400
+  version_requirements: *82417980
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &75473170 !ruby/object:Gem::Requirement
+  requirement: &83019290 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '2.3'
   type: :development
   prerelease: false
-  version_requirements: *75473170
+  version_requirements: *83019290
 description: Slide'em up is a presentation tool that displays markdown-formatted slides
 email: bruno.michel@af83.com
 executables:
@@ -91,6 +91,8 @@ files:
 - bin/slide-em-up
 - lib/slide-em-up.rb
 - lib/slide-em-up/slides_api.rb
+- lib/slide-em-up/remote_api.rb
+- lib/slide-em-up/routes.rb
 - lib/slide-em-up/presentation.rb
 - lib/slide-em-up/version.rb
 - themes/shower/index.erb
@@ -143,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Slide'em up is a presentation tool that displays markdown-formatted slides