{"id":26525280,"url":"https://github.com/adham90/elastic_map","last_synced_at":"2026-05-11T16:03:27.079Z","repository":{"id":80109143,"uuid":"94385287","full_name":"adham90/elastic_map","owner":"adham90","description":":shell: ElasticMap is a read-only ODM (Object-Document-Mapper) framework for Elasticsearch in Ruby.","archived":false,"fork":false,"pushed_at":"2017-06-29T17:48:30.000Z","size":43,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-21T15:11:16.962Z","etag":null,"topics":["elasticsearch","elasticsearch-client","gem","mapper","odm","ruby"],"latest_commit_sha":null,"homepage":"http://rubydoc.info/github/adham90/elastic_map","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adham90.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2017-06-15T01:00:34.000Z","updated_at":"2017-06-25T22:41:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"87c0b60c-5c81-4a31-9964-8c5cc770eee6","html_url":"https://github.com/adham90/elastic_map","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/adham90/elastic_map","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adham90%2Felastic_map","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adham90%2Felastic_map/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adham90%2Felastic_map/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adham90%2Felastic_map/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adham90","download_url":"https://codeload.github.com/adham90/elastic_map/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adham90%2Felastic_map/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32902271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-10T13:40:02.631Z","status":"online","status_checked_at":"2026-05-11T02:00:05.975Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["elasticsearch","elasticsearch-client","gem","mapper","odm","ruby"],"created_at":"2025-03-21T14:55:22.456Z","updated_at":"2026-05-11T16:03:27.071Z","avatar_url":"https://github.com/adham90.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# :shell: ElasticMap\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)\n[![Build Status](https://travis-ci.org/adham90/elastic_map.svg?branch=master)](https://travis-ci.org/adham90/elastic_map)\n[![Join the chat at https://gitter.im/elastic_map/Lobby](https://badges.gitter.im/elastic_map/Lobby.svg)](https://gitter.im/elastic_map/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![Dependency Status](https://gemnasium.com/badges/github.com/adham90/elastic_map.svg)](https://gemnasium.com/github.com/adham90/elastic_map)\n[![Inline docs](http://inch-ci.org/github/adham90/elastic_map.svg?branch=master)](http://inch-ci.org/github/adham90/elastic_map)\n\nElasticMap ODM (Object-Document-Mapper) is a [mongoid](https://github.com/mongodb/mongoid)-like gem for [Elasticsearch](https://github.com/elastic/elasticsearch) that provides the functionality of chainable queries, embedding indexes, relations, and aggregations.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'elastic_map'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install elastic_map\n\n## Usage\n\n### Client settings\n\nThere are two ways to configure the ElasticMap client: the `ElasticMap.settings` hash and `elastic_map.yml`\n\n```ruby\n# config/initializers/elastic_map.rb\nElasticMap.settings = {host: 'localhost:9250'} # do not use environments\n```\n\n```yaml\n# config/elastic_map.yml\n# separate environment configs\ntest:\n  host: 'localhost:9250'\n  prefix: 'test'\ndevelopment:\n  host: 'localhost:9200'\n```\n\nThe logger may be set explicitly:\n\n```ruby\nElasticMap.logger = Logger.new(STDOUT)\n```\nSee [config.rb](lib/elastic_map/config.rb) for more details.\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## TODO\n\n - [x] [Configrations and settings](https://github.com/adham90/elastic_map/projects/1#card-3395198)\n - [ ] [Create Index base class](https://github.com/adham90/elastic_map/projects/1#card-3398857)\n - [ ] [Object mapper](https://github.com/adham90/elastic_map/projects/1#card-3393856)\n - [ ] [Query DSL](https://github.com/adham90/elastic_map/projects/1#card-3393917)\n - [ ] [Query helpers](https://github.com/adham90/elastic_map/projects/1#card-3393926)\n - [ ] [Relations](https://github.com/adham90/elastic_map/projects/1#card-3393910)\n - [ ] [Embedding](https://github.com/adham90/elastic_map/projects/1#card-3393932)\n - [ ] [Aggregations](https://github.com/adham90/elastic_map/projects/1#card-3395154)\n - [ ] [Analyzer](https://github.com/adham90/elastic_map/projects/1#card-3395297)\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/adham90/elastic_map. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadham90%2Felastic_map","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadham90%2Felastic_map","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadham90%2Felastic_map/lists"}