tika-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a520c2018bc2474f7006b3dc2defca7ba0dd051
+  data.tar.gz: 33a1f20b73f45f6f4c3f46a58136569041dac139
+SHA512:
+  metadata.gz: a2adeecc540ee13117e32848226d8616f833a82103caa7ebb6d09185948c22dc753801499e9f3c355bc43cf7fef8d7cf6372737462a7cfcd60692a04cb42ce1b
+  data.tar.gz: 6461f28df9c2975bb0e707dff6fac55ec1141b5fdd157bafa57c00d298491759c2392d7a571ab814b863e463c0188686053e3267e43428cce3a093d32a915897

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-client.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::Client
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tika-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tika-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tika-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,76 @@
+require "bundler/gem_tasks"
+require "openssl"
+require "net/http"
+
+TEMP_DIR = File.absolute_path("tmp")
+DOWNLOAD_DIR = TEMP_DIR
+BIN_DIR = File.absolute_path("bin")
+TIKA_VERSION = "1.7"
+PID_FILE = File.join(TEMP_DIR, "tika-server.pid")
+
+tika_version = ENV["TIKA_VERSION"] || TIKA_VERSION
+tika_path = File.join(BIN_DIR, "tika-server.jar")
+tika_server = File.basename(tika_path)
+tika_download_url = "http://archive.apache.org/dist/tika/tika-server-#{tika_version}.jar"
+tika_checksum_url = "#{tika_download_url}.sha"
+tika_checksum_type = :SHA1
+
+namespace :tika do
+  desc "Download Tika server"
+  task :download => [:download_dir] do
+    FileUtils.cd(DOWNLOAD_DIR) do
+      puts "Downloading Tika ... "
+      system "curl -L #{tika_download_url} -o #{tika_server}"
+      checksum = Net::HTTP.get(URI(tika_checksum_url)).chomp
+      puts "Verifiying checksum ... "
+      digest = OpenSSL::Digest.const_get(tika_checksum_type).new
+      digest << File.read(tika_server)
+      if digest.to_s != checksum
+        puts "Checksums do not match -- aborting!"
+        FileUtils.remove_entry_secure(tika_server)
+        abort
+      end
+      FileUtils.mv(tika_server, tika_path)
+    end
+  end
+
+  desc "Start Tika server"
+  task :start do
+    if File.exists?(tika_path)
+      puts "Starting Tika server ..."
+      File.open(PID_FILE, "w") do |pid_file|
+        pid = fork { exec "java -jar #{tika_path}" }
+        Process.detach(pid)
+        pid_file.write(pid)
+      end
+    else
+      puts "Tika server not found - run `rake tika:download'."
+    end
+  end
+
+  desc "Stop Tika server"
+  task :stop do
+    if File.exists?(PID_FILE)
+      puts "Stopping Tika server ..."
+      pid = File.read(PID_FILE).strip
+      Process.kill("KILL", pid.to_i)
+      File.unlink(PID_FILE)  
+    else
+      puts "Tika server is not running or was not started by `rake tika:start' task."
+    end
+  end
+  
+  desc "Check Tika server status"
+  task :status do
+    if File.exists?(PID_FILE)
+      pid = File.read(PID_FILE).strip
+      puts "Tika server is running (PID #{pid})"
+    else
+      puts "Tika server is not running or was not started by `rake tika:start' task."
+    end
+  end
+end
+
+task :download_dir do
+  FileUtils.mkdir(DOWNLOAD_DIR) unless Dir.exists?(DOWNLOAD_DIR)
+end

data/VERSION

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

data/lib/tika-client.rb

@@ -0,0 +1 @@
+require "tika/client"

data/lib/tika/api.rb

@@ -0,0 +1,26 @@
+module Tika
+  class Api
+
+    PUT = Net::HTTP::Put
+    GET = Net::HTTP::Get
+
+    JSON = "application/json"
+    TEXT = "text/plain"
+    
+    Endpoint = Struct.new(:request_method, :path, :response_format)
+
+    ENDPOINTS = {
+      get_metadata: Endpoint.new(PUT, "/meta", JSON),
+      get_text:     Endpoint.new(PUT, "/tika", TEXT)
+    }
+
+    def endpoint(name)
+      ENDPOINTS.fetch(name)
+    end
+
+    def has_endpoint?(name)
+      ENDPOINTS.include?(name)
+    end
+
+  end
+end

data/lib/tika/client.rb

@@ -0,0 +1,48 @@
+require_relative "configuration"
+require_relative "api"
+require_relative "request"
+require "forwardable"
+
+module Tika
+  class Client
+    extend Forwardable
+
+    class << self
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+    end
+
+    attr_accessor :host, :port, :api
+    def_delegators :api, :endpoint, :has_endpoint?
+
+    def initialize(opts={})
+      @host = opts.fetch(:host, config.host)
+      @port = opts.fetch(:port, config.port)
+      @api = Api.new
+    end
+
+    def config
+      self.class.config
+    end
+
+    def connection
+      @connection ||= Net::HTTP.new(host, port)
+    end
+
+    def execute(name, opts={})
+      request = Request.new(connection, endpoint(name))
+      request.execute(opts)
+    end
+
+    def method_missing(name, *args)
+      return execute(name, *args) if has_endpoint?(name)
+      super
+    end
+
+  end
+end

data/lib/tika/configuration.rb

@@ -0,0 +1,16 @@
+module Tika
+  class Configuration
+
+    DEFAULT_HOST = "localhost"
+    DEFAULT_PORT = 9998
+
+    attr_accessor :host
+    attr_accessor :port
+
+    def initialize
+      @host = ENV["TIKA_HOST"] || DEFAULT_HOST
+      @port = ENV["TIKA_PORT"] || DEFAULT_PORT
+    end
+
+  end
+end

data/lib/tika/request.rb

@@ -0,0 +1,38 @@
+require "uri"
+require "net/http"
+require "delegate"
+# require "mime-types"
+
+module Tika
+  # Executes an API method
+  class Request < SimpleDelegator
+
+    attr_reader :connection # , :endpoint, :http_request
+    
+    # def self.execute(*args)
+    #   request = new(*args)
+    #   yield request if block_given?
+    #   request.execute
+    # end
+
+    def initialize(connection, endpoint)
+      @connection = connection
+      @endpoint = endpoint
+      uri = URI::HTTP.build(host: connection.address, port: connection.port, path: endpoint.path)
+      super endpoint.request_method.new(uri)
+      self["Accept"] = endpoint.response_format
+    end
+
+    def execute(opts={})
+      connection.start do |conn|
+        if file = opts.delete(:file)
+          self.body = file.read
+          self.content_length = file.size
+        end
+        self.content_type = opts[:content_type] if opts[:content_type]
+        conn.request(__getobj__)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+# 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/tika-client.gemspec

@@ -0,0 +1,25 @@
+# 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-client"
+  spec.version       = File.read(File.expand_path("../VERSION", __FILE__)).chomp
+  spec.authors       = ["dchandekstark"]
+  spec.email         = ["dchandekstark@gmail.com"]
+  spec.summary       = "Ruby bindings for Apache Tika Server REST API"
+  spec.description   = "Ruby bindings for Apache Tika Server REST API"
+  spec.homepage      = "https://github.com/duke-libraries/tika-client"
+  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.required_ruby_version = "~> 2.0"
+
+  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,101 @@
+--- !ruby/object:Gem::Specification
+name: tika-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dchandekstark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-14 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 bindings for Apache Tika Server REST API
+email:
+- dchandekstark@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/tika-client.rb
+- lib/tika/api.rb
+- lib/tika/client.rb
+- lib/tika/configuration.rb
+- lib/tika/request.rb
+- spec/spec_helper.rb
+- tika-client.gemspec
+homepage: https://github.com/duke-libraries/tika-client
+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: '2.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 bindings for Apache Tika Server REST API
+test_files:
+- spec/spec_helper.rb