opener-webservice 2.0.0 → 2.1.0

data/lib/opener/webservice.rb

@@ -1,418 +1,19 @@
-require "uuidtools"
-require "sinatra/base"
-require "json"
-require "opener/webservice/version"
-require "opener/webservice/opt_parser"
-require 'opener/callback_handler'
-
-module Opener
-  class Webservice < Sinatra::Base
-    configure do
-      enable :logging
-      if ARGV && pos = ARGV.index("--")
-        ws_options = ARGV[pos..-1]
-      else
-        ws_options = []
-      end
-      options = OptParser.parse!(ws_options)
-
-      options.each do |k,v|
-        Sinatra::Application.set k.to_sym, v
-      end
-    end
-
-    configure :development do
-      set :raise_errors, true
-      set :dump_errors, true
-    end
-
-    before %r{^((?!.css|.jpg|.png|.js|.ico).)+$} do
-      extract_params
-      authenticate! if Sinatra::Application.respond_to?(:authentication)
-    end
-
-    ##
-    # Presents a simple form that can be used for getting the NER of a KAF
-    # document.
-    #
-    get '/' do
-      erb :index
-    end
-
-    ##
-    # Puts the text through the primary processor. This route either accepts
-    # regular POST fields or a JSON payload.
-    #
-    # @param [Hash] params The POST parameters.
-    #
-    # @option params [String] :input the input to send to the processor
-    #
-    # @option params [Array<String>] :callbacks A collection of callback URLs
-    #  that act as a chain. The results are posted to the first URL which is
-    #  then shifted of the list.
-    #
-    # @option params [String] :error_callback Callback URL to send errors to
-    #  when using the asynchronous setup.
-    #
-    post '/' do
-      input_params = get_input_params
-      input        = get_input(input_params)
-
-      if !input or input.strip.empty?
-        logger.error('Failed to process the request: no input specified')
-
-        halt(400, 'No input specified')
-      end
-
-      input_params[:input] = input
-
-      callbacks      = extract_callbacks(input_params[:callbacks])
-      error_callback = input_params[:error_callback]
-
-      if callbacks.empty?
-        process_sync(input_params)
-      else
-        process_async(input_params, callbacks, error_callback)
-      end
-    end
-
-    ##
-    # @return [HTTPClient]
-    #
-    def self.http_client
-      return @http_client || new_http_client
-    end
-
-    ##
-    # @return [Opener::CallbackHandler]
-    #
-    def self.callback_handler
-      return @callback_handler || new_callback_handler
-    end
-
-    ##
-    # @return [HTTPClient]
-    #
-    def self.new_http_client
-      client = HTTPClient.new
-      client.connect_timeout = 120
-
-      return client
-    end
-
-    ##
-    # @return [Opener::CallbackHandler]
-    #
-    def self.new_callback_handler
-      handler = Opener::CallbackHandler.new
-
-      return handler
-    end
-
-    ##
-    # Specifies the text processor to use or returns it if no parameter is
-    # given.
-    #
-    # @param [Class] processor
-    # @return [Class]
-    #
-    def self.text_processor(processor=nil)
-      if processor.nil?
-        return @processor
-      else
-        @processor = processor
-      end
-    end
-
-    ##
-    # Specifies what parameters are accepted.
-    #
-    # @param [Array] array The parameters to accept.
-    #
-    def self.accepted_params(*array)
-      if array.empty?
-        return @accepted_params
-      else
-        @accepted_params = array
-      end
-      @accepted_params.concat([secret_symbol, token_symbol]) if Sinatra::Application.respond_to?(:authentication)
-    end
-
-    ##
-    # @return [Class]
-    #
-    def text_processor
-      self.class.text_processor
-    end
-
-    ##
-    # @return [Array]
-    #
-    def accepted_params
-      self.class.accepted_params
-    end
-
-    ##
-    # Processes the request synchronously.
-    #
-    # @param [Hash] input_params
-    #
-    def process_sync(input_params)
-      output, type = analyze(filtered_params(input_params))
-      content_type(type)
-
-      body(output)
-    end
-
-    ##
-    # Filter the params hash based on the accepted_params
-    #
-    # @param [Hash] input_params
-    # @return [Hash]
-    #
-    def filtered_params(input_params)
-      options = input_params.select{|k,v| accepted_params.include?(k.to_sym)}
-      cleaned = {}
-
-      options.each do |k, v|
-        v = true  if v == "true"
-        v = false if v == "false"
-
-        cleaned[k.to_sym] = v
-      end
-
-      return cleaned
-    end
-
-    ##
-    # Processes the request asynchronously.
-    #
-    # @param [Hash] input_params
-    # @param [Array] callbacks The callback URLs to use.
-    # @param [String] error_callback
-    #
-    def process_async(input_params, callbacks, error_callback)
-      request_id = get_request_id
-      output_url = callbacks.last
-
-      Thread.new do
-        analyze_async(
-          filtered_params(input_params),
-          request_id,
-          callbacks,
-          error_callback
-        )
-      end
-
-      content_type :json
-
-      {
-        :request_id => request_id.to_s,
-        :output_url => [output_url, request_id].join("/")
-      }.to_json
-    end
-
-    ##
-    # Gets the Analyzed output of an input.
-    #
-    # @param [Hash] options The options for the text_processor
-    # @return [String] output the output of the text_processor
-    # @return [Symbol] type the output type ot the text_processor
-    #
-    # @raise RunetimeError Raised when the tagging process failed.
-    #
-    def analyze(options)
-      processor             = text_processor.new(options)
-      output, error, status = processor.run(options[:input])
+require 'securerandom'
+require 'json'
 
-      if processor.respond_to?(:output_type)
-        type = processor.output_type
-      else
-        type = :xml
-      end
-
-      raise(error) if !status.nil? && !status.success?
-
-      return output, type
-    end
-
-    ##
-    # Gets the NER of a KAF document and submits it to a callback URL.
-    #
-    # @param [Hash] options
-    # @param [String] request_id
-    # @param [Array] callbacks
-    # @param [String] error_callback
-    #
-    def analyze_async(options, request_id, callbacks, error_callback = nil)
-      begin
-        output, _ = analyze(options)
-      rescue => error
-        logger.error("Failed to process input: #{error.inspect}")
-
-        submit_error(error_callback, error.message) if error_callback
-      end
-
-      url = callbacks.shift
-
-      logger.info("Submitting results to #{url}")
-
-      begin
-        process_callback(options, url, output, request_id, callbacks, error_callback)
-      rescue => error
-        logger.error("Failed to submit the results: #{error.inspect}")
-
-        submit_error(error_callback, error.message) if error_callback
-      end
-    end
-
-    ##
-    # @param [Hash] options
-    # @param [String] url
-    # @param [String] text
-    # @param [String] request_id
-    # @param [Array] callbacks
-    #
-    def process_callback(options, url, text, request_id, callbacks, error_callback)
-      if request.content_type == 'application/json'
-        headers = {'Content-Type' => 'application/json'}
-        output  = JSON.dump(
-          filtered_params(options).merge(
-            :input          => text,
-            :request_id     => request_id,
-            :callbacks      => callbacks,
-            :error_callback => error_callback
-          )
-        )
-      else
-        headers = {}
-        output  = filtered_params(options).merge(
-          :input          => text,
-          :request_id     => request_id,
-          :'callbacks[]'  => callbacks,
-          :error_callback => error_callback
-        )
-      end
-
-      extract_params
-
-      callback_handler.post(url, :body => output, :header => headers)
-    end
-
-    ##
-    # @param [String] url
-    # @param [String] message
-    #
-    def submit_error(url, message)
-      callback_handler.post(url, :body => {:error => message})
-    end
-
-    ##
-    # Returns an Array containing the callback URLs, ignoring empty values.
-    #
-    # @param [Array|String] input
-    # @return [Array]
-    #
-    def extract_callbacks(input)
-      return [] if input.nil? || input.empty?
-
-      callbacks = input.compact.reject(&:empty?)
-
-      return callbacks
-    end
-
-    ##
-    # @return [String]
-    #
-    def get_request_id
-      return params[:request_id] || UUIDTools::UUID.random_create
-    end
-
-    ##
-    # @see Opener::Webservice.http_client
-    #
-    def http_client
-      return self.class.http_client
-    end
-
-    ##
-    # @see Opener::Webservice.callback_handler
-    #
-    def callback_handler
-      return self.class.callback_handler
-    end
-
-    def authenticate!
-      credentials = {
-        secret_symbol => params[secret_symbol.to_s],
-        token_symbol => params[token_symbol.to_s]
-      }
-      response = http_client.get(Sinatra::Application.authentication, credentials)
-      halt response.body unless response.ok?
-    end
-
-    ##
-    # Returns a Hash containing the input parameters to use. If a JSON payload
-    # is submitted the parameters will be based on the payload.
-    #
-    # @return [Hash]
-    #
-    def get_input_params
-      input = {}
-
-      if request.content_type == 'application/json'
-        JSON.load(request.body).each do |key, value|
-          input[key.to_sym] = value
-        end
-      else
-        input = params
-      end
-
-      return input
-    end
-
-    def extract_params
-      if request.referrer
-        uri = URI.parse(request.referrer)
-        extracted = Rack::Utils.parse_nested_query(uri.query)
-        params.merge!(extracted)
-      end
-    end
-
-    def self.secret_symbol
-      Sinatra::Application.respond_to?(:secret)? Sinatra::Application.secret.to_sym : :secret
-    end
-
-    def self.token_symbol
-      Sinatra::Application.respond_to?(:token)? Sinatra::Application.token.to_sym : :token
-    end
-
-    def secret_symbol
-      return self.class.secret_symbol
-    end
-
-    def token_symbol
-      return self.class.token_symbol
-    end
-
-    ##
-    # Returns the KAF/text input as a String.
-    #
-    # @param [Hash] params
-    # @return [String]
-    #
-    def get_input(params)
-      input = nil
-
-      if params[:input]
-        input = params[:input]
-
-      elsif params[:input_url]
-        resp  = HTTPClient.get(params[:input_url], :follow_redirect => true)
-        input = resp.body if resp.ok?
-      end
-
-      return input
-    end
-  end
-end
+require 'puma/cli'
+require 'slop'
+require 'sinatra/base'
+require 'opener/core'
+require 'opener/callback_handler'
+require 'rollbar'
+require 'new_relic/control'
+
+require_relative 'webservice/version'
+require_relative 'webservice/configuration'
+require_relative 'webservice/server'
+require_relative 'webservice/uploader'
+require_relative 'webservice/error_handler'
+require_relative 'webservice/input_extractor'
+require_relative 'webservice/input_sanitizer'
+require_relative 'webservice/option_parser'

data/opener-webservice.gemspec

@@ -1,10 +1,10 @@
 require File.expand_path('../lib/opener/webservice/version', __FILE__)
 
 Gem::Specification.new do |spec|
-  spec.name          = "opener-webservice"
+  spec.name          = 'opener-webservice'
   spec.version       = Opener::Webservice::VERSION
-  spec.authors       = ["development@olery.com"]
-  spec.summary       = %q{Basic webservice hooks for the opener toolchain}
+  spec.authors       = ['development@olery.com']
+  spec.summary       = 'Basic webservice hooks for the OpeNER toolchain'
   spec.description   = spec.summary
 
   spec.license = 'Apache 2.0'
@@ -16,13 +16,21 @@ Gem::Specification.new do |spec|
     'LICENSE.txt'
   ]).select { |file| File.file?(file) }
 
-  spec.add_dependency "sinatra", "~> 1.4.3"
-  spec.add_dependency "uuidtools"
-  spec.add_dependency "json"
-  spec.add_dependency "opener-callback-handler", '~> 1.0'
+  spec.add_dependency 'sinatra', '~> 1.4.3'
+  spec.add_dependency 'uuidtools'
+  spec.add_dependency 'json'
+  spec.add_dependency 'opener-callback-handler', '~> 1.0'
   spec.add_dependency 'httpclient', ['~> 2.0', '>= 2.5.3.3']
+  spec.add_dependency 'opener-core', '~> 2.0'
+  spec.add_dependency 'puma'
+  spec.add_dependency 'slop', '~> 3.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
+  spec.add_dependency 'newrelic_rpm'
+  spec.add_dependency 'rollbar', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack-test'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opener-webservice
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - development@olery.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -86,6 +86,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.3.3
+- !ruby/object:Gem::Dependency
+  name: opener-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rollbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +198,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Basic webservice hooks for the opener toolchain
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Basic webservice hooks for the OpeNER toolchain
 email: 
 executables: []
 extensions: []
@@ -137,7 +235,13 @@ files:
 - LICENSE.txt
 - README.md
 - lib/opener/webservice.rb
-- lib/opener/webservice/opt_parser.rb
+- lib/opener/webservice/configuration.rb
+- lib/opener/webservice/error_handler.rb
+- lib/opener/webservice/input_extractor.rb
+- lib/opener/webservice/input_sanitizer.rb
+- lib/opener/webservice/option_parser.rb
+- lib/opener/webservice/server.rb
+- lib/opener/webservice/uploader.rb
 - lib/opener/webservice/version.rb
 - opener-webservice.gemspec
 homepage: 
@@ -163,6 +267,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Basic webservice hooks for the opener toolchain
+summary: Basic webservice hooks for the OpeNER toolchain
 test_files: []
 has_rdoc: