picky-client 0.0.0

data/README.textile

@@ -0,0 +1,3 @@
+h1. Search engine client.
+
+# TODO Usage etc.

data/lib/search-engine.rb

@@ -0,0 +1,10 @@
+$KCODE = 'UTF-8' unless RUBY_VERSION > '1.8.7'
+
+require 'rubygems'
+
+require 'active_support'
+
+this = File.dirname __FILE__
+require File.join(this, '/search/engine')
+require File.join(this, '/search/serializer')
+require File.join(this, '/search/convenience')

data/lib/search/convenience.rb

@@ -0,0 +1,37 @@
+module Search
+  # Use this class to extend the hash the serializer returns.
+  #
+  module Convenience
+
+    # Are there any allocations?
+    #
+    def empty?
+      allocations.empty?
+    end
+    # Returns the topmost limit results.
+    #
+    def ids limit = 20
+      ids = []
+      allocations.each { |allocation| allocation[4].each { |id| break if ids.size > limit; ids << id } }
+      ids
+    end
+    # Removes the ids from each allocation.
+    #
+    def clear_ids
+      allocations.each { |allocation| allocation[4].clear }
+    end
+
+    # Caching readers.
+    #
+    def allocations
+      @allocations || @allocations = self[:allocations]
+    end
+    def allocations_size
+      @allocations_size || @allocations_size = allocations.size
+    end
+    def total
+      @total || @total = self[:total]
+    end
+
+  end
+end

data/lib/search/engine.rb

@@ -0,0 +1,96 @@
+require 'net/http'
+
+module Search
+  # Frontend for the search client.
+  #
+  # Configure a search by passing the options in the initializer:
+  #   * host
+  #   * port
+  #   * path
+  #
+  # TODO Rewrite such that instead of an http request we connect through tcp.
+  # Or use EventMachine.
+  #
+  module Engine
+
+    class Base
+
+      attr_accessor :host, :port, :path
+
+      def initialize options = {}
+        options = default_configuration.merge options
+
+        @host = options[:host]
+        @port = options[:port]
+        @path = options[:path]
+      end
+      def default_configuration
+        {}
+      end
+      def self.default_configuration options = {}
+        define_method :default_configuration do
+          options
+        end
+      end
+      def default_params
+        {}
+      end
+      def self.default_params options = {}
+        options.stringify_keys! if options.respond_to?(:stringify_keys!)
+        define_method :default_params do
+          options
+        end
+      end
+
+      # Merges the given params, overriding the defaults.
+      #
+      def defaultize params = {}
+        default_params.merge params
+      end
+
+      # Searches the index. Use this method.
+      #
+      # Returns a hash. Extend with Convenience.
+      #
+      def search params = {}
+        return {} if params[:query].blank?
+
+        send_search params
+      end
+
+      # Sends a search to the configured address.
+      #
+      def send_search params = {}
+        params = defaultize params
+        Net::HTTP.get self.host, "#{self.path}?#{params.to_query}", self.port
+      end
+
+    end
+
+    class Full < Base
+      default_configuration :host => 'localhost', :port => 4000, :path => '/searches/full'
+
+      # Full needs to deserialize the results.
+      #
+      def send_search params = {}
+        Serializer.deserialize super(params)
+      end
+
+    end
+
+    class Live < Base
+      default_configuration :host => 'localhost', :port => 4000, :path => '/searches/live'
+    end
+
+  end
+end
+
+# Extend hash with to_query method.
+#
+class Hash
+  def to_query namespace = nil
+    collect do |key, value|
+      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+    end.sort * '&'
+  end
+end

data/lib/search/serializer.rb

@@ -0,0 +1,25 @@
+module Search
+
+  # This class handles serialization and deserialization.
+  #
+  class Serializer
+
+    # Serialize the Results.
+    #
+    # Note: This code is executed on the search engine side.
+    #
+    def self.serialize serializable_results
+      Marshal.dump serializable_results.serialize
+    end
+
+    # Create new search results from serialized ones.
+    #
+    # Note: This code is executed on the client side.
+    #
+    def self.deserialize serialized_results
+      Marshal.load serialized_results
+    end
+
+  end
+
+end

data/spec/search/convenience_spec.rb

@@ -0,0 +1,113 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Search::Convenience do
+
+  before(:each) do
+    @convenience = {
+      :allocations => [[nil, nil, nil, nil, [1,2,3,4,5,6,7,8]],
+                       [nil, nil, nil, nil, [9,10,11,12,13,14,15,16]],
+                       [nil, nil, nil, nil, [17,18,19,20,21,22,23]]],
+      :offset => 123,
+      :total => 12345,
+      :duration => 0.12345
+    }.extend Search::Convenience
+  end
+
+  # describe 'replace_ids_with' do
+  #   before(:each) do
+  #     @results = Search::Results.new [
+  #         [nil, nil, nil, [1,2,3,4,5,6,7,8]],
+  #         [nil, nil, nil, [9,10,11,12,13,14,15,16]],
+  #         [nil, nil, nil, [17,18,19,20,21,22,23]]
+  #       ], [], nil, 123, true, true, 0.123, 1234
+  #   end
+  #   it 'should replace the ids' do
+  #     new_ids = (11..31).to_a # +10
+  #     @results.replace_ids_with new_ids
+  #     @results.ids.should == (11..31).to_a
+  #   end
+  # end
+
+  describe 'clear_ids' do
+    it 'should clear all ids' do
+      @convenience.clear_ids
+
+      @convenience.ids.should == []
+    end
+  end
+
+  describe 'ids' do
+    it 'should return the top default ids' do
+      @convenience.ids.should == (1..21).to_a
+    end
+    it 'should return the top limit entries' do
+      @convenience.ids(7).should == (1..8).to_a
+    end
+  end
+
+  describe 'allocations_size' do
+    it 'should just add up the allocations of both types' do
+      @convenience.allocations_size.should == 3
+    end
+  end
+
+  # describe 'render?' do
+  #   context 'no ids' do
+  #     before(:each) do
+  #       @convenience.stub! :empty? => true
+  #     end
+  #     it 'should not render' do
+  #       @convenience.render?.should == false
+  #     end
+  #   end
+  #   context 'less results than the treshold' do
+  #     before(:each) do
+  #       @convenience.stub! :empty? => false
+  #       @convenience.stub! :total => 7
+  #     end
+  #     it 'should render' do
+  #       @convenience.render?.should == true
+  #     end
+  #   end
+  #   context 'too many, but just in one allocation' do
+  #     before(:each) do
+  #       @convenience.stub! :empty? => false
+  #       @convenience.stub! :total => 100
+  #       @convenience.stub! :allocations_size => 1
+  #     end
+  #     it 'should render' do
+  #       @convenience.render?.should == true
+  #     end
+  #   end
+  #   context 'too many' do
+  #     before(:each) do
+  #       @convenience.stub! :empty? => false
+  #       @convenience.stub! :total => 100
+  #       @convenience.stub! :allocations_size => 2
+  #     end
+  #     it 'should not render' do
+  #       @convenience.render?.should == false
+  #     end
+  #   end
+  # end
+
+  describe 'empty?' do
+    context 'allocations empty' do
+      before(:each) do
+        @convenience.stub! :allocations => stub(:allocations, :empty? => true)
+      end
+      it 'should be true' do
+        @convenience.empty?.should == true
+      end
+    end
+    context 'allocations not empty' do
+      before(:each) do
+        @convenience.stub! :allocations => stub(:allocations, :empty? => false)
+      end
+      it 'should be false' do
+        @convenience.empty?.should == false
+      end
+    end
+  end
+
+end

data/spec/search/engine_spec.rb

@@ -0,0 +1,184 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Search::Engine do
+  
+  describe 'defaultize' do
+    context 'no default params' do
+      before(:each) do
+        @base = Search::Engine::Base.new
+      end
+      it 'should return unchanged' do
+        @base.defaultize( :a => :b ).should == { :a => :b }
+      end
+    end
+    context 'default params' do
+      before(:each) do
+        Search::Engine::Base.default_params 'c' => 'd'
+        @base = Search::Engine::Base.new
+      end
+      after(:each) do
+        Search::Engine::Base.default_params
+      end
+      it 'should return changed' do
+        @base.defaultize( 'a' => 'b' ).should == { 'a' => 'b', 'c' => 'd' }
+      end
+      it 'should override the default' do
+        @base.defaultize( 'c' => 'b' ).should == { 'c' => 'b' }
+      end
+    end
+  end
+  
+  describe 'Base' do
+    before(:each) do
+      @base = Search::Engine::Base.new
+    end
+    it 'should have a default_configuration method' do
+      lambda { @base.default_configuration }.should_not raise_error
+    end
+    it 'should return an empty configuration hash' do
+      @base.default_configuration.should == {}
+    end
+    it 'should have a default_params method' do
+      lambda { @base.default_params }.should_not raise_error
+    end
+    it 'should return an empty params hash' do
+      @base.default_params.should == {}
+    end
+  end
+
+  describe "Full" do
+    before(:each) do
+      @full = Search::Engine::Full.new
+    end
+    describe "defaults" do
+      it "should set host to 'localhost'" do
+        @full.host.should == 'localhost'
+      end
+      it "should set port to 4000" do
+        @full.port.should == 4000
+      end
+      it "should set path to '/searches/full'" do
+        @full.path.should == '/searches/full'
+      end
+    end
+
+    describe "cattr_accessors" do
+      before(:each) do
+        @full = Search::Engine::Full.new :host => :some_host, :port => :some_port, :path => :some_path
+      end
+      it "should have a writer for the host" do
+        @full.host = :some_host
+        @full.host.should == :some_host
+      end
+      it "should have a writer for the port" do
+        @full.port = :some_port
+        @full.port.should == :some_port
+      end
+      it "should have a writer for the path" do
+        @full.path = :some_path
+        @full.path.should == :some_path
+      end
+      it "should have a reader for the host" do
+        lambda { @full.host }.should_not raise_error
+      end
+      it "should have a reader for the port" do
+        lambda { @full.port }.should_not raise_error
+      end
+      it "should have a reader for the path" do
+        lambda { @full.path }.should_not raise_error
+      end
+    end
+
+    describe "search" do
+      describe "with nil as search term" do
+        before(:each) do
+          @query = nil
+        end
+        it "should return a Search::Results for company" do
+          @full.search(:query => @query).should be_kind_of(Hash)
+        end
+        it "should return an empty Search::Results" do
+          @full.search(:query => @query).should be_empty
+        end
+      end
+      describe "with '' as search term" do
+        before(:each) do
+          @query = ''
+        end
+        it "should return a Search::Results for company" do
+          @full.search(:query => @query).should be_kind_of(Hash)
+        end
+        it "should return an empty Search::Results" do
+          @full.search(:query => @query).should be_empty
+        end
+      end
+    end
+  end
+
+  describe "Live" do
+    before(:each) do
+      @live = Search::Engine::Live.new
+    end
+    describe "defaults" do
+      it "should set host to 'localhost'" do
+        @live.host.should == 'localhost'
+      end
+      it "should set port to 4000" do
+        @live.port.should == 4000
+      end
+      it "should set path to '/searches/live'" do
+        @live.path.should == '/searches/live'
+      end
+    end
+
+    describe "cattr_accessors" do
+      it "should have a writer for the host" do
+        @live.host = :some_host
+        @live.host.should == :some_host
+      end
+      it "should have a writer for the port" do
+        @live.port = :some_port
+        @live.port.should == :some_port
+      end
+      it "should have a writer for the path" do
+        @live.path = :some_path
+        @live.path.should == :some_path
+      end
+      it "should have a reader for the host" do
+        lambda { @live.host }.should_not raise_error
+      end
+      it "should have a reader for the port" do
+        lambda { @live.port }.should_not raise_error
+      end
+      it "should have a reader for the path" do
+        lambda { @live.path }.should_not raise_error
+      end
+    end
+
+    describe "search" do
+      describe "with nil as search term" do
+        before(:each) do
+          @query = nil
+        end
+        it "should return a Search::Results" do
+          @live.search(:query => @query).should be_kind_of(Hash)
+        end
+        it "should return an empty Search::Results" do
+          @live.search(:query => @query).should be_empty
+        end
+      end
+      describe "with '' as search term" do
+        before(:each) do
+          @query = ''
+        end
+        it "should return a Search::Results" do
+          @live.search(:query => @query).should be_kind_of(Hash)
+        end
+        it "should return an empty Search::Results" do
+          @live.search(:query => @query).should be_empty
+        end
+      end
+    end
+  end
+
+end

data/spec/search/serializer_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Search::Serializer do
+
+  describe "serialize-deserialize" do
+    it "should serialize and deserialize certain values" do
+      results = stub :results
+      results.stub! :serialize => {}
+
+      deserialized = Search::Serializer.deserialize Search::Serializer.serialize(results)
+
+      deserialized.should == {}
+    end
+  end
+
+  describe "serialize" do
+    it "should serialize" do
+      results = stub :results, :serialize => {
+        :allocations => [[nil, nil, nil, [1,2,3,4,5,6,7,8]],
+                         [nil, nil, nil, [9,10,11,12,13,14,15,16]],
+                         [nil, nil, nil, [17,18,19,20,21,22,23]]],
+        :offset => 123,
+        :total => 12345,
+        :duration => 0.12345
+      }
+
+      Search::Serializer.serialize(results).should == "\x04\b{\t:\x10allocations[\b[\t000[\ri\x06i\ai\bi\ti\ni\vi\fi\r[\t000[\ri\x0Ei\x0Fi\x10i\x11i\x12i\x13i\x14i\x15[\t000[\fi\x16i\x17i\x18i\x19i\x1Ai\ei\x1C:\voffseti\x01{:\ntotali\x0290:\rdurationf\x0F0.12345\x00\xF2|"
+    end
+  end
+
+  describe "deserialize" do
+    it "should deserialize" do
+      results = Search::Serializer.deserialize "\x04\b{\t:\x10allocations[\b[\t000[\ri\x06i\ai\bi\ti\ni\vi\fi\r[\t000[\ri\x0Ei\x0Fi\x10i\x11i\x12i\x13i\x14i\x15[\t000[\fi\x16i\x17i\x18i\x19i\x1Ai\ei\x1C:\voffseti\x01{:\ntotali\x0290:\rdurationf\x0F0.12345\x00\xF2|"
+
+      results.should be_kind_of(Hash)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: picky-client
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Florian Hanke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-10 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: florian.hanke+picky-client@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- lib/search/convenience.rb
+- lib/search/engine.rb
+- lib/search/serializer.rb
+- lib/search-engine.rb
+- spec/search/convenience_spec.rb
+- spec/search/engine_spec.rb
+- spec/search/serializer_spec.rb
+- README.textile
+has_rdoc: true
+homepage: http://floere.github.com/picky
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: picky Search Engine Client
+test_files: 
+- spec/search/convenience_spec.rb
+- spec/search/engine_spec.rb
+- spec/search/serializer_spec.rb