slideoff 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87edcce9bece900268c1ae4cb9470fa69283d469
+  data.tar.gz: 128ac25f3d45253eb3ec9a48109a916c409c5724
+SHA512:
+  metadata.gz: ef2ff59adab75e9f16ea05d26243ea442975057818ccd5b2b3731babbc305e5873926a23b8f4f1a4bb6d392b086d21967e64923d6994ce2dabbda129742c05f3
+  data.tar.gz: 0498a98e72099a68672d5dbfe29b558471f1a9fe04186d2297a96fdb760bfcf968ca8840f5162f468c4dbfb5bbb576e272d1ab2dae7bdede68a6cf9fe8518980

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bruno Michel <bruno.michel@af83.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,218 @@
+# Slideoff
+
+Slideoff is a presentation tool. You write some slides in markdown, choose
+a style and it displays it in HTML5. With a browser in full-screen, you can
+make amazing presentations!
+
+## Requirements
+
+* **Ruby 1.9.3** or higher
+* **Sass** for themes with sass files
+* **CoffeeScript** for themes with coffee files
+* **pygments** for syntax highlighting
+* **wget** for static site generation
+* **python3** for serving static presentation
+* **git** for installing themes and make your slides version controled
+* **scp** for uploading to remote host
+* **Browser** for viewing presentation
+
+
+## First presentation
+
+1. `gem install slideoff` Install Slideoff
+1. `slideoff init mypres` Initialize presentation in `mypres/`
+1. `$EDITOR presentation.json` and add your Flickr API key
+1. `$EDITOR main/index.md` Edit your slides
+1. `slideoff serve` Start server
+1. Open <http://localhost:9000/>
+1. Use the arrows keys to navigate between slides
+
+## Themes
+
+Several themes are available: `io2012`, `shower`, `3d_slideshow`, `reveal`,
+`html5rocks`, `CSSS`, `memories` and `modern`. To choose the theme for your
+presentation, edit the `presentation.json` file and change the `"theme"`
+element.
+
+You can also create your own theme, for example, by copying the template:
+
+```sh
+mkdir -p ~/.slideoff
+cp -r themes/template ~/.slideoff/my-theme
+$EDITOR ~/.slideoff/my-theme/README
+```
+
+
+## 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/
+
+Many more additional elements are added. See `main/index.md` after initialization to get an example.
+
+
+## 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
+    ```
+
+
+##Flickr integration
+
+To integrate this [Flickr photo (22565509)](https://secure.flickr.com/photos/scoobymoo/22565509) you have to write this:
+
+```
+!F[22565509]
+```
+
+Only the ID of the photo is relevant. All other information like image source, title, author or license are requested via the Flickr
+API. So it's important to generate a Flickr API key to have access to the API. You can do it on
+<https://secure.flickr.com/services/apps/create/>. You have to specify this key in your `presentation.json`.
+
+
+##Boxes
+
+```
+!SLIDE
+#Boxes
+
++++
++++Normal box
++++Content
+
++++shadow
++++Box with shadow
++++Content
+
++++box-alert
++++Alert box
++++Content
+```
+
+
+##Description list
+
+```
+!SLIDE
+#Description list
+
+Elephant
+  : big animal
+House
+  : big garage
+Car
+  : big bike with four wheels
+Smartphone
+  : smart mobile phone with touch display
+```
+
+
+##Change colors
+
+Highlighting text with red background:
+
+```
+==red==text==
+```
+
+Red text:
+
+```
+__red__text__
+```
+
+
+##Incremental view of slide
+
+If you like to display some information incrementally, you can do it! If you specify an additional slide class `incr-list`
+and all `li`-HTML-Elements will be displayed after some key strokes. For example:
+
+```
+!SLIDE incr-list
+
+* First item will be displayed after first key stroke
+* Second item will be displayed after second key stroke
+* Third item will be displayed after third key stroke
+```
+
+If you like to add some opacity to visited elements, you can add `incr-list hover` to `!SLIDE`.
+
+If you don't like to increment list items only, you can do it more precise. You only have to add `!PAUSE` in your slide. For example:
+
+```
+!SLIDE
+
+This paragraph will be displayed first.
+
+!PAUSE
+
++++box-red shadow
++++Box
++++This box is displayed after one next key stroke.
+```
+
+Try it in your example presentation after initialization.
+
+## Export to PDF
+
+Change to list mode with stroking `esc` key and use your normal printer dialog. You have to specify the correct margins and paper dimensions. I added a custom "PX 1024x640" and set width to 270mm and height to 169mm and all margins to 0.
+
+You can export your presentation to PDF by installing
+[phantomjs](http://phantomjs.org/) and then run `slideoff2pdf`.
+
+
+## Issues or Suggestions
+
+Found an issue or have a suggestion? Please report it on
+[Github's issue tracker](http://github.com/DSIW/slideoff/issues).
+
+If you wants to make a pull request, please check the specs before:
+
+    bundle exec spec/slideoff_spec.rb
+
+
+## Credits
+
+Bruno Michel is the guy who made [Slide'em up](https://github.com/nono/slide-em-up) and Scott Chacon is the guy who made
+[ShowOff](https://github.com/schacon/showoff).  Slideoff is based on Slide'em up and Showoff.
+
+Themes were picked from the internet. Thanks to:
+
+- Hakim El Hattab for 3d_slideshow and reveal
+- Google for html5rocks
+- Vadim Makeev for shower
+- Lea Verou for CSSS (and its modified version, memories)
+- Google for io2012
+
+♡2014 by DSIW. Copying is an act of love. Please copy and share.
+Released under the MIT license

data/bin/slideoff

@@ -0,0 +1,127 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'gli'
+
+require "slideoff"
+
+include GLI::App
+
+version "0.3.5" # Slideoff::VERSION
+
+
+desc 'Create new slideoff presentation'
+arg_name 'dir_name'
+long_desc 'This command helps start a new slideoff presentation by setting up the proper directory structure for you.  It takes the directory name you would like slideoff to create for you.'
+command [:init] do |c|
+
+  c.action do |global_options,options,args|
+    raise "dir_name is required" if args.empty?
+    Slideoff::Utils.init_directory(args[0])
+    puts "Done. Run 'slideoff serve' in #{args[0]}/ dir to see slideshow"
+  end
+end
+
+
+desc 'Install new slideoff theme'
+arg_name 'repository_url'
+long_desc 'Installs theme under ~/.slideoff.'
+command [:install_theme] do |c|
+  c.action do |global_options,options,args|
+    raise "repository_url is required" if args.empty?
+    Slideoff::Utils.install_theme(args[0])
+    puts "Done."
+  end
+end
+
+
+desc 'Puts your slideoff presentation into a gh-pages branch'
+long_desc 'Generates a static version of your presentation into your gh-pages branch for publishing to GitHub Pages'
+command :upload do |c|
+  c.desc 'Port on which to run'
+  c.default_value Slideoff::Server::DEFAULT_PORT
+  c.flag [:p,:port]
+
+  c.action do |global_options,options,args|
+    puts "Generating static content"
+    Slideoff::Utils.upload(options)
+    puts "Uploaded!"
+  end
+end
+
+
+desc 'Serves the slideoff presentation in the current directory'
+command :serve do |c|
+  c.desc 'Show verbose messaging'
+  c.switch :verbose
+
+  c.desc 'Port on which to run'
+  c.default_value Slideoff::Server::DEFAULT_PORT
+  c.flag [:p,:port]
+
+  c.desc 'Host or ip to run on'
+  c.default_value Slideoff::Server::DEFAULT_ADDRESS
+  c.flag [:h,:host]
+
+  c.desc 'API key for remote access'
+  c.flag [:remote_key]
+
+  c.action do |global_options,options,args|
+    server = Slideoff::Server.new(options)
+    puts "Your remote key is #{server.remote_key}\n\n"
+    server.start
+  end
+end
+
+
+desc 'Generate static version of presentation'
+long_desc 'Creates a static version of the presentation in "static" directory'
+command [:static] do |c|
+  c.desc 'Port on which to run'
+  c.default_value Slideoff::Server::DEFAULT_PORT
+  c.flag [:p,:port]
+
+  c.action do |global_options,options,args|
+    Slideoff::Utils.generate_static(options)
+  end
+end
+
+
+desc 'Serves static version of presentation'
+long_desc 'Serves static version of presentation'
+command [:serve_static] do |c|
+  c.desc 'Port on which to run'
+  c.default_value "4242"
+  c.flag [:p,:port]
+
+  c.action do |global_options,options,args|
+    if File.basename(Dir.pwd) =~ /^static/
+      Slideoff::Utils.serve_static(options[:port], verbose: true)
+    else
+      Dir.chdir(Slideoff::Utils.static_dir) do |dir|
+        Slideoff::Utils.serve_static(options[:port], verbose: true)
+      end
+    end
+  end
+end
+
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abourt and not call the
+  # chosen command
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+
+exit run(ARGV)

data/lib/slideoff/config_builder.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require "yajl"
+require "ostruct"
+
+module Slideoff
+  class ConfigBuilder < OpenStruct
+    DEFAULT = {
+      "title" => "No title",
+      "theme" => "shower",
+      "duration" => 60,
+      "author" => "Max Mustermann",
+      "pygments_style" => "colorful"
+    }
+    SECTION_DEFAULT = {
+      "show_chapter" => true,
+      "show_toc" => true
+    }
+
+    def initialize(_dir)
+      infos = extract_normal_infos(_dir) || extract_infos_from_showoff(_dir) || {}
+
+      unless infos.empty?
+        infos = DEFAULT.merge({dir: _dir}.merge(infos))
+        infos['sections'] = infos['sections'].reduce({}) do |new_hash, (k, hash)|
+          new_hash.merge!(k => SECTION_DEFAULT.merge(hash))
+        end
+        Dir.chdir(_dir) do
+          infos['css'] = Dir["**/*.css"]
+          infos['js']  = Dir["**/*.js"]
+        end
+        ENV["FLICKR_API_KEY"] = infos['flickr_api_key']
+      end
+
+      super(infos)
+    end
+
+    private
+
+    def extract_normal_infos(dir)
+      parse_file(dir, "presentation")
+    end
+
+    def extract_infos_from_showoff(dir)
+      infos = parse_file(dir, "showoff")
+      sections = infos["sections"].map {|s| s["section"] }
+      {
+        "title" => infos["name"],
+        "theme" => "showoff",
+        "sections" => sections
+      }
+    end
+
+    def parse_file(dir, file)
+      filename = "#{dir}/#{file}.json"
+      return {} unless File.exists?(filename)
+      Yajl::Parser.parse(File.read filename)
+    end
+  end
+end

data/lib/slideoff/flickr_api.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'net/http'
+require 'json'
+
+module Slideoff
+  class FlickrAPIException < Exception
+    def initialize(code, message)
+      @code = code
+      @message = message
+    end
+
+    def self.from_json(json)
+      new(json['code'], json['message'])
+    end
+
+    def to_s
+      "#{@message} [Code: #{@code}]"
+    end
+  end
+
+  class FlickrAPI
+    ENDPOINT = "https://api.flickr.com/services/rest/"
+
+    DEFAULT_PARAMS = {
+      :api_key => CONFIG.flickr_api_key,
+      :format => :json,
+      :nojsoncallback => 1
+    }
+
+    def initialize(params = {})
+      raise "Please specify your Flickr API key in presentation.json" unless CONFIG.flickr_api_key
+      @params = params
+    end
+
+    def uri
+      _uri = URI(ENDPOINT)
+      _uri.query = URI.encode_www_form(DEFAULT_PARAMS.merge(@params))
+      _uri
+    end
+
+    def json
+      @json ||= begin
+        _json = JSON.parse(Net::HTTP.get(uri))
+        raise FlickrAPIException.from_json(_json) unless _json['stat'] == 'ok'
+        _json
+      end
+    end
+  end
+end

data/lib/slideoff/flickr_image.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+module Slideoff
+  class FlickrImage
+    def initialize(id)
+      @id = id
+    end
+
+    def image_src
+      # Prefer m else lagest size
+      size = sizes.select { |size| %w[Large Original].include?(size["label"]) }.first || sizes.last
+      size["source"]
+    end
+
+    def sizes
+      @sizes ||= FlickrAPI.new(method: 'flickr.photos.getSizes', photo_id: @id).json["sizes"]["size"]
+    end
+
+    def author
+      realname = info["owner"]["realname"]
+      !realname.strip.empty? ? realname : info["owner"]["username"]
+    end
+
+    def title
+      info["title"]["_content"]
+    end
+
+    def license
+      license_id = info["license"]
+      license_id = license_id.to_i rescue 0
+      flickr_licenses[license_id]
+    end
+
+    def page
+      info["urls"]["url"].first["_content"]
+    end
+
+    private
+
+    # Source: https://secure.flickr.com/services/api/explore/flickr.photos.licenses.getInfo
+    def flickr_licenses
+      [
+        {
+          "name" => "All Rights Reserved",
+          "url" => ""
+        },
+        {
+          "name" => "Attribution-NonCommercial-ShareAlike License",
+          "url" => "http://creativecommons.org/licenses/by-nc-sa/2.0/",
+          "cc_attributes" => %w[by nc sa]
+        },
+        {
+          "name" => "Attribution-NonCommercial License",
+          "url" => "http://creativecommons.org/licenses/by-nc/2.0/",
+          "cc_attributes" => %w[by nc]
+        },
+        {
+          "name" => "Attribution-NonCommercial-NoDerivs License",
+          "url" => "http://creativecommons.org/licenses/by-nc-nd/2.0/",
+          "cc_attributes" => %w[by nc nd]
+        },
+        {
+          "name" => "Attribution License",
+          "url" => "http://creativecommons.org/licenses/by/2.0/",
+          "cc_attributes" => %w[by]
+        },
+        {
+          "name" => "Attribution-ShareAlike License",
+          "url" => "http://creativecommons.org/licenses/by-sa/2.0/",
+          "cc_attributes" => %w[by sa]
+        },
+        {
+          "name" => "Attribution-NoDerivs License",
+          "url" => "http://creativecommons.org/licenses/by-nd/2.0/",
+          "cc_attributes" => %w[by nd]
+        },
+        {
+          "name" => "No known copyright restrictions",
+          "url" => "http://www.flickr.com/commons/usage/"
+        },
+        {
+          "name" => "United States Government Work",
+          "url" => "http://www.usa.gov/copyright.shtml"
+        }
+      ]
+    end
+
+    def info
+      @info ||= FlickrAPI.new(method: 'flickr.photos.getInfo', photo_id: @id).json["photo"]
+    end
+  end
+end