tika-client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bb963d542e83e8d690b3e243bf05a155ec22391
-  data.tar.gz: 7776e59b7a1210326b8006f3891dfb78f14cf9c8
+  metadata.gz: 2657a16d46c66487c7e90bb41b17bc18b178e972
+  data.tar.gz: 9386b75938dd03c8622c7c8efb2dd641b3627f52
 SHA512:
-  metadata.gz: 09198bec1ef7e2f79d0bee0b2b7762dc438ef3e5f821f52c000f297526a82d6e145d46a8e5b6ad17c9244f1dda5a978e96c9cb0bdc0aacf90269438165f16a5a
-  data.tar.gz: e058fd18fb370a579d21a58a1c227313d81000bc5a6e27344fb42a0c6a14c6a89644070fc435a5f6a68d1432f42db2ae77ee84848565c981fadaf98f16a08e2e
+  metadata.gz: 6a205ff0d6422c6098c904f1ed2fa458367de5b991ca8197b54f6fbf64ea093ba5c3a7f3cd7ee85e3d34c9b042dca3df40ee94c4cbd327e0a8da502c7e058f37
+  data.tar.gz: 507f8ebc7ed4aeb4d6171450f7cf8b96b434dc903cc560dbfe3f8d49969474b81826a02ce7bcbf8fbb4ef1a6dac6d7a4bfb64a8942c62914824a781fb3f5e0cb

data/Rakefile

@@ -1,4 +1,5 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 require "openssl"
 require "net/http"
 
@@ -36,7 +37,10 @@ namespace :tika do
 
   desc "Start Tika server"
   task :start do
-    if File.exists?(tika_path)
+    if File.exists?(PID_FILE)
+      pid = File.read(PID_FILE).strip
+      puts "Tika server is already running (PID #{pid})"
+    elsif File.exists?(tika_path)
       puts "Starting Tika server ..."
       File.open(PID_FILE, "w") do |pid_file|
         pid = fork { exec "java -jar #{tika_path}" }
@@ -74,3 +78,8 @@ end
 task :download_dir do
   FileUtils.mkdir(DOWNLOAD_DIR) unless Dir.exists?(DOWNLOAD_DIR)
 end
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/tika/client.rb

@@ -1,3 +1,4 @@
+require "net/http"
 require_relative "configuration"
 require_relative "requests"
 
@@ -19,8 +20,8 @@ module Tika
     attr_reader :host, :port
 
     def initialize(opts={})
-      @host = opts.fetch(:host, config.host)
-      @port = opts.fetch(:port, config.port)
+      @host = opts.fetch(:host, self.class.config.host)
+      @port = opts.fetch(:port, self.class.config.port)
     end
 
     def get_text(opts={})
@@ -31,12 +32,28 @@ module Tika
       GetMetadataRequest.execute(connection, opts)
     end
 
-    private
+    def get_version
+      GetVersionRequest.execute(connection)
+    end
 
-    def config
-      self.class.config
+    def get_mime_types
+      GetMimeTypesRequest.execute(connection)
     end
 
+    def get_parsers
+      GetParsersRequest.execute(connection)
+    end
+
+    def get_parsers_details
+      GetParsersDetailsRequest.execute(connection)
+    end
+
+    def get_detectors
+      GetDetectorsRequest.execute(connection)
+    end
+
+    private
+    
     def connection
       @connection ||= Net::HTTP.new(host, port)
     end

data/lib/tika/request.rb

@@ -1,59 +1,79 @@
 require "uri"
-require "net/http"
 require "delegate"
 
 module Tika
   class Request < SimpleDelegator
 
     class << self
-      attr_accessor :endpoint
+      attr_accessor :http_method, :path
+
+      def headers
+        {}
+      end
     end
 
-    attr_reader :connection
+    attr_reader :connection, :options
     
-    def self.execute(connection, opts={})
-      request = new(connection)
-      yield request if block_given?
-      request.execute(opts)
+    def self.execute(connection, options={})
+      request = new(connection, options)
+      request.execute
     end
 
-    def initialize(connection)
+    def initialize(connection, options={})
       @connection = connection
+      @options = options
       super build_request
-      set_defaults
+      handle_options
       post_initialize
     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]
-        yield self if block_given?
-        conn.request(__getobj__)
-      end
+    def execute
+      response = connection.start { |conn| conn.request(__getobj__) }
+      handle_response(response)
     end
 
-    def endpoint
-      self.class.endpoint
+    def uri
+      @uri ||= URI::HTTP.build(host: connection.address, port: connection.port, path: self.class.path)
     end
 
-    def uri
-      @uri ||= URI::HTTP.build(host: connection.address, port: connection.port, path: endpoint.path)
+    def handle_response(response)
+      response.body
     end
 
     private
 
-    def post_initialize; end
+    def handle_options
+      add_file if file
+      set_content_type
+      add_headers
+    end
 
-    def build_request
-      endpoint.request_method.new(uri)
+    def set_content_type
+      self.content_type = options[:content_type] if options[:content_type]
+    end
+
+    def add_file
+      self.body = file.read
+      self.content_length = file.size
     end
 
-    def set_defaults
-      self["Accept"] = endpoint.response_format
+    def file
+      options[:file]
+    end
+
+    def headers
+      @headers ||= self.class.headers.merge options.fetch(:headers, {})
+    end
+
+    def add_headers
+      headers.each { |header, value| self[header] = value }
+    end
+
+    # Subclass hook
+    def post_initialize; end
+
+    def build_request
+      self.class.http_method.new(uri)
     end
 
   end

data/lib/tika/requests.rb

@@ -1,19 +1,63 @@
+require "json"
+require "net/http"
 require_relative "request"
-require_relative "endpoints"
 
 module Tika
   module Requests
 
-    include Endpoints
+    PUT = Net::HTTP::Put
+    GET = Net::HTTP::Get
 
-    def self.request_class(endpoint)
-      klass = Class.new(Request)
-      klass.endpoint = endpoint
-      klass
+    class TextRequest < Request
+      def self.headers
+        {"Accept" => "text/plain"}
+      end
     end
 
-    GetTextRequest     = request_class GetTextEndpoint
-    GetMetadataRequest = request_class GetMetadataEndpoint
+    class JSONRequest < Request
+      def self.headers
+        {"Accept" => "application/json"}
+      end
+
+      def handle_response(response)
+        JSON.load(response.body)
+      end
+    end
+
+    class GetTextRequest < TextRequest
+      self.http_method = PUT
+      self.path        = "/tika"
+    end
+
+    class GetMetadataRequest < JSONRequest
+      self.http_method = PUT
+      self.path        = "/meta"
+    end
+
+    class GetVersionRequest < Request
+      self.http_method = GET
+      self.path        = "/version"
+    end
+
+    class GetMimeTypesRequest < JSONRequest
+      self.http_method = GET
+      self.path        = "/mime-types"
+    end
+
+    class GetParsersRequest < JSONRequest
+      self.http_method = GET
+      self.path        = "/parsers"
+    end
+
+    class GetParsersDetailsRequest < JSONRequest
+      self.http_method = GET
+      self.path        = "/parsers/details"
+    end
+
+    class GetDetectorsRequest < JSONRequest
+      self.http_method = GET
+      self.path        = "/detectors"
+    end
 
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
+require "tika-client"
+
+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

data/spec/unit/client_spec.rb

@@ -0,0 +1,51 @@
+module Tika
+  RSpec.describe Client do
+
+    describe "#get_text" do
+      let(:file) { File.new(File.join(FIXTURE_DIR, "Lorem_ipsum.docx")) }
+      it "should return the text of the file" do
+        text = subject.get_text(file: file, content_type: "application/vnd.openxmlformats-officedocument.wordprocessingml.document")
+        expect(text).to match(/^Lorem ipsum/)
+      end
+    end
+
+    describe "#get_metadata" do
+      let(:file) { File.new(File.join(FIXTURE_DIR, "Lorem_ipsum.pdf")) }
+      it "should return the metadata of the file" do
+        metadata = subject.get_metadata(file: 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 server 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 server" do
+        expect(subject.get_mime_types).to have_key("application/pdf")
+      end
+    end
+
+    describe "#get_parsers" do
+      it "should return the parsers available to the Tika server" do
+        expect(subject.get_parsers["name"]).to eq("org.apache.tika.parser.DefaultParser")
+      end
+    end
+
+    describe "#get_parsers_details" do
+      it "should return the parsers available to the Tika server and the MIME types they support" do
+        expect(subject.get_parsers_details["name"]).to eq("org.apache.tika.parser.DefaultParser")
+      end
+    end
+
+    describe "#get_detectors" do
+      it "should return the detectors available to the Tika server" do
+        expect(subject.get_detectors["name"]).to eq("org.apache.tika.detect.DefaultDetector")
+      end
+    end
+
+  end
+end

data/spec/unit/request_spec.rb

@@ -0,0 +1,10 @@
+module Tika
+  RSpec.describe Request do
+
+    subject { described_class.new(connection, options) }
+    let(:connection) { Net::HTTP.new("localhost", 9998) }
+    
+    
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tika-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - dchandekstark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-14 00:00:00.000000000 Z
+date: 2015-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,10 +69,15 @@ files:
 - lib/tika-client.rb
 - lib/tika/client.rb
 - lib/tika/configuration.rb
-- lib/tika/endpoints.rb
 - lib/tika/request.rb
 - lib/tika/requests.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/client_spec.rb
+- spec/unit/request_spec.rb
 - tika-client.gemspec
 homepage: https://github.com/duke-libraries/tika-client
 licenses:
@@ -99,4 +104,10 @@ signing_key:
 specification_version: 4
 summary: Ruby bindings for Apache Tika Server REST API
 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/client_spec.rb
+- spec/unit/request_spec.rb

data/lib/tika/endpoints.rb

@@ -1,18 +0,0 @@
-require "net/http"
-
-module Tika
-  module Endpoints
-
-    PUT = Net::HTTP::Put
-    GET = Net::HTTP::Get
-
-    JSON = "application/json"
-    TEXT = "text/plain"
-    
-    Endpoint = Struct.new(:request_method, :path, :response_format)
-
-    GetTextEndpoint     = Endpoint.new(PUT, "/tika", TEXT)
-    GetMetadataEndpoint = Endpoint.new(PUT, "/meta", JSON)
-
-  end
-end