rapinoe 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7b0b8295ed07411999367b9d49c5f04afbfc62e
+  data.tar.gz: 2086de2bda02ddd0adca922539ba33a51e49c3ea
+SHA512:
+  metadata.gz: 5a8b0fad50b816d783c76a50176e6bd9668d12511d49983065d130e8ea475fa8c5a638cab90c7dbf671120c596ba219e3ea08ab130947ca84d879dc6395e3433
+  data.tar.gz: e37ae7a82f002d55a31831cb2ebb9a4169c8f78c915894d84a1f7c1fdbd627605ac68bbc82a796221d01f1c488108aa2c61edc004f2b9f1f2b393357bda7bc30

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    rapinoe (0.0.1)
+      rubyzip (~> 1.1.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rubyzip (1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rapinoe!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Zach Holman, http://zachholman.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,29 @@
+![megan rapinoe](https://cloud.githubusercontent.com/assets/2723/12370366/16ac568a-bbc3-11e5-951d-f9367476eae2.jpg)
+
+# Rapinoe
+
+Rapinoe helps you parse Apple Keynote files.
+
+Primarily it's designed to help you access the simple metadata of a Keynote file: return how many slides there are, extract the slide previews baked into the file, tell you various details about the file itself on disk, and so on.
+
+## Install
+
+```sh
+gem install rapinoe
+```
+
+## Usage
+
+```ruby
+rapinoe = Rapinoe.new('talks/Literal Best Player Ever.key')
+# => <Rapinoe::Keynote: @name="Literal Best Player Ever", @path="talks/Literal Best Player Ever.key", @data=[…]>
+
+rapinoe.write_preview_to_file("my_dope_talk.jpg")
+# => Writes the higher quality 1024px-width preview of your entire deck to a file
+
+rapinoe.slides
+# => [<Rapinoe::Slide>, <Rapinoe::Slide>, <Rapinoe::Slide>, <Rapinoe::Slide>]
+
+rapinoe.slides.first.write_preview_to_file("/tmp/slide-preview.jpg")
+# => writes the Keynote-generated slide preview to a file
+```

data/Rakefile

@@ -0,0 +1,134 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test' << '.'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/lib/rapinoe/keynote.rb

@@ -0,0 +1,70 @@
+module Rapinoe
+  class Keynote
+    # The path where we can find the .key file.
+    attr_accessor :path
+
+    # The name of the file.
+    attr_accessor :name
+
+    # The (first stage) of uncompressed Keynote data in memory.
+    attr_accessor :data
+
+    # Create a new Keynote instance.
+    #
+    #   path - The path to the .key file on disk.
+    #
+    # Returns a Keynote.
+    def initialize(path)
+      @path = path
+      @name = File.basename(path, ".key")
+      extract_key_file
+    end
+
+    # Returns the file size of the Keynote file in bytes.
+    def size
+      File.size(path)
+    end
+
+    def slides
+      @data.glob("Data/st*").map do |preview_jpg_data|
+        Slide.new(preview_jpg_data.get_input_stream.read)
+      end
+    end
+
+    # The binary data associated with the .jpg Keynote writes to make a
+    # high(ish) quality preview version of the deck. You likely will want to
+    # access this via #write_preview_to_file, unless you have specific needs for
+    # the binary data.
+    #
+    # Returns the contents of preview.jpg.
+    def preview_data
+      @data.find_entry("preview.jpg").get_input_stream.read
+    end
+
+    # Writes Keynote's preview.jpg to disk somewhere.
+    #
+    #   path - The path to the new file you want to write.
+    #
+    # Returns nothing.
+    def write_preview_to_file(path)
+      File.open(path, 'wb') do |out|
+        out.write(preview_data)
+      end
+    end
+
+    def inspect
+      "<Rapinoe::Keynote: @name=\"#{@name}\", @path=\"#{@path}\", @data=[…]>"
+    end
+
+  private
+
+    # .key files basically just try to masquerade as .zip files. Once we extract
+    # the main directory structure (in memory), we can start looking into what's
+    # inside.
+    #
+    # Returns a complex data structure that maps to Zip::File.
+    def extract_key_file
+      @data = Zip::File.open(path)
+    end
+  end
+end

data/lib/rapinoe/slide.rb

@@ -0,0 +1,45 @@
+module Rapinoe
+  # `Slide` is a really vague approximation. Keynote stores its data in a
+  # zip-compressed file that has a bunch of .iwa files in it, which is where it
+  # stores its data. Each of those .iwa files is a file that's been compressed
+  # with a non-standard version of Google's Snappy compression format, and in
+  # turn the resulting data is stored in Google's Protobuf interchange format.
+  #
+  # I think we could probably get pretty deep into this, but I couldn't get the
+  # Ruby Snappy bindings to decompress the .iwa data (presumably due to the
+  # lacking Stream Identifier chunk). Might be something we look into later and
+  # see how many details we can glean from the full dataset.
+  #
+  # For more information, see @obriensp's excellent docs:
+  #   https://github.com/obriensp/iWorkFileFormat/blob/master/Docs/index.md
+  #
+  # For now, we're going to instead look at the generated jpeg previews inside
+  # the `Data/` subdirectory. It's a nasty approximation, but it should map
+  # fairly well to the actual number of slides in the file.
+  class Slide
+    # The binary data representing the jpeg representation of this slide.
+    attr_accessor :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    # The contents of the preview jpeg, loaded into memory.
+    #
+    # Returns a string of the jpeg's binary data.
+    def preview_data
+      @data
+    end
+
+    # Writes the preview for this slide to disk.
+    def write_preview_to_file(path)
+      File.open(path, 'wb') do |out|
+        out.write(preview_data)
+      end
+    end
+
+    def inspect
+      "<Rapinoe::Slide>"
+    end
+  end
+end

data/lib/rapinoe.rb

@@ -0,0 +1,12 @@
+require 'zip'
+
+require_relative 'rapinoe/keynote'
+require_relative 'rapinoe/slide'
+
+module Rapinoe
+  VERSION = '0.0.1'
+
+  def self.new(path)
+    Keynote.new(path)
+  end
+end

data/rapinoe.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name        = 'rapinoe'
+  s.version     = '0.0.1'
+  s.licenses    = ['MIT']
+  s.summary     = "Parse Keynote files in Ruby."
+  s.description = "Rapinoe is designed to parse the native files for Apple's Keynote presentation software. Its main focus is to help extract previews and general metadata about the presentation."
+  s.authors     = ["Zach Holman"]
+  s.email       = 'zach@zachholman.com'
+  s.files       = ["lib/rapinoe.rb"]
+  s.homepage    = 'https://github.com/holman/rapinoe'
+  s.require_paths = %w[lib]
+  s.add_runtime_dependency 'rubyzip', '~> 1.1', '>= 1.1.7'
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Gemfile.lock
+    LICENSE.md
+    README.md
+    Rakefile
+    lib/rapinoe.rb
+    lib/rapinoe/keynote.rb
+    lib/rapinoe/slide.rb
+    rapinoe.gemspec
+    test/fixtures/ice-cream.key
+    test/test_keynote.rb
+    test/test_rapinoe.rb
+    test/test_slide.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/test/test_keynote.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+require 'lib/rapinoe'
+include Rapinoe
+
+class TestKeynote < Test::Unit::TestCase
+  def setup
+    @keynote = Keynote.new('test/fixtures/ice-cream.key')
+  end
+
+  def test_path
+    assert_equal 'test/fixtures/ice-cream.key', @keynote.path
+  end
+
+  def test_name
+    assert_equal "ice-cream", @keynote.name
+  end
+
+  def test_size
+    assert_equal 327378, @keynote.size
+  end
+
+  def test_slides
+    assert_kind_of Rapinoe::Slide, @keynote.slides.first
+  end
+
+  def test_data
+    assert_not_nil @keynote.data
+  end
+
+  def test_preview_data
+    assert_equal 32858, @keynote.preview_data.size
+  end
+
+  def test_write_preview_to_file
+    tempfile = "/tmp/rapinoe-test.jpg"
+
+    refute File.exist?(tempfile)
+    @keynote.write_preview_to_file(tempfile)
+
+    assert File.exist?(tempfile)
+    assert_operator File.size(tempfile), :>, 32858
+  ensure
+    File.delete tempfile
+  end
+end

data/test/test_rapinoe.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require 'lib/rapinoe'
+
+class TestRapinoe < Test::Unit::TestCase
+  def setup
+    @keynote = Rapinoe.new('test/fixtures/ice-cream.key')
+  end
+
+  def test_quick_initializes
+    assert_kind_of Rapinoe::Keynote, @keynote
+  end
+end

data/test/test_slide.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+require 'lib/rapinoe'
+include Rapinoe
+
+class TestSlide < Test::Unit::TestCase
+  def setup
+    @keynote = Keynote.new('test/fixtures/ice-cream.key')
+    @slide   = @keynote.slides.first
+  end
+
+  def test_preview_data
+    assert_equal 1484, @slide.preview_data.size
+  end
+
+  def test_write_preview_to_file
+    tempfile = "/tmp/rapinoe-slide-preview.jpg"
+
+    refute File.exist?(tempfile)
+    @slide.write_preview_to_file(tempfile)
+
+    assert File.exist?(tempfile)
+    assert_operator File.size(tempfile), :>, 1484
+  ensure
+    File.delete tempfile
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rapinoe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zach Holman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+description: Rapinoe is designed to parse the native files for Apple's Keynote presentation
+  software. Its main focus is to help extract previews and general metadata about
+  the presentation.
+email: zach@zachholman.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/rapinoe.rb
+- lib/rapinoe/keynote.rb
+- lib/rapinoe/slide.rb
+- rapinoe.gemspec
+- test/fixtures/ice-cream.key
+- test/test_keynote.rb
+- test/test_rapinoe.rb
+- test/test_slide.rb
+homepage: https://github.com/holman/rapinoe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Parse Keynote files in Ruby.
+test_files:
+- test/test_keynote.rb
+- test/test_rapinoe.rb
+- test/test_slide.rb