{"id":13879056,"url":"https://github.com/elastic/enterprise-search-ruby","last_synced_at":"2025-04-04T13:13:03.187Z","repository":{"id":38847788,"uuid":"286522185","full_name":"elastic/enterprise-search-ruby","owner":"elastic","description":"Official Ruby client for Elastic Enterprise Search, App Search, and Workplace Search","archived":false,"fork":false,"pushed_at":"2025-03-05T11:09:17.000Z","size":944,"stargazers_count":20,"open_issues_count":5,"forks_count":8,"subscribers_count":196,"default_branch":"main","last_synced_at":"2025-03-28T12:09:23.115Z","etag":null,"topics":["app-search","appsearch","client","elastic-app-search","elastic-enterprise-search","elastic-workplace-search","enterprise-search","ruby","workplace-search"],"latest_commit_sha":null,"homepage":"https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elastic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-10T16:13:05.000Z","updated_at":"2025-02-24T17:24:00.000Z","dependencies_parsed_at":"2023-11-16T13:27:56.248Z","dependency_job_id":"6f3e0c07-0eab-4f2b-8115-983cb21435e1","html_url":"https://github.com/elastic/enterprise-search-ruby","commit_stats":{"total_commits":466,"total_committers":7,"mean_commits":66.57142857142857,"dds":0.01931330472102999,"last_synced_commit":"78580f8b02919dc5ca285a94af72ad5199219146"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elastic%2Fenterprise-search-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elastic%2Fenterprise-search-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elastic%2Fenterprise-search-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elastic%2Fenterprise-search-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elastic","download_url":"https://codeload.github.com/elastic/enterprise-search-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247182401,"owners_count":20897381,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["app-search","appsearch","client","elastic-app-search","elastic-enterprise-search","elastic-workplace-search","enterprise-search","ruby","workplace-search"],"created_at":"2024-08-06T08:02:08.301Z","updated_at":"2025-04-04T13:13:03.165Z","avatar_url":"https://github.com/elastic.png","language":"Ruby","readme":"# Elastic Enterprise Search Client\n\n![rubocop](https://github.com/elastic/enterprise-search-ruby/workflows/rubocop/badge.svg)\n[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)\n![build](https://github.com/elastic/enterprise-search-ruby/workflows/main/badge.svg)\n[![Build status](https://badge.buildkite.com/a6c44f2af741c866381fb3c845e8d4b0e9b5c5883ef84ac30e.svg)](https://buildkite.com/elastic/enterprise-search-ruby)\n\nOfficial Ruby API client for [Elastic Enterprise Search](https://www.elastic.co/enterprise-search). Use this gem to integrate App Search and Workplace Search into your Ruby code.\n\n## Installation\n\nInstall the `elastic-enterprise-search` gem from [Rubygems](https://rubygems.org/gems/elastic-enterprise-search):\n\n```\n$ gem install elastic-enterprise-search\n```\n\nOr add it to your project's Gemfile:\n\n```ruby\ngem 'elastic-enterprise-search', 'VERSION'\n```\n\nThe Enterprise Search client is implemented with [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/) as the HTTP layer, which uses [Faraday](https://rubygems.org/gems/faraday). Faraday supports several [adapters](https://lostisland.github.io/faraday/adapters/) and will use `Net::HTTP` by default. For optimal performance with the Enterprise Search API, we suggest using an HTTP library which supports persistent (\"keep-alive\") connections. For the standard Ruby implementation, this could be [Net::HTTP::Persistent](https://github.com/drbrain/net-http-persistent), [patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus). For JRuby, [Manticore](https://github.com/cheald/manticore) is a great option as well. Require the library for the adapter in your code and then pass in the `:adapter` parameter to the client when you initialize it:\n\n```ruby\nrequire 'elastic-enterprise-search'\nrequire 'faraday/net_http_persistent'\n\nclient = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent)\n```\nIf an adapter is not specified, the client will try to auto-detect available libraries and use the best available HTTP client.\n\n## Documentation\n\n[See the documentation](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html) for usage, code examples, configuring the client, and an API reference.\n\nSee code examples of usage for the [Enterprise Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/enterprise-search-api.html), [App Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/app-search-api.html) and [Workplace Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html) APIs.\n\n## Compatibility\n\nWe follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).\n\n## Development\n\nSee [CONTRIBUTING](https://github.com/elastic/enterprise-search-ruby/blob/main/CONTRIBUTING.md).\n\n## License\n\nThis software is licensed under the [Apache 2 license](./LICENSE). See [NOTICE](./NOTICE).\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felastic%2Fenterprise-search-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felastic%2Fenterprise-search-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felastic%2Fenterprise-search-ruby/lists"}