keynote-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50cfb8dc4b8875c72701235b4dd69b341e3f3403
+  data.tar.gz: 08ca6c611ea8ab9b898603579b145cb08d166cda
+SHA512:
+  metadata.gz: 7f97140e20d61d439b25a5d6cc55ac92c11675074bf747965b813e9e91b2c828ba7f3ede0473884a7bb6fcffdea710704cadbceaec74d6b003e86899ca43f44a
+  data.tar.gz: 21f615964d153831968f8edba649fbbaaa331c6c9a772e3088a721d899435e2618bec1a2f8a1567d04b7c564f040ad96188da4216f85c06272580d9ac5ab4a0f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ryo katsuma
+
+MIT License
+
+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,95 @@
+# keynote-client
+
+`keynote-client` will provide a high level API (like ActiveRecord style) to control your Keynote.
+
+Currently this project is in alpha stage. It supports these features.
+
+- Creating a new document with specified theme
+- Appending a new slide with specified master slide
+- Saving a document
+
+## Usage
+
+```ruby
+require 'keynote-client'
+inlude Keynote
+
+themes = Theme.find_by(:all)
+# => [#<Keynote::Theme:0x007fd9ec821748 @id="Application/Black/Standard", @name="ブラック">,
+# #<Keynote::Theme:0x007fd9ec821518 @id="Application/White/Standard", @name="ホワイト">,
+# #<Keynote::Theme:0x007fd9ec820fa0 @id="Application/Gradient/Standard", @name="グラデーション">,
+# #<Keynote::Theme:0x007fd9ec813e40 @id="Application/Parchment/Standard", @name="羊皮紙">,
+# ...
+# #<Keynote::Theme:0x007fd9ec813d78 @id="User/AC506922-367E-4300-AF77-8040B9CFA2B7", @name="cookpad">]
+
+theme = Theme.find_by(name: 'ブラック').first
+# #<Keynote::Theme:0x007fd9ec821748 @id="Application/Black/Standard", @name="ブラック">,
+
+doc = Document.new(theme: theme, file_path: '/path/to/foo.key')
+# => #<Keynote::Document:0x007fbe03224228
+# @auto_loop=false,
+# @auto_play=false,
+# @auto_restart=false,
+# @current_slide=nil,
+# @document_theme=#<Keynote::Theme:0x007fbe031f6e68 @id="Application/Black/Standard", @name="ブラック">,
+# @height=768,
+# @maximum_idle_duration=15,
+# @name="名称未設定",
+# @slide_numbers_showing=false,
+# @slides=[],
+# @width=1024>
+
+doc.save
+# => true
+
+doc.slides
+# => [#<Keynote::Slide:0x007fa17c2bcb98
+#  @base_slide=#<Keynote::MasterSlide:0x007fa17c2bcbe8 @name="タイトル & サブタイトル">,
+#  @body_showing=true,
+#  @default_body_item=nil,
+#  @default_title_item=nil,
+#  @presenter_notes="",
+#  @skipped=false,
+#  @slide_number=1,
+#  @title_showing=true,
+#  @transition_properties={"transitionDelay"=>0.5, "automaticTransition"=>false, "transitionEffect"=>"no transition effect", "transitionDuration"=>1}>]
+
+doc.append_slide("空白")
+# => [#<Keynote::Slide:0x007fa17c2bcb98
+#   @base_slide=#<Keynote::MasterSlide:0x007fa17c2bcbe8 @name="タイトル & サブタイトル">,
+#   @body_showing=true,
+#   @default_body_item=nil,
+#   @default_title_item=nil,
+#   @presenter_notes="",
+#   @skipped=false,
+#   @slide_number=1,
+#   @title_showing=true,
+#   @transition_properties={"transitionDelay"=>0.5, "automaticTransition"=>false, "transitionEffect"=>"no transition effect", "transitionDuration"=>1}>,
+#  #<Keynote::Slide:0x007fa17a8bbc08
+#   @base_slide=#<Keynote::MasterSlide:0x007fa17a8bbc58 @name="空白">,
+#   @body_showing=false,
+#   @default_body_item=nil,
+#   @default_title_item=nil,
+#   @presenter_notes="",
+#   @skipped=false,
+#   @slide_number=2,
+#   @title_showing=false,
+#   @transition_properties={"transitionDelay"=>0.5, "automaticTransition"=>false, "transitionEffect"=>"no transition effect", "transitionDuration"=>1}>]
+```
+
+
+## Supported OS
+- OSX Mavericks
+
+
+## License
+`keynote-client` is released under the MIT License.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/katsuma/keynote-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/keynote-client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keynote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keynote-client"
+  spec.version       = Keynote::Client::VERSION
+  spec.authors       = ["ryo katsuma"]
+  spec.email         = ["katsuma@gmail.com"]
+  spec.summary       = %q{keynote client with high level API.}
+  spec.description   = %q{keynote-client provides a high level API like ActiveRecord style to control your Keynote.}
+  spec.homepage      = "https://github.com/katsuma/keynote-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "unindent", "~> 1.0"
+  spec.add_development_dependency "pry"
+end

data/lib/keynote-client.rb

@@ -0,0 +1,8 @@
+require "keynote/version"
+require "keynote/theme"
+require "keynote/document"
+require "keynote/master_slide"
+require "keynote/slide"
+
+module Keynote
+end

data/lib/keynote/document.rb

@@ -0,0 +1,195 @@
+require 'unindent'
+require 'keynote/theme'
+require 'keynote/util'
+
+module Keynote
+  class Document
+    extend Keynote::Util
+    include Keynote::Util
+
+    attr_accessor(
+      :name,
+      :slides,
+      :master_slides,
+      :slide_numbers_showing,
+      :document_theme,
+      :auto_loop,
+      :auto_play,
+      :auto_restart,
+      :maximum_idle_duration,
+      :current_slide,
+      :height,
+      :width,
+      :file_path,
+    )
+
+    attr_reader :id
+
+    DEFAULT_WIDTH = 1024
+    DEFAULT_HEIGHT = 768
+    WIDE_WIDTH = 1900
+    WIDE_HEIGHT = 1080
+
+    def initialize(arguments = {})
+      @document_theme = arguments[:theme] || Theme.default
+      @width = arguments.has_key?(:wide) && arguments[:wide] ? WIDE_WIDTH : DEFAULT_WIDTH
+      @height = arguments.has_key?(:wide) && arguments[:wide] ? WIDE_HEIGHT : DEFAULT_HEIGHT
+      @file_path = arguments[:file_path]
+
+      result = Document.create(theme: @document_theme, width: @width, height: @height)
+      @id = result["id"]
+      @maximum_idle_duration = result["maximumIdleDuration"]
+      @current_slide = result["currentSlide"]
+      @slide_numbers_showing = result["slideNumbersShowing"]
+      @auto_loop = result["autoLoop"]
+      @auto_play = result["autoPlay"]
+      @auto_restart = result["autoRestart"]
+      @maximum_idle_duration = result["maximumIdleDuration"]
+      @name = result["name"]
+    end
+
+    def master_slides
+      results = eval_script <<-APPLE.unindent
+        var Keynote = Application("Keynote")
+        var doc = Keynote.documents.byId("#{id}")
+        var masterSlides = doc.masterSlides()
+        var results = []
+        for(var i=0; i<masterSlides.length; i++) {
+          results.push({ name: masterSlides[i].name()})
+        }
+        JSON.stringify(results);
+      APPLE
+
+      return [] unless results
+      results.map do |result|
+        MasterSlide.new(result["name"])
+      end
+    end
+
+    def slides
+      results = eval_script <<-APPLE.unindent
+        var Keynote = Application("Keynote")
+        var doc = Keynote.documents.byId("#{id}")
+        var slides = doc.slides()
+        var results = []
+        for(var i=0; i<slides.length; i++) {
+          var slide = slides[i]
+          results.push({
+            base_slide: slide.baseSlide().name(),
+            body_showing: slide.bodyShowing(),
+            skipped: slide.skipped(),
+            slide_number: slide.slideNumber(),
+            title_showing: slide.titleShowing(),
+            default_body_item: slide.defaultBodyItem(),
+            default_title_item: slide.defaultTitleItem(),
+            presenter_notes: slide.presenterNotes(),
+            transition_properties: slide.transitionProperties()
+          })
+        }
+        JSON.stringify(results);
+      APPLE
+
+      @slides = results.map do |result|
+        Slide.new(
+          base_slide: MasterSlide.new(result["base_slide"]),
+          body_showing: result["body_showing"],
+          skipped: result["skipped"],
+          slide_number: result["slide_number"],
+          title_showing: result["title_showing"],
+          default_body_item: result["default_body_item"],
+          default_title_item: result["default_title_item"],
+          presenter_notes: result["presenter_notes"],
+          transition_properties: result["transition_properties"],
+        )
+      end
+    end
+
+    # arguments is not implemented
+    # It will support title, body, ... or so on.
+    def append_slide(master_slide_name, arguments = {})
+      raise ArgumentError.new "nil master_slide_name is given" unless master_slide_name
+
+      result = eval_script <<-APPLE.unindent
+        var Keynote = Application("Keynote")
+        var doc = Keynote.documents.byId("#{self.id}")
+        var masterSlide = doc.masterSlides.whose({name: "#{master_slide_name}"}).first
+        var slide = Keynote.Slide({ baseSlide: masterSlide })
+        doc.slides.push(slide)
+        slide = doc.slides()[doc.slides().length - 1]
+
+        var slideResult = {
+          body_showing: slide.bodyShowing(),
+          skipped: slide.skipped(),
+          slide_number: slide.slideNumber(),
+          title_showing: slide.titleShowing(),
+          default_body_item: slide.defaultBodyItem(),
+          default_title_item: slide.defaultTitleItem(),
+          presenter_notes: slide.presenterNotes(),
+          transition_properties: slide.transitionProperties()
+        }
+        JSON.stringify(slideResult)
+      APPLE
+
+      slide = Slide.new(
+        base_slide: MasterSlide.new(master_slide_name),
+        body_showing: result["body_showing"],
+        skipped: result["skipped"],
+        slide_number: result["slide_number"],
+        title_showing: result["title_showing"],
+        default_body_item: result["default_body_item"],
+        default_title_item: result["default_title_item"],
+        presenter_notes: result["presenter_notes"],
+        transition_properties: result["transition_properties"],
+      )
+      @slides << slide
+    end
+
+    def save
+      return false unless @id
+      return false unless @file_path
+      eval_script <<-APPLE.unindent
+        var Keynote = Application("Keynote")
+        var doc = Keynote.documents.byId("#{@id}")
+        var path = Path("#{@file_path}")
+        doc.save({ in: path })
+      APPLE
+      true
+    rescue => e
+      false
+    end
+
+    class DocumentInvalid < RuntimeError; end
+
+    def save!
+      raise DocumentInvalid unless save
+    end
+
+    def export
+      # TBD
+    end
+
+    def self.create(arguments = {})
+      theme = arguments[:theme] || Theme.default
+      width = arguments[:width]
+      height = arguments[:height]
+
+      eval_script <<-APPLE.unindent
+        var Keynote = Application("Keynote")
+        var theme = Keynote.themes.whose({ id: "#{theme.id}" }).first
+        Keynote.documents.push(Keynote.Document({ documentTheme: theme, width: #{width}, height: #{height} }));
+        var doc = Keynote.documents()[Keynote.documents().length - 1];
+        JSON.stringify({
+          id: doc.id(),
+          height: doc.height(),
+          autoRestart: doc.autoRestart(),
+          maximumIdleDuration: doc.maximumIdleDuration(),
+          width: doc.width(),
+          slideNumbersShowing: doc.slideNumbersShowing(),
+          autoPlay: doc.autoPlay(),
+          autoLoop: doc.autoLoop(),
+          name: doc.name()
+        });
+      APPLE
+    end
+  end
+end

data/lib/keynote/master_slide.rb

@@ -0,0 +1,26 @@
+module Keynote
+  class MasterSlide
+    attr_reader :name
+
+    def default_names
+      {
+        title_and_sub_title: "タイトル & サブタイトル", # Title & Subtitle
+        photo_horizontal: "画像（横長）", # Photo - Horizontal
+        title_center: "タイトル（中央）", # Title - Center
+        photo_vertical: "画像（縦長）", # Photo - Vertical
+        title_top: "タイトル（上）", # Title - Top
+        title_and_bullets: "タイトル & 箇条書き", # Title & Bullets
+        title_bullets_and_photo: "タイトル、箇条書き、画像", # Title, Bullets & Photo
+        bullets: "箇条書き", # Bullets
+        quote: "引用", # Quote
+        photo: "画像", # Photo
+        blank: "空白", # Blank
+      }
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+  end
+end

data/lib/keynote/slide.rb

@@ -0,0 +1,28 @@
+require 'unindent'
+require 'keynote/util'
+
+module Keynote
+  class Slide
+    extend Keynote::Util
+    include Keynote::Util
+
+    attr_accessor(
+      :id,
+      :base_slide,
+      :body_showing,
+      :skipped,
+      :slide_number,
+      :title_showing,
+      :default_body_item,
+      :default_title_item,
+      :presenter_notes,
+      :transition_properties,
+    )
+
+    def initialize(arguments = {})
+      arguments.each do |attr, val|
+        send("#{attr}=", val)
+      end
+    end
+  end
+end

data/lib/keynote/theme.rb

@@ -0,0 +1,47 @@
+require 'unindent'
+require 'keynote/util'
+
+module Keynote
+  class Theme
+    extend Keynote::Util
+
+    attr_reader :id, :name
+
+    def initialize(id: nil, name: nil)
+      @id = id
+      @name = name
+    end
+
+    def self.default
+      self.find_by(:all).first
+    end
+
+    def self.find_by(args)
+      raise ArgumentError.new('nil argument is given') unless args
+
+      if args.is_a?(Hash) && args.has_key?(:name)
+        conditions = ".whose({ name: '#{args[:name]}' })"
+      elsif args == :all
+        conditions = ''
+      else
+        raise ArgumentError.new('Unsupported argument is given')
+      end
+
+      results = eval_script <<-APPLE.unindent
+        var themes = Application("Keynote").themes#{conditions};
+        var results = [];
+        for(var i = 0, len = themes.length; i < len; i++) {
+          var theme = themes[i];
+          results.push({ id: theme.id(), name: theme.name() });
+        }
+        JSON.stringify(results);
+      APPLE
+
+      return [] unless results
+
+      results.map do |result|
+        self.new(id: result["id"], name: result["name"])
+      end
+    end
+  end
+end

data/lib/keynote/util.rb

@@ -0,0 +1,20 @@
+require 'open3'
+require 'json'
+require "tempfile"
+
+module Keynote
+  module Util
+    def eval_script(script)
+      file = Tempfile.new(['osascript', '.js'])
+      file.write(script)
+      file.close
+      command = "osascript -l JavaScript #{file.path}"
+      execute_out, process_status = *Open3.capture2(command)
+      execute_out.chomp!
+      JSON.parse(execute_out) unless execute_out.empty?
+    ensure
+      file.delete
+    end
+
+  end
+end

data/lib/keynote/version.rb

@@ -0,0 +1,5 @@
+module Keynote
+  module Client
+    VERSION = "0.0.1"
+  end
+end

data/spec/keynote/client_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Keynote::Client do
+  it 'has a version number' do
+    expect(Keynote::Client::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'keynote/client'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: keynote-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ryo katsuma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unindent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: keynote-client provides a high level API like ActiveRecord style to control
+  your Keynote.
+email:
+- katsuma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- keynote-client.gemspec
+- lib/keynote-client.rb
+- lib/keynote/document.rb
+- lib/keynote/master_slide.rb
+- lib/keynote/slide.rb
+- lib/keynote/theme.rb
+- lib/keynote/util.rb
+- lib/keynote/version.rb
+- spec/keynote/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/katsuma/keynote-client
+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.4.5
+signing_key: 
+specification_version: 4
+summary: keynote client with high level API.
+test_files:
+- spec/keynote/client_spec.rb
+- spec/spec_helper.rb