elasticsearch-rails2 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elasticsearch-rails2.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Edgar Gonzalez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,201 @@
+# Elasticsearch::Rails2 [![Build Status](https://travis-ci.org/edgar/elasticsearch-rails2.png?branch=master)](https://travis-ci.org/edgar/elasticsearch-rails2)
+
+The `elasticsearch-rails2` library is based on the
+[`elasticsearch-model`](https://github.com/elasticsearch/elasticsearch-model) and builds on top of the
+the [`elasticsearch`](https://github.com/elasticsearch/elasticsearch-ruby) library.
+
+It aims to simplify integration of [Ruby on Rails](http://rubyonrails.org) 2.3 models (`ActiveRecord`)
+with the [Elasticsearch](http://www.elasticsearch.org) search.
+
+(If your app is in Ruby on Rails 2.3 you can't use [`elasticsearch-model`](https://github.com/elasticsearch/elasticsearch-model) because it requires Ruby on Rails >= 3.0)
+
+The library is compatible with Ruby 1.9.3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'elasticsearch-rails2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elasticsearch-rails2
+
+## Usage
+
+Let's suppose you have an `Article` model:
+
+```ruby
+require 'elasticsearch/rails2'
+
+class Article < ActiveRecord::Base
+  include Elasticsearch::Rails2
+end
+```
+
+This will extend the model with functionality related to Elasticsearch:
+
+### Elasticsearch client
+
+The module will set up a [client](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch),
+connected to `localhost:9200`, by default. You can access and use it as any other `Elasticsearch::Client`:
+
+```ruby
+Article.client.cluster.health
+# => { "cluster_name"=>"elasticsearch", "status"=>"yellow", ... }
+```
+
+To use a client with different configuration, just set up a client for the model:
+
+```ruby
+Article.client = Elasticsearch::Client.new host: 'api.server.org'
+```
+
+Or configure the client for all models:
+
+```ruby
+Elasticsearch::Rails2.client = Elasticsearch::Client.new log: true
+```
+
+You might want to do this during you application bootstrap process, e.g. in a Rails initializer.
+
+Please refer to the
+[`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport)
+library documentation for all the configuration options, and to the
+[`elasticsearch-api`](http://rubydoc.info/gems/elasticsearch-api) library documentation
+for information about the Ruby client API.
+
+### Searching
+
+For starters, we can try the "simple" type of search:
+
+```ruby
+response = Article.search 'fox dogs'
+
+response.took
+# => 3
+
+response.results.total
+# => 2
+
+response.results.first._score
+# => 0.02250402
+
+response.results.first._source.title
+# => "Quick brown fox"
+```
+
+#### Search results
+
+The returned `response` object is a rich wrapper around the JSON returned from Elasticsearch,
+providing access to response metadata and the actual results ("hits").
+
+Each "hit" is wrapped in the `Result` class, and provides method access
+to its properties via [`Hashie::Mash`](http://github.com/intridea/hashie).
+
+The `results` object supports the `Enumerable` interface:
+
+```ruby
+response.results.map { |r| r._source.title }
+# => ["Quick brown fox", "Fast black dogs"]
+
+response.results.select { |r| r.title =~ /^Q/ }
+# => [#<Elasticsearch::Model::Response::Result:0x007 ... "_source"=>{"title"=>"Quick brown fox"}}>]
+```
+
+In fact, the `response` object will delegate `Enumerable` methods to `results`:
+
+```ruby
+response.any? { |r| r.title =~ /fox|dog/ }
+# => true
+```
+
+To use `Array`'s methods (including any _ActiveSupport_ extensions), just call `to_a` on the object:
+
+```ruby
+response.to_a.last.title
+# "Fast black dogs"
+```
+
+#### Search results as database records
+
+Instead of returning documents from Elasticsearch, the `records` method will return a collection
+of model instances, fetched from the primary database, ordered by score:
+
+```ruby
+response.records.to_a
+# Article Load (0.3ms)  SELECT "articles".* FROM "articles" WHERE "articles"."id" IN (1, 2)
+# => [#<Article id: 1, title: "Quick brown fox">, #<Article id: 2, title: "Fast black dogs">]
+```
+
+The returned object is the genuine collection of model instances returned by your database,
+
+The `records` method returns the real instances of your model, which is useful when you want to access your
+model methods -- at the expense of slowing down your application, of course.
+In most cases, working with `results` coming from Elasticsearch is sufficient, and much faster. See the
+[`elasticsearch-rails`](https://github.com/elasticsearch/elasticsearch-rails/tree/master/elasticsearch-rails)
+library for more information about compatibility with the Ruby on Rails framework.
+
+#### The Elasticsearch DSL
+
+In most situation, you'll want to pass the search definition
+in the Elasticsearch [domain-specific language](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html) to the client:
+
+```ruby
+response = Article.search query:     { match:  { title: "Fox Dogs" } },
+                          highlight: { fields: { title: {} } }
+
+response.results.first.highlight.title
+# ["Quick brown <em>fox</em>"]
+```
+
+You can pass any object which implements a `to_hash` method, or you can use your favourite JSON builder
+to build the search definition as a JSON string:
+
+```ruby
+require 'jbuilder'
+
+query = Jbuilder.encode do |json|
+  json.query do
+    json.match do
+      json.title do
+        json.query "fox dogs"
+      end
+    end
+  end
+end
+
+response = Article.search query
+response.results.first.title
+# => "Quick brown fox"
+```
+
+### Index Configuration
+
+By default, index name and document type will be inferred from your class name,
+you can set it explicitely, however:
+
+```ruby
+class Article
+  index_name    "articles-#{Rails.env}"
+  document_type "post"
+end
+```
+
+For `index_name` there is a global setting in case you want to use the same index for all models:
+
+```ruby
+Elasticsearch::Rails2.index_name = 'production'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+task :default => :spec
+task :test => :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r elasticsearch/rails2.rb"
+end

data/elasticsearch-rails2.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elasticsearch/rails2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elasticsearch-rails2"
+  spec.version       = Elasticsearch::Rails2::VERSION
+  spec.authors       = ["Edgar Gonzalez"]
+  spec.email         = ["edgargonzalez@gmail.com"]
+  spec.description   = "Rails 2.3 ActiveRecord integrations for Elasticsearch"
+  spec.summary       = "Rails 2.3 ActiveRecord integrations for Elasticsearch"
+  spec.homepage      = "https://github.com/edgar/elasticsearch-rails2"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = "1.9.3"
+
+  spec.add_dependency "elasticsearch", '>= 1.0.5'
+  spec.add_dependency "activerecord", '2.3.18'
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', "~> 3.1.0"
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/elasticsearch/rails2.rb

@@ -0,0 +1,63 @@
+require 'elasticsearch'
+
+require 'hashie'
+require 'active_record'
+
+require "elasticsearch/rails2/version"
+require "elasticsearch/rails2/configuration"
+require "elasticsearch/rails2/client"
+require "elasticsearch/rails2/naming"
+require "elasticsearch/rails2/searching"
+require "elasticsearch/rails2/response"
+require "elasticsearch/rails2/response/result"
+require "elasticsearch/rails2/response/results"
+
+module Elasticsearch
+  module Rails2
+
+    def self.included(base)
+      base.send :include, Elasticsearch::Rails2::Client::InstanceMethods
+      base.extend Elasticsearch::Rails2::Client::ClassMethods
+
+      base.send :include, Elasticsearch::Rails2::Naming::InstanceMethods
+      base.extend Elasticsearch::Rails2::Naming::ClassMethods
+
+      base.extend Elasticsearch::Rails2::Searching::ClassMethods
+    end
+
+    module ClassMethods
+      # Get the client common for all models
+      #
+      # @example Get the client
+      #
+      #     Elasticsearch::Model.client
+      #     => #<Elasticsearch::Transport::Client:0x007f96a7d0d000 @transport=... >
+      #
+      def client
+        @client ||= Elasticsearch::Client.new
+      end
+
+      # Set the client for all models
+      #
+      # @example Configure (set) the client for all models
+      #
+      #     Elasticsearch::Model.client Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
+      #     => #<Elasticsearch::Transport::Client:0x007f96a6dd0d80 @transport=... >
+      #
+      # @note You have to set the client before you call Elasticsearch methods on the model,
+      #       or set it directly on the model; see {Elasticsearch::Model::Client::ClassMethods#client}
+      #
+      def client=(client)
+        @client = client
+      end
+
+      def options=(options={})
+        Configuration::VALID_OPTIONS_KEYS.each do |key|
+          send("#{key}=", options[key])
+        end
+      end
+    end
+    extend ClassMethods
+    extend Configuration
+  end
+end

data/lib/elasticsearch/rails2/client.rb

@@ -0,0 +1,58 @@
+module Elasticsearch
+  module Rails2
+    module Client
+      # Contains an `Elasticsearch::Client` instance
+      #
+      module ClassMethods
+
+        # Get the client for a specific model class
+        #
+        # @example Get the client for `Building` and perform API request
+        #
+        #     Building.client.cluster.health
+        #     # => { "cluster_name" => "elasticsearch" ... }
+        #
+        def client
+          @client ||= Elasticsearch::Rails2.client
+        end
+
+        # Set the client for a specific model class
+        #
+        # @example Configure the client for the `Building` model
+        #
+        #     Building.client = Elasticsearch::Client.new host: 'http://api.server:8080'
+        #     Building.search ...
+        #
+        def client=(client)
+          @client = client
+        end
+      end
+
+      module InstanceMethods
+
+        # Get or set the client for a specific model instance
+        #
+        # @example Get the client for a specific record and perform API request
+        #
+        #     @building = Building.first
+        #     @building.client.info
+        #     # => { "name" => "Node-1", ... }
+        #
+        def client
+          @client ||= self.class.client
+        end
+
+        # Set the client for a specific model instance
+        #
+        # @example Set the client for a specific record
+        #
+        #     @building = Building.first
+        #     @building.client = Elasticsearch::Client.new host: 'http://api.server:8080'
+        #
+        def client=(client)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/rails2/configuration.rb

@@ -0,0 +1,39 @@
+module Elasticsearch
+  module Rails2
+  # Defines constants and methods related to configuration
+    module Configuration
+      # An array of valid keys in the options hash when configuring Elasticsearch::Rails2
+      VALID_OPTIONS_KEYS = [
+        :index_name
+      ].freeze
+
+      # By default, don't set an index_name
+      DEFAULT_INDEX_NAME = nil
+
+      # @private
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      # When this module is extended, set all configuration options to their default values
+      def self.extended(base)
+        base.reset
+      end
+
+      # Convenience method to allow configuration options to be set in a block
+      def configure
+        yield self
+      end
+
+      # Create a hash of options and their values
+      def options
+        VALID_OPTIONS_KEYS.inject({}) do |option, key|
+          option.merge!(key => send(key))
+        end
+      end
+
+      # Reset all configuration options to defaults
+      def reset
+        self.index_name     = DEFAULT_INDEX_NAME
+      end
+    end
+  end
+end