opener-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8224c6b41577a334b81e3a324b806f7a15bddaef
+  data.tar.gz: 82d9f14ad375997975f519f269fd91c95cf97362
+SHA512:
+  metadata.gz: c5bb6aaf1656e8851f2c680930f985ea00a5bcd37daac94fa91f8c3e11a54ff7c7802278381f1b192a4118eb6103bbef83918e6eade7208cfbbc10ec3df35b2d
+  data.tar.gz: 0f962edc4afa1422f341032158b9e89739d4511316643c4ac7c2e583cc4bae4e76e9c99a777928ee22dfb8228c143532e4ba43976505a871f4370598b7f42da7

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Wilco van Duinkerken
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Opener::Client
+
+This is a ruby library that makes it very easy to connect to OpeNER webservices
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opener-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opener-client
+
+## Usage
+
+You have to create your own OpeNER pipeline. You can do this like this:
+
+```ruby
+require 'opener/client'
+
+class Basic < Opener::Client::Pipeline
+  # Define your processors. The order matters.
+  define_processors "language-identifier",
+                    "tokenizer",
+                    "pos-tagger",
+                    "polarity-tagger",
+                    "ner",
+                    "opinion-detector"
+
+  # Defaults to :async, the other option is :sync
+  processor_style :async
+
+  webservice_host "http://opener.olery.com"
+end
+```
+
+That's it basically. You can now process files like this:
+
+```ruby
+pipeline = Basic.new
+response = pipeline.process("This is the text to analyse")
+```
+
+By default the async callback chain is used. So the response will contain
+an output url where you can find your output after a few seconds.
+
+Check out the examples folder in this repository for a more extensive example.
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/lib/opener/client.rb

@@ -0,0 +1,17 @@
+require 'nokogiri'
+require 'active_support/inflector'
+require 'httpclient'
+
+require "opener/client/version"
+
+require 'opener/client/processor'
+require 'opener/client/processor_definer'
+require 'opener/client/processors/language_identifier'
+require 'opener/client/processors/tokenizer'
+
+require 'opener/client/pipeline'
+
+module Opener
+  module Client
+  end
+end

data/lib/opener/client/pipeline.rb

@@ -0,0 +1,51 @@
+require 'json'
+
+module Opener
+  module Client
+    class Pipeline
+      include ProcessorDefiner
+      include Processors
+
+      def self.processor_style(style)
+        @@style = style
+      end
+
+      def self.webservice_host(host=nil)
+        @@host = host
+      end
+
+      def self.outlet(outlet)
+        @@outlet = outlet
+      end
+
+      def pipe
+        @pipe ||= self.class.processors.map{|p| p.new(@@host)}
+      end
+
+      def process_sync(input)
+        pipe.inject(input) do |memo, pipe|
+          memo = pipe.process(memo)
+        end
+      end
+
+      def process_async(input)
+        endpoints = pipe.map(&:endpoint)
+
+        callbacks = endpoints[1..-1]
+        callbacks << @@outlet
+
+        pipe[0].process(input, callbacks)
+      end
+
+      def process(input)
+        json_to_hash send(:"process_#{@@style}", input)
+      end
+
+      private
+
+      def json_to_hash(response)
+        JSON.parse(response)
+      end
+    end
+  end
+end

data/lib/opener/client/processor.rb

@@ -0,0 +1,43 @@
+module Opener
+  module Client
+    module Processor
+      attr_reader :host
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def processor(processor)
+          define_method "processor" do
+            return processor
+          end
+        end
+      end
+
+      def initialize(host)
+        @host = host
+      end
+
+      def process(input, callbacks=nil)
+        opts = {:input=>input}.merge(options)
+        opts[:'callbacks[]'] = callbacks unless callbacks.nil?
+
+        response = HTTPClient.post(endpoint, opts)
+        if response.status == 500
+          raise "Internal Server error in: #{self.class.name}, #{response.body}"
+        else
+          return response.body
+        end
+      end
+
+      def endpoint
+        [host, processor].join("/")
+      end
+
+      def options
+        {}
+      end
+    end
+  end
+end

data/lib/opener/client/processor_definer.rb

@@ -0,0 +1,45 @@
+module Opener
+  module Client
+    module ProcessorDefiner
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        @@processors = []
+
+        def add_processor(processor)
+          @@processors << processor
+        end
+
+        def processors
+          @@processors
+        end
+
+        def define_processors(*paths)
+          paths.each do |p|
+            define_processor(p)
+          end
+        end
+
+        def define_processor(p)
+          klass_name = p.split("-").map(&:camelize).join
+
+          if !const_defined?(klass_name)
+            klass = const_set(klass_name,Class.new)
+          else
+            klass = const_get(klass_name)
+          end
+
+          klass.class_eval do
+            include Processor
+            processor p
+          end
+
+          self.add_processor klass
+        end
+
+      end
+    end
+  end
+end

data/lib/opener/client/processors/language_identifier.rb

@@ -0,0 +1,11 @@
+module Opener
+  module Client
+    module Processors
+      class LanguageIdentifier
+        def options
+          {kaf: true}
+        end
+      end
+    end
+  end
+end

data/lib/opener/client/processors/tokenizer.rb

@@ -0,0 +1,10 @@
+module Opener
+  module Client
+    class Tokenizer
+      def options
+        {kaf: false,
+         language: "en"}
+      end
+    end
+  end
+end

data/lib/opener/client/version.rb

@@ -0,0 +1,5 @@
+module Opener
+  module Client
+    VERSION = "1.0.0"
+  end
+end

data/opener-webservice.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('../lib/opener/client/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name        = "opener-client"
+  spec.version     = Opener::Client::VERSION
+  spec.authors     = ["Wilco van Duinkerken"]
+  spec.email       = ["wilcovanduinkerken@olery.com"]
+  spec.summary     = %q{A helper gem to make use of OpeNER webservices}
+  spec.description = spec.summary
+  spec.homepage    = "http://opener-project.github.com"
+  spec.license     = "MIT"
+
+  spec.files = Dir.glob([
+    'lib/**/*',
+    'LICENSE.txt',
+    '*.gemspec',
+    'README.md'
+  ]).select { |file| File.file?(file) }
+
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'httpclient'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: opener-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Wilco van Duinkerken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: activesupport
+  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: httpclient
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A helper gem to make use of OpeNER webservices
+email:
+- wilcovanduinkerken@olery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/opener/client.rb
+- lib/opener/client/pipeline.rb
+- lib/opener/client/processor.rb
+- lib/opener/client/processor_definer.rb
+- lib/opener/client/processors/language_identifier.rb
+- lib/opener/client/processors/tokenizer.rb
+- lib/opener/client/version.rb
+- opener-webservice.gemspec
+homepage: http://opener-project.github.com
+licenses:
+- MIT
+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: A helper gem to make use of OpeNER webservices
+test_files: []
+has_rdoc: