cheminee 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69f9d4856f7f3d4f693aa9affb128fc80a79870f2a7ef0125ab5629ecc31a104
-  data.tar.gz: 9a33b5e2cbb5f8e8f6793d7f83db0c88b245f376f062404fec10eff4363dbba6
+  metadata.gz: a65121f7843c1764ac85077b8ceaa08a05c0a5f71978ea8d6f96881bada945b1
+  data.tar.gz: 5ae188e4b9b0567db00612372c3fe9f1e57ce379560a35eca2cfd83805c2d4bb
 SHA512:
-  metadata.gz: 99e125d536f7bbda6e0242d20ba225284d5a9abb3aa0f8edad28a6d42ff9e88086785bd54e3deaed2d4393860079fac1f1b960350f9f063c9c50d15343447b38
-  data.tar.gz: dd107d62aef25c62a8664e7b9ea8843af3d49955e67e71efcedaa1106e4401379c2975f2a6e90d87727ea9a40e775ab5dc712ed05d8c6f89389b156afa77080b
+  metadata.gz: b414dae786b782a47511dfe8d13f96fda7d30b9d890de210b4ee4ab2c17372e39d03dd63e6848cae0ea49c8b7d58695ce35b81b058ddd94864f80c371d3d7e78
+  data.tar.gz: 62129b1704d60fb0038c369ff861ff82bfb68b31684904e9dfe5dc470eff1345e40b8b8e9331cf2bfc0aad91531c58dd8b115d6724577f0ce4ee7843122fe9d8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cheminee (0.1.5)
+    cheminee (0.1.6)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -7,7 +7,7 @@ Cheminée: The Chemical Structure Search Engine
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 0.1.5
+- Package version: 0.1.6
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://github.com/rdkit-rs/cheminee](https://github.com/rdkit-rs/cheminee)
 
@@ -24,16 +24,16 @@ gem build cheminee.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cheminee-0.1.5.gem
+gem install ./cheminee-0.1.6.gem
 ```
 
-(for development, run `gem install --dev ./cheminee-0.1.5.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cheminee-0.1.6.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cheminee', '~> 0.1.5'
+    gem 'cheminee', '~> 0.1.6'
 
 ### Install from Git
 
@@ -75,6 +75,7 @@ All URIs are relative to *http://localhost:3000/api*
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *Cheminee::DefaultApi* | [**v1_indexes_get**](docs/DefaultApi.md#v1_indexes_get) | **GET** /v1/indexes | 
+*Cheminee::DefaultApi* | [**v1_indexes_index_bulk_index_post**](docs/DefaultApi.md#v1_indexes_index_bulk_index_post) | **POST** /v1/indexes/{index}/bulk_index | 
 *Cheminee::DefaultApi* | [**v1_indexes_index_get**](docs/DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | 
 *Cheminee::DefaultApi* | [**v1_indexes_index_post**](docs/DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | 
 *Cheminee::DefaultApi* | [**v1_indexes_index_search_substructure_get**](docs/DefaultApi.md#v1_indexes_index_search_substructure_get) | **GET** /v1/indexes/{index}/search/substructure | 
@@ -84,10 +85,15 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [Cheminee::BulkRequest](docs/BulkRequest.md)
+ - [Cheminee::BulkRequestDoc](docs/BulkRequestDoc.md)
  - [Cheminee::CreateIndexError](docs/CreateIndexError.md)
  - [Cheminee::GetIndexesResponseError](docs/GetIndexesResponseError.md)
  - [Cheminee::IndexMeta](docs/IndexMeta.md)
  - [Cheminee::ListIndexResponseErr](docs/ListIndexResponseErr.md)
+ - [Cheminee::PostIndexBulkResponseError](docs/PostIndexBulkResponseError.md)
+ - [Cheminee::PostIndexBulkResponseOk](docs/PostIndexBulkResponseOk.md)
+ - [Cheminee::PostIndexBulkResponseOkStatus](docs/PostIndexBulkResponseOkStatus.md)
  - [Cheminee::Schema](docs/Schema.md)
  - [Cheminee::Smile](docs/Smile.md)
  - [Cheminee::StandardizedSmile](docs/StandardizedSmile.md)

data/docs/BulkRequest.md

@@ -0,0 +1,18 @@
+# Cheminee::BulkRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **docs** | [**Array<BulkRequestDoc>**](BulkRequestDoc.md) |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::BulkRequest.new(
+  docs: null
+)
+```
+

data/docs/BulkRequestDoc.md

@@ -0,0 +1,20 @@
+# Cheminee::BulkRequestDoc
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **smile** | **String** |  |  |
+| **extra_data** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::BulkRequestDoc.new(
+  smile: null,
+  extra_data: null
+)
+```
+

data/docs/DefaultApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost:3000/api*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**v1_indexes_get**](DefaultApi.md#v1_indexes_get) | **GET** /v1/indexes |  |
+| [**v1_indexes_index_bulk_index_post**](DefaultApi.md#v1_indexes_index_bulk_index_post) | **POST** /v1/indexes/{index}/bulk_index |  |
 | [**v1_indexes_index_get**](DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} |  |
 | [**v1_indexes_index_post**](DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} |  |
 | [**v1_indexes_index_search_substructure_get**](DefaultApi.md#v1_indexes_index_search_substructure_get) | **GET** /v1/indexes/{index}/search/substructure |  |
@@ -71,6 +72,70 @@ No authorization required
 - **Accept**: application/json; charset=utf-8
 
 
+## v1_indexes_index_bulk_index_post
+
+> <PostIndexBulkResponseOk> v1_indexes_index_bulk_index_post(index, bulk_request)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+bulk_request = Cheminee::BulkRequest.new({docs: [Cheminee::BulkRequestDoc.new({smile: 'smile_example'})]}) # BulkRequest | 
+
+begin
+  
+  result = api_instance.v1_indexes_index_bulk_index_post(index, bulk_request)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_bulk_index_post: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_bulk_index_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostIndexBulkResponseOk>, Integer, Hash)> v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostIndexBulkResponseOk>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_bulk_index_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+| **bulk_request** | [**BulkRequest**](BulkRequest.md) |  |  |
+
+### Return type
+
+[**PostIndexBulkResponseOk**](PostIndexBulkResponseOk.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=utf-8
+- **Accept**: application/json; charset=utf-8
+
+
 ## v1_indexes_index_get
 
 > <Array<IndexMeta>> v1_indexes_index_get(index)

data/docs/PostIndexBulkResponseError.md

@@ -0,0 +1,18 @@
+# Cheminee::PostIndexBulkResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::PostIndexBulkResponseError.new(
+  error: null
+)
+```
+

data/docs/PostIndexBulkResponseOk.md

@@ -0,0 +1,18 @@
+# Cheminee::PostIndexBulkResponseOk
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **statuses** | [**Array<PostIndexBulkResponseOkStatus>**](PostIndexBulkResponseOkStatus.md) |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::PostIndexBulkResponseOk.new(
+  statuses: null
+)
+```
+

data/docs/PostIndexBulkResponseOkStatus.md

@@ -0,0 +1,20 @@
+# Cheminee::PostIndexBulkResponseOkStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **opcode** | **Integer** |  | [optional] |
+| **error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::PostIndexBulkResponseOkStatus.new(
+  opcode: null,
+  error: null
+)
+```
+

data/lib/cheminee/api/default_api.rb

@@ -72,6 +72,76 @@ module Cheminee
       return data, status_code, headers
     end
 
+    # @param index [String] 
+    # @param bulk_request [BulkRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PostIndexBulkResponseOk]
+    def v1_indexes_index_bulk_index_post(index, bulk_request, opts = {})
+      data, _status_code, _headers = v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request, opts)
+      data
+    end
+
+    # @param index [String] 
+    # @param bulk_request [BulkRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PostIndexBulkResponseOk, Integer, Hash)>] PostIndexBulkResponseOk data, response status code and response headers
+    def v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.v1_indexes_index_bulk_index_post ...'
+      end
+      # verify the required parameter 'index' is set
+      if @api_client.config.client_side_validation && index.nil?
+        fail ArgumentError, "Missing the required parameter 'index' when calling DefaultApi.v1_indexes_index_bulk_index_post"
+      end
+      # verify the required parameter 'bulk_request' is set
+      if @api_client.config.client_side_validation && bulk_request.nil?
+        fail ArgumentError, "Missing the required parameter 'bulk_request' when calling DefaultApi.v1_indexes_index_bulk_index_post"
+      end
+      # resource path
+      local_var_path = '/v1/indexes/{index}/bulk_index'.sub('{' + 'index' + '}', CGI.escape(index.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=utf-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(bulk_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PostIndexBulkResponseOk'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.v1_indexes_index_bulk_index_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#v1_indexes_index_bulk_index_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # @param index [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<IndexMeta>]

data/lib/cheminee/models/bulk_request.rb

@@ -0,0 +1,223 @@
+=begin
+#Cheminée
+
+#Cheminée: The Chemical Structure Search Engine
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.1.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module Cheminee
+  class BulkRequest
+    attr_accessor :docs
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'docs' => :'docs'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'docs' => :'Array<BulkRequestDoc>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Cheminee::BulkRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          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
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'docs')
+        if (value = attributes[:'docs']).is_a?(Array)
+          self.docs = value
+        end
+      else
+        self.docs = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @docs.nil?
+        invalid_properties.push('invalid value for "docs", docs cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @docs.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          docs == o.docs
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [docs].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Cheminee.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end