gnfinder 0.15.4.1 → 0.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d4e2adc23e4ffd6a025c50ff224e30a788a68ed82230a2df3056c5c6ec6181d
-  data.tar.gz: 8eb3c0c31d94e69abebdffcbad11fcab26ee2aaa83571ae7cdd4be1e8efa6d2c
+  metadata.gz: fbac598ce79e8e9db5ad0fd4f24b5004b2cf4f91d3f5fae0ece871b525d1f488
+  data.tar.gz: 36abaa471d385f27ae6bfa32f6f960bb7bc3a1b258b0b2a5402826e41d629d6f
 SHA512:
-  metadata.gz: 7557354c2fe98ed21eedd0ff461a44eb9cc8f1415a8b23f9acc894d50f9568a1b290ef4b12d21e5e883f7aae1c0fb8ada990fa2a122ebe2a95f13f13a45bb6fe
-  data.tar.gz: 0ede5ae354bca00835a7a31ee274cb9a266df7a73850ea98c29b3708adbb7eb06dbe19b7546d05fe2948f0d9ee5d3b17d4828c895fe3cc5d9ee0d001d03f4612
+  metadata.gz: 5e6a3e825edfaa873e0d178a7323d7a9b6124292e940e504834b48d8127e18ae08298044458b15fc1125abf9b98afcd1faa292eadfb6edf64f80d6b3d89d43d7
+  data.tar.gz: 68e7871b2ce105ca751c63b391ca7477a33ce965c88d6ef87235635fd8aebbfba18e856c549d0e0a26d2a4228f0a0bf46ab8cce58892c677824273f6c1f9d259

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## [v0.15.5]
+
+- Add [#16]: Search names using URL.
+
 ## [v0.15.4]
 
 - Add [#14]: Compatibility with gnfider v0.15.4, switching to REST API.

data/README.md

@@ -1,10 +1,10 @@
 # gnfinder
 
-Ruby gem to access functionality of [gnfinder] project written in Go. This gem
+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)
+- [GNfinder](#gnfinder)
   - [Requirements](#requirements)
   - [Installation](#installation)
   - [Usage](#usage)
@@ -19,12 +19,12 @@ plain texts for Ruby-based projects.
 
 ## Requirements
 
-This gem uses gRPC to access a running [gnfinder] server. You can find how
-to run it in [gnfinder] README file.
+This gem uses REST API to access a running [GNfinder] server. You can find how
+to run it in [GNfinder] README file.
 
 ## Installation
 
-To use the gem from Ruby proect install it using Gemfile, or manually:
+To use the gem from a Ruby proect install it using Gemfile, or manually:
 
 ```bash
 gem install gnfinder
@@ -32,10 +32,10 @@ gem install gnfinder
 
 ## Usage
 
-The purpose of this gem is to access [gnfinder] functionality out of Ruby
+The purpose of this gem is to access [GNfinder] functionality from Ruby
 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.
+the original Go-lang [GNfinder] README file.
 
 First you need to create a instance of a `gnfinder` client
 
@@ -63,7 +63,7 @@ gf = Gnfinder::Client.new(host = '0.0.0.0', port = 8000)
 
 ### Finding names in a text using default settings
 
-You can find format of returning result in [proto file] or in [tests]
+You can find format of returning result in [GNfinder API docs]
 
 ```ruby
 txt = File.read('utf8-text-with-names.txt')
@@ -73,6 +73,18 @@ puts res.names[0].value
 puts res.names[0].odds
 ```
 
+### Finding names by a URL
+
+If you need to find names in an HTML page, or a PDF document available on
+Internet, use `find_url` method.
+
+```ruby
+url = 'https://en.wikipedia.org/wiki/Monochamus_galloprovincialis'
+res = gf.find_url(url)
+puts res.names[0].value
+puts res.names[0].odds
+```
+
 Returned result will have the following methods for each name:
 
   * value: name-string cleaned up for verification.
@@ -173,21 +185,6 @@ res = gf.find_names(txt, language: 'eng', sources: [1, 4, 179])
 
 ## Development
 
-This gem uses gRPC to access [gnfinder] server. gRPC in turn depends on a
-protobuf library. If you need to compile Ruby programs with protobuf you need
-to install [Go] language and download [gnfinder] project.
-
-```bash
-go get github.com/gnames/gnfinder
-```
-Then you need to run bundle from the root of the project and generate
-grpc files:
-
-```bash
-bundle
-rake grpc
-```
-
 If you get an error, you might need to set a ``GOPATH`` environment variable.
 
 After starting the server with default host and port (localhost:8778) you will
@@ -208,10 +205,10 @@ To run tests without rubocop
 bundle exec rspec
 ```
 
-[gnfinder]: https://github.com/gnames/gnfinder
+[GNfinder]: https://github.com/gnames/gnfinder
 [gnfinder recent release]: https://github.com/gnames/gnfinder/releases
 [Go]: https://golang.org/doc/install
 [client]: https://github.com/GlobalNamesArchitecture/gnfinder/blob/master/lib/gnfinder/client.rb
 [data-source list]: http://index.globalnames.org/datasource
-[proto file]: https://github.com/GlobalNamesArchitecture/gnfinder/blob/master/lib/protob_pb.rb
 [tests]: https://github.com/GlobalNamesArchitecture/gnfinder/blob/master/spec/lib/client_spec.rb
+[GNfinder API docs]: https://apidoc.globalnames.org/gnfinder

data/lib/gnfinder/client.rb

@@ -21,13 +21,24 @@ module Gnfinder
       @site['/ping'].get.body
     end
 
-    # rubocop:disable all
+    def find_url(url, opts = {})
+      return to_open_struct({ "names": [] }) if url.to_s.strip == ''
+
+      params = { url: url }
+      find(params, opts)
+    end
+
     def find_names(text, opts = {})
-      if text.to_s.strip == ''
-        return to_open_struct({ "names": [] })
-      end
+      return to_open_struct({ "names": [] }) if text.to_s.strip == ''
 
       params = { text: text }
+      find(params, opts)
+    end
+
+    private
+
+    # rubocop:disable all
+    def find(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 != ''
@@ -54,8 +65,6 @@ module Gnfinder
     end
     # rubocop:enable all
 
-    private
-
     def to_open_struct(obj)
       case obj
       when Hash

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.4.1'
+  VERSION = '0.15.5'
 
   def self.version
     VERSION

metadata

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