elastico 0.0.3 → 0.0.4

data/Gemfile

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

data/Gemfile.lock

@@ -1,12 +1,15 @@
 PATH
   remote: .
   specs:
-    elastico (0.0.3)
+    elastico (0.0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    mime-types (1.25)
     rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     spawnling (2.1.1)
 
 PLATFORMS
@@ -15,4 +18,5 @@ PLATFORMS
 DEPENDENCIES
   elastico!
   rake
+  rest-client
   spawnling (~> 2.1.1)

data/README.md

@@ -1,6 +1,23 @@
 # Elastico
 
-TODO: Write a gem description
+Elastico is a __simple__ layer that enables you to use elasticsearch __full__ API. The elasticsearch team created this [great API](http://www.elasticsearch.org/guide/) which enables you to do almost anything todays search engines allow you to do. 
+
+__Simple__. Elastico is built in a way so your configuration and usage is as simple and streat forward as possible. 
+
+__Full__. Elastico is built to be transparent, non-blocking, non-opinionated layer between your code to elasticsearch API. Meaning Elastico won't force anything about how to index your active records models, neither how to search it.
+
+There is one reason for building it Simple and Full:
+Elasticsearch community is large. Its supportive, and very helpful. Though most of it does not use ruby. Its most likely that you want to spend your time on feaguring out how to use elasticsearch rather than how to use the gem that works with elasticsearch. If you use Elastico, its most likely that your time will go to the former, and will be able to take advantage of the elasticsearch community.
+
+You should give Elastico a try if you want to use elasticsearch full api. 
+
+
+## Elasticsearch mini Background
+
+In general, in order to be able to use elasticsearch search capabilities you should:
+
+1. Define what and how you want to index (settings and mappings)
+2. Define what and how you want to search (query the index)
 
 ## Installation
 
@@ -10,7 +27,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -18,7 +35,80 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your model:
+
+  class Apple < ActiveRecord::Base
+
+    def self.prepare_elastico_settings_and_mappings_json
+      json = { "apple" => {
+            "properties" => {
+                "name" => {"type" => "string"},
+                "color" => {"type" => "string"}
+            }
+        }}.to_json
+    end
+    include Elastico
+
+    attr_accessible :color, :name
+    
+  end
+
+
+In your controller:
+
+    class ApplesController < ApplicationController  
+        def index
+          if params[:query]
+            Apple.search_query = prepare_search_json_for params[:query]
+            @apples = Apple.elastico_search
+          else
+            @apples = Apple.all
+          end
+        end
+
+        private
+          def prepare_search_json_for query
+            json = { "query" => 
+                      {
+                        "term" => { "color" => query.to_s }
+                      }
+                    }.to_json
+          end
+        # now do something with your apples 
+    end
+
+
+Learn by Example
+================
+Fork the example app that shows how to use Elastico [here](https://github.com/gneyal/ElasticoExample).
+
+
+Configure it
+------------
+
+In order to get a model work with elasticsearch + Elastico you have to:
+
+__Mandatory__
+
+1. In your controller, Create a class method __'prepare\_search\_json\_for'__ to be your standard search query for that model (defaults to nil). This is the same search query you would send if you were using the curl command.
+
+2. In your model, Create a class method __'prepare\_elastico\_settings\_and\_mappings\_json'__ to be your settings and mapping json (defaults to nil). This is the same search query you would send if you were using the curl command.
+
+__Optional__
+
+1. Set Apple.elastico\_url= to be the ip of your elasticsearch server (defaults to "localhost:9200").
+
+2. Set up Apple.elastico\_index\_name (optional - defaults to your class name followed by Rail.env; here it will be apples_development).
+
+3. Set up Apple.elastico\_type\_name (optional - defaults to your class name; here it will be Apple).
+
+Use it.
+-------
+1. After every save Elastico will automatically save you instance in elasticsearch.
+
+2. Import current database instances by creating a rake task to "save" them all.
+
+3. Search it: call Apple.elastico_search to get your results, or override it to better suit your needs.
 
 ## Contributing
 
@@ -28,63 +118,6 @@ TODO: Write usage instructions here
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-Usage:
-
-In order to get a model work with elastic search you have to:
-1. Set Elastico::Configuration.url= to be the ip of your elasticsearch server (defaults to "localhost").
-2. Set Elastico::Index.settings_and_mappings_json= to be your settings and mapping json.
-3. Set up Elastico::Search.search_json= to be your standard search query for that model.
-4. Elastico will automatically save your active record models after every "save" call on that instance.
-5. In later versions I will add an auto rake task to import all of your Elastico models to elasticsearch server.
-
-
-In order to search this model, all you need to do is to do Model.elastic_search(term). This will return the elasticsearch results in an Elastico results object. You should override this method (elastic_search) if you want to get a better tailored solution.
-=======
-
-Usage:
-======
-
-1. Setup (define the mapping and settings)
-2. Index current data (Rake task)
-3. Search (define how to search, what to search)
-4. Callbacks (automatically added)
-
-
-class Someclass < ActiveRecord::Base
-	Elastico::Setup = { } (How to index)
-	Elastico::Search = {} (What to search)
-	Elastico:Index = {} (What to index)
-end
-
-
-Setup
-=====
-You should give a hash that looks something like that:
-settings_json[:settings] = {
-              :settings => {
-                :number_of_shards => 2,
-                :number_of_replicas => 0,
-                :analysis => {
-                  :filter => {
-                    :my_ngram  => {
-                       "type"     => "nGram",
-                       "max_gram" => 15,
-                       "min_gram" => 1 
-                     },
-                     :my_stemmer => {
-                      "type" => "stemmer",
-                      "name" => "english"
-                      }
-                   },
-                    :analyzer => {
-                      :ngram_analyzer => {
-                        "tokenizer"    => "whitespace",
-                        "filter"       => ["stop", "my_ngram", "lowercase"],
-                        "type"         => "custom" 
-                      }
-                    }
-                 } 
-                }
-              }
+## Feedback
 
-a
+Please send your feedback to gneyal+elastico@gmail.com

data/elastico.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |gem|
   gem.name          = "elastico"
   gem.version       = Elastico::VERSION
   gem.authors       = ["Eyal Goren"]
-  gem.email         = ["gneyal@gmail.com"]
+  gem.email         = ["gneyal+elastico@gmail.com"]
   gem.description   = %q{A general way to use elasticsearch}
   gem.summary       = %q{Elastico presents a simple way to work with elasticsearch. 1. Define your setup. 2. Define your search query. 3. Search.}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/gneyal/Elastico"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -19,4 +19,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency "spawnling", "~> 2.1.1"
+  gem.add_development_dependency "rest-client"
 end

data/lib/elastico/callbacks.rb

@@ -2,10 +2,13 @@ module Elastico
 	module Callbacks
 		def self.included(base)
 			update_conditions = lambda { update_index_with_instance_elastico }
-
+      destroy_instance = lambda { destroy_instance_in_elastic_search }
 			base.send :after_save, update_conditions
-			base.send :after_destroy, update_conditions
+			base.send :after_destroy, destroy_instance
       base.send :after_touch, update_conditions
+
+      base.send :settings_and_mappings_json=, base.prepare_elastico_settings_and_mappings_json
+      base.send :send_settings_mappings_to_elasticsearch_server
 		end
 
     def update_index_with_instance_elastico
@@ -16,5 +19,13 @@ module Elastico
       instance = self.to_json
       self.class.general_request(instance, url)
     end
+
+    def destroy_instance_in_elastic_search
+      type = self.class.elastico_type_name
+      index = self.class.elastico_index_name
+      id = self.id
+      url = self.class.elastico_url + index + "/" + type + "/" + id.to_s
+      self.class.delete_instance(url)
+    end
 	end
 end

data/lib/elastico/client.rb

@@ -8,20 +8,30 @@ module Elastico
 			end
 		end
 
-		def general_request(content=nil, url=self.elastico_url, hash_respond_wanted = true)
-			RestClient.post(url, content, :content_type => :json, :accept => :json) do |response, request, result|
-			  ret = JSON.pretty_generate(JSON.parse(response.to_str))
- 				hash_respond_wanted ? JSON.parse(ret) : ret
-			end
+		def delete_instance url
+			RestClient.delete url
+		end
+
+		def general_request(content=nil, url=self.elastico_url, options = { :hash_respond_wanted => :true })
+
+				logger.info("========== in post ")
+				RestClient.post(url, content, :content_type => :json, :accept => :json) do |response, request, result|
+				  ret = JSON.pretty_generate(JSON.parse(response.to_str))
+	 				options[:hash_respond_wanted] ? JSON.parse(ret) : ret
+				end
 		end
 
 		def elastico_search(hash_respond_wanted = true)
 			to_url = self.elastico_url + self.elastico_index_name + "/_search" 
-			response = ""
-			RestClient.get(to_url, JSON.parse(self.search_query)) do |response, request, result|
-				ret = JSON.pretty_generate(JSON.parse(response.to_str))
-				hash_respond_wanted ? JSON.parse(ret) : ret
-			end	
+			
+			RestClient.post(to_url, self.search_query, :content_type => :json, :accept => :json) do |response, request, result|
+			  ret = JSON.pretty_generate(JSON.parse(response.to_str))
+ 				hash_respond_wanted ? JSON.parse(ret) : ret
+			end
+
 		end
 	end
-end
+end
+ # curl -XGET "http://localhost:9200/apples_development/_search" -d '{"query":{"term":{"color":"test"}}}'
+
+ # RestClient.post "http://localhost:9200/apples_development/_search", '{"query":{"term":{"color":"test"}}}', :content_type => :json

data/lib/elastico/index.rb

@@ -13,7 +13,7 @@ module Elastico
 		end
 
 		def elastico_index_name
-			(@index_name || self.name.gsub(/::/, "_").pluralize).downcase
+			(@index_name || (self.name.gsub(/::/, "_").pluralize + "_" + Rails.env) ).downcase
 		end
 
 		def elastico_index_name= index_name

data/lib/elastico/version.rb

@@ -1,3 +1,3 @@
 module Elastico
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: elastico
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
+  prerelease: 
 platform: ruby
 authors:
 - Eyal Goren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-15 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: spawnling
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,13 +38,30 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A general way to use elasticsearch
 email:
-- gneyal@gmail.com
+- gneyal+elastico@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -65,28 +86,29 @@ files:
 - test/lib/elastico/search_test.rb
 - test/lib/elastico/version_test.rb
 - test/test_helper.rb
-homepage: ''
+homepage: https://github.com/gneyal/Elastico
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Elastico presents a simple way to work with elasticsearch. 1. Define your
   setup. 2. Define your search query. 3. Search.
 test_files:

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2JkZTg4NmYzZjZkM2QwNjEyZjFjMjFiOGU2OGIzY2YyYjZmMzM1Nw==
-  data.tar.gz: !binary |-
-    OGEwOTQ3ZDcwZWUzMDhkOGU5NjM4YWM0NTczMTE0N2U3MWQ0NDZiOQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    OGRjYzhlZDUyNDhhOTZiYTg5MzYxNzVjMzhmMWE5NzgyNmQ4MTdjNTMwMWFl
-    MGZiMjBiMjY2ZDAwMGFlY2YyMDY0NWE4N2UxYmRkMmYyYTM2ZjNhNmZlMDZh
-    NTJjZjA1NGI5N2JkNWVhZTVjMWIxNWY1NjFlOGE1ZTM0YTM5NDA=
-  data.tar.gz: !binary |-
-    NGZlZjQ1MzUyMTE2MGFlODIxMjQxZWVmYWZkYTkzMTcwNjE2YjZhZDZjYjIz
-    OTQ5ZGEwOGI3YmU2NjVmNDFhNmUxOWJkMjg2NmJlNGI2NTY2OTM1YTlmNjI5
-    ZDA2MTI2MTQzNmU2YmJkMjU3MmM1NzYyNmY3YzJmMjhhMWQ2ODI=