cheminee 0.0.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2245000aaf941c82d3815031b336ae318c70412ccc30e8f8e231353f190ad85c
+  data.tar.gz: ee7655419ed25badf16f610879150f0ab66d90d10bcff2c310404437e434f2a7
+SHA512:
+  metadata.gz: 189d84e99d4476b19d0ffe05215d90c27313ed017bbe715d335b4af97c77c8b00c3b69c881c1f5e536d89f16ff89b759a549de1bcbbd101c12eb6a4d59ffc9a2
+  data.tar.gz: c27158dd5fe24d175d2a8229e16d67a4f68045024dafd1d6ebbe269614d491133e4938dd0dd47e1f5bd7de4a40b35e08c3a81aca880caacc955c635ea973448f

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    cheminee (0.0.14)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.16.3)
+    jaro_winkler (1.5.6)
+    method_source (1.0.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.0)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  cheminee!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -0,0 +1,112 @@
+# cheminee
+
+Cheminee - the Ruby gem for the Cheminée
+
+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.0.14
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://github.com/rdkit-rs/cheminee](https://github.com/rdkit-rs/cheminee)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cheminee.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cheminee-0.0.14.gem
+```
+
+(for development, run `gem install --dev ./cheminee-0.0.14.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.0.14'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'cheminee', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+
+begin
+  #List indexes
+  result = api_instance.v1_indexes_get
+  p result
+rescue Cheminee::ApiError => e
+  puts "Exception when calling DefaultApi->v1_indexes_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+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 | List indexes
+*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
+*Cheminee::DefaultApi* | [**v1_indexes_index_get**](docs/DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | Get extended information about an index
+*Cheminee::DefaultApi* | [**v1_indexes_index_post**](docs/DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | Create an index
+*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
+*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
+*Cheminee::DefaultApi* | [**v1_schemas_get**](docs/DefaultApi.md#v1_schemas_get) | **GET** /v1/schemas | List schemas available for creating indexes
+*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
+
+
+## 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::IndexSchema](docs/IndexSchema.md)
+ - [Cheminee::ListIndexResponseErr](docs/ListIndexResponseErr.md)
+ - [Cheminee::PostIndexBulkResponseError](docs/PostIndexBulkResponseError.md)
+ - [Cheminee::PostIndexBulkResponseOk](docs/PostIndexBulkResponseOk.md)
+ - [Cheminee::PostIndexBulkResponseOkStatus](docs/PostIndexBulkResponseOkStatus.md)
+ - [Cheminee::QueryResponseError](docs/QueryResponseError.md)
+ - [Cheminee::QuerySearchHit](docs/QuerySearchHit.md)
+ - [Cheminee::Schema](docs/Schema.md)
+ - [Cheminee::Smiles](docs/Smiles.md)
+ - [Cheminee::StandardizedSmiles](docs/StandardizedSmiles.md)
+ - [Cheminee::StructureResponseError](docs/StructureResponseError.md)
+ - [Cheminee::StructureSearchHit](docs/StructureSearchHit.md)
+
+
+## Documentation for Authorization
+
+Endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/cheminee.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=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.3.0-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cheminee/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cheminee"
+  s.version     = Cheminee::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Xavier Lange"]
+  s.email       = ["xrlange@gmail.com"]
+  s.homepage    = "https://github.com/rdkit-rs/cheminee-ruby"
+  s.summary     = "Cheminée Ruby Gem"
+  s.description = "Cheminée: The Chemical Structure Search Engine"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 3.0"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

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 |
+| ---- | ---- | ----------- | ----- |
+| **smiles** | **String** |  |  |
+| **extra_data** | **Object** | This value can store an arbitrary JSON object like '{}' | [optional] |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::BulkRequestDoc.new(
+  smiles: null,
+  extra_data: null
+)
+```
+

data/docs/CreateIndexError.md

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