antiwordr 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 kitplummer@gmail.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.textile

@@ -0,0 +1,22 @@
+h1. antiwordr
+
+Wrapper around the command line tool antiword which converts Word Document (97/2003) to text or Docbook.
+
+h1. requirements
+
+Just antiword, Ruby and a few gems (1.8.6+ as far as I know).
+
+h1. using
+
+<pre><code lang="ruby">require 'antiwordr'
+require 'nokogiri'
+file = DocFilePath.new([Path to Source PDF])
+string = file.convert()
+xml = file.convert_to_docbook()
+doc = file.convert_to_docbook_document()</code></pre>
+
+See included test cases for more usage examples.
+
+h1. license
+
+MIT (See included MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'antiwordr'
+
+PKG_NAME      = 'antiwordr'
+PKG_VERSION   = AntiWordR::VERSION
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc "Clean generated files"
+task :clean do
+  rm_rf 'pkg'
+  rm_rf 'rdoc'
+end
+
+desc 'Test the antiwordr gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the antiwordr gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'antiwordr'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+# Create compressed packages
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = PKG_NAME
+  s.summary = "Convert Word Docs to text."
+  s.description = %q{Uses command-line antiword tools to convert Docs to text.}
+  s.version = PKG_VERSION
+
+  s.author = "Kit Plummer"
+  s.email = "kitplummer@gmail.com"
+  s.rubyforge_project = PKG_NAME
+  s.homepage = "http://github.com/kitplummer/antiwordr"
+
+  s.has_rdoc = true
+  s.requirements << 'none'
+  s.require_path = 'lib'
+  s.autorequire = 'antiwordr'
+  s.add_dependency("nokogiri", ">= 1.3.3")
+  s.files = [ "Rakefile", "README.textile", "MIT-LICENSE" ]
+  s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+  s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) || item.include?("\.png") }
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = false
+  p.need_zip = true
+end

data/lib/antiwordr.rb

@@ -0,0 +1,96 @@
+# The library has a single method for converting PDF files into HTML. The
+# method current takes in the source path, and either/both the user and owner
+# passwords set on the source PDF document.  The convert method returns the
+# HTML as a string for further manipulation of loading into a Document.
+#
+# Requires that pdftohtml be installed and on the path
+#
+# Author:: Kit Plummer (mailto:kitplummer@gmail.com)
+# Copyright:: Copyright (c) 2010 Kit Plummer
+# License:: MIT
+
+require 'rubygems'
+require 'nokogiri'
+require 'uri'
+require 'open-uri'
+require 'tempfile'
+
+module AntiWordR
+  
+  # Simple local error abstraction
+  class AntiWordRError < RuntimeError; end
+  
+  VERSION = '0.1.0'
+
+  # Provides facilities for converting Word Docs to Text rom Ruby code.
+  class DocFile
+    attr :path
+    attr :target
+    attr :format
+    
+    def initialize(input_path, target_path=nil)
+      @path = input_path
+      @target = target_path
+    end
+
+    # Convert the PDF document to HTML.  Returns a string
+    def convert()
+      errors = ""
+      output = ""
+      
+      cmd = "antiword #{format}" + ' "' + @path + '"'
+      
+      output = `#{cmd} 2>&1`
+      
+      if (output.include?("command not found"))
+        raise AntiWordRError, "AntiWordR requires antiword to be installed"
+      elsif (output.include?("is not a Word Document"))
+        raise AntiWordRError, "Source document is not a Word Document"
+      elsif (output.include?("Error:"))
+        raise AntiWordRError, output.split("\n").first.to_s.chomp
+      else
+        return output
+      end
+    end
+    
+    # Convert the PDF document to HTML.  Returns a Nokogiri::HTML:Document
+    def convert_to_docbook_document() 
+      Nokogiri::XML.parse(convert_to_docbook())
+    end
+    
+    def convert_to_docbook()
+      @format = "-x db"
+      convert()
+    end
+  end
+  
+  # Handle a string-based local path as input, extends PdfFile
+  class DocFilePath < DocFile
+    def initialize(input_path, target_path=nil)
+      # check to make sure file is legit
+      if (!File.exist?(input_path))
+        raise AntiWordRError, "invalid file path"
+      end
+      
+      super(input_path, target_path)
+      
+    end 
+  end
+  
+  # Handle a URI as a remote path to a PDF, extends PdfFile
+  class DocFileUrl < DocFile
+    def initialize(input_url, target_path=nil)
+      # check to make sure file is legit
+      begin
+        if ((input_url =~ URI::regexp).nil?)
+          raise AntiWordRError, "invalid file url"
+        end
+        tempfile = Tempfile.new('antiwordr')
+        File.open(tempfile.path, 'wb') {|f| f.write(open(input_url).read) }
+        super(tempfile.path, target_path)
+      rescue => bang
+        raise AntiWordRError, bang.to_s
+      end
+    end
+  end
+end

data/test/antiwordr_test.rb

@@ -0,0 +1,86 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), '../lib/antiwordr')
+
+class DocFileTest < Test::Unit::TestCase
+  include AntiWordR
+
+  CURRENT_DIR = File.dirname(File.expand_path(__FILE__)) + "/"
+  TEST_DOC_PATH = CURRENT_DIR + "test.doc"
+  TEST_BAD_PATH = "blah.doc"
+  TEST_NON_DOC = CURRENT_DIR + "antiwordr_test.rb"
+  TEST_URL_DOC =
+   "http://github.com/kitplummer/antiwordr/raw/master/test/test.doc"
+  TEST_URL_NON_DOC =
+   "http://github.com/kitplummer/antiwordr/raw/master/test/antiwordr_test.rb"
+  
+  def test_docfile_new
+    file = DocFilePath.new(TEST_DOC_PATH, ".")
+    assert file
+  end
+  
+  def test_invalid_docfile
+    e = assert_raise AntiWordRError do 
+      file = DocFilePath.new(TEST_NON_DOC, ".")
+      file.convert
+    end
+    assert_equal "Source document is not a Word Document", e.to_s
+  end
+
+  def test_bad_docfile_new
+    e = assert_raise AntiWordRError do
+      file = DocFilePath.new(TEST_BAD_PATH, ".")
+    end
+    assert_equal "invalid file path", e.to_s
+  end
+
+  def test_string_from_docfile
+    file = DocFilePath.new(TEST_DOC_PATH, ".")
+    assert_equal "String", file.convert().class.to_s
+    assert_equal `antiword "#{TEST_DOC_PATH}"`, file.convert() 
+  end 
+
+  def test_return_docbook
+    file = DocFilePath.new(TEST_DOC_PATH, ".")
+    assert_equal "String", file.convert_to_docbook().class.to_s
+  end
+
+  def test_return_docbook_document
+    file = DocFilePath.new(TEST_DOC_PATH, ".")
+    assert_equal "Nokogiri::XML::Document",
+    file.convert_to_docbook_document().class.to_s
+    assert_equal Nokogiri::XML.parse(
+    `antiword -x db "#{TEST_DOC_PATH}"`
+    ).css('para').first.to_s,
+    file.convert_to_docbook_document().css('para').first.to_s
+  end
+
+  def test_invalid_URL_docfile
+    e = assert_raise AntiWordRError do
+      file = DocFileUrl.new("blah", ".")
+    end
+    assert_equal "invalid file url", e.to_s
+  end
+
+  def test_invalid_URL_resource_docfile
+    e = assert_raise AntiWordRError do
+      file = DocFileUrl.new("http://github.com/kitplummer/blah", ".")
+    end
+    assert_equal "404 Not Found", e.to_s
+  end
+
+  def test_invalid_URL_docfile
+    e = assert_raise AntiWordRError do
+      file = DocFileUrl.new(TEST_URL_NON_DOC, ".")
+      file.convert
+    end
+    assert_equal "Source document is not a Word Document", e.to_s
+  end
+
+  def test_valid_URL_docfile
+    # http://github.com/kitplummer/pdftohtmlr/raw/master/test/test.pdf
+    file = DocFileUrl.new(TEST_URL_DOC)
+    assert_equal "String", file.convert().class.to_s
+    assert_equal `antiword "#{TEST_DOC_PATH}"`, file.convert()
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: antiwordr
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kit Plummer
+autorequire: antiwordr
+bindir: bin
+cert_chain: []
+
+date: 2010-01-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.3
+    version: 
+description: Uses command-line antiword tools to convert Docs to text.
+email: kitplummer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.textile
+- MIT-LICENSE
+- lib/antiwordr.rb
+- test/antiwordr_test.rb
+- test/test.doc
+- test/test.docx
+has_rdoc: true
+homepage: http://github.com/kitplummer/antiwordr
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- none
+rubyforge_project: antiwordr
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Convert Word Docs to text.
+test_files: []
+