opener-webservice 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 573f4773532c5dec1df14ada6c020e8dd97faff9
-  data.tar.gz: 1b7738d6bebb403d45f3f4f281f1bd32e5a82783
+  metadata.gz: 02a6433aa01c06b1251256710c706a59e45586b2
+  data.tar.gz: 6dc2b0270835171445461234f8123fb13e267d36
 SHA512:
-  metadata.gz: cbcf4d076901ff9f275548955b984923a9ecc69a07c55a65d485f343f62d0b0e5dc68bfc003a18be62de2e1951e55e8bb07d6f5f2dc956e500cdeb39a8a808af
-  data.tar.gz: c4a58ae8772825cc65672601ceb3056d747b7ea4daa9f284d936e101b64277cf06feaeb9931c7ad5c6e48236313de6e35f8339a443a8ed0c431059c4923b54f9
+  metadata.gz: 733000a6cd389bcfbdfd0865432cc45c4896d4564a653fa7ad5a14a123d1cf5eb28ab0202e13fa47daa4e5f2b4a64f88f753abf3046d71fc11d7198329468c02
+  data.tar.gz: cfd032408fe8d59f391577d029eb96880684eb93ff61f4920f6264ac9ac214bed9d869b52b81d612c95ac386f552e43d8c5055e2024aa82e52a4597a778285fc

data/lib/opener/webservice/version.rb

@@ -2,6 +2,6 @@ require 'sinatra/base'
 
 module Opener
   class Webservice < Sinatra::Base
-    VERSION = "1.2.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/opener/webservice.rb

@@ -25,7 +25,7 @@ module Opener
       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)
@@ -40,44 +40,49 @@ module Opener
     end
 
     ##
-    # Puts the text through the primary processor
+    # 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 = get_input(params)
-      
+      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
-      
-      params[:input] = input
-      callbacks = extract_callbacks(params[:callbacks])
-      error_callback = params[:error_callback]
+
+      input_params[:input] = input
+
+      callbacks      = extract_callbacks(input_params[:callbacks])
+      error_callback = input_params[:error_callback]
 
       if callbacks.empty?
-        process_sync
+        process_sync(input_params)
       else
-        process_async(callbacks, error_callback)
+        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]
     #
@@ -94,7 +99,7 @@ module Opener
 
       return client
     end
-    
+
     ##
     # @return [Opener::CallbackHandler]
     #
@@ -150,23 +155,29 @@ module Opener
     ##
     # Processes the request synchronously.
     #
-    def process_sync
-      output, type = analyze(filtered_params)
+    # @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
     #
-    # @return [Hash] accepted params
+    # @param [Hash] input_params
+    # @return [Hash]
     #
-    def filtered_params
-      options = params.select{|k,v| accepted_params.include?(k.to_sym)}
+    def filtered_params(input_params)
+      options = input_params.select{|k,v| accepted_params.include?(k.to_sym)}
       cleaned = {}
-      options.each_pair do |k, v|
+
+      options.each do |k, v|
         v = true  if v == "true"
         v = false if v == "false"
+
         cleaned[k.to_sym] = v
       end
 
@@ -176,13 +187,21 @@ module Opener
     ##
     # Processes the request asynchronously.
     #
+    # @param [Hash] input_params
     # @param [Array] callbacks The callback URLs to use.
+    # @param [String] error_callback
     #
-    def process_async(callbacks, 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, request_id, callbacks, error_callback)
+        analyze_async(
+          filtered_params(input_params),
+          request_id,
+          callbacks,
+          error_callback
+        )
       end
 
       content_type :json
@@ -220,7 +239,7 @@ module Opener
     ##
     # Gets the NER of a KAF document and submits it to a callback URL.
     #
-    # @param [String] text
+    # @param [Hash] options
     # @param [String] request_id
     # @param [Array] callbacks
     # @param [String] error_callback
@@ -239,7 +258,7 @@ module Opener
       logger.info("Submitting results to #{url}")
 
       begin
-        process_callback(url, output, request_id, callbacks, error_callback)
+        process_callback(options, url, output, request_id, callbacks, error_callback)
       rescue => error
         logger.error("Failed to submit the results: #{error.inspect}")
 
@@ -248,30 +267,36 @@ module Opener
     end
 
     ##
+    # @param [Hash] options
     # @param [String] url
     # @param [String] text
     # @param [String] request_id
     # @param [Array] callbacks
     #
-    def process_callback(url, text, request_id, callbacks, error_callback)
-      # FIXME: this is a bit of a hack to prevent the webservice from clogging
-      # Airbrake during the hackathon. For whatever reason somebody is posting
-      # internal server errors from *somewhere*. Validation? What's that?
-      return if text =~ /^internal server error/i
-      
-      output = {
-        :input          => text,
-        :request_id     => request_id,
-        :'callbacks[]'  => callbacks,
-        :error_callback => error_callback
-      }
-      
+    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 => filtered_params.merge(output)
-      )
+
+      callback_handler.post(url, :body => output, :header => headers)
     end
 
     ##
@@ -309,14 +334,14 @@ module Opener
     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],
@@ -325,7 +350,27 @@ module Opener
       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)
@@ -333,26 +378,41 @@ module Opener
         params.merge!(extracted)
       end
     end
-    
+
     def self.secret_symbol
-      Sinatra::Application.respond_to?(:secret)? Sinatra::Application.secret.to_sym : :secret 
+      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 
+      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)
-      return params[:input] if params[:input]
-      return HTTPClient.new.get(params[:input_url]).body if params[:input_url]
+      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

data/opener-webservice.gemspec

@@ -16,12 +16,13 @@ Gem::Specification.new do |spec|
     'LICENSE.txt'
   ]).select { |file| File.file?(file) }
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
-
   spec.add_dependency "sinatra", "~> 1.4.3"
   spec.add_dependency "uuidtools"
   spec.add_dependency "json"
-  spec.add_dependency "opener-callback-handler"
+  spec.add_dependency "opener-callback-handler", '~> 1.0'
+  spec.add_dependency 'httpclient', ['~> 2.0', '>= 2.5.3.3']
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,147 +1,168 @@
 --- !ruby/object:Gem::Specification
 name: opener-webservice
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - development@olery.com
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: uuidtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  name: pry
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: opener-callback-handler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  name: sinatra
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.3
-  prerelease: false
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.3.3
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: uuidtools
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.3.3
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
+  type: :development
   prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: json
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: opener-callback-handler
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
-  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Basic webservice hooks for the opener toolchain
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - lib/opener/webservice.rb
 - lib/opener/webservice/opt_parser.rb
 - lib/opener/webservice/version.rb
 - opener-webservice.gemspec
-- README.md
-- LICENSE.txt
-homepage:
+homepage: 
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message:
+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.1.9
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
 specification_version: 4
 summary: Basic webservice hooks for the opener toolchain
 test_files: []
+has_rdoc: