manticore-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb72a18507372a6ba6d8ed849f049cd41632390c0a7f0e2a94071f583380f649
+  data.tar.gz: 4304af2546bd12aba51dd1a06b66f872263274e815e13a330eefb16060a9fefd
+SHA512:
+  metadata.gz: cde7859cee0959839038a5623abc5674543248ccdcb2bfdca3e2dcc0bf87110d4535c6710cb8125a4af570f9446c9656d7892599543e8cca15f81cefe10a97be
+  data.tar.gz: 1ef43c514c1aeaab283b55d736a31724ca3a8c929bf14b0543b7863bd3f2dc6f6e13150544ae54ae7a09d004e6f5120e5084bfd019db96cda810a009e16f4be4

data/.gitignore

@@ -0,0 +1,39 @@
+# Generated by: https://openapi-generator.tech
+#
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.openapi-generator/FILES

@@ -0,0 +1,149 @@
+.gitignore
+.gitlab-ci.yml
+.openapi-generator-ignore
+.rspec
+.rubocop.yml
+.travis.yml
+Gemfile
+README.md
+Rakefile
+docs/AggComposite.md
+docs/AggCompositeSource.md
+docs/AggCompositeTerm.md
+docs/AggTerms.md
+docs/Aggregation.md
+docs/AutocompleteRequest.md
+docs/BoolFilter.md
+docs/BulkResponse.md
+docs/DeleteDocumentRequest.md
+docs/DeleteResponse.md
+docs/ErrorResponse.md
+docs/FulltextFilter.md
+docs/GeoDistance.md
+docs/GeoDistanceLocationAnchor.md
+docs/Highlight.md
+docs/HighlightAllOfFields.md
+docs/HighlightFieldOption.md
+docs/HitsHits.md
+docs/IndexApi.md
+docs/InsertDocumentRequest.md
+docs/Join.md
+docs/JoinCond.md
+docs/JoinOn.md
+docs/KnnQuery.md
+docs/Match.md
+docs/MatchAll.md
+docs/PercolateRequest.md
+docs/PercolateRequestQuery.md
+docs/QueryFilter.md
+docs/Range.md
+docs/ReplaceDocumentRequest.md
+docs/ResponseError.md
+docs/ResponseErrorDetails.md
+docs/SearchApi.md
+docs/SearchQuery.md
+docs/SearchRequest.md
+docs/SearchResponse.md
+docs/SearchResponseHits.md
+docs/SourceRules.md
+docs/SqlResponse.md
+docs/SuccessResponse.md
+docs/UpdateDocumentRequest.md
+docs/UpdateResponse.md
+docs/UtilsApi.md
+git_push.sh
+lib/manticore/client.rb
+lib/manticore/client/api/index_api.rb
+lib/manticore/client/api/search_api.rb
+lib/manticore/client/api/utils_api.rb
+lib/manticore/client/api_client.rb
+lib/manticore/client/api_error.rb
+lib/manticore/client/configuration.rb
+lib/manticore/client/models/agg_composite.rb
+lib/manticore/client/models/agg_composite_source.rb
+lib/manticore/client/models/agg_composite_term.rb
+lib/manticore/client/models/agg_terms.rb
+lib/manticore/client/models/aggregation.rb
+lib/manticore/client/models/autocomplete_request.rb
+lib/manticore/client/models/bool_filter.rb
+lib/manticore/client/models/bulk_response.rb
+lib/manticore/client/models/delete_document_request.rb
+lib/manticore/client/models/delete_response.rb
+lib/manticore/client/models/error_response.rb
+lib/manticore/client/models/fulltext_filter.rb
+lib/manticore/client/models/geo_distance.rb
+lib/manticore/client/models/geo_distance_location_anchor.rb
+lib/manticore/client/models/highlight.rb
+lib/manticore/client/models/highlight_all_of_fields.rb
+lib/manticore/client/models/highlight_field_option.rb
+lib/manticore/client/models/hits_hits.rb
+lib/manticore/client/models/insert_document_request.rb
+lib/manticore/client/models/join.rb
+lib/manticore/client/models/join_cond.rb
+lib/manticore/client/models/join_on.rb
+lib/manticore/client/models/knn_query.rb
+lib/manticore/client/models/match.rb
+lib/manticore/client/models/match_all.rb
+lib/manticore/client/models/percolate_request.rb
+lib/manticore/client/models/percolate_request_query.rb
+lib/manticore/client/models/query_filter.rb
+lib/manticore/client/models/range.rb
+lib/manticore/client/models/replace_document_request.rb
+lib/manticore/client/models/response_error.rb
+lib/manticore/client/models/response_error_details.rb
+lib/manticore/client/models/search_query.rb
+lib/manticore/client/models/search_request.rb
+lib/manticore/client/models/search_response.rb
+lib/manticore/client/models/search_response_hits.rb
+lib/manticore/client/models/source_rules.rb
+lib/manticore/client/models/sql_response.rb
+lib/manticore/client/models/success_response.rb
+lib/manticore/client/models/update_document_request.rb
+lib/manticore/client/models/update_response.rb
+lib/manticore/client/version.rb
+manticore/client.gemspec
+spec/api/index_api_spec.rb
+spec/api/search_api_spec.rb
+spec/api/utils_api_spec.rb
+spec/models/agg_composite_source_spec.rb
+spec/models/agg_composite_spec.rb
+spec/models/agg_composite_term_spec.rb
+spec/models/agg_terms_spec.rb
+spec/models/aggregation_spec.rb
+spec/models/autocomplete_request_spec.rb
+spec/models/bool_filter_spec.rb
+spec/models/bulk_response_spec.rb
+spec/models/delete_document_request_spec.rb
+spec/models/delete_response_spec.rb
+spec/models/error_response_spec.rb
+spec/models/fulltext_filter_spec.rb
+spec/models/geo_distance_location_anchor_spec.rb
+spec/models/geo_distance_spec.rb
+spec/models/highlight_all_of_fields_spec.rb
+spec/models/highlight_field_option_spec.rb
+spec/models/highlight_spec.rb
+spec/models/hits_hits_spec.rb
+spec/models/insert_document_request_spec.rb
+spec/models/join_cond_spec.rb
+spec/models/join_on_spec.rb
+spec/models/join_spec.rb
+spec/models/knn_query_spec.rb
+spec/models/match_all_spec.rb
+spec/models/match_spec.rb
+spec/models/percolate_request_query_spec.rb
+spec/models/percolate_request_spec.rb
+spec/models/query_filter_spec.rb
+spec/models/range_spec.rb
+spec/models/replace_document_request_spec.rb
+spec/models/response_error_details_spec.rb
+spec/models/response_error_spec.rb
+spec/models/search_query_spec.rb
+spec/models/search_request_spec.rb
+spec/models/search_response_hits_spec.rb
+spec/models/search_response_spec.rb
+spec/models/source_rules_spec.rb
+spec/models/sql_response_spec.rb
+spec/models/success_response_spec.rb
+spec/models/update_document_request_spec.rb
+spec/models/update_response_spec.rb
+spec/spec_helper.rb

data/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.13.0

data/.openapi-generator-ignore

@@ -0,0 +1,5 @@
+/lib/manticore/client.rb
+/lib/manticore/client/version.rb
+manticore/client.gemspec
+.rubocop.yml
+spec/models

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,160 @@
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+    - 'actionpack/lib/action_dispatch/journey/parser.rb'
+    - 'lib/manticore/client/**/*'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/manticore-client.rb'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: false
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+    Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+  EnforcedStyle: always
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: false
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "pry-byebug"
+  gem "rake", "~> 13.0.1"
+  gem "rspec", "~> 3.6", ">= 3.6.0"
+  gem "rubocop", "~> 1.75", require: false
+  gem "rubocop-rake", require: false
+  gem "rubocop-rspec", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    manticore-client (1.0.0)
+      faraday (>= 1.0.1, < 3.0)
+      faraday-multipart
+      marcel
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    byebug (12.0.0)
+    coderay (1.1.3)
+    diff-lcs (1.6.1)
+    faraday (2.13.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-multipart (1.1.0)
+      multipart-post (~> 2.0)
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    json (2.11.3)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    marcel (1.0.4)
+    method_source (1.1.0)
+    multipart-post (2.4.1)
+    net-http (0.6.0)
+      uri
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.11.0)
+      byebug (~> 12.0)
+      pry (>= 0.13, < 0.16)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.3)
+    rubocop (1.75.5)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-23
+
+DEPENDENCIES
+  manticore-client!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 1.75)
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.6.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-2023, Manticore Software LTD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+# manticore-client
+
+![RubyGems Version](https://img.shields.io/gem/v/manticore-client)
+![CI Status](https://github.com/numbata/manticoresearch-ruby/actions/workflows/ci.yml/badge.svg)
+
+A Ruby client for [Manticore Search](https://manticoresearch.com), generated from the OpenAPI specification.
+
+**API Version:** 5.0.0  •  **Gem Version:** 1.0.0  •  **Generator:** OpenAPI Generator v7.13.0
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Configuration](#configuration)
+* [Documentation](#documentation)
+* [Development](#development)
+* [Contributing](#contributing)
+* [License](#license)
+
+---
+
+## Installation
+
+### From RubyGems
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'manticore-client', '~> 1.0'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install manticore-client
+```
+
+### From GitHub
+
+```ruby
+# Gemfile
+gem 'manticore-client', git: 'https://github.com/numbata/manticore-client.git'
+```
+
+## Usage
+
+```ruby
+require 'manticore-client'
+
+# Optionally configure credentials or host
+Manticore::Client.configure do |config|
+  config.host = 'http://127.0.0.1:9308'
+  config.username = 'user'
+  config.password = 'pass'
+end
+
+# Create an API client instance
+client = Manticore::Client::IndexApi.new
+
+# Example: bulk operations
+body = <<~NDJSON
+  { "insert": { "index": "table_name", "id": 3, "doc": { "title": "New movie", "rating": 8.5 } } }
+  { "delete": { "index": "table_name", "id": 2 } }
+NDJSON
+
+begin
+  response = client.bulk(body)
+  puts response
+rescue Manticore::Client::ApiError => e
+  warn "API error: #{e.message} (status=#{e.code})"
+end
+```
+
+## Configuration
+
+You can override default settings by calling `configure`. Available options:
+
+| Option     | Default                 | Description                           |
+| ---------- | ----------------------- | ------------------------------------- |
+| `host`     | `http://127.0.0.1:9308` | Base URL for the Manticore Search API |
+| `username` | *nil*                   | HTTP Basic auth username              |
+| `password` | *nil*                   | HTTP Basic auth password              |
+| `timeout`  | `60`                    | HTTP request timeout in seconds       |
+
+## Documentation
+
+Generated API and model documentation is available under the `docs/` directory:
+
+* [API Endpoints](docs/IndexApi.md)
+* [Model Reference](docs/AggComposite.md)
+
+Or browse online at [GitHub Pages](https://numbata.github.io/manticore-client).
+
+## Development
+
+1. Fork and clone this repository
+2. Install dependencies:
+
+   ```bash
+   bundle install
+   ```
+3. Run tests:
+
+   ```bash
+   bundle exec rspec
+   ```
+4. Regenerate client after schema changes:
+
+   ```bash
+   openapi-generator-cli generate \
+     -i https://raw.githubusercontent.com/manticoresoftware/openapi/master/manticore.yml \
+     -g ruby \
+     -o ./ \
+     --skip-overwrite \
+     --additional-properties=\
+       library=faraday,\
+       gemName=manticore/client,\
+       moduleName=Manticore::Client,\
+       useAutoload=true
+   ```
+
+## Contributing
+
+Contributions are welcome! Please open issues and pull requests against `main`. Ensure your code passes lint and tests before submitting.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

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/docs/AggComposite.md

@@ -0,0 +1,20 @@
+# Manticore::Client::AggComposite
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **size** | **Integer** | Maximum number of composite buckets in the result | [optional] |
+| **sources** | **Array<Hash<String, AggCompositeSource>>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::AggComposite.new(
+  size: 1000,
+  sources: null
+)
+```
+

data/docs/AggCompositeSource.md

@@ -0,0 +1,18 @@
+# Manticore::Client::AggCompositeSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **terms** | [**AggCompositeTerm**](AggCompositeTerm.md) |  |  |
+
+## Example
+
+```ruby
+require 'manticore/client'
+
+instance = Manticore::Client::AggCompositeSource.new(
+  terms: null
+)
+```
+