yomu 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Erol Fornoles
+
+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/NOTICE.txt

@@ -0,0 +1,8 @@
+Textract
+Copyright 2011 Erol Fornoles, released under the MIT license
+
+Apache Tika
+Copyright 2011 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,73 @@
+# Yomu 読む
+[Yomu](http://github.com/Erol/yomu) is a library for extracting text and metadata using the [Apache TIKA](http://tika.apache.org/) content analysis toolkit.
+
+Here are some of the formats supported:
+
+- Microsoft Office OLE 2 and Office Open XML Formats (.doc, .docx, .xls, .xlsx,
+  .ppt, .pptx)
+- OpenOffice.org OpenDocument Formats (.odt, .ods, .odp)
+- Apple iWorks Formats
+- Rich Text Format (.rtf)
+- Portable Document Format (.pdf)
+
+For the complete list of supported formats, please visit the Apache Tika
+[Supported Document Formats](http://tika.apache.org/0.9/formats.html) page.
+
+## Installation and Dependencies
+
+Add this line to your application's Gemfile:
+
+    gem 'yomu'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yomu
+
+Yomu packages the Apache Tika application jar and thus requires a working JRE for it to work.
+
+## Usage
+
+If you're not using Bundler, you will need to require Yomu in your application:
+
+    require 'yomu'
+
+You can extract text by calling `Yomu.read` directly:
+
+    data = File.read 'sample.pages'
+    text = Yomu.read :text, data
+
+##### Filename
+
+You can also make a new instance of Yomu and pass a filename.
+
+    yomu = Yomu.new 'sample.pages'
+    text = yomu.text
+
+##### URL
+
+This is useful for reading remote files, like documents hosted on Amazon S3.
+
+    yomu = Yomu.new 'http://svn.apache.org/repos/asf/poi/trunk/test-data/document/sample.docx'
+    text = yomu.text
+
+##### Stream
+
+Yomu can also read from a stream or any object that responds to `read`, including Ruby on Rails' and Sinatra's file uploads:
+
+    post '/:name/:filename' do
+      yomu = Yomu.new params[:data]
+      yomu.text
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create tests and make them pass (`rake test`)
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = true
+end

data/lib/yomu.rb

@@ -0,0 +1,99 @@
+require "yomu/version"
+
+require 'net/http'
+require 'yaml'
+
+class Yomu
+  GEMPATH = File.dirname(File.dirname(__FILE__))
+  JARPATH = File.join(Yomu::GEMPATH, 'jar', 'tika-app-1.1.jar')
+
+  # Read text or metadata from a data buffer.
+  #
+  #   data = File.read 'sample.pages'
+  #   text = Yomu.read :text, data
+  #   metadata = Yomu.read :metadata, data
+
+  def self.read(type, data)
+    switch = case type
+    when :text
+      '-t'
+    when :metadata
+      '-m'
+    end
+
+    result = IO.popen "java -Djava.awt.headless=true -jar #{Yomu::JARPATH} #{switch}", 'r+' do |io|
+      io.write data
+      io.close_write
+      io.read
+    end
+
+    type == :metadata ? YAML.load(result) : result
+  end
+
+  # Create a new instance of Yomu.
+  #
+  # Using a file path:
+  #
+  #   Yomu.new 'sample.pages'
+  #
+  # Using a URL:
+  #
+  #   Yomu.new 'http://svn.apache.org/repos/asf/poi/trunk/test-data/document/sample.docx'
+  #
+  # Using a stream or object which responds to +read+
+  #
+  #   Yomu.new File.open('sample.pages')
+
+  def initialize(input)
+    if input.is_a? String
+      uri = URI.parse input
+      if uri.scheme and uri.host
+        @uri = uri
+      else
+        @path = input
+      end
+    elsif input.respond_to? :read
+      @stream = input
+    else
+      raise TypeError.new "can't read from #{input.class.name}"
+    end
+  end
+
+  # Returns the text contents of a Yomu object.
+  #
+  #   yomu = Yomu.new 'sample.pages'
+  #   yomu.text
+
+  def text
+    return @text if defined? @text
+
+    @text = Yomu.read :text, data
+  end
+
+  # Returns the metadata hash of a Yomu object.
+  #
+  #   yomu = Yomu.new 'sample.pages'
+  #   yomu.metadata['Content-Type']
+  
+  def metadata
+    return @metadata if defined? @metadata
+
+    @metadata = Yomu.read :metadata, data
+  end
+
+  protected
+
+  def data
+    return @data if defined? @data
+
+    if defined? @path
+      @data = File.read @path
+    elsif defined? @uri
+      @data = Net::HTTP.get @uri
+    elsif defined? @stream
+      @data = @stream.read
+    end
+
+    @data
+  end
+end

data/lib/yomu/version.rb

@@ -0,0 +1,3 @@
+class Yomu
+  VERSION = "0.1.0"
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+require 'minitest/autorun'

data/test/yomu_test.rb

@@ -0,0 +1,93 @@
+require_relative 'test_helper.rb'
+
+require 'yomu.rb'
+
+class YomuTest < MiniTest::Unit::TestCase
+  def test_yomu_can_read_text
+    data = File.read 'test/samples/sample.pages'
+    text = Yomu.read :text, data
+
+    assert_includes text, 'The quick brown fox jumped over the lazy cat.'
+  end
+
+  def test_yomu_can_read_metadata
+    data = File.read 'test/samples/sample.pages'
+    metadata = Yomu.read :metadata, data
+
+    assert_equal 'application/vnd.apple.pages', metadata['Content-Type']
+  end
+
+  def test_yomu_cannot_be_initialized_without_parameters
+    assert_raises ArgumentError do
+      Yomu.new
+    end
+  end
+
+  def test_yomu_can_be_initialized_with_a_path
+    assert_silent do
+      Yomu.new 'test/samples/sample.pages'
+    end
+  end
+
+  def test_yomu_can_be_initialized_with_a_url
+    assert_silent do
+      Yomu.new 'http://svn.apache.org/repos/asf/poi/trunk/test-data/document/sample.docx'
+    end
+  end
+
+  def test_yomu_can_be_initialized_with_a_stream_or_object_that_can_be_read
+    assert_silent do
+      File.open 'test/samples/sample.pages', 'r' do |file|
+        Yomu.new file
+      end
+    end
+  end
+
+  def test_yomu_cannot_be_initialized_with_other_objects
+    [nil, 1, 1.1].each do |object|
+      assert_raises TypeError do
+        Yomu.new object
+      end
+    end
+  end
+
+  def test_yomu_initialized_with_a_path_can_read_text
+    yomu = Yomu.new 'test/samples/sample.pages'
+
+    assert_includes yomu.text, 'The quick brown fox jumped over the lazy cat.'
+  end
+
+  def test_yomu_initialized_with_a_path_can_read_metadata
+    yomu = Yomu.new 'test/samples/sample.pages'
+
+    assert_equal 'application/vnd.apple.pages', yomu.metadata['Content-Type']
+  end
+
+  def test_yomu_initialized_with_a_url_can_read_text
+    yomu = Yomu.new 'http://svn.apache.org/repos/asf/poi/trunk/test-data/document/sample.docx'
+
+    assert_includes yomu.text, 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit.'
+  end
+
+  def test_yomu_initialized_with_a_url_can_read_metadata
+    yomu = Yomu.new 'http://svn.apache.org/repos/asf/poi/trunk/test-data/document/sample.docx'
+
+    assert_equal 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', yomu.metadata['Content-Type']
+  end
+
+  def test_yomu_initialized_with_a_stream_can_read_text
+    File.open 'test/samples/sample.pages', 'rb' do |file|
+      yomu = Yomu.new file
+
+      assert_includes yomu.text, 'The quick brown fox jumped over the lazy cat.'
+    end
+  end
+
+  def test_yomu_initialized_with_a_stream_can_read_metadata
+    File.open 'test/samples/sample.pages', 'rb' do |file|
+      yomu = Yomu.new file
+
+      assert_equal 'application/vnd.apple.pages', yomu.metadata['Content-Type']
+    end
+  end
+end

data/yomu.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yomu/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Erol Fornoles"]
+  gem.email         = ["erol.fornoles@gmail.com"]
+  gem.description   = %q{Yomu is a library for extracting text and metadata using the Apache TIKA content analysis toolkit.}
+  gem.summary       = %q{Yomu is a library for extracting text and metadata using the Apache TIKA content analysis toolkit.}
+  gem.homepage      = "http://github.com/Erol/yomu"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "yomu"
+  gem.require_paths = ["lib"]
+  gem.version       = Yomu::VERSION
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: yomu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Erol Fornoles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-25 00:00:00.000000000 Z
+dependencies: []
+description: Yomu is a library for extracting text and metadata using the Apache TIKA
+  content analysis toolkit.
+email:
+- erol.fornoles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- NOTICE.txt
+- README.md
+- Rakefile
+- jar/tika-app-1.1.jar
+- lib/yomu.rb
+- lib/yomu/version.rb
+- test/samples/sample.pages
+- test/test_helper.rb
+- test/yomu_test.rb
+- yomu.gemspec
+homepage: http://github.com/Erol/yomu
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Yomu is a library for extracting text and metadata using the Apache TIKA
+  content analysis toolkit.
+test_files:
+- test/samples/sample.pages
+- test/test_helper.rb
+- test/yomu_test.rb