picky-client 4.0.6 → 4.0.7

data/lib/picky-client/client/active_record.rb

@@ -0,0 +1,87 @@
+module Picky
+  class Client
+    
+    # An ActiveRecord integration that uses the
+    # Picky HTTP client to send index updates
+    # back to a Picky server (usually Sinatra).
+    # 
+    # Examples:
+    #   # Note that the Person will
+    #   # be indexed in three indexes.
+    #   #
+    #   class Person < ActiveRecord::Base
+    #     extend Picky::ActiveRecord.new # All attributes will be sent to index "people".
+    #     extend Picky::ActiveRecord.new('name') # Only the name will be sent to index "people".
+    #     extend Picky::ActiveRecord.new('surname', index: 'special_index') # Only the surname will be sent to index "special_index".
+    #     # Use the given Client to send index data.
+    #     #
+    #     extend Picky::ActiveRecord.new(client: Picky::Client.new(host: 'localhost', port: '4567', path: '/indexing'))
+    #     extend Picky::ActiveRecord.new(host: 'localhost', port: '4567', path: '/indexing')
+    #   end
+    #
+    #   florian = Person.new name: "Florian", surname: "Hanke"
+    #   florian.save
+    #   florian.update_attributes name: "Peter"
+    #
+    class ActiveRecord < Module
+      
+      # Takes an array of indexed attributes/methods
+      # and options.
+      #
+      # Note: See class documentation for a description.
+      #
+      # Examples:
+      #   Picky::Client::ActiveRecord.new
+      #   Picky::Client::ActiveRecord.new('name', 'surname', index: 'some_index_name')
+      #
+      # Options:
+      #   * index: The index name to save to.
+      #   * host: The host where the Picky server is.
+      #   * port: The host which the Picky server listens to.
+      #   * path: The path the Picky server uses for index updates (use e.f. extend Picky::Sinatra::IndexActions to open up a HTTP indexing interface).
+      #   * client: The client to use if you want to pass in your own (host, port, path options will be ignored).
+      #
+      def initialize *attributes
+        options = {}
+        options = attributes.pop if attributes.last.respond_to?(:to_hash)
+        
+        # Default path for indexing is '/'.
+        #
+        client = options[:client] ||
+                 (options[:path] ||= '/') && Picky::Client.new(options)      
+      
+        self.class.class_eval do
+          index_name = options[:index]
+        
+          define_method :extended do |model|
+            attributes = nil if attributes.empty?
+            index_name ||= model.table_name
+            
+            # Only after the database has actually
+            # updated the data do we want to index.
+            #
+            model.after_commit do |object|
+              data = { 'id' => object.id }
+              
+              if object.destroyed?
+                client.remove index_name, data
+              else
+                (attributes || object.attributes.keys).each do |attr|
+                  data[attr] = object.respond_to?(attr) &&
+                               object.send(attr) ||
+                               object[attr]
+                end
+                
+                client.replace index_name, data
+              end
+            end
+          
+          end
+        end
+      
+      end
+    
+    end
+    
+  end
+end

data/lib/picky-client/client_index.rb

@@ -0,0 +1,32 @@
+module Picky
+  class Client
+    
+    # TODO Rename?
+    #
+    # Parameters:
+    #   * index_name: An index that exists in the Picky server.
+    #   * data: A hash in the form of { :id => 1234, :attr1 => 'attr1', :attr2 => 'attr2', ... }.
+    #
+    def replace index_name, data
+      request Net::HTTP::Post.new(self.path), index_name, data
+    end
+    
+    # TODO Rename?
+    #
+    # Parameters:
+    #   * index_name: An index that exists in the Picky server.
+    #   * data: A hash in the form of { :id => 1234 }.
+    #
+    def remove index_name, data
+      request Net::HTTP::Delete.new(self.path), index_name, data
+    end
+    
+    # Sends a request to the Picky server.
+    #
+    def request request, index_name, data
+      request.form_data = { :index => index_name, :data => data }
+      Net::HTTP.new(self.host, self.port).start { |http| http.request request }
+    end
+
+  end
+end

data/lib/picky-client.rb

@@ -5,6 +5,9 @@ require 'yajl'
 
 dir = File.dirname __FILE__
 require File.expand_path('picky-client/client', dir)
+require File.expand_path('picky-client/client_index', dir)
 require File.expand_path('picky-client/convenience', dir)
 require File.expand_path('picky-client/helper', dir)
-require File.expand_path('picky-client/extensions/object', dir)
+require File.expand_path('picky-client/extensions/object', dir)
+
+require File.expand_path('picky-client/client/active_record', dir)

data/spec/picky-client/client/active_record_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe Picky::Client::ActiveRecord do
+  
+  let(:fake_ar) do
+    Class.new do
+      
+      attr_reader :id, :name, :surname
+      
+      def initialize id, name, surname
+        @id, @name, @surname = id, name, surname
+      end
+      
+      class << self
+        
+        attr_accessor :after_commits
+        
+        def after_commit &block
+          self.after_commits ||= []
+          self.after_commits << block
+        end
+        
+        def table_name
+          'some_index_name'
+        end
+        
+      end
+      
+      def attributes
+        { 'id' => nil, 'name' => nil, 'surname' => nil }
+      end
+      
+      def save
+        after_commit
+      end
+      
+      def destroy
+        @destroyed = true
+        after_commit
+      end
+      
+      def destroyed?
+        @destroyed
+      end
+      
+      def after_commit
+        self.class.after_commits.each do |block|
+          block.call self
+        end
+      end
+      
+    end
+  end
+  
+  it 'is a module' do
+    described_class.should be_kind_of(Module)
+  end
+  
+  context 'default module' do
+    let(:ar_module) { described_class.new }
+    
+    it 'is (also) a module' do
+      ar_module.should be_kind_of(Module)
+    end
+  end
+  
+  # describe 'directly extend' do
+  #   let(:ar) { fake_ar.extend(described_class) }
+  #   
+  #   it 'calls the right method in the client' do
+  #     ar.save
+  #   end
+  #     
+  #   it 'calls the right method in the client' do
+  #     ar.destroy
+  #   end
+  #   
+  # end
+  
+  context 'with params' do
+    let(:client) { stub :client }
+    context 'with client' do
+      let(:ar_module) { described_class.new :client => client }
+      let(:ar) { fake_ar.extend(ar_module).new(1, 'Niko', 'Dittmann') }
+    
+      it 'is a module' do
+        ar_module.should be_kind_of(Module)
+      end
+    
+      it 'calls the right method in the client' do
+        client.should_receive(:replace).once.with 'some_index_name', { 'id' => 1, 'name' => 'Niko', 'surname' => 'Dittmann' }
+      
+        ar.save
+      end
+      
+      it 'calls the right method in the client' do
+        client.should_receive(:remove).once.with 'some_index_name', { 'id' => 1 }
+        
+        ar.destroy
+      end
+      
+    end
+    
+    context 'with client and index' do
+      let(:ar_module) { described_class.new :client => client, :index => 'some_other_index_name' }
+      let(:ar) { fake_ar.extend(ar_module).new(1, 'Niko', 'Dittmann') }
+    
+      it 'is a module' do
+        ar_module.should be_kind_of(Module)
+      end
+    
+      it 'calls the right method in the client' do
+        client.should_receive(:replace).once.with 'some_other_index_name', { 'id' => 1, 'name' => 'Niko', 'surname' => 'Dittmann' }
+      
+        ar.save
+      end
+      
+      it 'calls the right method in the client' do
+        client.should_receive(:remove).once.with 'some_other_index_name', { 'id' => 1 }
+        
+        ar.destroy
+      end
+    end
+    context 'with client and specific attributes' do
+      let(:ar_module) { described_class.new 'name', :client => client }
+      let(:ar) { fake_ar.extend(ar_module).new(1, 'Niko', 'Dittmann') }
+    
+      it 'is a module' do
+        ar_module.should be_kind_of(Module)
+      end
+    
+      it 'calls the right method in the client' do
+        client.should_receive(:replace).once.with 'some_index_name', { 'id' => 1, 'name' => 'Niko' }
+      
+        ar.save
+      end
+      
+      it 'calls the right method in the client' do
+        client.should_receive(:remove).once.with 'some_index_name', { 'id' => 1 }
+        
+        ar.destroy
+      end
+    end
+    context 'standard client' do
+      it 'instantiates the client correctly' do
+        Picky::Client.should_receive(:new).once.with :path => '/'
+        
+        described_class.new
+      end
+      it 'instantiates the client correctly' do
+        Picky::Client.should_receive(:new).once.with :host => 'some_host', :port => :some_port, :path => '/bla'
+        
+        described_class.new :host => 'some_host', :port => :some_port, :path => '/bla'
+      end
+    end
+  end
+  
+end

data/spec/picky-client/client_index_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Picky::Client do
+  
+  let(:client) { described_class.new path: '/' }
+  
+  describe 'replace' do
+    it 'delegates to the request method' do
+      client.should_receive(:request).once.with anything, :some_index_name, :some_data
+    
+      client.replace :some_index_name, :some_data
+    end
+  end
+  
+  describe 'remove' do
+    it 'delegates to the request method' do
+      client.should_receive(:request).once.with anything, :some_index_name, :some_data
+    
+      client.remove :some_index_name, :some_data
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky-client
 version: !ruby/object:Gem::Version
-  version: 4.0.6
+  version: 4.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000 Z
+date: 2012-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70178924113460 !ruby/object:Gem::Requirement
+  requirement: &70126973731340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.7.8
   type: :runtime
   prerelease: false
-  version_requirements: *70178924113460
+  version_requirements: *70126973731340
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70178924112400 !ruby/object:Gem::Requirement
+  requirement: &70126973729580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70178924112400
+  version_requirements: *70126973729580
 description: Picky Client
 email: florian.hanke+picky-client@gmail.com
 executables: []
@@ -42,7 +42,9 @@ extra_rdoc_files:
 files:
 - lib/picky-client/aux/cursed.rb
 - lib/picky-client/aux/terminal.rb
+- lib/picky-client/client/active_record.rb
 - lib/picky-client/client.rb
+- lib/picky-client/client_index.rb
 - lib/picky-client/convenience.rb
 - lib/picky-client/extensions/object.rb
 - lib/picky-client/helper.rb
@@ -59,6 +61,8 @@ files:
 - javascripts/picky.min.js
 - README.rdoc
 - spec/picky-client/aux/terminal_spec.rb
+- spec/picky-client/client/active_record_spec.rb
+- spec/picky-client/client_index_spec.rb
 - spec/picky-client/client_spec.rb
 - spec/picky-client/convenience_spec.rb
 - spec/picky-client/extensions/object_spec.rb
@@ -90,6 +94,8 @@ specification_version: 3
 summary: Picky Ruby Search Engine Client
 test_files:
 - spec/picky-client/aux/terminal_spec.rb
+- spec/picky-client/client/active_record_spec.rb
+- spec/picky-client/client_index_spec.rb
 - spec/picky-client/client_spec.rb
 - spec/picky-client/convenience_spec.rb
 - spec/picky-client/extensions/object_spec.rb