cheminee 0.1.21 → 0.1.22

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 94540570dc590389820fe841bb3d558f78e6c9af38b3e7cf0fce6ff15feb4341
4
- data.tar.gz: dcca2f608d6482fd53e0a6945033027c0c45e6aecb8a39b7e560080abe7d5be0
3
+ metadata.gz: fd0fd97ae51080c209966e664af3d010b5039209f090bb675ed8c8fabb9b54cd
4
+ data.tar.gz: 0b64fcebc54a5a300b823e15c5a5675579ba82f413d45f45829878ca8d86f61d
5
5
  SHA512:
6
- metadata.gz: 89a4957b0f810d2013e6b99d07ccf8b9325b829490c3ea9abafc1017e315e89848c5acb8dde935e764200ea50f30e6f5f10f3420f2d583b94aa1ea217d059b6b
7
- data.tar.gz: 960a8638b55c76baa9396a1e1d01d1f88f51a34c1460131ba4178d4a13249fff4bd565397f0cb51cde2fab7dd4f819de1b115e5d621d9c8f947a134c4cdd81a7
6
+ metadata.gz: 2d19c6eb9230b6636e5744bddc2bc070687fa9f6d6cadf5434770b8ba7d9ebda7c364353c58bc6a378077b09679bc7db0935f0b1650e7e64ea72ec592139bfc2
7
+ data.tar.gz: 6b4108795132e7b21cd6f9e4bd2f46933cb7fc6935043b2c0f95b9b24ee7a0f0673266e341804160789dc3d154b86c7cace186bb6b4ac8bf6f6e7f6cefb09e87
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cheminee (0.1.21)
4
+ cheminee (0.1.22)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -17,7 +17,7 @@ GEM
17
17
  jaro_winkler (1.5.6)
18
18
  method_source (1.1.0)
19
19
  parallel (1.25.1)
20
- parser (3.3.3.0)
20
+ parser (3.3.4.0)
21
21
  ast (~> 2.4.1)
22
22
  racc
23
23
  pry (0.14.2)
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.21
10
+ - Package version: 0.1.22
11
11
  - Generator version: 7.8.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.21.gem
28
+ gem install ./cheminee-0.1.22.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./cheminee-0.1.21.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./cheminee-0.1.22.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.21'
37
+ gem 'cheminee', '~> 0.1.22'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -84,6 +84,7 @@ Class | Method | HTTP request | Description
84
84
  *Cheminee::DefaultApi* | [**v1_indexes_index_get**](docs/DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | Get extended information about an index
85
85
  *Cheminee::DefaultApi* | [**v1_indexes_index_post**](docs/DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | Create an index
86
86
  *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
87
+ *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
87
88
  *Cheminee::DefaultApi* | [**v1_indexes_index_search_substructure_get**](docs/DefaultApi.md#v1_indexes_index_search_substructure_get) | **GET** /v1/indexes/{index}/search/substructure | Perform substructure search against index
88
89
  *Cheminee::DefaultApi* | [**v1_schemas_get**](docs/DefaultApi.md#v1_schemas_get) | **GET** /v1/schemas | List schemas available for creating indexes
89
90
  *Cheminee::DefaultApi* | [**v1_standardize_post**](docs/DefaultApi.md#v1_standardize_post) | **POST** /v1/standardize | Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
data/docs/DefaultApi.md CHANGED
@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost:4001/api*
10
10
  | [**v1_indexes_index_get**](DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | Get extended information about an index |
11
11
  | [**v1_indexes_index_post**](DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | Create an index |
12
12
  | [**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 |
13
+ | [**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 |
13
14
  | [**v1_indexes_index_search_substructure_get**](DefaultApi.md#v1_indexes_index_search_substructure_get) | **GET** /v1/indexes/{index}/search/substructure | Perform substructure search against index |
14
15
  | [**v1_schemas_get**](DefaultApi.md#v1_schemas_get) | **GET** /v1/schemas | List schemas available for creating indexes |
15
16
  | [**v1_standardize_post**](DefaultApi.md#v1_standardize_post) | **POST** /v1/standardize | Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines |
@@ -400,6 +401,76 @@ No authorization required
400
401
  - **Accept**: application/json; charset=utf-8
401
402
 
402
403
 
404
+ ## v1_indexes_index_search_identity_get
405
+
406
+ > <Array<StructureSearchHit>> v1_indexes_index_search_identity_get(index, smiles, opts)
407
+
408
+ Perform identity search (i.e. exact match) against index
409
+
410
+ ### Examples
411
+
412
+ ```ruby
413
+ require 'time'
414
+ require 'cheminee'
415
+
416
+ api_instance = Cheminee::DefaultApi.new
417
+ index = 'index_example' # String |
418
+ smiles = 'smiles_example' # String |
419
+ opts = {
420
+ extra_query: 'extra_query_example', # String |
421
+ use_scaffolds: 'use_scaffolds_example' # String |
422
+ }
423
+
424
+ begin
425
+ # Perform identity search (i.e. exact match) against index
426
+ result = api_instance.v1_indexes_index_search_identity_get(index, smiles, opts)
427
+ p result
428
+ rescue Cheminee::ApiError => e
429
+ puts "Error when calling DefaultApi->v1_indexes_index_search_identity_get: #{e}"
430
+ end
431
+ ```
432
+
433
+ #### Using the v1_indexes_index_search_identity_get_with_http_info variant
434
+
435
+ This returns an Array which contains the response data, status code and headers.
436
+
437
+ > <Array(<Array<StructureSearchHit>>, Integer, Hash)> v1_indexes_index_search_identity_get_with_http_info(index, smiles, opts)
438
+
439
+ ```ruby
440
+ begin
441
+ # Perform identity search (i.e. exact match) against index
442
+ data, status_code, headers = api_instance.v1_indexes_index_search_identity_get_with_http_info(index, smiles, opts)
443
+ p status_code # => 2xx
444
+ p headers # => { ... }
445
+ p data # => <Array<StructureSearchHit>>
446
+ rescue Cheminee::ApiError => e
447
+ puts "Error when calling DefaultApi->v1_indexes_index_search_identity_get_with_http_info: #{e}"
448
+ end
449
+ ```
450
+
451
+ ### Parameters
452
+
453
+ | Name | Type | Description | Notes |
454
+ | ---- | ---- | ----------- | ----- |
455
+ | **index** | **String** | | |
456
+ | **smiles** | **String** | | |
457
+ | **extra_query** | **String** | | [optional] |
458
+ | **use_scaffolds** | **String** | | [optional] |
459
+
460
+ ### Return type
461
+
462
+ [**Array&lt;StructureSearchHit&gt;**](StructureSearchHit.md)
463
+
464
+ ### Authorization
465
+
466
+ No authorization required
467
+
468
+ ### HTTP request headers
469
+
470
+ - **Content-Type**: Not defined
471
+ - **Accept**: application/json; charset=utf-8
472
+
473
+
403
474
  ## v1_indexes_index_search_substructure_get
404
475
 
405
476
  > <Array<StructureSearchHit>> v1_indexes_index_search_substructure_get(index, smiles, opts)
@@ -56,7 +56,7 @@ module Cheminee
56
56
  # header parameters
57
57
  header_params = opts[:header_params] || {}
58
58
  # HTTP header 'Accept' (if needed)
59
- header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
59
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
60
60
  # HTTP header 'Content-Type'
61
61
  content_type = @api_client.select_header_content_type(['application/json; charset=utf-8'])
62
62
  if !content_type.nil?
@@ -116,7 +116,7 @@ module Cheminee
116
116
  # header parameters
117
117
  header_params = opts[:header_params] || {}
118
118
  # HTTP header 'Accept' (if needed)
119
- header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
119
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
120
120
 
121
121
  # form parameters
122
122
  form_params = opts[:form_params] || {}
@@ -183,7 +183,7 @@ module Cheminee
183
183
  # header parameters
184
184
  header_params = opts[:header_params] || {}
185
185
  # HTTP header 'Accept' (if needed)
186
- header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
186
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
187
187
  # HTTP header 'Content-Type'
188
188
  content_type = @api_client.select_header_content_type(['application/json; charset=utf-8'])
189
189
  if !content_type.nil?
@@ -249,7 +249,7 @@ module Cheminee
249
249
  # header parameters
250
250
  header_params = opts[:header_params] || {}
251
251
  # HTTP header 'Accept' (if needed)
252
- header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
252
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
253
253
 
254
254
  # form parameters
255
255
  form_params = opts[:form_params] || {}
@@ -320,7 +320,7 @@ module Cheminee
320
320
  # header parameters
321
321
  header_params = opts[:header_params] || {}
322
322
  # HTTP header 'Accept' (if needed)
323
- header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
323
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
324
324
 
325
325
  # form parameters
326
326
  form_params = opts[:form_params] || {}
@@ -391,7 +391,7 @@ module Cheminee
391
391
  # header parameters
392
392
  header_params = opts[:header_params] || {}
393
393
  # HTTP header 'Accept' (if needed)
394
- header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
394
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
395
395
 
396
396
  # form parameters
397
397
  form_params = opts[:form_params] || {}
@@ -422,6 +422,80 @@ module Cheminee
422
422
  return data, status_code, headers
423
423
  end
424
424
 
425
+ # Perform identity search (i.e. exact match) against index
426
+ # @param index [String]
427
+ # @param smiles [String]
428
+ # @param [Hash] opts the optional parameters
429
+ # @option opts [String] :extra_query
430
+ # @option opts [String] :use_scaffolds
431
+ # @return [Array<StructureSearchHit>]
432
+ def v1_indexes_index_search_identity_get(index, smiles, opts = {})
433
+ data, _status_code, _headers = v1_indexes_index_search_identity_get_with_http_info(index, smiles, opts)
434
+ data
435
+ end
436
+
437
+ # Perform identity search (i.e. exact match) against index
438
+ # @param index [String]
439
+ # @param smiles [String]
440
+ # @param [Hash] opts the optional parameters
441
+ # @option opts [String] :extra_query
442
+ # @option opts [String] :use_scaffolds
443
+ # @return [Array<(Array<StructureSearchHit>, Integer, Hash)>] Array<StructureSearchHit> data, response status code and response headers
444
+ def v1_indexes_index_search_identity_get_with_http_info(index, smiles, opts = {})
445
+ if @api_client.config.debugging
446
+ @api_client.config.logger.debug 'Calling API: DefaultApi.v1_indexes_index_search_identity_get ...'
447
+ end
448
+ # verify the required parameter 'index' is set
449
+ if @api_client.config.client_side_validation && index.nil?
450
+ fail ArgumentError, "Missing the required parameter 'index' when calling DefaultApi.v1_indexes_index_search_identity_get"
451
+ end
452
+ # verify the required parameter 'smiles' is set
453
+ if @api_client.config.client_side_validation && smiles.nil?
454
+ fail ArgumentError, "Missing the required parameter 'smiles' when calling DefaultApi.v1_indexes_index_search_identity_get"
455
+ end
456
+ # resource path
457
+ local_var_path = '/v1/indexes/{index}/search/identity'.sub('{' + 'index' + '}', CGI.escape(index.to_s))
458
+
459
+ # query parameters
460
+ query_params = opts[:query_params] || {}
461
+ query_params[:'smiles'] = smiles
462
+ query_params[:'extra_query'] = opts[:'extra_query'] if !opts[:'extra_query'].nil?
463
+ query_params[:'use_scaffolds'] = opts[:'use_scaffolds'] if !opts[:'use_scaffolds'].nil?
464
+
465
+ # header parameters
466
+ header_params = opts[:header_params] || {}
467
+ # HTTP header 'Accept' (if needed)
468
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
469
+
470
+ # form parameters
471
+ form_params = opts[:form_params] || {}
472
+
473
+ # http body (model)
474
+ post_body = opts[:debug_body]
475
+
476
+ # return_type
477
+ return_type = opts[:debug_return_type] || 'Array<StructureSearchHit>'
478
+
479
+ # auth_names
480
+ auth_names = opts[:debug_auth_names] || []
481
+
482
+ new_options = opts.merge(
483
+ :operation => :"DefaultApi.v1_indexes_index_search_identity_get",
484
+ :header_params => header_params,
485
+ :query_params => query_params,
486
+ :form_params => form_params,
487
+ :body => post_body,
488
+ :auth_names => auth_names,
489
+ :return_type => return_type
490
+ )
491
+
492
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
493
+ if @api_client.config.debugging
494
+ @api_client.config.logger.debug "API called: DefaultApi#v1_indexes_index_search_identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
495
+ end
496
+ return data, status_code, headers
497
+ end
498
+
425
499
  # Perform substructure search against index
426
500
  # @param index [String]
427
501
  # @param smiles [String]
@@ -471,7 +545,7 @@ module Cheminee
471
545
  # header parameters
472
546
  header_params = opts[:header_params] || {}
473
547
  # HTTP header 'Accept' (if needed)
474
- header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
548
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
475
549
 
476
550
  # form parameters
477
551
  form_params = opts[:form_params] || {}
@@ -526,7 +600,7 @@ module Cheminee
526
600
  # header parameters
527
601
  header_params = opts[:header_params] || {}
528
602
  # HTTP header 'Accept' (if needed)
529
- header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
603
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
530
604
 
531
605
  # form parameters
532
606
  form_params = opts[:form_params] || {}
@@ -590,7 +664,7 @@ module Cheminee
590
664
  # header parameters
591
665
  header_params = opts[:header_params] || {}
592
666
  # HTTP header 'Accept' (if needed)
593
- header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
667
+ header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) unless header_params['Accept']
594
668
  # HTTP header 'Content-Type'
595
669
  content_type = @api_client.select_header_content_type(['application/json; charset=utf-8'])
596
670
  if !content_type.nil?
@@ -11,5 +11,5 @@ Generator version: 7.8.0-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module Cheminee
14
- VERSION = '0.1.21'
14
+ VERSION = '0.1.22'
15
15
  end
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.21
4
+ version: 0.1.22
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-07-08 00:00:00.000000000 Z
11
+ date: 2024-07-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -116,7 +116,7 @@ files:
116
116
  - lib/cheminee/version.rb
117
117
  - openapi-generator-config.json
118
118
  - openapi.json
119
- - pkg/cheminee-0.1.21.gem
119
+ - pkg/cheminee-0.1.22.gem
120
120
  - spec/api/default_api_spec.rb
121
121
  - spec/api_client_spec.rb
122
122
  - spec/configuration_spec.rb
Binary file