cheminee 0.0.14

Sign up to get free protection for your applications and to get access to all the features.
Files changed (82) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +72 -0
  4. data/README.md +112 -0
  5. data/Rakefile +10 -0
  6. data/cheminee.gemspec +39 -0
  7. data/docs/BulkRequest.md +18 -0
  8. data/docs/BulkRequestDoc.md +20 -0
  9. data/docs/CreateIndexError.md +18 -0
  10. data/docs/DefaultApi.md +529 -0
  11. data/docs/GetIndexesResponseError.md +18 -0
  12. data/docs/IndexMeta.md +20 -0
  13. data/docs/IndexSchema.md +20 -0
  14. data/docs/ListIndexResponseErr.md +18 -0
  15. data/docs/PostIndexBulkResponseError.md +18 -0
  16. data/docs/PostIndexBulkResponseOk.md +18 -0
  17. data/docs/PostIndexBulkResponseOkStatus.md +20 -0
  18. data/docs/QueryResponseError.md +18 -0
  19. data/docs/QuerySearchHit.md +22 -0
  20. data/docs/Schema.md +20 -0
  21. data/docs/Smile.md +18 -0
  22. data/docs/Smiles.md +18 -0
  23. data/docs/StandardizedSmile.md +20 -0
  24. data/docs/StandardizedSmiles.md +20 -0
  25. data/docs/StructureResponseError.md +18 -0
  26. data/docs/StructureSearchHit.md +26 -0
  27. data/docs/SubstructureSearchHit.md +24 -0
  28. data/git_push.sh +57 -0
  29. data/lib/cheminee/api/default_api.rb +550 -0
  30. data/lib/cheminee/api_client.rb +393 -0
  31. data/lib/cheminee/api_error.rb +58 -0
  32. data/lib/cheminee/configuration.rb +291 -0
  33. data/lib/cheminee/models/bulk_request.rb +223 -0
  34. data/lib/cheminee/models/bulk_request_doc.rb +232 -0
  35. data/lib/cheminee/models/create_index_error.rb +221 -0
  36. data/lib/cheminee/models/get_indexes_response_error.rb +221 -0
  37. data/lib/cheminee/models/index_meta.rb +237 -0
  38. data/lib/cheminee/models/index_schema.rb +233 -0
  39. data/lib/cheminee/models/list_index_response_err.rb +221 -0
  40. data/lib/cheminee/models/post_index_bulk_response_error.rb +221 -0
  41. data/lib/cheminee/models/post_index_bulk_response_ok.rb +223 -0
  42. data/lib/cheminee/models/post_index_bulk_response_ok_status.rb +223 -0
  43. data/lib/cheminee/models/query_response_error.rb +221 -0
  44. data/lib/cheminee/models/query_search_hit.rb +249 -0
  45. data/lib/cheminee/models/schema.rb +233 -0
  46. data/lib/cheminee/models/smile.rb +221 -0
  47. data/lib/cheminee/models/smiles.rb +221 -0
  48. data/lib/cheminee/models/standardized_smile.rb +223 -0
  49. data/lib/cheminee/models/standardized_smiles.rb +223 -0
  50. data/lib/cheminee/models/structure_response_error.rb +221 -0
  51. data/lib/cheminee/models/structure_search_hit.rb +281 -0
  52. data/lib/cheminee/models/substructure_search_hit.rb +265 -0
  53. data/lib/cheminee/version.rb +15 -0
  54. data/lib/cheminee.rb +57 -0
  55. data/openapi-generator-config.json +7 -0
  56. data/openapi.json +77 -0
  57. data/pkg/cheminee-0.0.14.gem +0 -0
  58. data/spec/api/default_api_spec.rb +45 -0
  59. data/spec/api_client_spec.rb +228 -0
  60. data/spec/configuration_spec.rb +42 -0
  61. data/spec/models/bulk_request_doc_spec.rb +42 -0
  62. data/spec/models/bulk_request_spec.rb +36 -0
  63. data/spec/models/create_index_error_spec.rb +36 -0
  64. data/spec/models/get_indexes_response_error_spec.rb +36 -0
  65. data/spec/models/index_meta_spec.rb +42 -0
  66. data/spec/models/index_schema_spec.rb +42 -0
  67. data/spec/models/list_index_response_err_spec.rb +36 -0
  68. data/spec/models/post_index_bulk_response_error_spec.rb +36 -0
  69. data/spec/models/post_index_bulk_response_ok_spec.rb +36 -0
  70. data/spec/models/post_index_bulk_response_ok_status_spec.rb +42 -0
  71. data/spec/models/query_response_error_spec.rb +36 -0
  72. data/spec/models/query_search_hit_spec.rb +48 -0
  73. data/spec/models/schema_spec.rb +42 -0
  74. data/spec/models/smile_spec.rb +34 -0
  75. data/spec/models/smiles_spec.rb +36 -0
  76. data/spec/models/standardized_smile_spec.rb +40 -0
  77. data/spec/models/standardized_smiles_spec.rb +42 -0
  78. data/spec/models/structure_response_error_spec.rb +36 -0
  79. data/spec/models/structure_search_hit_spec.rb +60 -0
  80. data/spec/models/substructure_search_hit_spec.rb +54 -0
  81. data/spec/spec_helper.rb +111 -0
  82. metadata +187 -0
@@ -0,0 +1,291 @@
1
+ =begin
2
+ #Cheminée
3
+
4
+ #Cheminée: The Chemical Structure Search Engine
5
+
6
+ The version of the OpenAPI document: 1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 7.3.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ module Cheminee
14
+ class Configuration
15
+ # Defines url scheme
16
+ attr_accessor :scheme
17
+
18
+ # Defines url host
19
+ attr_accessor :host
20
+
21
+ # Defines url base path
22
+ attr_accessor :base_path
23
+
24
+ # Define server configuration index
25
+ attr_accessor :server_index
26
+
27
+ # Define server operation configuration index
28
+ attr_accessor :server_operation_index
29
+
30
+ # Default server variables
31
+ attr_accessor :server_variables
32
+
33
+ # Default server operation variables
34
+ attr_accessor :server_operation_variables
35
+
36
+ # Defines API keys used with API Key authentications.
37
+ #
38
+ # @return [Hash] key: parameter name, value: parameter value (API key)
39
+ #
40
+ # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
41
+ # config.api_key['api_key'] = 'xxx'
42
+ attr_accessor :api_key
43
+
44
+ # Defines API key prefixes used with API Key authentications.
45
+ #
46
+ # @return [Hash] key: parameter name, value: API key prefix
47
+ #
48
+ # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
49
+ # config.api_key_prefix['api_key'] = 'Token'
50
+ attr_accessor :api_key_prefix
51
+
52
+ # Defines the username used with HTTP basic authentication.
53
+ #
54
+ # @return [String]
55
+ attr_accessor :username
56
+
57
+ # Defines the password used with HTTP basic authentication.
58
+ #
59
+ # @return [String]
60
+ attr_accessor :password
61
+
62
+ # Defines the access token (Bearer) used with OAuth2.
63
+ attr_accessor :access_token
64
+
65
+ # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
66
+ # Overrides the access_token if set
67
+ # @return [Proc]
68
+ attr_accessor :access_token_getter
69
+
70
+ # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
71
+ # HTTP responses with return type `File` will be returned as a stream of binary data.
72
+ # Default to false.
73
+ attr_accessor :return_binary_data
74
+
75
+ # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
76
+ # details will be logged with `logger.debug` (see the `logger` attribute).
77
+ # Default to false.
78
+ #
79
+ # @return [true, false]
80
+ attr_accessor :debugging
81
+
82
+ # Defines the logger used for debugging.
83
+ # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
84
+ #
85
+ # @return [#debug]
86
+ attr_accessor :logger
87
+
88
+ # Defines the temporary folder to store downloaded files
89
+ # (for API endpoints that have file response).
90
+ # Default to use `Tempfile`.
91
+ #
92
+ # @return [String]
93
+ attr_accessor :temp_folder_path
94
+
95
+ # The time limit for HTTP request in seconds.
96
+ # Default to 0 (never times out).
97
+ attr_accessor :timeout
98
+
99
+ # Set this to false to skip client side validation in the operation.
100
+ # Default to true.
101
+ # @return [true, false]
102
+ attr_accessor :client_side_validation
103
+
104
+ ### TLS/SSL setting
105
+ # Set this to false to skip verifying SSL certificate when calling API from https server.
106
+ # Default to true.
107
+ #
108
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
109
+ #
110
+ # @return [true, false]
111
+ attr_accessor :verify_ssl
112
+
113
+ ### TLS/SSL setting
114
+ # Set this to false to skip verifying SSL host name
115
+ # Default to true.
116
+ #
117
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
118
+ #
119
+ # @return [true, false]
120
+ attr_accessor :verify_ssl_host
121
+
122
+ ### TLS/SSL setting
123
+ # Set this to customize the certificate file to verify the peer.
124
+ #
125
+ # @return [String] the path to the certificate file
126
+ #
127
+ # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
128
+ # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
129
+ attr_accessor :ssl_ca_cert
130
+
131
+ ### TLS/SSL setting
132
+ # Client certificate file (for client certificate)
133
+ attr_accessor :cert_file
134
+
135
+ ### TLS/SSL setting
136
+ # Client private key file (for client certificate)
137
+ attr_accessor :key_file
138
+
139
+ # Set this to customize parameters encoding of array parameter with multi collectionFormat.
140
+ # Default to nil.
141
+ #
142
+ # @see The params_encoding option of Ethon. Related source code:
143
+ # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
144
+ attr_accessor :params_encoding
145
+
146
+
147
+ attr_accessor :inject_format
148
+
149
+ attr_accessor :force_ending_format
150
+
151
+ def initialize
152
+ @scheme = 'http'
153
+ @host = 'localhost:3000'
154
+ @base_path = '/api'
155
+ @server_index = nil
156
+ @server_operation_index = {}
157
+ @server_variables = {}
158
+ @server_operation_variables = {}
159
+ @api_key = {}
160
+ @api_key_prefix = {}
161
+ @client_side_validation = true
162
+ @verify_ssl = true
163
+ @verify_ssl_host = true
164
+ @cert_file = nil
165
+ @key_file = nil
166
+ @timeout = 0
167
+ @params_encoding = nil
168
+ @debugging = false
169
+ @inject_format = false
170
+ @force_ending_format = false
171
+ @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
172
+
173
+ yield(self) if block_given?
174
+ end
175
+
176
+ # The default Configuration object.
177
+ def self.default
178
+ @@default ||= Configuration.new
179
+ end
180
+
181
+ def configure
182
+ yield(self) if block_given?
183
+ end
184
+
185
+ def scheme=(scheme)
186
+ # remove :// from scheme
187
+ @scheme = scheme.sub(/:\/\//, '')
188
+ end
189
+
190
+ def host=(host)
191
+ # remove http(s):// and anything after a slash
192
+ @host = host.sub(/https?:\/\//, '').split('/').first
193
+ end
194
+
195
+ def base_path=(base_path)
196
+ # Add leading and trailing slashes to base_path
197
+ @base_path = "/#{base_path}".gsub(/\/+/, '/')
198
+ @base_path = '' if @base_path == '/'
199
+ end
200
+
201
+ # Returns base URL for specified operation based on server settings
202
+ def base_url(operation = nil)
203
+ if operation_server_settings.key?(operation) then
204
+ index = server_operation_index.fetch(operation, server_index)
205
+ server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
206
+ else
207
+ server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
208
+ end
209
+ end
210
+
211
+ # Gets API key (with prefix if set).
212
+ # @param [String] param_name the parameter name of API key auth
213
+ def api_key_with_prefix(param_name, param_alias = nil)
214
+ key = @api_key[param_name]
215
+ key = @api_key.fetch(param_alias, key) unless param_alias.nil?
216
+ if @api_key_prefix[param_name]
217
+ "#{@api_key_prefix[param_name]} #{key}"
218
+ else
219
+ key
220
+ end
221
+ end
222
+
223
+ # Gets access_token using access_token_getter or uses the static access_token
224
+ def access_token_with_refresh
225
+ return access_token if access_token_getter.nil?
226
+ access_token_getter.call
227
+ end
228
+
229
+ # Gets Basic Auth token string
230
+ def basic_auth_token
231
+ 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
232
+ end
233
+
234
+ # Returns Auth Settings hash for api client.
235
+ def auth_settings
236
+ {
237
+ }
238
+ end
239
+
240
+ # Returns an array of Server setting
241
+ def server_settings
242
+ [
243
+ {
244
+ url: "http://localhost:3000/api",
245
+ description: "No description provided",
246
+ }
247
+ ]
248
+ end
249
+
250
+ def operation_server_settings
251
+ {
252
+ }
253
+ end
254
+
255
+ # Returns URL based on server settings
256
+ #
257
+ # @param index array index of the server settings
258
+ # @param variables hash of variable and the corresponding value
259
+ def server_url(index, variables = {}, servers = nil)
260
+ servers = server_settings if servers == nil
261
+
262
+ # check array index out of bound
263
+ if (index.nil? || index < 0 || index >= servers.size)
264
+ fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
265
+ end
266
+
267
+ server = servers[index]
268
+ url = server[:url]
269
+
270
+ return url unless server.key? :variables
271
+
272
+ # go through variable and assign a value
273
+ server[:variables].each do |name, variable|
274
+ if variables.key?(name)
275
+ if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
276
+ url.gsub! "{" + name.to_s + "}", variables[name]
277
+ else
278
+ fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
279
+ end
280
+ else
281
+ # use default value
282
+ url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
283
+ end
284
+ end
285
+
286
+ url
287
+ end
288
+
289
+
290
+ end
291
+ end
@@ -0,0 +1,223 @@
1
+ =begin
2
+ #Cheminée
3
+
4
+ #Cheminée: The Chemical Structure Search Engine
5
+
6
+ The version of the OpenAPI document: 1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 7.3.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Cheminee
17
+ class BulkRequest
18
+ attr_accessor :docs
19
+
20
+ # Attribute mapping from ruby-style variable name to JSON key.
21
+ def self.attribute_map
22
+ {
23
+ :'docs' => :'docs'
24
+ }
25
+ end
26
+
27
+ # Returns all the JSON keys this model knows about
28
+ def self.acceptable_attributes
29
+ attribute_map.values
30
+ end
31
+
32
+ # Attribute type mapping.
33
+ def self.openapi_types
34
+ {
35
+ :'docs' => :'Array<BulkRequestDoc>'
36
+ }
37
+ end
38
+
39
+ # List of attributes with nullable: true
40
+ def self.openapi_nullable
41
+ Set.new([
42
+ ])
43
+ end
44
+
45
+ # Initializes the object
46
+ # @param [Hash] attributes Model attributes in the form of hash
47
+ def initialize(attributes = {})
48
+ if (!attributes.is_a?(Hash))
49
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Cheminee::BulkRequest` initialize method"
50
+ end
51
+
52
+ # check to see if the attribute exists and convert string to symbol for hash key
53
+ attributes = attributes.each_with_object({}) { |(k, v), h|
54
+ if (!self.class.attribute_map.key?(k.to_sym))
55
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Cheminee::BulkRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
56
+ end
57
+ h[k.to_sym] = v
58
+ }
59
+
60
+ if attributes.key?(:'docs')
61
+ if (value = attributes[:'docs']).is_a?(Array)
62
+ self.docs = value
63
+ end
64
+ else
65
+ self.docs = nil
66
+ end
67
+ end
68
+
69
+ # Show invalid properties with the reasons. Usually used together with valid?
70
+ # @return Array for valid properties with the reasons
71
+ def list_invalid_properties
72
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
73
+ invalid_properties = Array.new
74
+ if @docs.nil?
75
+ invalid_properties.push('invalid value for "docs", docs cannot be nil.')
76
+ end
77
+
78
+ invalid_properties
79
+ end
80
+
81
+ # Check to see if the all the properties in the model are valid
82
+ # @return true if the model is valid
83
+ def valid?
84
+ warn '[DEPRECATED] the `valid?` method is obsolete'
85
+ return false if @docs.nil?
86
+ true
87
+ end
88
+
89
+ # Checks equality by comparing each attribute.
90
+ # @param [Object] Object to be compared
91
+ def ==(o)
92
+ return true if self.equal?(o)
93
+ self.class == o.class &&
94
+ docs == o.docs
95
+ end
96
+
97
+ # @see the `==` method
98
+ # @param [Object] Object to be compared
99
+ def eql?(o)
100
+ self == o
101
+ end
102
+
103
+ # Calculates hash code according to all attributes.
104
+ # @return [Integer] Hash code
105
+ def hash
106
+ [docs].hash
107
+ end
108
+
109
+ # Builds the object from hash
110
+ # @param [Hash] attributes Model attributes in the form of hash
111
+ # @return [Object] Returns the model itself
112
+ def self.build_from_hash(attributes)
113
+ return nil unless attributes.is_a?(Hash)
114
+ attributes = attributes.transform_keys(&:to_sym)
115
+ transformed_hash = {}
116
+ openapi_types.each_pair do |key, type|
117
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
118
+ transformed_hash["#{key}"] = nil
119
+ elsif type =~ /\AArray<(.*)>/i
120
+ # check to ensure the input is an array given that the attribute
121
+ # is documented as an array but the input is not
122
+ if attributes[attribute_map[key]].is_a?(Array)
123
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
124
+ end
125
+ elsif !attributes[attribute_map[key]].nil?
126
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
127
+ end
128
+ end
129
+ new(transformed_hash)
130
+ end
131
+
132
+ # Deserializes the data based on type
133
+ # @param string type Data type
134
+ # @param string value Value to be deserialized
135
+ # @return [Object] Deserialized data
136
+ def self._deserialize(type, value)
137
+ case type.to_sym
138
+ when :Time
139
+ Time.parse(value)
140
+ when :Date
141
+ Date.parse(value)
142
+ when :String
143
+ value.to_s
144
+ when :Integer
145
+ value.to_i
146
+ when :Float
147
+ value.to_f
148
+ when :Boolean
149
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
150
+ true
151
+ else
152
+ false
153
+ end
154
+ when :Object
155
+ # generic object (usually a Hash), return directly
156
+ value
157
+ when /\AArray<(?<inner_type>.+)>\z/
158
+ inner_type = Regexp.last_match[:inner_type]
159
+ value.map { |v| _deserialize(inner_type, v) }
160
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
161
+ k_type = Regexp.last_match[:k_type]
162
+ v_type = Regexp.last_match[:v_type]
163
+ {}.tap do |hash|
164
+ value.each do |k, v|
165
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
166
+ end
167
+ end
168
+ else # model
169
+ # models (e.g. Pet) or oneOf
170
+ klass = Cheminee.const_get(type)
171
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
172
+ end
173
+ end
174
+
175
+ # Returns the string representation of the object
176
+ # @return [String] String presentation of the object
177
+ def to_s
178
+ to_hash.to_s
179
+ end
180
+
181
+ # to_body is an alias to to_hash (backward compatibility)
182
+ # @return [Hash] Returns the object in the form of hash
183
+ def to_body
184
+ to_hash
185
+ end
186
+
187
+ # Returns the object in the form of hash
188
+ # @return [Hash] Returns the object in the form of hash
189
+ def to_hash
190
+ hash = {}
191
+ self.class.attribute_map.each_pair do |attr, param|
192
+ value = self.send(attr)
193
+ if value.nil?
194
+ is_nullable = self.class.openapi_nullable.include?(attr)
195
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
196
+ end
197
+
198
+ hash[param] = _to_hash(value)
199
+ end
200
+ hash
201
+ end
202
+
203
+ # Outputs non-array value in the form of hash
204
+ # For object, use to_hash. Otherwise, just return the value
205
+ # @param [Object] value Any valid value
206
+ # @return [Hash] Returns the value in the form of hash
207
+ def _to_hash(value)
208
+ if value.is_a?(Array)
209
+ value.compact.map { |v| _to_hash(v) }
210
+ elsif value.is_a?(Hash)
211
+ {}.tap do |hash|
212
+ value.each { |k, v| hash[k] = _to_hash(v) }
213
+ end
214
+ elsif value.respond_to? :to_hash
215
+ value.to_hash
216
+ else
217
+ value
218
+ end
219
+ end
220
+
221
+ end
222
+
223
+ end