prepare v1 release (close #96)

Author: dimus

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v1.0.0] - 2022-08-24 Wed
+
+- Add: prepare for v1.0.0
+
 ## [v1.0.0-RC1] - 2022-05-10 Tue
 
 - Add: update gnmatcher, gnames to v1.0.0-RC1

README.md

@@ -10,36 +10,36 @@ search feature.
 
 <!-- vim-markdown-toc GFM -->
 
-- [Citing](#citing)
-- [Features](#features)
-- [Installation](#installation)
-  - [Using Homebrew on Mac OS X, Linux, and Linux on Windows ([WSL2])](#using-homebrew-on-mac-os-x-linux-and-linux-on-windows-wsl2)
-  - [MS Windows](#ms-windows)
-  - [Linux and Mac (without Homebrew)](#linux-and-mac-without-homebrew)
-  - [Compile from source](#compile-from-source)
-- [Usage](#usage)
-  - [As a web service](#as-a-web-service)
-  - [As a RESTful API](#as-a-restful-api)
-  - [One name-string](#one-name-string)
-  - [Many name-strings in a file](#many-name-strings-in-a-file)
-  - [Advanced search](#advanced-search)
-  - [Options and flags](#options-and-flags)
-    - [help](#help)
-    - [version](#version)
-    - [port](#port)
-    - [all_matches](#all_matches)
-    - [capitalize](#capitalize)
-    - [species group](#species-group)
-    - [format](#format)
-    - [jobs](#jobs)
-    - [quiet](#quiet)
-    - [sources](#sources)
-  - [web-logs](#web-logs)
-  - [nsqd-tcp](#nsqd-tcp)
-  - [Configuration file](#configuration-file)
-  - [Advanced Search Query Language](#advanced-search-query-language)
-    - [Examples of searches](#examples-of-searches)
-- [Copyright](#copyright)
+* [Citing](#citing)
+* [Features](#features)
+* [Installation](#installation)
+  * [Using Homebrew on Mac OS X, Linux, and Linux on Windows ([WSL2])](#using-homebrew-on-mac-os-x-linux-and-linux-on-windows-wsl2)
+  * [MS Windows](#ms-windows)
+  * [Linux and Mac (without Homebrew)](#linux-and-mac-without-homebrew)
+  * [Compile from source](#compile-from-source)
+* [Usage](#usage)
+  * [As a web service](#as-a-web-service)
+  * [As a RESTful API](#as-a-restful-api)
+  * [One name-string](#one-name-string)
+  * [Many name-strings in a file](#many-name-strings-in-a-file)
+  * [Advanced search](#advanced-search)
+  * [Options and flags](#options-and-flags)
+    * [help](#help)
+    * [version](#version)
+    * [port](#port)
+    * [all_matches](#all_matches)
+    * [capitalize](#capitalize)
+    * [species group](#species-group)
+    * [format](#format)
+    * [jobs](#jobs)
+    * [quiet](#quiet)
+    * [sources](#sources)
+  * [web-logs](#web-logs)
+  * [nsqd-tcp](#nsqd-tcp)
+  * [Configuration file](#configuration-file)
+  * [Advanced Search Query Language](#advanced-search-query-language)
+    * [Examples of searches](#examples-of-searches)
+* [Copyright](#copyright)
 
 <!-- vim-markdown-toc -->
 
@@ -88,7 +88,7 @@ If you want to cite GNverifier, use [DOI generated by Zenodo][zenodo doi]:
 
 Homebrew is a popular package manager for Open Source software originally
 developed for Mac OS X. Now it is also available on Linux, and can easily
-be used on Windows 10, if Windows Subsystem for Linux (WSL) is
+be used on Windows 10 or 11, if Windows Subsystem for Linux (WSL) is
 [installed][wsl install].
 
 To use [GNverifier] with Homebrew:
@@ -117,8 +117,8 @@ mkdir C:\Users\your_username\bin
 copy path_to\gnverifier.exe C:\Users\your_username\bin
 ```
 
-[Add `C:\Users\your_username\bin` directory to your `PATH`][winpath]
-environment variable.
+[Add `C:\Users\your_username\bin` directory to your `PATH`][winpath] `user`
+and/or `system` environment variable.
 
 Another, simpler way, would be to use `cd C:\Users\your_username\bin` command
 in `cmd` terminal window. The [GNverifier] program then will be automatically
@@ -462,9 +462,6 @@ to enter several settings at once loosely following rules of nomenclature
 (`n:B. bubo Linn. 1758`). For example, in contrast with GNparser results, it
 is possible to have abbreviated specific epithets or range in years: `n:Mono. gall. Oliv. 1750-1800`.
 
-The query language is in `Beta` stage, and might change to some degree, to
-improve its functionality.
-
 Often there are errors in species eptithets gender. Because of that search
 will try to detect names in any gender that correspond to the epithet.
 
@@ -502,11 +499,11 @@ details.
 [default gnverifier.yaml]: https://github.com/gnames/gnverifier/blob/master/gnverifier/cmd/gnverifier.yaml
 [dimus]: https://github.com/dimus
 [latest release]: https://github.com/gnames/gnverifier/releases/latest
-[gnames]: https://apidoc.globalnames.org/gnames-beta
+[gnames]: https://apidoc.globalnames.org/gnames
 [go-install]: https://golang.org/doc/install
 [test directory]: https://github.com/gnames/gnverifier/tree/master/testdata
 [ubio]: https://ubio.org/
-[verifier api]: https://apidoc.globalnames.org/gnames-beta
+[verifier api]: https://apidoc.globalnames.org/gnames
 [web-service]: https://verifier.globalnames.org
 [win-pdf]: https://github.com/gnames/gnverifier/blob/master/use-gnverifier-windows.pdf
 [winpath]: https://www.computerhope.com/issues/ch000549.htm

config/config.go

@@ -91,7 +91,7 @@ func OptFormat(f gnfmt.Format) Option {
 	}
 }
 
-//OptJobs sets number of jobs to run in parallel.
+// OptJobs sets number of jobs to run in parallel.
 func OptJobs(i int) Option {
 	return func(cnf *Config) {
 		cnf.Jobs = i
@@ -169,7 +169,7 @@ func OptWithWebLogs(b bool) Option {
 func New(opts ...Option) Config {
 	cnf := Config{
 		Format:            gnfmt.CSV,
-		VerifierURL:       "https://verifier.globalnames.org/api/v0/",
+		VerifierURL:       "https://verifier.globalnames.org/api/v1/",
 		Batch:             5000,
 		Jobs:              4,
 		NamesNumThreshold: 20,

config/config_test.go

@@ -14,7 +14,7 @@ func TestConfigDefault(t *testing.T) {
 	cnf := config.New()
 	deflt := config.Config{
 		Format:      gnfmt.CSV,
-		VerifierURL: "https://verifier.globalnames.org/api/v0/",
+		VerifierURL: "https://verifier.globalnames.org/api/v1/",
 	}
 	assert.Equal(t, deflt.Format, cnf.Format)
 	assert.Equal(t, deflt.VerifierURL, cnf.VerifierURL)

gnverifier/cmd/gnverifier.yaml

@@ -5,7 +5,7 @@
 # DataSources is a list of data-source IDs that should always return
 # matched records if they are found.
 # You can find list of all data-sources at
-# https://verifier.globalnames.org/api/v0/data_sources
+# https://verifier.globalnames.org/api/v1/data_sources
 #
 # If DataSources are set to 0, results are returned from all sources.
 # DataSources:
@@ -34,7 +34,7 @@
 
 # VerifierURL is a URL to gnames REST API
 #
-# VerifierURL: "https://verifier.globalnames.org/api/v0/"
+# VerifierURL: "https://verifier.globalnames.org/api/v1/"
 
 # Jobs is number of jobs to run in parallel.
 #

gnverifier/cmd/root.go

@@ -213,7 +213,7 @@ func init() {
   195 - AlgaeBase`)
 	rootCmd.Flags().StringP("verifier_url", "v", "",
 		`URL for verification service.
-  Default: https://verifier.globalnames.org/api/v0`)
+  Default: https://verifier.globalnames.org/api/v1`)
 	rootCmd.Flags().BoolP("web-logs", "", false, "enable logs for the web service")
 	rootCmd.Flags().StringP("nsqd-tcp", "", "", "an addresss pointing to NSQ TCP service for logs redirection (e.g. 127.0.0.1:4150)")
 }

go.mod

@@ -1,6 +1,6 @@
 module github.com/gnames/gnverifier
 
-go 1.18
+go 1.19
 
 require (
 	github.com/dnaeon/go-vcr v1.2.0

io/verifrest/fixtures/capitalize.yaml

@@ -7,7 +7,7 @@ interactions:
     headers:
       Content-Type:
       - application/json
-    url: https://verifier.globalnames.org/api/v0/verifications
+    url: https://verifier.globalnames.org/api/v1/verifications
     method: POST
   response:
     body: |

io/verifrest/fixtures/ds4.yaml

@@ -7,7 +7,7 @@ interactions:
     headers:
       Content-Type:
       - application/json
-    url: https://verifier.globalnames.org/api/v0/data_sources/4
+    url: https://verifier.globalnames.org/api/v1/data_sources/4
     method: GET
   response:
     body: |

io/verifrest/fixtures/dss.yaml

@@ -7,7 +7,7 @@ interactions:
     headers:
       Content-Type:
       - application/json
-    url: https://verifier.globalnames.org/api/v0/data_sources
+    url: https://verifier.globalnames.org/api/v1/data_sources
     method: GET
   response:
     body: |

io/verifrest/fixtures/name.yaml

@@ -7,7 +7,7 @@ interactions:
     headers:
       Content-Type:
       - application/json
-    url: https://verifier.globalnames.org/api/v0/verifications
+    url: https://verifier.globalnames.org/api/v1/verifications
     method: POST
   response:
     body: |

io/verifrest/fixtures/name_pref.yaml

@@ -7,7 +7,7 @@ interactions:
     headers:
       Content-Type:
       - application/json
-    url: https://verifier.globalnames.org/api/v0/verifications
+    url: https://verifier.globalnames.org/api/v1/verifications
     method: POST
   response:
     body: |

io/verifrest/fixtures/names.yaml

@@ -8,7 +8,7 @@ interactions:
     headers:
       Content-Type:
       - application/json
-    url: https://verifier.globalnames.org/api/v0/verifications
+    url: https://verifier.globalnames.org/api/v1/verifications
     method: POST
   response:
     body: |

io/verifrest/fixtures/search.yaml

@@ -7,7 +7,7 @@ interactions:
     headers:
       Content-Type:
       - application/json
-    url: https://verifier.globalnames.org/api/v0/search/n:Bubo%20bubo%20all:true
+    url: https://verifier.globalnames.org/api/v1/search/n:Bubo%20bubo%20all:true
     method: GET
   response:
     body: |

io/verifrest/verifrest_internal_test.go

@@ -11,7 +11,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-var urlAPI = "https://verifier.globalnames.org/api/v0/"
+var urlAPI = "https://verifier.globalnames.org/api/v1/"
 
 func TestDataSources(t *testing.T) {
 	r, err := recorder.New("fixtures/dss")

io/web/templates/api.html

@@ -1,4 +1,4 @@
-{{ define "api" }}   
+{{ define "api" }}
 <div id="content-splash">
   <h2>Application Programming Interface (API)</h2>
 </div>
@@ -14,16 +14,16 @@ <h3 id="get">GET</h3>
   </p>
 
   <pre class='code'>
-    /api/v0/verifications/Aus+bus|Aus+bus+D.+%26+M.,+1870
+    /api/v1/verifications/Aus+bus|Aus+bus+D.+%26+M.,+1870
   </pre>
 
   <h3 id="post">POST</h3>
 
-  <p><code>/api/v0/verifications</code></p>
+  <p><code>/api/v1/verifications</code></p>
 
   <p>
     with request body in JSON format according to
-    <a href="https://apidoc.globalnames.org/gnames-beta">
+    <a href="https://apidoc.globalnames.org/gnames">
       specification
     </a>:
   </p>
@@ -45,7 +45,7 @@ <h3 id="post">POST</h3>
   <h3> OpenAPI Schema</h3>
   <p>
     Read the GNames's
-    <a href="https://apidoc.globalnames.org/gnames-beta">
+    <a href="https://apidoc.globalnames.org/gnames">
       Verification OpenAPI documentation
     </a> to learn about all options and the output schema.
   </p>

version.go

@@ -2,7 +2,7 @@ package gnverifier
 
 var (
 	// Version of the gnverifier
-	Version = "v1.0.0-RC1"
+	Version = "v1.0.0+"
 	// Build timestamp
 	Build = "n/a"
 )