escargot 0.0.2

data/test/nrt_enqueue_test.rb

@@ -0,0 +1,87 @@
+# tests the Near Real Time support in the :updates => true mode
+require 'test_helper'
+
+class NrtEnqueue < Test::Unit::TestCase
+  load_schema
+  resque_available
+
+  class User < ActiveRecord::Base
+    elastic_index :updates => :enqueue
+  end
+
+  def setup
+    User.delete_all
+    Escargot::LocalIndexing.create_index_for_model(User)
+    
+    @tim = User.create(:name => 'Tim the Wise')
+    User.create(:name => 'Peter the Young')
+    User.create(:name => 'Peter the Old')
+    User.create(:name => 'Bob the Skinny')
+    User.create(:name => 'Jamie the Flying Machine')    
+  end
+  
+  def teardown
+    User.delete_all
+    User.delete_index
+  end
+  
+  def test_document_creation
+    # the Resque tasks have not run yet, so there should be nothing in the index
+    # but now run the Resque tasks and check that the index is good
+    Resque.run!
+    User.refresh_index
+
+    assert_equal 5, User.search("*").total_entries
+    results = User.search("wise")
+    assert_equal results.total_entries, 1
+    assert_equal results.first.name, 'Tim the Wise'
+  end
+  
+  def test_document_updates
+    # now run the Resque tasks and check that the index is good
+    Resque.run!
+    User.refresh_index
+
+    assert_equal 5, User.search("*").total_entries
+
+    # make a change in a document
+    @tim.name = 'Tim the Reborn'
+    @tim.save!
+    User.refresh_index
+
+    # check that it's not in the index yet
+    assert_equal User.search_count("wise"), 1
+    assert_equal User.search_count("reborn"), 0
+    
+    # but when we run the Resque tasks, all is well
+    Resque.run!
+    User.refresh_index
+
+    assert_equal User.search_count("wise"), 0
+    assert_equal User.search_count("reborn"), 1
+  end
+  
+  def test_document_deletes
+    # now run the Resque tasks and check that the index is good
+    Resque.run!
+    User.refresh_index
+
+    assert_equal User.search("*").total_entries, 5
+
+    # Destroy the element
+    @tim.destroy
+    User.refresh_index
+    
+    # but still there until run Resque
+    assert_equal User.search("*").total_entries, 5
+
+    # but when we run the Resque tasks, all is well
+    Resque.run!
+    User.refresh_index
+    assert_equal User.search("*").total_entries, 4
+  end
+
+  def test_changes_are_updated_in_all_versions
+
+  end
+end

data/test/nrt_immediate_test.rb

@@ -0,0 +1,57 @@
+# tests the Near Real Time support in the :updates => true mode
+
+require 'test_helper'
+
+class NrtImmediate < Test::Unit::TestCase
+  load_schema
+  resque_available
+  
+  class User < ActiveRecord::Base
+    elastic_index
+  end
+  
+  def setup
+    User.delete_all
+    User.delete_index
+    Escargot::LocalIndexing.create_index_for_model(User)
+    
+    @tim = User.create(:name => 'Tim the Wise')
+    User.create(:name => 'Peter the Young')
+    User.create(:name => 'Peter the Old')
+    User.create(:name => 'Bob the Skinny')
+    User.create(:name => 'Jamie the Flying Machine')    
+  end
+  
+  def teardown
+    User.delete_all
+    User.delete_index
+  end
+  
+  def test_document_creation
+    User.refresh_index
+    assert_equal 5, User.search_count    
+    results = User.search("wise")
+    assert_equal results.total_entries, 1
+    assert_equal results.first.name, 'Tim the Wise'
+  end
+  
+  def test_document_updates
+    # make a change in a document
+    @tim.name = 'Tim the Reborn'
+    @tim.save!
+    User.refresh_index
+
+    assert_equal User.search_count("wise"), 0
+    assert_equal User.search_count("reborn"), 1
+  end
+  
+  def test_document_deletes
+    User.refresh_index
+    assert_equal 5, User.search_count
+
+    @tim.destroy
+    User.refresh_index
+
+    assert_equal 4, User.search_count
+  end
+end

data/test/nrt_immediate_with_refresh_test.rb

@@ -0,0 +1,49 @@
+# tests the Near Real Time support in the :updates => :immediate_with_refresh mode
+
+require 'test_helper'
+
+class NrtImmediateWithRefreshTest < Test::Unit::TestCase
+  load_schema
+  resque_available
+  
+  class User < ActiveRecord::Base
+    elastic_index :updates => :immediate_with_refresh
+  end
+  
+  def setup
+    User.delete_all
+    User.delete_index
+    Escargot::LocalIndexing.create_index_for_model(User)
+    
+    @tim = User.create(:name => 'Tim the Wise')
+    User.create(:name => 'Peter the Young')
+    User.create(:name => 'Peter the Old')
+    User.create(:name => 'Bob the Skinny')
+    User.create(:name => 'Jamie the Flying Machine')    
+  end
+  
+  def teardown
+    User.delete_all
+    User.delete_index
+  end
+  
+  def test_document_creation
+    assert_equal 5, User.search_count    
+    results = User.search("wise")
+    assert_equal results.total_entries, 1
+    assert_equal results.first.name, 'Tim the Wise'
+  end
+  
+  def test_document_updates
+    @tim.name = 'Tim the Reborn'
+    @tim.save!
+    assert_equal User.search_count("wise"), 0
+    assert_equal User.search_count("reborn"), 1
+  end
+  
+  def test_document_deletes
+    @tim.destroy
+    assert_equal 4, User.search_count
+  end
+  
+end

data/test/schema.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.string :country_code
+    t.date :created_at
+  end
+  
+  create_table :legacy_users, :force => true, :primary_key => :legacy_id do |t|
+    t.string :name
+    t.string :country_code
+    t.date :created_at
+  end
+  
+  create_table :renew_users, :force => true, :primary_key => :renew_id do |t|
+    t.string :name
+    t.string :country_code
+    t.date :created_at
+  end
+  
+end

data/test/search_multiple_models_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+# tests the behaviour of Searching multiple models
+
+class SearchMultipleModels < Test::Unit::TestCase
+
+  load_schema
+  flush_indexes_models
+  
+  class User < ActiveRecord::Base
+    elastic_index
+  end
+  
+  class LegacyUser < ActiveRecord::Base
+    set_primary_key :legacy_id
+    elastic_index
+  end
+
+  class RenewUser < ActiveRecord::Base
+    set_primary_key :renew_id
+    elastic_index
+  end
+
+  def setup
+
+    Escargot.flush_all_indexed_models
+
+    User.new(:name => 'Cote').save!
+    User.new(:name => 'Grillo').save!
+    User.new(:name => 'Mencho').save!
+
+    LegacyUser.new(:name => 'Cote').save!
+    LegacyUser.new(:name => 'Cote').save!
+    LegacyUser.new(:name => 'Grillo').save!
+
+    RenewUser.new(:name => 'Cote').save!
+    RenewUser.new(:name => 'Cote').save!
+    RenewUser.new(:name => 'Mencho').save!
+    
+    User.refresh_index
+    LegacyUser.refresh_index
+    RenewUser.refresh_index
+
+  end
+
+
+  def teardown
+    User.delete_all
+    User.delete_index
+    LegacyUser.delete_all
+    LegacyUser.delete_index
+    RenewUser.delete_all
+    RenewUser.delete_index
+    Escargot.flush_all_indexed_models
+  end
+  
+  
+  def test_search_multiple_models
+
+    # Search "Cote" in all Models
+    assert_equal Escargot.search("Cote").total_entries, 5
+
+    # Search "Cote" in model User
+    assert_equal Escargot.search("Cote", :classes =>[User]).total_entries, 1
+
+    # Search "Cote" in model User, if it's only one model you don't need pass like array
+    assert_equal Escargot.search("Cote", :classes => User).total_entries, 1
+
+    # Search "Cote" in model LegacyUser
+    assert_equal Escargot.search("Cote", :classes =>[LegacyUser]).total_entries, 2
+
+    # Search "Cote" in model User, LegacyUser
+    assert_equal Escargot.search("Cote", :classes =>[User,LegacyUser]).total_entries, 3
+  end
+end

data/test/search_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+#require File.dirname(__FILE__) + '/test_helper.rb'
+
+# tests the behaviour of the index creation tasks that run locally (in the "simple" mode)
+# without real time support
+
+class BasicSearchTest < Test::Unit::TestCase
+  load_schema
+  
+  class ::User < ActiveRecord::Base
+    elastic_index :updates => false, :mapping => {
+        :properties => {
+          :country_code => {:type => "string", :index => "not_analyzed"}
+        }
+    }
+    
+  end
+
+  def setup
+    User.delete_all
+    User.delete_index
+    
+    User.create(:name => 'John the Long', :country_code => 'ca')
+    User.create(:name => 'Peter the Young', :created_at => Date.today, :country_code => 'uk')
+    User.create(:name => 'Peter the Old', :created_at => Date.today - 1, :country_code => 'us')
+    User.create(:name => 'Bob the Skinny', :country_code => 'ca')
+    User.create(:name => 'John the Skinny Too', :country_code => 'it')
+    User.create(:name => 'Jamie the Amazing Flying Machine', :country_code => 'es')
+    
+    Escargot::LocalIndexing.create_index_for_model(User)
+  end
+
+  def teardown
+    User.delete_all
+    User.delete_index
+  end
+
+  def test_search_count
+    results = User.search("peter")
+    assert_equal results.total_entries, 2
+    assert_equal User.search_count("peter"), 2
+  end
+
+  def test_search_count_with_query
+    results = User.search(:term => {:name => "john"})
+    assert_equal results.total_entries, 2
+    assert_equal User.search_count(:term => {:name => "john"}), 2
+  end
+
+  def test_facets
+    assert_equal User.facets(:country_code)[:country_code]["ca"], 2
+    facets = User.facets([:name, :country_code], :query => "LONG or SKINNY", :size => 100)
+    assert_equal facets[:name]["john"], 2
+    assert_equal facets[:country_code]["it"], 1
+  end
+
+  def test_facets_size
+    assert_equal User.facets(:name)[:name].keys.size, 10
+    assert_equal User.facets(:name, :size => 1000)[:name].keys.size, 12
+  end
+
+  def test_search
+    results = User.search("peter")
+    assert_equal [results.first.name, results.second.name].sort, ['Peter the Old', 'Peter the Young']
+  end
+  
+  def test_wildcard
+    results = User.search("*")
+    assert_equal results.total_entries, 6
+  end
+  
+  def test_paging
+    results = User.search("*", :per_page => 3, :page => 2)
+    assert_equal 6, results.total_entries
+    assert_equal 2, results.current_page
+    assert_equal 3, results.per_page
+  end
+  
+  def test_sort
+    assert_equal User.search("peter", :sort => 'created_at').first.name, "Peter the Old"
+    assert_equal User.search("peter", :sort => 'created_at:desc').first.name, "Peter the Young"
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+  db_adapter = ENV['DB']
+
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite'
+      'sqlite'
+    rescue MissingSourceFile
+      begin
+        require 'sqlite3'
+        'sqlite3'
+      rescue MissingSourceFile
+      end
+    end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../rails/init.rb'
+end
+
+def resque_available
+  begin
+    require 'resque'
+    require 'resque_unit'
+    Resque.reset!
+    return true
+  rescue NameError, MissingSourceFile
+    puts "Please install the 'resque' and 'resque_unit' gems to test the distributed mode."
+    exit
+  end
+end
+
+def flush_indexes_models
+  Escargot.flush_all_indexed_models
+end  

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: escargot
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Angel Faus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-03 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubberband
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 0
+        - 5
+        version: 0.0.5
+  type: :runtime
+  version_requirements: *id002
+description: Connects any Rails model with ElasticSearch, supports near real time updates, distributed indexing and models that integrate data from many databases.
+email: 
+- angel@vlex.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- escargot.gemspec
+- init.rb
+- install.rb
+- lib/escargot.rb
+- lib/escargot/activerecord_ex.rb
+- lib/escargot/distributed_indexing.rb
+- lib/escargot/elasticsearch_ex.rb
+- lib/escargot/local_indexing.rb
+- lib/escargot/queue_backend/base.rb
+- lib/escargot/queue_backend/resque.rb
+- lib/escargot/version.rb
+- lib/tasks/escargot.rake
+- rails/init.rb
+- test/admin_index_test.rb
+- test/database.yml
+- test/define_index_test.rb
+- test/distributed_index_creation_test.rb
+- test/index_options_test.rb
+- test/indexed_content_test.rb
+- test/local_index_creation_test.rb
+- test/mappings_test.rb
+- test/nrt_enqueue_test.rb
+- test/nrt_immediate_test.rb
+- test/nrt_immediate_with_refresh_test.rb
+- test/schema.rb
+- test/search_multiple_models_test.rb
+- test/search_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/angelf/escargot
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: escargot
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: ElasticSearch connector for Rails
+test_files: []
+