manticore-client 1.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require "manticore/client"
+require "uri"
+require "json"
+require "net/http"
+require "pry"
+require_relative "support/manticore_sql_helper"
+
+# Table prefix for all test indexes; configurable via ENV
+TABLE_PREFIX = ENV["MANTICORE_TEST_PREFIX"] || "test_"
+
+# Configure Manticore::Client from MANTICORESEARCH_URI or default
+uri = ENV["MANTICORESEARCH_URI"] || "http://127.0.0.1:9308"
+parsed = URI.parse(uri)
+
+unless parsed.host && parsed.port
+  abort "\n[ERROR] MANTICORESEARCH_URI must specify a valid host and port. Got: #{uri}\n"
+end
+
+Manticore::Client.configure do |config|
+  config.host = "#{parsed.scheme}://#{parsed.host}:#{parsed.port}"
+  config.username = parsed.user if parsed.user
+  config.password = parsed.password if parsed.password
+  config.debugging = ENV["DEBUG"] == "true"
+end
+
+# Optionally, check if the server is available before running specs
+begin
+  Net::HTTP.start(parsed.host, parsed.port, read_timeout: 2) do |http|
+    http.head("/")
+  end
+rescue StandardError => e
+  abort "\n[ERROR] Could not connect to ManticoreSearch at #{parsed.host}:#{parsed.port}. " \
+        "Is it running? (#{e.class}: #{e.message})\n"
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    ManticoreSqlHelper.tables(prefix: TABLE_PREFIX).each do |table|
+      ManticoreSqlHelper.drop_table(table)
+    end
+  end
+
+  config.after(:suite) do
+    ManticoreSqlHelper.tables(prefix: TABLE_PREFIX).each do |table|
+      ManticoreSqlHelper.drop_table(table)
+    end
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  config.disable_monkey_patching!
+  config.warnings = true
+
+  config.default_formatter = "doc" if config.files_to_run.one?
+
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end
+
+# Helper method to check if docs exist in a table
+# This matcher checks if the table contains the expected documents
+# It queries the table and compares the results with the expected documents
+# If the table does not exist or if there are no matching documents, it raises an error
+# Usage:
+# expect(TABLE_PREFIX + "movies").to have_docs(
+#   { id: 1, title: "Scary movie", rating: 9.5 },
+#   { id: 3, title: "New movie", rating: 8.5 }
+# )
+RSpec::Matchers.define :have_docs do |expected|
+  match do |actual|
+    result = ManticoreSqlHelper.query("SELECT * FROM #{actual}")
+    result.any? { |row| row >= expected }
+  end
+
+  failure_message do |actual|
+    "expected that table #{actual} would have #{expected} rows, but it has #{actual.count}"
+  end
+
+  failure_message_when_negated do |actual|
+    "expected that table #{actual} would not have #{expected} rows, but it does"
+  end
+end

data/spec/support/manticore_sql_helper.rb

@@ -0,0 +1,33 @@
+module ManticoreSqlHelper
+  QueryError = Class.new(StandardError) do
+    attr_reader :sql, :error
+
+    def initialize(error, sql)
+      @sql = sql
+      @error = error
+      super("SQL query failed: #{sql}\n#{error}")
+    end
+  end
+
+  def self.client
+    @client ||= Manticore::Client::UtilsApi.new
+  end
+
+  def self.query(sql)
+    sql_encoded = URI.encode_www_form_component(sql)
+    response = client.sql("query=#{sql_encoded}", query_params: { mode: "raw" }).first
+    raise QueryError.new(response[:error], sql) unless response[:error].empty?
+
+    response[:data]
+  end
+
+  def self.tables(prefix: nil)
+    res = query("SHOW TABLES")
+    tables = res.map { |row| row[:Table] }
+    prefix ? tables.select { |t| t.start_with?(prefix) } : tables
+  end
+
+  def self.drop_table(name)
+    query("DROP TABLE #{name}")
+  end
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: manticore-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- OpenAPI-Generator
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Сlient for Manticore Search. '
+email:
+- subbota@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".openapi-generator-ignore"
+- ".openapi-generator/FILES"
+- ".openapi-generator/VERSION"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- 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
+- lib/manticore-client.rb
+- 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/spec_helper.rb
+- spec/support/manticore_sql_helper.rb
+homepage: https://github.com/numbata/manticore-client
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/numbata/manticore-client/issues
+  changelog_uri: https://github.com/numbata/manticore-client/blob/v1.0.0/CHANGELOG.md
+  homepage_uri: https://github.com/numbata/manticore-client
+  source_code_uri: https://github.com/numbata/manticore-client
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Autogenerated Manticore Search client
+test_files: []