epub_validator 0.1.0

data/.autotest

@@ -0,0 +1,7 @@
+require "autotest/growl"
+
+Autotest.add_hook :initialize do |at|
+  at.add_mapping(%r%^spec/(epub_validator)/.*rb$%) {|filename, _|
+    filename
+  }
+end

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/README.md

@@ -0,0 +1,49 @@
+# epubValidator - Check your EPUB Books
+
+This library will check that your EPUB v2 files are valid IDPF documents (using epubcheck-1.2.jar) and return a successful or error message. It can be called as a Ruby library, or invoked from the command line.
+
+For more about the IDPF see http://idpf.org
+
+For more about the epubcheck tool see http://code.google.com/p/epubcheck/
+
+
+## Setup
+
+```
+gem install epub_validator
+```
+
+## Basic Usage
+
+Sample usage and output for a missing EPUB file:
+
+``` ruby
+require 'epub_validator'
+
+ev = EpubValidator.check_file('/path/to/missing.epub')
+ev.message.each do |m|
+  puts m
+end
+=> # FAILED!
+=> # ERROR: /path/to/missing.epub: I/O error: path/to/missing.epub (No such file or directory)
+```
+
+Now from the command line:
+
+``` terminal
+$ epub_validator /path/to/missing.epub
+Checking....
+FAILED!
+ERROR: /path/to/missing.epub: I/O error: /path/to/missing.epub (No such file or directory)
+```
+
+
+## Requirements
+
+Java must be installed and set in your PATH.
+
+## Future Features
+
+* Accept directory containing many .epub files for processing.
+* Write results to log file.
+* Format "error" output for more intuitive instructions.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+#require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+#Cucumber::RakeTask.new(:features)
+
+task :default => :spec

data/bin/epub_validator

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'epub_validator'
+#require 'epub_validator/command'
+
+# Thanks heroku!
+args = ARGV.dup
+ARGV.clear
+command = args.shift.strip rescue 'help'
+
+# need to implement Command class
+#EpubValidator::Command.run(command, args)
+
+puts "Checking...."
+ev = EpubValidator.check_file(command)
+puts ev.message
+

data/epub_validator.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'epub_validator/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+
+  s.name        = "epub_validator"
+  s.version     = EpubValidator::VERSION
+  s.summary     = %q{Run epubcheck.jar on single/multiple EPUB files.}
+  s.description = %q{EPUB Validator allows you to check your EPUB files for errors using the epubcheck Java file. You can check just one file at a time for now - eventually directories full of EPUB files and then output any errors to a log file.}
+
+  s.authors     = ["Mike Cook"]
+  s.email       = ["m@mikecook.co.uk"]
+  s.homepage    = "http://mikecook.co.uk"
+
+  s.required_ruby_version     = ">= 1.9.2"
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Examples
+  #s.add_dependency('posix-spawn', "~> 0.3.6")
+  #s.add_runtime_dependency "rest-client"
+
+  s.add_dependency "rspec"
+  s.add_dependency "ZenTest"
+  s.add_dependency "autotest-growl"
+end

data/lib/epub_validator.rb

@@ -0,0 +1,10 @@
+Dir["#{File.dirname(__FILE__)}/epub_validator/**/*"].each {|file| require(file)}
+
+require 'epub_validator/check_epub'
+
+module EpubValidator
+  def self.check_file(filename)
+    CheckEpub.new(filename)
+  end
+end
+

data/lib/epub_validator/check_epub.rb

@@ -0,0 +1,30 @@
+module EpubValidator
+  class CheckEpub
+    attr_accessor :message
+
+    def initialize(filename)
+      @filename = filename
+      @message = format_epubcheck_message(process_epub)
+    end
+
+    def process_epub
+      epubcheck_jar = File.expand_path(File.dirname(__FILE__) + '/../epubcheck-1-2/epubcheck-1.2.jar')
+      epubcheck = `java -jar #{epubcheck_jar} "#{@filename}" 2>&1`
+    end
+
+    def format_epubcheck_message(message)
+      return ['Passed.'] if message.match('No errors or warnings detected')
+
+      m_array = message.split(/\n/)
+
+      # clean up all useless info
+      m_array.delete_if do |s|
+        s.empty? or
+          s.match('^Epubcheck Version.*') or
+          s.match('^Check finished.*')
+      end
+
+      m_array.unshift('FAILED!')
+    end
+  end
+end

data/lib/epub_validator/version.rb

@@ -0,0 +1,3 @@
+module EpubValidator
+  VERSION = "0.1.0"
+end

data/lib/epubcheck-1-2/COPYING.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2007 Adobe Systems Incorporated
+
+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/lib/epubcheck-1-2/README.txt

@@ -0,0 +1,61 @@
+This folder contains the distribution of epubcheck project.
+
+EpubCheck is a tool to validate IDPF Epub files. It can detect many
+types of errors in Epub. OCF container structure, OPF and OPS mark-up,
+and internal reference consistency are checked. EpubCheck can be run
+as a standalone command-line tool, installed as a web application or
+used as a library.
+
+Epubcheck project home: http://code.google.com/p/epubcheck/
+
+BUILDING
+
+To build epubcheck from the sources you need Java Development Kit (JDK) 1.5 or above
+and Apache ant (http://ant.apache.org/) 1.6 or above installed
+
+Run
+
+ant -f build.xml
+
+RUNNING
+
+To run the tool you need Java Runtime (1.5 or above). Any OS should do. Run
+it from the command line: 
+
+java -jar epubcheck-x.x.x.jar file.epub
+
+All detected errors are simply printed to stderr. 
+
+USING AS A LIBRARY
+
+You can also use EpubCheck as a library in your Java application. EpubCheck
+public interfaces can be found in com.adobe.epubcheck.api package. EpubCheck
+class can be used to instantiate a validation engine. Use one of its
+constructors and then call validate() method. Report is an interface that
+you can implement to get a list of the errors and warnings reported by the
+validation engine (instead of the error list being printed out).
+
+LICENSING
+
+See COPYING.txt
+
+AUTHORS
+
+Peter Sorotokin 
+Garth Conboy 
+Markus Gylling 
+Piotr Kula
+
+Most of the EpubCheck functionality comes from the schema validation tool Jing
+and schemas that were developed by IDPF and DAISY. EpubCheck development was
+largely done at Adobe Systems. 
+
+
+
+
+
+
+
+
+
+

data/lib/epubcheck-1-2/jing_license.txt

@@ -0,0 +1,12 @@
+Jing Copying Conditions
+
+Copyright (c) 2001-2003 Thai Open Source Software Center Ltd
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of the Thai Open Source Software Center Ltd nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/spec/epub_validator/check_epub_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module EpubValidator
+  describe CheckEpub do
+    context "when it tries to process a missing file" do
+      it "should return missing file error message" do
+        failed_message = 'FAILED!\n\nNo .epub file to check was specified in arguments!\n\nThe tool will EXIT!'
+        ce = CheckEpub.new('test.epub')
+        CheckEpub.any_instance.stub(:process_epub).and_return(failed_message)
+        ce.process_epub.should eq(failed_message)
+      end
+    end
+    context "when it processes a valid file" do
+      it "should return 'Passed.' message as an array" do
+        success_message = "Epubcheck Version 1.2\n\nNo errors or warnings detected\n"
+        ce = CheckEpub.new('test.epub')
+        ce.format_epubcheck_message(success_message).should eq(['Passed.'])
+      end
+    end
+    context "when it processes an invalid file" do
+      it "should return error message as an array" do
+        failed_message = "Epubcheck Version 1.2\n\nERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing\n\nCheck finished with warnings or errors!"
+        formatted_failed_message = ["FAILED!", "ERROR: book.epub: resource OEBPS/stylesheets/handbookish.css is missing"]
+        ce = CheckEpub.new('test.epub')
+        ce.format_epubcheck_message(failed_message).should eq(formatted_failed_message)
+      end
+    end
+  end
+end

data/spec/epub_validator_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe EpubValidator do
+  context "when given a single EPUB filename" do
+    it "should validate the file"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'epub_validator'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: epub_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mike Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &11655920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11655920
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: &11654780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11654780
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  requirement: &11653840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11653840
+description: EPUB Validator allows you to check your EPUB files for errors using the
+  epubcheck Java file. You can check just one file at a time for now - eventually
+  directories full of EPUB files and then output any errors to a log file.
+email:
+- m@mikecook.co.uk
+executables:
+- epub_validator
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- bin/epub_validator
+- epub_validator.gemspec
+- lib/epub_validator.rb
+- lib/epub_validator/check_epub.rb
+- lib/epub_validator/version.rb
+- lib/epubcheck-1-2/COPYING.txt
+- lib/epubcheck-1-2/README.txt
+- lib/epubcheck-1-2/epubcheck-1.2.jar
+- lib/epubcheck-1-2/jing_license.txt
+- lib/epubcheck-1-2/lib/jing.jar
+- lib/epubcheck-1-2/lib/saxon.jar
+- spec/epub_validator/check_epub_spec.rb
+- spec/epub_validator_spec.rb
+- spec/spec_helper.rb
+homepage: http://mikecook.co.uk
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Run epubcheck.jar on single/multiple EPUB files.
+test_files: []