gnfinder 0.15.5 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbac598ce79e8e9db5ad0fd4f24b5004b2cf4f91d3f5fae0ece871b525d1f488
-  data.tar.gz: 36abaa471d385f27ae6bfa32f6f960bb7bc3a1b258b0b2a5402826e41d629d6f
+  metadata.gz: ac89d96503cd4b2030ab6a681e97201959b3acb46035c36b5af6524ee8ef725b
+  data.tar.gz: ce28eb276f6ce689210c16c43aa162ef4f35715eae46453779b176893394822f
 SHA512:
-  metadata.gz: 5e6a3e825edfaa873e0d178a7323d7a9b6124292e940e504834b48d8127e18ae08298044458b15fc1125abf9b98afcd1faa292eadfb6edf64f80d6b3d89d43d7
-  data.tar.gz: 68e7871b2ce105ca751c63b391ca7477a33ce965c88d6ef87235635fd8aebbfba18e856c549d0e0a26d2a4228f0a0bf46ab8cce58892c677824273f6c1f9d259
+  metadata.gz: d95363b28362959633773ec570217b1b9824a140e1c7000196de791adc88b191fceaf190b5e7384f4ea7b3c57949f1879306a17c9ca85cf4e647ed90d055599c
+  data.tar.gz: b32921b2b52d449ebb8582acca511fd5d9acdf6f10898a75b7357af535f34160dd8c13e2883e03a53a0a56dd9ea2132f1408f30e4474d9495f28b41fe262a3d1

data/README.md

@@ -1,31 +1,37 @@
 # gnfinder
 
 Ruby gem to access functionality of [GNfinder] project written in Go. This gem
-allows to perform fast and accurate scientific name finding in UTF-8 encoded
-plain texts for Ruby-based projects.
-
-- [GNfinder](#gnfinder)
-  - [Requirements](#requirements)
-  - [Installation](#installation)
-  - [Usage](#usage)
-    - [Finding names in a text using default settings](#finding-names-in-a-text-using-default-settings)
-    - [Optionally disable Bayes search](#optionally-disable-bayes-search)
-    - [Set a language for the text](#set-a-language-for-the-text)
-  - [Set automatic detection of text's language](#set-automatic-detection-of-texts-language)
-    - [Set verification option](#set-verification-option)
-    - [Set preferred data-sources list](#set-preferred-data-sources-list)
-    - [Combination of parameters.](#combination-of-parameters)
-  - [Development](#development)
+allows to perform fast and accurate scientific name finding in texts,
+web-pages, as well as a large variety of documents. Document files can be
+accessed either locally or via a URL.
+
+
+<!-- vim-markdown-toc GFM -->
+
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Finding names in a text using default settings](#finding-names-in-a-text-using-default-settings)
+  * [Finding names by a URL](#finding-names-by-a-url)
+  * [Finding names in a file](#finding-names-in-a-file)
+  * [Optionally disable Bayes search](#optionally-disable-bayes-search)
+  * [Set a language for the text](#set-a-language-for-the-text)
+* [Set automatic detection of text's language](#set-automatic-detection-of-texts-language)
+  * [Set verification option](#set-verification-option)
+  * [Set preferred data-sources list](#set-preferred-data-sources-list)
+  * [Combination of parameters.](#combination-of-parameters)
+* [Development](#development)
+
+<!-- vim-markdown-toc -->
 
 ## Requirements
 
 This gem uses REST API to access a running [GNfinder] server. You can find how
-to run it in [GNfinder] README file.
+to run it in [GNfinder] README file. By default it uses
+`https://gnfinder.globalnames.org/api/v1`
 
 ## Installation
 
-To use the gem from a Ruby proect install it using Gemfile, or manually:
-
 ```bash
 gem install gnfinder
 ```
@@ -37,7 +43,7 @@ applications. If you need to find names using other languages, use the
 [source code][client] of this gem for reference. For other usages read
 the original Go-lang [GNfinder] README file.
 
-First you need to create a instance of a `gnfinder` client
+First you need to create an instance of a `gnfinder` client
 
 ```ruby
 require 'gnfinder'
@@ -45,19 +51,18 @@ require 'gnfinder'
 gf = Gnfinder::Client.new
 ```
 
-By default the client will try to connect to `localhost:8778`. If you
-have another location for the server use:
-
-
+By default the client will try to connect to
+`https://gnfinder.globalnames.org/api/v1`. If you have another location for the
+server use:
 
 ```ruby
 require 'gnfinder'
 
 # you can use global public gnfinder server
 # located at finder-rpc.globalnames.org
-gf = Gnfinder::Client.new(host = 'finder-rpc.globalnames.org', port = 80)
+gf = Gnfinder::Client.new(host = 'finder.example.org', port = 80)
 
-# localhost, different port
+# localhost, port 8000
 gf = Gnfinder::Client.new(host = '0.0.0.0', port = 8000)
 ```
 
@@ -85,7 +90,27 @@ puts res.names[0].value
 puts res.names[0].odds
 ```
 
-Returned result will have the following methods for each name:
+### Finding names in a file
+
+Many different file types are supported (PDF, JPB, TIFF, MS Word, MS Excel
+etc).
+
+```ruby
+path = "/path/to/file.pdf"
+res = gf.find_file(path)
+puts res.names[0].value
+```
+
+Support of file-uploading uses 'multipart/form' approach. Here is an 
+illustration for `curl`:
+
+```bash
+curl -v -F sources[]=1 -F sources[]=12 -F file=@file.pdf \
+    https://finder.globalnames.org/api/v1/find
+```
+
+Returned result is quite detailed and contains many accessor methods, for
+example:
 
   * value: name-string cleaned up for verification.
   * verbatim: name-string as it was found in the text.

data/lib/gnfinder/client.rb

@@ -21,6 +21,15 @@ module Gnfinder
       @site['/ping'].get.body
     end
 
+    def find_file(path, opts = {})
+      params = {}
+      update_params(params, opts)
+      file = File.new(path, 'rb')
+      params = params.merge(file: file)
+      resp = @site['find'].post(params)
+      prepare_result(resp)
+    end
+
     def find_url(url, opts = {})
       return to_open_struct({ "names": [] }) if url.to_s.strip == ''
 
@@ -39,29 +48,33 @@ module Gnfinder
 
     # rubocop:disable all
     def find(params, opts = {})
+      update_params(params, opts)
+
+      resp = @site['find'].post params.to_json, {content_type: :json, accept: :json}
+      prepare_result(resp)
+    end
+    # rubocop:enable all
+
+    def prepare_result(response)
+      output = JSON.parse(response.body)
+      res = output['metadata']
+      res['names'] = output['names'] || []
+      res = res.deep_transform_keys(&:underscore)
+      res['names'] = [] if res['names'].nil?
+      to_open_struct(res)
+    end
+
+    # rubocop:disable all
+    def update_params(params, opts)
       params[:noBayes] = true if opts[:no_bayes]
       params[:oddsDetails] = true if opts[:odds_details]
       params[:language] = opts[:language] if opts[:language].to_s.strip != ''
 
-      if opts[:words_around] && opts[:words_around] > 0
-        params[:wordsAround] = opts[:words_around]
-      end
+      params[:wordsAround] = opts[:words_around] if opts[:words_around] && opts[:words_around].positive?
 
       params[:verification] = true if opts[:verification]
 
-      if opts[:sources] && !opts[:sources].empty?
-        params[:sources] = opts[:sources]
-      end
-
-      res = @site['find'].post params.to_json, {content_type: :json, accept: :json}
-      output = JSON.parse(res.body)
-      res = output["metadata"]
-      res["names"] = output["names"] || []
-      res = res.deep_transform_keys(&:underscore)
-      if res["names"].nil?
-        res["names"] = []
-      end
-      to_open_struct(res)
+      params[:sources] = opts[:sources] if opts[:sources] && !opts[:sources].empty?
     end
     # rubocop:enable all
 

data/lib/gnfinder/version.rb

@@ -3,7 +3,7 @@
 # Gnfinder is a namespace module for gndinfer gem.
 module Gnfinder
   # Version corresponds to the minimal supported version of Go gnfinder
-  VERSION = '0.15.5'
+  VERSION = '0.16.1'
 
   def self.version
     VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnfinder
 version: !ruby/object:Gem::Version
-  version: 0.15.5
+  version: 0.16.1
 platform: ruby
 authors:
 - Dmitry Mozzherin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-13 00:00:00.000000000 Z
+date: 2021-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client