tika-app 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7e13e3b027b7dfdb22b89fd6c07a8b021c3210e
+  data.tar.gz: 2e1021d068af535cef610eb244540a4c4f671052
+SHA512:
+  metadata.gz: 1f8ff1d0edac49772f8ecd1f8577458824014a6dfd359b96c0680f600addb1039ae1c90dd2d4605653698715bb45427abd5e89f5d9102e05844804727356ecc4
+  data.tar.gz: 74dedc5a7debfb4100a9db85dc1a095c0da329e01659b0a8526770ec95c52cddc62fa5d229d1a2e3a7849ac3e5e07f2f8d11f7093e62a3970fca4b75aa91c23b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) Duke University.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimer.
+
+    2. 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.
+
+    3. Neither the name of Duke University 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 COPYRIGHT HOLDER 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/README.md

@@ -0,0 +1,31 @@
+# Tika::App
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tika-app'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tika-app
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tika-app/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"
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/tika/app.rb

@@ -0,0 +1,89 @@
+require_relative "error"
+require_relative "commands"
+require_relative "resource"
+
+module Tika
+  class App
+
+    class << self
+      attr_accessor :path
+    end
+
+    include Commands
+
+    DEFAULT_PATH = File.expand_path("../../../bin/tika-app.jar", __FILE__)
+
+    attr_reader :path
+    attr_accessor :result
+
+    def initialize(opts={})
+      @path = opts[:path] || self.class.path || ENV["TIKA_APP"] || DEFAULT_PATH      
+    end
+
+    def get_text(file, opts={})
+      execute GetTextCommand, file, opts
+    end
+
+    def get_metadata(file, opts={})
+      execute GetMetadataCommand, file, opts
+    end
+
+    def get_version
+      execute GetVersionCommand
+    end
+
+    def get_mime_types
+      execute GetMimeTypesCommand
+    end
+    alias_method :list_supported_types, :get_mime_types
+
+    def get_parsers
+      execute GetParsersCommand
+    end
+    alias_method :list_parsers, :get_parsers
+
+    def get_parsers_details
+      execute GetParsersDetailsCommand
+    end
+    alias_method :list_parser_details, :get_parsers_details
+
+    def get_detectors
+      execute GetDetectorsCommand
+    end
+    alias_method :list_detectors, :get_detectors
+
+    def detect(file, opts={})
+      execute DetectCommand, file, opts
+    end
+
+    def get_language(file, opts={})
+      execute GetLanguageCommand, file, opts
+    end
+
+    def get_metadata_models
+      execute GetMetadataModelsCommand
+    end
+    alias_method :list_met_models, :get_metadata_models
+
+    def command_line
+      ["java", "-jar", path].freeze
+    end
+
+    private
+
+    def reset
+      @result = nil
+    end
+
+    def execute(command, *args)
+      reset
+      @result = command.execute(self, *args)
+      if result.success?
+        result.render
+      else
+        raise Error, result.error
+      end
+    end
+
+  end
+end

data/lib/tika/command.rb

@@ -0,0 +1,45 @@
+require "open3"
+require "tempfile"
+require_relative "result"
+
+module Tika
+  class Command
+
+    class << self
+      attr_accessor :options, :result_class
+
+      def execute(app, *args)
+        new(app, *args).execute
+      end
+    end
+
+    attr_reader :app, :file, :options
+
+    def initialize(app, *args)
+      @app = app
+      @file = args.shift
+      @options = args.pop || {}
+    end
+
+    def result_class
+      self.class.result_class
+    end
+
+    def command_line
+      cmd = app.command_line + self.class.options
+      if options[:password]
+        cmd << "-p#{options[:password]}"
+      end
+      if file
+        cmd << file
+      end
+      cmd
+    end
+
+    def execute
+      raw_result = Open3.capture3(*command_line)
+      result_class.new(*raw_result)
+    end
+
+  end
+end

data/lib/tika/commands.rb

@@ -0,0 +1,57 @@
+require_relative "command"
+
+module Tika
+  module Commands
+
+    class GetTextCommand < Command
+      self.options = ["-t", "-eUTF8"]
+      self.result_class = TextResult
+    end
+
+    class GetMetadataCommand < Command
+      self.options = ["-j"]
+      self.result_class = JSONResult
+    end
+
+    class GetVersionCommand < Command
+      self.options = ["-V"]
+      self.result_class = TextResult
+    end
+
+    class GetMimeTypesCommand < Command
+      self.options = ["--list-supported-types"]
+      self.result_class = TextResult
+    end
+
+    class GetParsersCommand < Command
+      self.options = ["--list-parsers"]
+      self.result_class = TextResult
+    end
+
+    class GetParsersDetailsCommand < Command
+      self.options = ["--list-parser-details"]
+      self.result_class = TextResult
+    end
+
+    class GetDetectorsCommand < Command
+      self.options = ["--list-detectors"]
+      self.result_class = TextResult
+    end
+
+    class DetectCommand < Command
+      self.options = ["-d"]
+      self.result_class = TextResult
+    end
+
+    class GetMetadataModelsCommand < Command
+      self.options = ["--list-met-models"]
+      self.result_class = TextResult
+    end
+
+    class GetLanguageCommand < Command
+      self.options = ["-l"]
+      self.result_class = TextResult
+    end
+
+  end
+end

data/lib/tika/error.rb

@@ -0,0 +1,3 @@
+module Tika
+  class Error < StandardError; end
+end

data/lib/tika/resource.rb

@@ -0,0 +1,31 @@
+require_relative "app"
+
+module Tika
+  class Resource
+
+    attr_reader :file, :app, :opts
+    
+    def initialize(file, opts={})
+      @file = file
+      @app = App.new
+      @opts = opts
+    end
+
+    def text
+      @text ||= app.get_text(file, opts)
+    end
+
+    def metadata
+      @metadata ||= app.get_metadata(file, opts)
+    end
+
+    def content_type
+      @content_type ||= app.detect(file, opts)
+    end
+
+    def language
+      @language ||= app.get_language(file, opts)
+    end
+
+  end
+end

data/lib/tika/result.rb

@@ -0,0 +1,34 @@
+require "json"
+require "forwardable"
+
+module Tika
+
+  class Result
+    extend Forwardable
+
+    attr_reader :output, :error, :status
+
+    def_delegator :status, :success?
+
+    def initialize(output, error, status)
+      @output, @error, @status = output, error, status
+    end
+
+    def render
+      output
+    end
+  end
+
+  class TextResult < Result
+    def render
+      output.strip
+    end
+  end
+
+  class JSONResult < Result
+    def render
+      JSON.load(output)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require "tika/app"
+
+FIXTURE_DIR = File.expand_path("../fixtures", __FILE__)
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+end

data/spec/unit/app_spec.rb

@@ -0,0 +1,74 @@
+module Tika
+  RSpec.describe App do
+
+    describe "#get_text" do
+      describe "with a document" do
+        let(:file) { File.join(FIXTURE_DIR, "Lorem_ipsum.docx") }
+        it "should return the text of the file" do
+          text = subject.get_text(file)
+          expect(text).to match(/Lorem ipsum/)
+        end
+      end
+      describe "with an image" do
+        let(:file) { File.join(FIXTURE_DIR, "Lorem_ipsum.tiff") }
+        it "should return the text of the file" do
+          text = subject.get_text(file)
+          expect(text).to match(/^Lorem ipsum/)
+        end
+      end
+    end
+
+    describe "#get_metadata" do
+      let(:file) { File.join(FIXTURE_DIR, "Lorem_ipsum.pdf") }
+      it "should return the metadata of the file" do
+        metadata = subject.get_metadata(file, content_type: "application/pdf")
+        expect(metadata["Creation-Date"]).to eq("2015-02-15T01:54:41Z")
+      end
+    end
+
+    describe "#get_version" do
+      it "should return the Tika app version" do
+        expect(subject.get_version).to match(/^Apache Tika/)
+      end
+    end
+
+    describe "#get_mime_types" do
+      it "should return the MIME Types support by the Tika app" do
+        expect(subject.get_mime_types).to match(/application\/pdf/)
+      end
+    end
+
+    describe "#get_parsers" do
+      it "should return the parsers available to the Tika app" do
+        expect(subject.get_parsers).to match(/org\.apache\.tika\.parser\.DefaultParser/)
+      end
+    end
+
+    describe "#get_parsers_details" do
+      it "should return the parsers available to the Tika app and the MIME types they support" do
+        expect(subject.get_parsers_details).to match(/org\.apache\.tika\.parser\.DefaultParser/)
+      end
+    end
+
+    describe "#get_detectors" do
+      it "should return the detectors available to the Tika app" do
+        expect(subject.get_detectors).to match(/org\.apache\.tika\.detect\.DefaultDetector/)
+      end
+    end
+
+    describe "#detect" do
+      let(:file) { File.join(FIXTURE_DIR, "Lorem_ipsum.png") }
+      it "should return the MIME type of the resource (if successful)" do
+        expect(subject.detect(file)).to eq("image/png")
+      end
+    end
+
+    describe "#get_language" do
+      let(:file) { "http://www.archives.gov/exhibits/charters/constitution_transcript.html" }
+      it "should return the language code" do
+        expect(subject.get_language(file)).to eq("en")
+      end
+    end
+
+  end
+end

data/spec/unit/resource_spec.rb

@@ -0,0 +1,43 @@
+module Tika
+  RSpec.describe Resource do
+
+    subject { described_class.new(file) }
+
+    describe "#text" do
+      describe "with a document" do
+        let(:file) { File.join(FIXTURE_DIR, "Lorem_ipsum.docx") }
+        it "should return the text of the file" do
+          expect(subject.text).to match(/^Lorem ipsum/)
+        end
+      end
+      describe "with an image" do
+        let(:file) { File.join(FIXTURE_DIR, "Lorem_ipsum.tiff") }
+        it "should return the text of the file" do
+          expect(subject.text).to match(/^Lorem ipsum/)
+        end
+      end
+    end
+
+    describe "#metadata" do
+      let(:file) { File.join(FIXTURE_DIR, "Lorem_ipsum.pdf") }
+      it "should return the metadata of the file" do
+        expect(subject.metadata["Creation-Date"]).to eq("2015-02-15T01:54:41Z")
+      end
+    end
+
+    describe "#content_type" do
+      let(:file) { File.join(FIXTURE_DIR, "Lorem_ipsum.png") }
+      it "should return the MIME type of the resource (if successful)" do
+        expect(subject.content_type).to eq("image/png")
+      end
+    end
+
+    describe "#language" do
+      let(:file) { "http://www.archives.gov/exhibits/charters/constitution_transcript.html" }
+      it "should return the language code" do
+        expect(subject.language).to eq("en")
+      end
+    end
+
+  end
+end

data/tika-app.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "tika-app"
+  spec.version       = File.read(File.expand_path("../VERSION", __FILE__)).chomp
+  spec.authors       = ["dchandekstark"]
+  spec.email         = ["dchandekstark@gmail.com"]
+  spec.summary       = "Ruby Tika app bindings"
+  spec.description   = "Ruby Tika app bindings"
+  spec.homepage      = "https://github.com/duke-libraries/tika-app"
+  spec.license       = "BSD-3-Clause"
+
+  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", "~> 3.1"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: tika-app
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dchandekstark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-15 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: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Ruby Tika app bindings
+email:
+- dchandekstark@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/tika/app.rb
+- lib/tika/command.rb
+- lib/tika/commands.rb
+- lib/tika/error.rb
+- lib/tika/resource.rb
+- lib/tika/result.rb
+- spec/fixtures/Lorem_ipsum.docx
+- spec/fixtures/Lorem_ipsum.pdf
+- spec/fixtures/Lorem_ipsum.png
+- spec/fixtures/Lorem_ipsum.tiff
+- spec/spec_helper.rb
+- spec/unit/app_spec.rb
+- spec/unit/resource_spec.rb
+- tika-app.gemspec
+homepage: https://github.com/duke-libraries/tika-app
+licenses:
+- BSD-3-Clause
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Tika app bindings
+test_files:
+- spec/fixtures/Lorem_ipsum.docx
+- spec/fixtures/Lorem_ipsum.pdf
+- spec/fixtures/Lorem_ipsum.png
+- spec/fixtures/Lorem_ipsum.tiff
+- spec/spec_helper.rb
+- spec/unit/app_spec.rb
+- spec/unit/resource_spec.rb