https://github.com/grokify/elastirad-ruby
Elasticsearch client with JSON API interface in Ruby.
https://github.com/grokify/elastirad-ruby
elasticsearch ruby ruby-gem search-engine
Last synced: 3 months ago
JSON representation
Elasticsearch client with JSON API interface in Ruby.
- Host: GitHub
- URL: https://github.com/grokify/elastirad-ruby
- Owner: grokify
- License: mit
- Created: 2016-07-10T08:21:38.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-14T09:18:29.000Z (over 8 years ago)
- Last Synced: 2024-10-12T00:46:37.425Z (9 months ago)
- Topics: elasticsearch, ruby, ruby-gem, search-engine
- Language: Ruby
- Homepage:
- Size: 34.2 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Elastirad: A Ruby SDK Wrapper for Elasticsearch
===============================================
[![Gem Version][gem-version-svg]][gem-version-link]
[![Build Status][build-status-svg]][build-status-link]
[![Dependency Status][dependency-status-svg]][dependency-status-link]
[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
[![Downloads][downloads-svg]][downloads-link]
[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
[![License][license-svg]][license-link]
## Synopsis
Elastirad is a simple wrapper for Elasticsearch's `Elasticsearch::API` that makes requests using Elasticsearch's online cURL-based documentation without needing to understand the syntax of the [Elasticsearch Ruby SDK](https://github.com/elastic/elasticsearch-ruby).
`Elastirad::Client` includes `Elasticsearch::API` and thus supports `Elasticsearch::API` methods.
Benefits include:
* Direct use of documentation URLs, e.g. `_search`
* [URI search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html), e.g. `tweet/_search?q=user:kimchy`
## Installation
Download and install elastirad with the following:
```
$ gem install elastirad
```
## Usage
```ruby
require 'elastirad'
# Defaults to http://localhost:9200
rad = Elastirad::Client.new
# All of the following arguments are optional
# Setting :index will enable request code to not include the index
# for greater flexibility when switching between deployments, e.g.
# dev, staging, production, etc.
rad = Elastirad::Client.new(
scheme: 'https', # defaults to 'http'
hostname: 'localhost', # defaults to 'localhost'
port: 9200, # defaults to 9200
index: 'twitter'
)
# path can be a simple string. Leading slash will over ride default :index
result_hash = rad.request path: '/twitter/_count'
# path can also be an array
result_hash = rad.request path: ['/twitter/tweet', 1 ]
# default index can be used without leading slash
result_hash = rad.request path: ['tweet', 1 ]
# retreive all responses for :get requests only
result_hash = rad.request_all path: 'tweet/_search'
# optional :verb can be used for non-GET requests, :get is used by default
# :body can be a hash or JSON string
tweet = { user: 'kimchy', message: 'trying out Elasticsearch' }
result_hash = rad.request(
verb: 'put',
path: ['tweet', 1 ],
body: tweet
)
result_hash = rad.request(
verb: 'put',
path: ['tweet', 1 ],
body: JSON.dump( tweet )
)
# Can be used with ES URI Search
result_hash = rad.request(
path: 'tweet/_search?q=user:kimchy'
)
# :put verb can automatically be added using #rad_index method
result_hash = rad.rad_index(
path: ['tweet', 1 ],
body: tweet
)
# Use with Hashie
require 'hashie'
mash = Hashie::Mash.new result_hash
puts mash.hits.total
# Supports Elasticsearch::API methods
p rad.cluster.health
# --> GET _cluster/health {}
# => "{"cluster_name":"elasticsearch" ... }"
```
## Documentation
This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:
```bash
$ gem install yard
$ yard server -g
```
## Change Log
See [CHANGELOG.md](CHANGELOG.md).
## Links
Elasticseach Reference Guide
* https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
Elasticsearch::API for Ruby
* https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-api
## License
Elastirad is available under an MIT-style license. See [LICENSE.md](LICENSE.md) for details.
Elastirad © 2014-2016 by John Wang
[gem-version-svg]: https://badge.fury.io/rb/elastirad.svg
[gem-version-link]: http://badge.fury.io/rb/elastirad
[downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/elastirad
[downloads-link]: https://rubygems.org/gems/elastirad
[build-status-svg]: https://api.travis-ci.org/grokify/elastirad-ruby.svg?branch=master
[build-status-link]: https://travis-ci.org/grokify/elastirad-ruby
[coverage-status-svg]: https://coveralls.io/repos/grokify/elastirad-ruby/badge.svg?branch=master
[coverage-status-link]: https://coveralls.io/r/grokify/elastirad-ruby?branch=master
[dependency-status-svg]: https://gemnasium.com/grokify/elastirad-ruby.svg
[dependency-status-link]: https://gemnasium.com/grokify/elastirad-ruby
[codeclimate-status-svg]: https://codeclimate.com/github/grokify/elastirad-ruby/badges/gpa.svg
[codeclimate-status-link]: https://codeclimate.com/github/grokify/elastirad-ruby
[scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/elastirad-ruby/badges/quality-score.png?b=master
[scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/elastirad-ruby/?branch=master
[docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
[docs-rubydoc-link]: http://www.rubydoc.info/gems/elastirad/
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
[license-link]: https://github.com/grokify/elastirad-ruby/blob/master/LICENSE