gom-elasticsearch-adapter 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Philipp Brüll
+
+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.rdoc

@@ -0,0 +1,4 @@
+
+= Generic Object Mapper - ElasticSearch adapter
+
+{<img src="http://travis-ci.org/phifty/gom-elasticsearch-adapter.png" />}[http://travis-ci.org/phifty/gom-elasticsearch-adapter]

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+gem 'rspec'
+gem 'reek'
+require 'rspec'
+require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+require 'reek/rake/task'
+
+task :default => :spec
+
+namespace :gem do
+
+  desc "Builds the gem"
+  task :build do
+    system "gem build *.gemspec && mkdir -p pkg/ && mv *.gem pkg/"
+  end
+
+  desc "Builds and installs the gem"
+  task :install => :build do
+    system "gem install pkg/"
+  end
+
+end
+
+Reek::Rake::Task.new do |task|
+  task.fail_on_error = true
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.add [ "README.rdoc", "lib/**/*.rb" ]
+  rdoc.main = "README.rdoc"
+  rdoc.title = ""
+end
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = "spec/lib/**/*_spec.rb"
+end
+
+namespace :spec do
+
+  desc "Run all integration specs in spec/acceptance directory"
+  RSpec::Core::RakeTask.new(:acceptance) do |task|
+    task.pattern = "spec/acceptance/**/*_spec.rb"
+  end
+
+end

data/lib/gom/elasticsearch-adapter.rb

@@ -0,0 +1,5 @@
+require 'gom'
+require 'gom/couchdb-adapter'
+require File.join(File.dirname(__FILE__), "storage")
+
+GOM::Storage::Adapter.register :elasticsearch, GOM::Storage::ElasticSearch::Adapter

data/lib/gom/storage.rb

@@ -0,0 +1,6 @@
+
+module GOM::Storage
+
+  autoload :ElasticSearch, File.join(File.dirname(__FILE__), "storage", "elastic_search")
+
+end

data/lib/gom/storage/elastic_search.rb

@@ -0,0 +1,9 @@
+
+module GOM::Storage::ElasticSearch
+
+  autoload :Adapter, File.join(File.dirname(__FILE__), "elastic_search", "adapter")
+  autoload :Collection, File.join(File.dirname(__FILE__), "elastic_search", "collection")
+  autoload :CouchDB, File.join(File.dirname(__FILE__), "elastic_search", "couchdb")
+  autoload :Draft, File.join(File.dirname(__FILE__), "elastic_search", "draft")
+
+end

data/lib/gom/storage/elastic_search/adapter.rb

@@ -0,0 +1,94 @@
+require 'tire'
+
+# The ElasticSearch storage adapter.
+class GOM::Storage::ElasticSearch::Adapter < GOM::Storage::Adapter
+
+  attr_reader :storage_configuration
+
+  def setup
+    setup_connection
+    setup_index
+    assign_storage
+    setup_river
+  end
+
+  def teardown
+    
+  end
+
+  def fetch(id)
+    storage_adapter.fetch id
+  end
+
+  def store(draft)
+    storage_adapter.store draft
+  end
+
+  def remove(id)
+    storage_adapter.remove id
+  end
+
+  def collection(name, options = { })
+    view = configuration.views[name.to_sym]
+    raise ArgumentError, "the given view #{name} isn't defined!'" unless view
+
+    query_string = build_query view.class_name, options[:query]
+    search = Tire.search @index_name do
+      query { string query_string }
+    end
+
+    GOM::Object::Collection.new GOM::Storage::ElasticSearch::Collection::Fetcher.new(search.results), configuration.name
+  end
+
+  private
+
+  def storage_adapter
+    storage_configuration.adapter
+  end
+
+  def setup_connection
+    @host, @port = *configuration.values_at(:host, :port)
+    @host ||= "localhost"
+    @port ||= 9200
+
+    # Tire.configure { url "http://#{@host}:#{@port}" }
+  end
+
+  def setup_index
+    @index_name, delete_index_if_exists, create_index_if_missing =
+      *configuration.values_at(:index_name, :delete_index_if_exists, :create_index_if_missing)
+
+    Tire.index @index_name do
+      delete if delete_index_if_exists && exists?
+      create if create_index_if_missing && !exists?
+    end
+  end
+
+  def assign_storage
+    assign_to_storage = configuration[:assign_to_storage]
+
+    @storage_configuration = GOM::Storage::Configuration[assign_to_storage]
+    raise ArgumentError, "the specified storage #{assign_to_storage} doesn't exists" unless @storage_configuration
+  end
+
+  def setup_river
+    delete_river_if_exists, create_river_if_missing =
+      *configuration.values_at(:delete_river_if_exists, :create_river_if_missing)
+
+    river = GOM::Storage::ElasticSearch::CouchDB::River.new :couch_db => storage_configuration,
+                                                            :elastic_search => {
+                                                              :host => @host,
+                                                              :port => @port,
+                                                              :index_name => @index_name
+                                                            }
+
+    river.delete_if_exists if delete_river_if_exists
+    river.create_if_missing if create_river_if_missing
+  end
+
+  def build_query(model_class, query)
+    terms = [ model_class ].flatten.compact.map{ |klass| "model_class:\"#{klass}\"" }
+    "(#{terms.join(" OR ")})" + (query && query != "" ? " AND #{query}" : "")
+  end
+
+end

data/lib/gom/storage/elastic_search/collection.rb

@@ -0,0 +1,6 @@
+
+module GOM::Storage::ElasticSearch::Collection
+
+  autoload :Fetcher, File.join(File.dirname(__FILE__), "collection", "fetcher")
+
+end

data/lib/gom/storage/elastic_search/collection/fetcher.rb

@@ -0,0 +1,16 @@
+
+class GOM::Storage::ElasticSearch::Collection::Fetcher
+
+  def initialize(results)
+    @results = results
+  end
+
+  def drafts
+    drafts = [ ]
+    @results.each do |item|
+      drafts << GOM::Storage::ElasticSearch::Draft::Builder.new(item).draft
+    end
+    drafts
+  end
+
+end

data/lib/gom/storage/elastic_search/couchdb.rb

@@ -0,0 +1,6 @@
+
+module GOM::Storage::ElasticSearch::CouchDB
+
+  autoload :River, File.join(File.dirname(__FILE__), "couchdb", "river")
+
+end

data/lib/gom/storage/elastic_search/couchdb/river.rb

@@ -0,0 +1,56 @@
+require 'transport'
+
+class GOM::Storage::ElasticSearch::CouchDB::River
+
+  def initialize(options)
+    @couch_db = options[:couch_db]
+    @elastic_search = options[:elastic_search]
+  end
+
+  def create
+    Transport::JSON.request :put, "#{elastic_search_base_url}/_river/#{@elastic_search[:index_name]}/_meta",
+                            :body => {
+                              :type => "couchdb",
+                              :couchdb => {
+                                :host => @couch_db[:host],
+                                :port => @couch_db[:port],
+                                :db => @couch_db[:database],
+                                :user => @couch_db[:username],
+                                :password => @couch_db[:password]
+                              },
+                              :index => {
+                                :index => @elastic_search[:index_name],
+                                :type => @elastic_search[:index_name],
+                                :bulk_size => "100",
+                                :bulk_timeout => "10ms"
+                              }
+                            },
+                            :expected_status_code => [ 200, 201 ]
+  end
+
+  def create_if_missing
+    create unless exists?
+  end
+
+  def delete
+    Transport::JSON.request :delete, "#{elastic_search_base_url}/_river/#{@elastic_search[:index_name]}", :expected_status_code => 200
+  end
+
+  def delete_if_exists
+    delete if exists?
+  end
+
+  def exists?
+    Transport::JSON.request :get, "#{elastic_search_base_url}/_river/#{@elastic_search[:index_name]}/_meta", :expected_status_code => 200
+    true
+  rescue Transport::UnexpectedStatusCodeError
+    false
+  end
+
+  private
+
+  def elastic_search_base_url
+    "http://#{@elastic_search[:host]}:#{@elastic_search[:port]}"
+  end
+
+end

data/lib/gom/storage/elastic_search/draft.rb

@@ -0,0 +1,6 @@
+
+module GOM::Storage::ElasticSearch::Draft
+
+  autoload :Builder, File.join(File.dirname(__FILE__), "draft", "builder")
+
+end

data/lib/gom/storage/elastic_search/draft/builder.rb

@@ -0,0 +1,56 @@
+
+# Builds a draft out of a search result item document.
+class GOM::Storage::ElasticSearch::Draft::Builder
+
+  def initialize(item)
+    @item = item.to_hash
+  end
+
+  def draft
+    initialize_draft
+    set_object_id
+    set_class
+    set_properties_and_relations
+    @draft
+  end
+
+  private
+
+  def initialize_draft
+    @draft = GOM::Object::Draft.new
+  end
+
+  def set_object_id
+    @draft.object_id = @item[:_id]
+  end
+
+  def set_class
+    @draft.class_name = @item[:model_class]
+  end
+
+  def set_properties_and_relations
+    @item.each do |key, value|
+      set_property key.to_s, value if property_key?(key)
+      set_relation key.to_s, value if relation_key?(key)
+    end
+  end
+
+  def set_property(key, value)
+    @draft.properties[key.to_sym] = value
+  end
+
+  def set_relation(key, value)
+    name = key.sub /_id$/, ""
+    id = GOM::Object::Id.new value
+    @draft.relations[name.to_sym] = GOM::Object::Proxy.new id
+  end
+
+  def property_key?(key)
+    !relation_key?(key) && ![ "_id", "_rev", "model_class" ].include?(key)
+  end
+
+  def relation_key?(key)
+    !!(key =~ /.+_id$/)
+  end
+
+end

data/spec/acceptance/adapter_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "helper"))
+
+describe "couchdb adapter" do
+
+  it_should_behave_like "an adapter with search view"
+
+end

data/spec/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+gem 'rspec', '>= 2'
+require 'rspec'
+
+require 'gom/spec'
+require 'gom/couchdb-adapter'
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "gom", "elasticsearch-adapter"))
+require File.join(File.dirname(__FILE__), "storage_configuration")

data/spec/storage_configuration.rb

@@ -0,0 +1,27 @@
+
+GOM::Storage.configure {
+  storage {
+    name :test_couchdb_storage
+    adapter :couchdb
+    username "test"
+    password "test"
+    database "test"
+    delete_database_if_exists false
+    create_database_if_missing true
+  }
+  storage {
+    name :test_storage
+    adapter :elasticsearch
+    index_name "test"
+    delete_index_if_exists false
+    create_index_if_missing true
+    delete_river_if_exists false
+    create_river_if_missing true
+    assign_to_storage :test_couchdb_storage
+    view {
+      name :test_search_view
+      kind :search
+      model_class GOM::Spec::Object
+    }
+  }
+}

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: gom-elasticsearch-adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Philipp Brüll
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gom
+  requirement: &18084220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *18084220
+- !ruby/object:Gem::Dependency
+  name: gom-couchdb-adapter
+  requirement: &18083500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *18083500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &18082780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: *18082780
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: &18082120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: *18082120
+description: ElasticSearch adapter for the General Object Mapper. Current versions
+  of ElasticSearch are supported.
+email: b.phifty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- LICENSE
+- Rakefile
+- lib/gom/elasticsearch-adapter.rb
+- lib/gom/storage/elastic_search.rb
+- lib/gom/storage/elastic_search/collection/fetcher.rb
+- lib/gom/storage/elastic_search/couchdb/river.rb
+- lib/gom/storage/elastic_search/adapter.rb
+- lib/gom/storage/elastic_search/draft/builder.rb
+- lib/gom/storage/elastic_search/draft.rb
+- lib/gom/storage/elastic_search/couchdb.rb
+- lib/gom/storage/elastic_search/collection.rb
+- lib/gom/storage.rb
+- spec/helper.rb
+- spec/storage_configuration.rb
+- spec/acceptance/adapter_spec.rb
+homepage: http://github.com/phifty/gom-elasticsearch-adapter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 41961588728074855
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 41961588728074855
+requirements: []
+rubyforge_project: gom-elasticsearch-adapter
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ElasticSearch adapter for the General Object Mapper.
+test_files:
+- spec/acceptance/adapter_spec.rb