name-spotter 0.0.2 → 0.0.3

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Dmitry Mozzherin
+Copyright (c) 2012 Marine Biological Laboratory
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,48 @@
 = name-spotter
 
-Finds biodiversity scientific names in texts using TaxonFinder or NetiNeti libraries. 
+Finds biodiversity scientific names in texts using TaxonFinder or NetiNeti libraries. This gem works with ruby >= 1.9.2
+
+== Installation
+
+    gem install name-spotter
+
+== Usage
+
+Fist you have to download TaxonFinder and NetiNeti services.
+    
+* TaxonFinder: http://code.google.com/p/taxon-finder/
+* NetiNeti: https://github.com/mbl-cli/NetiNeti
+
+If you are using localhost and default ports:
+
+    require 'name-spotter'
+
+    neti_client       = NameSpotter::NetiNetiClient.new()
+    tf_client         = NameSpotter::TaxonFinderClient.new()
+    neti_name_spotter = NameSpotter.new(neti_client)
+    tf_name_spotter   = NameSpotter.new(tf_client)
+
+    neti_name_spotter.find(your_text)
+    tf_name_spotter.find(your_text)
+
+If you have installed NetiNeti and TaxonFinder on a machine with non-default port:
+
+    neti_client = NameSpotter::NetiNetiClient.new(host: "example.com", port: 5555)
+    #or
+    neti_client = NameSpotter::NetiNetiClient.new(host: "123.123.123.111", port: 5555)
+
+If you want to get results in JSON or XML formats
+    
+    neti_name_spotter.find(your_text, "json")
+    neti_name_spotter.find(your_text, "xml")
+
+== Development
+
+To run tests start TaxonFinder and NetiNeti on your local machine with default configurations and run
+
+    rake
+
+
 
 == Contributing to name-spotter
  
@@ -14,6 +56,8 @@ Finds biodiversity scientific names in texts using TaxonFinder or NetiNeti libra
 
 == Copyright
 
+Authors: Chuck Ha, Anthony Goddard,  Dmitry Mozzherin
+
 Copyright (c) 2012 Marine Biologica Laboratory. See LICENSE.txt for
 further details.
 

data/Rakefile

@@ -20,7 +20,7 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{Scientific names finder}
   gem.description = %Q{The gem searches for scientific names in texts using socket servers running TaxonFinder (by Patrick Leary) and NetiNeti (by Lakshmi Manohar Akella)}
   gem.email = "dmozzherin@gmail.com"
-  gem.authors = ["Ryan Schenk", "Anthony Goddard", "Chuck Ha", "Dmitry Mozzherin"]
+  gem.authors = ["Anthony Goddard", "Chuck Ha", "Dmitry Mozzherin"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/name-spotter.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{name-spotter}
-  s.version = "0.0.2"
+  s.name = "name-spotter"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Ryan Schenk}, %q{Anthony Goddard}, %q{Chuck Ha}, %q{Dmitry Mozzherin}]
-  s.date = %q{2012-01-12}
-  s.description = %q{The gem searches for scientific names in texts using socket servers running TaxonFinder (by Patrick Leary) and NetiNeti (by Lakshmi Manohar Akella)}
-  s.email = %q{dmozzherin@gmail.com}
+  s.authors = ["Anthony Goddard", "Chuck Ha", "Dmitry Mozzherin"]
+  s.date = "2012-01-12"
+  s.description = "The gem searches for scientific names in texts using socket servers running TaxonFinder (by Patrick Leary) and NetiNeti (by Lakshmi Manohar Akella)"
+  s.email = "dmozzherin@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -40,11 +40,11 @@ Gem::Specification.new do |s|
     "spec/scientific_name_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/GlobalNamesArchitecture/name-spotter}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{Scientific names finder}
+  s.homepage = "http://github.com/GlobalNamesArchitecture/name-spotter"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Scientific names finder"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: name-spotter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
-- Ryan Schenk
 - Anthony Goddard
 - Chuck Ha
 - Dmitry Mozzherin
@@ -16,7 +15,7 @@ date: 2012-01-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70256498363600 !ruby/object:Gem::Requirement
+  requirement: &70131407564320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256498363600
+  version_requirements: *70131407564320
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70256498363000 !ruby/object:Gem::Requirement
+  requirement: &70131407562420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +34,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256498363000
+  version_requirements: *70131407562420
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70256498362380 !ruby/object:Gem::Requirement
+  requirement: &70131407561440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256498362380
+  version_requirements: *70131407561440
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70256498361800 !ruby/object:Gem::Requirement
+  requirement: &70131407560480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +56,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256498361800
+  version_requirements: *70131407560480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70256498361220 !ruby/object:Gem::Requirement
+  requirement: &70131407559220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +67,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70256498361220
+  version_requirements: *70131407559220
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70256498360620 !ruby/object:Gem::Requirement
+  requirement: &70131407558420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256498360620
+  version_requirements: *70131407558420
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70256498360020 !ruby/object:Gem::Requirement
+  requirement: &70131407557480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +89,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256498360020
+  version_requirements: *70131407557480
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70256498359340 !ruby/object:Gem::Requirement
+  requirement: &70131407556400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,10 +100,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70256498359340
+  version_requirements: *70131407556400
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70256498358740 !ruby/object:Gem::Requirement
+  requirement: &70131407555260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -112,10 +111,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70256498358740
+  version_requirements: *70131407555260
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70256498358140 !ruby/object:Gem::Requirement
+  requirement: &70131407554000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -123,10 +122,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256498358140
+  version_requirements: *70131407554000
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70256498357540 !ruby/object:Gem::Requirement
+  requirement: &70131407552800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -134,7 +133,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256498357540
+  version_requirements: *70131407552800
 description: The gem searches for scientific names in texts using socket servers running
   TaxonFinder (by Patrick Leary) and NetiNeti (by Lakshmi Manohar Akella)
 email: dmozzherin@gmail.com
@@ -181,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2758893711713117720
+      hash: 947943124713619845
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -190,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Scientific names finder