Nazrin
Nazrin is a Ruby wrapper for Amazon CloudSearch (aws-sdk), with ActiveRecord, Mongoid support for easy integration with your Rails application.
Nazrin has the ability of the extent which find what you're looking for...
Installation
Add this line to your application's Gemfile:
gem 'nazrin'And then execute:
$ bundle
Or install it yourself as:
$ gem install nazrin
Usage
in Ruby on Rails
$ bundle exec rails g nazrin:config # execute before including nazrin to model
Nazrin.configure do |config|
config.debug_mode = false
config.mode = 'production'
config.search_endpoint = ''
config.document_endpoint = ''
config.region = ''
config.access_key_id = ''
config.secret_access_key = ''
config.logger = nil
endclass Post < ActiveRecord::Base
include Nazrin::Searchable
# You can override settings
searchable_configure do |config|
config.search_endpoint = 'http://example.com/override-search-endpoint'
config.document_endpoint = 'http://example.com/override-document-endpoint'
# If you set domain_name, CloudSearch data using index_fields configured for the search domain is loaded, not a database.
# So you can use nazrin for plain object
config.domain_name = 'my-cloudsearch-domain-name'
end
searchable do
fields [:content]
field(:created_at) { created_at.utc.iso8601 }
end
after_create :add_to_index
after_update :update_in_index
after_destroy :delete_from_index
end.search
result = Post.search(where: :foo, includes: :bar).size(1).start(0).query("(and 'content')").query_parser('structured').execute
=> [#<Post id: 1, content: "content">]
# You can access facets
result.facets
=> {}.batch_operation
post1 = Post.create
post2 = Post.create
post3 = Post.create
post3.destroy
Post.batch_operation(
add: [post1, post2],
delete: [post3]
)Supported pagination libraries
If you want to use other supported pagination libraries, for example, nazrin-kaminari generates Kaminari::PaginatableArray instead of Nazrin::PaginatedArray.
gem 'nazrin'
gem 'nazrin-kaminari'Currently supported libraries
- kaminari: nazrin-kaminari
Sandbox mode
When there is no instance for development and you don't want to request to CloudSearch
Nazrin.config.mode = 'sandbox'"sandbox" mode where it does nothing with any requests and just returns an empty collection for any searches.
Development
After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.
To 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Contributing
- Fork it ( https://github.com/[my-github-username]/nazrin/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request