cheminee 0.1.35 → 0.1.37
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +5 -4
- data/docs/DefaultApi.md +71 -12
- data/docs/QuerySearchHit.md +1 -1
- data/docs/StructureSearchHit.md +1 -1
- data/lib/cheminee/api/default_api.rb +65 -7
- data/lib/cheminee/models/query_search_hit.rb +2 -6
- data/lib/cheminee/models/structure_search_hit.rb +2 -6
- data/lib/cheminee/version.rb +1 -1
- data/pkg/cheminee-0.1.37.gem +0 -0
- metadata +3 -3
- data/pkg/cheminee-0.1.35.gem +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz: '
|
3
|
+
metadata.gz: 7ddd36c59df6b4a0f859c3add057653cda701fddbf2f28b86fc6f3f41087937e
|
4
|
+
data.tar.gz: '08aa55fcf8e7a310d4fbe44f58d98b7f84dcf6c86488e9e12b2f608f33b814e1'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2b66cbb84cfabbf06950f724e228d3776cf17a99c4f37a832abc6c49fcf2bf567e2e8b47fcd7b7985a51bc4e1f675bced8d73b3cb0ea54af0416eb22c26281cc
|
7
|
+
data.tar.gz: e18fa869193887951222fd4aa19845118b9077fd9f2931505fa72a1c402170531c915f20a21fcab94b2986ffd4387ff0d1db3e78175e602d3932702b79ceedd5
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Cheminée: The Chemical Structure Search Engine
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version: 0.1.
|
10
|
+
- Package version: 0.1.37
|
11
11
|
- Generator version: 7.9.0-SNAPSHOT
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
13
13
|
For more information, please visit [https://github.com/rdkit-rs/cheminee](https://github.com/rdkit-rs/cheminee)
|
@@ -25,16 +25,16 @@ gem build cheminee.gemspec
|
|
25
25
|
Then either install the gem locally:
|
26
26
|
|
27
27
|
```shell
|
28
|
-
gem install ./cheminee-0.1.
|
28
|
+
gem install ./cheminee-0.1.37.gem
|
29
29
|
```
|
30
30
|
|
31
|
-
(for development, run `gem install --dev ./cheminee-0.1.
|
31
|
+
(for development, run `gem install --dev ./cheminee-0.1.37.gem` to install the development dependencies)
|
32
32
|
|
33
33
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
34
34
|
|
35
35
|
Finally add this to the Gemfile:
|
36
36
|
|
37
|
-
gem 'cheminee', '~> 0.1.
|
37
|
+
gem 'cheminee', '~> 0.1.37'
|
38
38
|
|
39
39
|
### Install from Git
|
40
40
|
|
@@ -85,6 +85,7 @@ Class | Method | HTTP request | Description
|
|
85
85
|
*Cheminee::DefaultApi* | [**v1_indexes_index_bulk_index_post**](docs/DefaultApi.md#v1_indexes_index_bulk_index_post) | **POST** /v1/indexes/{index}/bulk_index | Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
|
86
86
|
*Cheminee::DefaultApi* | [**v1_indexes_index_delete**](docs/DefaultApi.md#v1_indexes_index_delete) | **DELETE** /v1/indexes/{index} | Delete an index
|
87
87
|
*Cheminee::DefaultApi* | [**v1_indexes_index_get**](docs/DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | Get extended information about an index
|
88
|
+
*Cheminee::DefaultApi* | [**v1_indexes_index_merge_post**](docs/DefaultApi.md#v1_indexes_index_merge_post) | **POST** /v1/indexes/{index}/merge | Merge segments inside the index
|
88
89
|
*Cheminee::DefaultApi* | [**v1_indexes_index_post**](docs/DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | Create an index
|
89
90
|
*Cheminee::DefaultApi* | [**v1_indexes_index_search_basic_get**](docs/DefaultApi.md#v1_indexes_index_search_basic_get) | **GET** /v1/indexes/{index}/search/basic | Perform basic query search against index
|
90
91
|
*Cheminee::DefaultApi* | [**v1_indexes_index_search_identity_get**](docs/DefaultApi.md#v1_indexes_index_search_identity_get) | **GET** /v1/indexes/{index}/search/identity | Perform identity search (i.e. exact match) against index
|
data/docs/DefaultApi.md
CHANGED
@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost:4001/api*
|
|
11
11
|
| [**v1_indexes_index_bulk_index_post**](DefaultApi.md#v1_indexes_index_bulk_index_post) | **POST** /v1/indexes/{index}/bulk_index | Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable |
|
12
12
|
| [**v1_indexes_index_delete**](DefaultApi.md#v1_indexes_index_delete) | **DELETE** /v1/indexes/{index} | Delete an index |
|
13
13
|
| [**v1_indexes_index_get**](DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | Get extended information about an index |
|
14
|
+
| [**v1_indexes_index_merge_post**](DefaultApi.md#v1_indexes_index_merge_post) | **POST** /v1/indexes/{index}/merge | Merge segments inside the index |
|
14
15
|
| [**v1_indexes_index_post**](DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | Create an index |
|
15
16
|
| [**v1_indexes_index_search_basic_get**](DefaultApi.md#v1_indexes_index_search_basic_get) | **GET** /v1/indexes/{index}/search/basic | Perform basic query search against index |
|
16
17
|
| [**v1_indexes_index_search_identity_get**](DefaultApi.md#v1_indexes_index_search_identity_get) | **GET** /v1/indexes/{index}/search/identity | Perform identity search (i.e. exact match) against index |
|
@@ -457,9 +458,71 @@ No authorization required
|
|
457
458
|
- **Accept**: application/json
|
458
459
|
|
459
460
|
|
461
|
+
## v1_indexes_index_merge_post
|
462
|
+
|
463
|
+
> String v1_indexes_index_merge_post(index)
|
464
|
+
|
465
|
+
Merge segments inside the index
|
466
|
+
|
467
|
+
### Examples
|
468
|
+
|
469
|
+
```ruby
|
470
|
+
require 'time'
|
471
|
+
require 'cheminee'
|
472
|
+
|
473
|
+
api_instance = Cheminee::DefaultApi.new
|
474
|
+
index = 'index_example' # String |
|
475
|
+
|
476
|
+
begin
|
477
|
+
# Merge segments inside the index
|
478
|
+
result = api_instance.v1_indexes_index_merge_post(index)
|
479
|
+
p result
|
480
|
+
rescue Cheminee::ApiError => e
|
481
|
+
puts "Error when calling DefaultApi->v1_indexes_index_merge_post: #{e}"
|
482
|
+
end
|
483
|
+
```
|
484
|
+
|
485
|
+
#### Using the v1_indexes_index_merge_post_with_http_info variant
|
486
|
+
|
487
|
+
This returns an Array which contains the response data, status code and headers.
|
488
|
+
|
489
|
+
> <Array(String, Integer, Hash)> v1_indexes_index_merge_post_with_http_info(index)
|
490
|
+
|
491
|
+
```ruby
|
492
|
+
begin
|
493
|
+
# Merge segments inside the index
|
494
|
+
data, status_code, headers = api_instance.v1_indexes_index_merge_post_with_http_info(index)
|
495
|
+
p status_code # => 2xx
|
496
|
+
p headers # => { ... }
|
497
|
+
p data # => String
|
498
|
+
rescue Cheminee::ApiError => e
|
499
|
+
puts "Error when calling DefaultApi->v1_indexes_index_merge_post_with_http_info: #{e}"
|
500
|
+
end
|
501
|
+
```
|
502
|
+
|
503
|
+
### Parameters
|
504
|
+
|
505
|
+
| Name | Type | Description | Notes |
|
506
|
+
| ---- | ---- | ----------- | ----- |
|
507
|
+
| **index** | **String** | | |
|
508
|
+
|
509
|
+
### Return type
|
510
|
+
|
511
|
+
**String**
|
512
|
+
|
513
|
+
### Authorization
|
514
|
+
|
515
|
+
No authorization required
|
516
|
+
|
517
|
+
### HTTP request headers
|
518
|
+
|
519
|
+
- **Content-Type**: Not defined
|
520
|
+
- **Accept**: application/json, application/json; charset=utf-8
|
521
|
+
|
522
|
+
|
460
523
|
## v1_indexes_index_post
|
461
524
|
|
462
|
-
> <IndexMeta> v1_indexes_index_post(index, schema
|
525
|
+
> <IndexMeta> v1_indexes_index_post(index, schema)
|
463
526
|
|
464
527
|
Create an index
|
465
528
|
|
@@ -472,13 +535,10 @@ require 'cheminee'
|
|
472
535
|
api_instance = Cheminee::DefaultApi.new
|
473
536
|
index = 'index_example' # String |
|
474
537
|
schema = 'schema_example' # String |
|
475
|
-
opts = {
|
476
|
-
sort_by: 'sort_by_example' # String |
|
477
|
-
}
|
478
538
|
|
479
539
|
begin
|
480
540
|
# Create an index
|
481
|
-
result = api_instance.v1_indexes_index_post(index, schema
|
541
|
+
result = api_instance.v1_indexes_index_post(index, schema)
|
482
542
|
p result
|
483
543
|
rescue Cheminee::ApiError => e
|
484
544
|
puts "Error when calling DefaultApi->v1_indexes_index_post: #{e}"
|
@@ -489,12 +549,12 @@ end
|
|
489
549
|
|
490
550
|
This returns an Array which contains the response data, status code and headers.
|
491
551
|
|
492
|
-
> <Array(<IndexMeta>, Integer, Hash)> v1_indexes_index_post_with_http_info(index, schema
|
552
|
+
> <Array(<IndexMeta>, Integer, Hash)> v1_indexes_index_post_with_http_info(index, schema)
|
493
553
|
|
494
554
|
```ruby
|
495
555
|
begin
|
496
556
|
# Create an index
|
497
|
-
data, status_code, headers = api_instance.v1_indexes_index_post_with_http_info(index, schema
|
557
|
+
data, status_code, headers = api_instance.v1_indexes_index_post_with_http_info(index, schema)
|
498
558
|
p status_code # => 2xx
|
499
559
|
p headers # => { ... }
|
500
560
|
p data # => <IndexMeta>
|
@@ -509,7 +569,6 @@ end
|
|
509
569
|
| ---- | ---- | ----------- | ----- |
|
510
570
|
| **index** | **String** | | |
|
511
571
|
| **schema** | **String** | | |
|
512
|
-
| **sort_by** | **String** | | [optional] |
|
513
572
|
|
514
573
|
### Return type
|
515
574
|
|
@@ -681,11 +740,11 @@ api_instance = Cheminee::DefaultApi.new
|
|
681
740
|
index = 'index_example' # String |
|
682
741
|
smiles = 'smiles_example' # String |
|
683
742
|
opts = {
|
684
|
-
use_chirality:
|
743
|
+
use_chirality: true, # Boolean |
|
685
744
|
result_limit: 56, # Integer |
|
686
745
|
tautomer_limit: 56, # Integer |
|
687
746
|
extra_query: 'extra_query_example', # String |
|
688
|
-
use_scaffolds:
|
747
|
+
use_scaffolds: true # Boolean |
|
689
748
|
}
|
690
749
|
|
691
750
|
begin
|
@@ -721,11 +780,11 @@ end
|
|
721
780
|
| ---- | ---- | ----------- | ----- |
|
722
781
|
| **index** | **String** | | |
|
723
782
|
| **smiles** | **String** | | |
|
724
|
-
| **use_chirality** | **
|
783
|
+
| **use_chirality** | **Boolean** | | [optional] |
|
725
784
|
| **result_limit** | **Integer** | | [optional] |
|
726
785
|
| **tautomer_limit** | **Integer** | | [optional] |
|
727
786
|
| **extra_query** | **String** | | [optional] |
|
728
|
-
| **use_scaffolds** | **
|
787
|
+
| **use_scaffolds** | **Boolean** | | [optional] |
|
729
788
|
|
730
789
|
### Return type
|
731
790
|
|
data/docs/QuerySearchHit.md
CHANGED
data/docs/StructureSearchHit.md
CHANGED
@@ -479,11 +479,71 @@ module Cheminee
|
|
479
479
|
return data, status_code, headers
|
480
480
|
end
|
481
481
|
|
482
|
+
# Merge segments inside the index
|
483
|
+
# @param index [String]
|
484
|
+
# @param [Hash] opts the optional parameters
|
485
|
+
# @return [String]
|
486
|
+
def v1_indexes_index_merge_post(index, opts = {})
|
487
|
+
data, _status_code, _headers = v1_indexes_index_merge_post_with_http_info(index, opts)
|
488
|
+
data
|
489
|
+
end
|
490
|
+
|
491
|
+
# Merge segments inside the index
|
492
|
+
# @param index [String]
|
493
|
+
# @param [Hash] opts the optional parameters
|
494
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
495
|
+
def v1_indexes_index_merge_post_with_http_info(index, opts = {})
|
496
|
+
if @api_client.config.debugging
|
497
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.v1_indexes_index_merge_post ...'
|
498
|
+
end
|
499
|
+
# verify the required parameter 'index' is set
|
500
|
+
if @api_client.config.client_side_validation && index.nil?
|
501
|
+
fail ArgumentError, "Missing the required parameter 'index' when calling DefaultApi.v1_indexes_index_merge_post"
|
502
|
+
end
|
503
|
+
# resource path
|
504
|
+
local_var_path = '/v1/indexes/{index}/merge'.sub('{' + 'index' + '}', CGI.escape(index.to_s))
|
505
|
+
|
506
|
+
# query parameters
|
507
|
+
query_params = opts[:query_params] || {}
|
508
|
+
|
509
|
+
# header parameters
|
510
|
+
header_params = opts[:header_params] || {}
|
511
|
+
# HTTP header 'Accept' (if needed)
|
512
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json; charset=utf-8']) unless header_params['Accept']
|
513
|
+
|
514
|
+
# form parameters
|
515
|
+
form_params = opts[:form_params] || {}
|
516
|
+
|
517
|
+
# http body (model)
|
518
|
+
post_body = opts[:debug_body]
|
519
|
+
|
520
|
+
# return_type
|
521
|
+
return_type = opts[:debug_return_type] || 'String'
|
522
|
+
|
523
|
+
# auth_names
|
524
|
+
auth_names = opts[:debug_auth_names] || []
|
525
|
+
|
526
|
+
new_options = opts.merge(
|
527
|
+
:operation => :"DefaultApi.v1_indexes_index_merge_post",
|
528
|
+
:header_params => header_params,
|
529
|
+
:query_params => query_params,
|
530
|
+
:form_params => form_params,
|
531
|
+
:body => post_body,
|
532
|
+
:auth_names => auth_names,
|
533
|
+
:return_type => return_type
|
534
|
+
)
|
535
|
+
|
536
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
537
|
+
if @api_client.config.debugging
|
538
|
+
@api_client.config.logger.debug "API called: DefaultApi#v1_indexes_index_merge_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
539
|
+
end
|
540
|
+
return data, status_code, headers
|
541
|
+
end
|
542
|
+
|
482
543
|
# Create an index
|
483
544
|
# @param index [String]
|
484
545
|
# @param schema [String]
|
485
546
|
# @param [Hash] opts the optional parameters
|
486
|
-
# @option opts [String] :sort_by
|
487
547
|
# @return [IndexMeta]
|
488
548
|
def v1_indexes_index_post(index, schema, opts = {})
|
489
549
|
data, _status_code, _headers = v1_indexes_index_post_with_http_info(index, schema, opts)
|
@@ -494,7 +554,6 @@ module Cheminee
|
|
494
554
|
# @param index [String]
|
495
555
|
# @param schema [String]
|
496
556
|
# @param [Hash] opts the optional parameters
|
497
|
-
# @option opts [String] :sort_by
|
498
557
|
# @return [Array<(IndexMeta, Integer, Hash)>] IndexMeta data, response status code and response headers
|
499
558
|
def v1_indexes_index_post_with_http_info(index, schema, opts = {})
|
500
559
|
if @api_client.config.debugging
|
@@ -514,7 +573,6 @@ module Cheminee
|
|
514
573
|
# query parameters
|
515
574
|
query_params = opts[:query_params] || {}
|
516
575
|
query_params[:'schema'] = schema
|
517
|
-
query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
|
518
576
|
|
519
577
|
# header parameters
|
520
578
|
header_params = opts[:header_params] || {}
|
@@ -702,11 +760,11 @@ module Cheminee
|
|
702
760
|
# @param index [String]
|
703
761
|
# @param smiles [String]
|
704
762
|
# @param [Hash] opts the optional parameters
|
705
|
-
# @option opts [
|
763
|
+
# @option opts [Boolean] :use_chirality
|
706
764
|
# @option opts [Integer] :result_limit
|
707
765
|
# @option opts [Integer] :tautomer_limit
|
708
766
|
# @option opts [String] :extra_query
|
709
|
-
# @option opts [
|
767
|
+
# @option opts [Boolean] :use_scaffolds
|
710
768
|
# @return [Array<StructureSearchHit>]
|
711
769
|
def v1_indexes_index_search_substructure_get(index, smiles, opts = {})
|
712
770
|
data, _status_code, _headers = v1_indexes_index_search_substructure_get_with_http_info(index, smiles, opts)
|
@@ -717,11 +775,11 @@ module Cheminee
|
|
717
775
|
# @param index [String]
|
718
776
|
# @param smiles [String]
|
719
777
|
# @param [Hash] opts the optional parameters
|
720
|
-
# @option opts [
|
778
|
+
# @option opts [Boolean] :use_chirality
|
721
779
|
# @option opts [Integer] :result_limit
|
722
780
|
# @option opts [Integer] :tautomer_limit
|
723
781
|
# @option opts [String] :extra_query
|
724
|
-
# @option opts [
|
782
|
+
# @option opts [Boolean] :use_scaffolds
|
725
783
|
# @return [Array<(Array<StructureSearchHit>, Integer, Hash)>] Array<StructureSearchHit> data, response status code and response headers
|
726
784
|
def v1_indexes_index_search_substructure_get_with_http_info(index, smiles, opts = {})
|
727
785
|
if @api_client.config.debugging
|
@@ -38,7 +38,7 @@ module Cheminee
|
|
38
38
|
# Attribute type mapping.
|
39
39
|
def self.openapi_types
|
40
40
|
{
|
41
|
-
:'extra_data' => :'
|
41
|
+
:'extra_data' => :'Object',
|
42
42
|
:'smiles' => :'String',
|
43
43
|
:'query' => :'String'
|
44
44
|
}
|
@@ -47,6 +47,7 @@ module Cheminee
|
|
47
47
|
# List of attributes with nullable: true
|
48
48
|
def self.openapi_nullable
|
49
49
|
Set.new([
|
50
|
+
:'extra_data',
|
50
51
|
])
|
51
52
|
end
|
52
53
|
|
@@ -89,10 +90,6 @@ module Cheminee
|
|
89
90
|
def list_invalid_properties
|
90
91
|
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
91
92
|
invalid_properties = Array.new
|
92
|
-
if @extra_data.nil?
|
93
|
-
invalid_properties.push('invalid value for "extra_data", extra_data cannot be nil.')
|
94
|
-
end
|
95
|
-
|
96
93
|
if @smiles.nil?
|
97
94
|
invalid_properties.push('invalid value for "smiles", smiles cannot be nil.')
|
98
95
|
end
|
@@ -108,7 +105,6 @@ module Cheminee
|
|
108
105
|
# @return true if the model is valid
|
109
106
|
def valid?
|
110
107
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
111
|
-
return false if @extra_data.nil?
|
112
108
|
return false if @smiles.nil?
|
113
109
|
return false if @query.nil?
|
114
110
|
true
|
@@ -44,7 +44,7 @@ module Cheminee
|
|
44
44
|
# Attribute type mapping.
|
45
45
|
def self.openapi_types
|
46
46
|
{
|
47
|
-
:'extra_data' => :'
|
47
|
+
:'extra_data' => :'Object',
|
48
48
|
:'smiles' => :'String',
|
49
49
|
:'score' => :'Float',
|
50
50
|
:'query' => :'String',
|
@@ -55,6 +55,7 @@ module Cheminee
|
|
55
55
|
# List of attributes with nullable: true
|
56
56
|
def self.openapi_nullable
|
57
57
|
Set.new([
|
58
|
+
:'extra_data',
|
58
59
|
])
|
59
60
|
end
|
60
61
|
|
@@ -109,10 +110,6 @@ module Cheminee
|
|
109
110
|
def list_invalid_properties
|
110
111
|
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
111
112
|
invalid_properties = Array.new
|
112
|
-
if @extra_data.nil?
|
113
|
-
invalid_properties.push('invalid value for "extra_data", extra_data cannot be nil.')
|
114
|
-
end
|
115
|
-
|
116
113
|
if @smiles.nil?
|
117
114
|
invalid_properties.push('invalid value for "smiles", smiles cannot be nil.')
|
118
115
|
end
|
@@ -136,7 +133,6 @@ module Cheminee
|
|
136
133
|
# @return true if the model is valid
|
137
134
|
def valid?
|
138
135
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
139
|
-
return false if @extra_data.nil?
|
140
136
|
return false if @smiles.nil?
|
141
137
|
return false if @score.nil?
|
142
138
|
return false if @query.nil?
|
data/lib/cheminee/version.rb
CHANGED
Binary file
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: cheminee
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.37
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Xavier Lange
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-10-01 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|
@@ -154,7 +154,7 @@ files:
|
|
154
154
|
- lib/cheminee/version.rb
|
155
155
|
- openapi-generator-config.json
|
156
156
|
- openapi.json
|
157
|
-
- pkg/cheminee-0.1.
|
157
|
+
- pkg/cheminee-0.1.37.gem
|
158
158
|
- spec/api/default_api_spec.rb
|
159
159
|
- spec/api_client_spec.rb
|
160
160
|
- spec/configuration_spec.rb
|
data/pkg/cheminee-0.1.35.gem
DELETED
Binary file
|