elasticsearch-persistence 0.0.0 → 0.0.1

data/examples/sinatra/test.rb

@@ -0,0 +1,118 @@
+ENV['RACK_ENV'] = 'test'
+
+at_exit { Elasticsearch::Test::IntegrationTestCase.__run_at_exit_hooks } if ENV['SERVER']
+
+require 'test/unit'
+require 'shoulda-context'
+require 'mocha/setup'
+require 'rack/test'
+require 'turn'
+
+require 'elasticsearch/extensions/test/cluster'
+require 'elasticsearch/extensions/test/startup_shutdown'
+
+require_relative 'application'
+
+NoteRepository.index_name = 'notes_test'
+
+class Elasticsearch::Persistence::ExampleApplicationTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  alias :response :last_response
+
+  def app
+    Application.new
+  end
+
+  context "Note" do
+    should "be initialized with a Hash" do
+      note = Note.new 'foo' => 'bar'
+      assert_equal 'bar', note.attributes['foo']
+    end
+
+    should "add created_at when it's not passed" do
+      note = Note.new
+      assert_not_nil note.created_at
+      assert_match   /#{Time.now.year}/, note.created_at
+    end
+
+    should "not add created_at when it's passed" do
+      note = Note.new 'created_at' => 'FOO'
+      assert_equal 'FOO', note.created_at
+    end
+
+    should "trim long text" do
+      assert_equal 'Hello World', Note.new('text' => 'Hello World').text
+      assert_equal 'FOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFOOFO (...)',
+                   Note.new('text' => 'FOO'*200).text
+    end
+
+    should "delegate methods to attributes" do
+      note = Note.new 'foo' => 'bar'
+      assert_equal 'bar', note.foo
+    end
+
+    should "have tags" do
+      assert_not_nil Note.new.tags
+    end
+
+    should "provide a `to_hash` method" do
+      note = Note.new 'foo' => 'bar'
+      assert_instance_of Hash, note.to_hash
+      assert_equal ['created_at', 'foo'], note.to_hash.keys.sort
+    end
+
+    should "extract tags from the text" do
+      note = Note.new 'text' => 'Hello [foo] [bar]'
+      assert_equal 'Hello',        note.text
+      assert_equal ['foo', 'bar'], note.tags
+    end
+  end
+
+  context "Application" do
+    setup do
+      app.settings.repository.client = Elasticsearch::Client.new \
+        hosts: [{ host: 'localhost', port: ENV.fetch('TEST_CLUSTER_PORT', 9250)}],
+        log: true
+      app.settings.repository.client.transport.logger.formatter = proc { |s, d, p, m| "\e[2m#{m}\n\e[0m" }
+      app.settings.repository.create_index! force: true
+      app.settings.repository.client.cluster.health wait_for_status: 'yellow'
+    end
+
+    should "have the correct index name" do
+      assert_equal 'notes_test', app.settings.repository.index
+    end
+
+    should "display empty page when there are no notes" do
+      get '/'
+      assert response.ok?,           response.status.to_s
+      assert_match /No notes found/, response.body.to_s
+    end
+
+    should "display the notes" do
+      app.settings.repository.save Note.new('text' => 'Hello')
+      app.settings.repository.refresh_index!
+
+      get '/'
+      assert response.ok?,        response.status.to_s
+      assert_match /<p>\s*Hello/, response.body.to_s
+    end
+
+    should "create a note" do
+      post '/', { 'text' => 'Hello World' }
+      follow_redirect!
+
+      assert response.ok?,        response.status.to_s
+      assert_match /Hello World/, response.body.to_s
+    end
+
+    should "delete a note" do
+      app.settings.repository.save Note.new('id' => 'foobar', 'text' => 'Perish...')
+      delete "/foobar"
+      follow_redirect!
+
+      assert response.ok?,      response.status.to_s
+      assert_no_match /Perish/, response.body.to_s
+    end
+  end
+
+end

data/lib/elasticsearch/persistence.rb

@@ -1,7 +1,93 @@
-require "elasticsearch/persistence/version"
+require 'elasticsearch'
+require 'elasticsearch/model/indexing'
+require 'hashie'
+
+require 'active_support/inflector'
+
+require 'elasticsearch/persistence/version'
+
+require 'elasticsearch/persistence/client'
+require 'elasticsearch/persistence/repository/response/results'
+require 'elasticsearch/persistence/repository/naming'
+require 'elasticsearch/persistence/repository/serialize'
+require 'elasticsearch/persistence/repository/store'
+require 'elasticsearch/persistence/repository/find'
+require 'elasticsearch/persistence/repository/search'
+require 'elasticsearch/persistence/repository/class'
+require 'elasticsearch/persistence/repository'
 
 module Elasticsearch
+
+  # Persistence for Ruby domain objects and models in Elasticsearch
+  # ===============================================================
+  #
+  # `Elasticsearch::Persistence` contains modules for storing and retrieving Ruby domain objects and models
+  # in Elasticsearch.
+  #
+  # == Repository
+  #
+  # The repository patterns allows to store and retrieve Ruby objects in Elasticsearch.
+  #
+  #     require 'elasticsearch/persistence'
+  #
+  #     class Note
+  #       def to_hash; {foo: 'bar'}; end
+  #     end
+  #
+  #     repository = Elasticsearch::Persistence::Repository.new
+  #
+  #     repository.save Note.new
+  #     # => {"_index"=>"repository", "_type"=>"note", "_id"=>"mY108X9mSHajxIy2rzH2CA", ...}
+  #
+  # Customize your repository by including the main module in a Ruby class
+  #     class MyRepository
+  #       include Elasticsearch::Persistence::Repository
+  #
+  #       index 'my_notes'
+  #       klass Note
+  #
+  #       client Elasticsearch::Client.new log: true
+  #     end
+  #
+  #     repository = MyRepository.new
+  #
+  #     repository.save Note.new
+  #     # 2014-04-04 22:15:25 +0200: POST http://localhost:9200/my_notes/note [status:201, request:0.009s, query:n/a]
+  #     # 2014-04-04 22:15:25 +0200: > {"foo":"bar"}
+  #     # 2014-04-04 22:15:25 +0200: < {"_index":"my_notes","_type":"note","_id":"-d28yXLFSlusnTxb13WIZQ", ...}
+  #
   module Persistence
-    # Your code goes here...
+
+    # :nodoc:
+    module ClassMethods
+
+      # Get or set the default client for all repositories and models
+      #
+      # @example Set and configure the default client
+      #
+      #     Elasticsearch::Persistence.client Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
+      #
+      # @example Perform an API request through the client
+      #
+      #     Elasticsearch::Persistence.client.cluster.health
+      #     # => { "cluster_name" => "elasticsearch" ... }
+      #
+      def client client=nil
+        @client = client || @client || Elasticsearch::Client.new
+      end
+
+      # Set the default client for all repositories and models
+      #
+      # @example Set and configure the default client
+      #
+      #     Elasticsearch::Persistence.client = Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
+      #     => #<Elasticsearch::Transport::Client:0x007f96a6dd0d80 @transport=... >
+      #
+      def client=(client)
+        @client = client
+      end
+    end
+
+    extend ClassMethods
   end
 end

data/lib/elasticsearch/persistence/client.rb

@@ -0,0 +1,51 @@
+module Elasticsearch
+  module Persistence
+    module Repository
+
+      # Wraps the Elasticsearch Ruby
+      # [client](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch#usage)
+      #
+      module Client
+
+        # Get or set the default client for this repository
+        #
+        # @example Set and configure the client for the repository class
+        #
+        #     class MyRepository
+        #       include Elasticsearch::Persistence::Repository
+        #       client Elasticsearch::Client.new host: 'http://localhost:9200', log: true
+        #     end
+        #
+        # @example Set and configure the client for this repository instance
+        #
+        #     repository.client Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
+        #
+        # @example Perform an API request through the client
+        #
+        #     MyRepository.client.cluster.health
+        #     repository.client.cluster.health
+        #     # => { "cluster_name" => "elasticsearch" ... }
+        #
+        def client client=nil
+          @client = client || @client || Elasticsearch::Persistence.client
+        end
+
+        # Set the default client for this repository
+        #
+        # @example Set and configure the client for the repository class
+        #
+        #     MyRepository.client = Elasticsearch::Client.new host: 'http://localhost:9200', log: true
+        #
+        # @example Set and configure the client for this repository instance
+        #
+        #     repository.client = Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
+        #
+        def client=(client)
+          @client = client
+          @client
+        end
+      end
+
+    end
+  end
+end

data/lib/elasticsearch/persistence/repository.rb

@@ -0,0 +1,75 @@
+module Elasticsearch
+  module Persistence
+
+    # Delegate methods to the repository (acting as a gateway)
+    #
+    module GatewayDelegation
+      def method_missing(method_name, *arguments, &block)
+        gateway.respond_to?(method_name) ? gateway.__send__(method_name, *arguments, &block) : super
+      end
+
+      def respond_to?(method_name, include_private=false)
+        gateway.respond_to?(method_name) || super
+      end
+
+      def respond_to_missing?(method_name, *)
+        gateway.respond_to?(method_name) || super
+      end
+    end
+
+    # When included, creates an instance of the {Repository::Class} class as a "gateway"
+    #
+    # @example Include the repository in a custom class
+    #
+    #     class MyRepository
+    #       include Elasticsearch::Persistence::Repository
+    #     end
+    #
+    module Repository
+      def self.included(base)
+        gateway = Elasticsearch::Persistence::Repository::Class.new host: base
+
+        # Define the instance level gateway
+        #
+        base.class_eval do
+          define_method :gateway do
+            @gateway ||= gateway
+          end
+
+          include GatewayDelegation
+        end
+
+        # Define the class level gateway
+        #
+        (class << base; self; end).class_eval do
+          define_method :gateway do |&block|
+            @gateway ||= gateway
+            @gateway.instance_eval(&block) if block
+            @gateway
+          end
+
+          include GatewayDelegation
+        end
+
+        # Catch repository methods (such as `serialize` and others) defined in the receiving class,
+        # and overload the default definition in the gateway
+        #
+        def base.method_added(name)
+          if :gateway != name && respond_to?(:gateway) && (gateway.public_methods - Object.public_methods).include?(name)
+            gateway.define_singleton_method(name, self.new.method(name).to_proc)
+          end
+        end
+      end
+
+      # Shortcut method to allow concise repository initialization
+      #
+      # @example Create a new default repository
+      #
+      #     repository = Elasticsearch::Persistence::Repository.new
+      #
+      def new(options={}, &block)
+        Elasticsearch::Persistence::Repository::Class.new( {index: 'repository'}.merge(options), &block )
+      end; module_function :new
+    end
+  end
+end

data/lib/elasticsearch/persistence/repository/class.rb

@@ -0,0 +1,71 @@
+module Elasticsearch
+  module Persistence
+    module Repository
+
+      # The default repository class, to be used either directly, or as a gateway in a custom repository class
+      #
+      # @example Standalone use
+      #
+      #     repository = Elasticsearch::Persistence::Repository::Class.new
+      #     # => #<Elasticsearch::Persistence::Repository::Class ...>
+      #     repository.save(my_object)
+      #     # => {"_index"=> ... }
+      #
+      # @example Shortcut use
+      #
+      #     repository = Elasticsearch::Persistence::Repository.new
+      #     # => #<Elasticsearch::Persistence::Repository::Class ...>
+      #
+      # @example Configuration via a block
+      #
+      #     repository = Elasticsearch::Persistence::Repository.new do
+      #       index 'my_notes'
+      #     end
+      #
+      #     # => #<Elasticsearch::Persistence::Repository::Class ...>
+      #     # > repository.save(my_object)
+      #     # => {"_index"=> ... }
+      #
+      # @example Accessing the gateway in a custom class
+      #
+      #     class MyRepository
+      #       include Elasticsearch::Persistence::Repository
+      #     end
+      #
+      #     repository = MyRepository.new
+      #
+      #     repository.gateway.client.info
+      #     # => {"status"=>200, "name"=>"Venom", ... }
+      #
+      class Class
+        include Elasticsearch::Persistence::Repository::Client
+        include Elasticsearch::Persistence::Repository::Naming
+        include Elasticsearch::Persistence::Repository::Serialize
+        include Elasticsearch::Persistence::Repository::Store
+        include Elasticsearch::Persistence::Repository::Find
+        include Elasticsearch::Persistence::Repository::Search
+
+        include Elasticsearch::Model::Indexing::ClassMethods
+
+        attr_reader :options
+
+        def initialize(options={}, &block)
+          @options = options
+          index_name options.delete(:index)
+          block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
+        end
+
+        # Return the "host" class, if this repository is a gateway hosted in another class
+        #
+        # @return [nil, Class]
+        #
+        # @api private
+        #
+        def host
+          options[:host]
+        end
+      end
+
+    end
+  end
+end

data/lib/elasticsearch/persistence/repository/find.rb

@@ -0,0 +1,73 @@
+module Elasticsearch
+  module Persistence
+    module Repository
+      class DocumentNotFound < StandardError; end
+
+      # Retrieves one or more domain objects from the repository
+      #
+      module Find
+
+        # Retrieve a single object or multiple objects from Elasticsearch by ID or IDs
+        #
+        # @example Retrieve a single object by ID
+        #
+        #     repository.find(1)
+        #     # => <Note ...>
+        #
+        # @example Retrieve multiple objects by IDs
+        #
+        #     repository.find(1, 2)
+        #     # => [<Note ...>, <Note ...>
+        #
+        # @return [Object,Array]
+        #
+        def find(*args)
+          options  = args.last.is_a?(Hash) ? args.pop : {}
+          ids      = args
+
+          if args.size == 1
+            id = args.pop
+            id.is_a?(Array) ? __find_many(id, options) : __find_one(id, options)
+          else
+            __find_many args, options
+          end
+        end
+
+        # Return if object exists in the repository
+        #
+        # @example
+        #
+        #     repository.exists?(1)
+        #     => true
+        #
+        # @return [true, false]
+        #
+        def exists?(id, options={})
+          type     = document_type || (klass ? __get_type_from_class(klass) : '_all')
+          client.exists( { index: index_name, type: type, id: id }.merge(options) )
+        end
+
+        # @api private
+        #
+        def __find_one(id, options={})
+          type     = document_type || (klass ? __get_type_from_class(klass) : '_all')
+          document = client.get( { index: index_name, type: type, id: id }.merge(options) )
+
+          deserialize(document)
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound => e
+          raise DocumentNotFound, e.message, caller
+        end
+
+        # @api private
+        #
+        def __find_many(ids, options={})
+          type     = document_type || (klass ? __get_type_from_class(klass) : '_all')
+          documents = client.mget( { index: index_name, type: type, body: { ids: ids } }.merge(options) )
+
+          documents['docs'].map { |document| document['found'] ? deserialize(document) : nil }
+        end
+      end
+
+    end
+  end
+end