picky-client 0.0.0 → 0.0.1

data/README.rdoc

@@ -0,0 +1,24 @@
+= Picky Client
+
+== Usage
+
+1. Define a client instance, and save it (as an example) in a constant:
+   
+   <tt>FullSearch = Picky::Client::Full.new :host => 'some_host', :port => 1234, :path => '/path/to/search'</tt>
+   
+2. Use it in your controllers to search:
+   
+   <tt>result = FullSearch.search :query => 'some query', :offset => 123 # This gets you a hash</tt>
+   
+3. Then, to make access easier (if needed):
+   
+   <tt>result.extend Picky::Convenience</tt>
+   
+4. This gets you the following methods on result:
+   
+   * <tt>empty?</tt>
+   * <tt>ids(limit=20)</tt>
+   * <tt>clear_ids</tt>
+   * <tt>allocations</tt>
+   * <tt>allocations_size</tt>
+   * <tt>total</tt>

data/lib/picky-client.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, '/picky-client/engine')
+require File.join(this, '/picky-client/serializer')
+require File.join(this, '/picky-client/convenience')

data/lib/{search → picky-client}/convenience.rb

@@ -1,4 +1,4 @@
-module Search
+module Picky
   # Use this class to extend the hash the serializer returns.
   #
   module Convenience

data/lib/{search → picky-client}/engine.rb

@@ -1,6 +1,6 @@
 require 'net/http'
 
-module Search
+module Picky
   # Frontend for the search client.
   #
   # Configure a search by passing the options in the initializer:
@@ -11,7 +11,7 @@ module Search
   # TODO Rewrite such that instead of an http request we connect through tcp.
   # Or use EventMachine.
   #
-  module Engine
+  module Client
 
     class Base
 
@@ -41,23 +41,23 @@ module Search
           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?
-
+        return {} unless params[:query] && !params[:query].empty?
+        
         send_search params
       end
-
+      
       # Sends a search to the configured address.
       #
       def send_search params = {}
@@ -87,6 +87,7 @@ end
 
 # Extend hash with to_query method.
 #
+require 'active_support/core_ext/object/to_query'
 class Hash
   def to_query namespace = nil
     collect do |key, value|

data/lib/{search → picky-client}/serializer.rb

@@ -1,4 +1,4 @@
-module Search
+module Picky
 
   # This class handles serialization and deserialization.
   #

data/spec/{search → picky-client}/convenience_spec.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-describe Search::Convenience do
+describe Picky::Convenience do
 
   before(:each) do
     @convenience = {
@@ -10,7 +10,7 @@ describe Search::Convenience do
       :offset => 123,
       :total => 12345,
       :duration => 0.12345
-    }.extend Search::Convenience
+    }.extend Picky::Convenience
   end
 
   # describe 'replace_ids_with' do

data/spec/{search → picky-client}/engine_spec.rb

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-describe Search::Engine do
+describe Picky::Client do
   
   describe 'defaultize' do
     context 'no default params' do
       before(:each) do
-        @base = Search::Engine::Base.new
+        @base = Picky::Client::Base.new
       end
       it 'should return unchanged' do
         @base.defaultize( :a => :b ).should == { :a => :b }
@@ -13,11 +13,11 @@ describe Search::Engine do
     end
     context 'default params' do
       before(:each) do
-        Search::Engine::Base.default_params 'c' => 'd'
-        @base = Search::Engine::Base.new
+        Picky::Client::Base.default_params 'c' => 'd'
+        @base = Picky::Client::Base.new
       end
       after(:each) do
-        Search::Engine::Base.default_params
+        Picky::Client::Base.default_params
       end
       it 'should return changed' do
         @base.defaultize( 'a' => 'b' ).should == { 'a' => 'b', 'c' => 'd' }
@@ -30,7 +30,7 @@ describe Search::Engine do
   
   describe 'Base' do
     before(:each) do
-      @base = Search::Engine::Base.new
+      @base = Picky::Client::Base.new
     end
     it 'should have a default_configuration method' do
       lambda { @base.default_configuration }.should_not raise_error
@@ -48,7 +48,7 @@ describe Search::Engine do
 
   describe "Full" do
     before(:each) do
-      @full = Search::Engine::Full.new
+      @full = Picky::Client::Full.new
     end
     describe "defaults" do
       it "should set host to 'localhost'" do
@@ -64,7 +64,7 @@ describe Search::Engine do
 
     describe "cattr_accessors" do
       before(:each) do
-        @full = Search::Engine::Full.new :host => :some_host, :port => :some_port, :path => :some_path
+        @full = Picky::Client::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
@@ -94,7 +94,7 @@ describe Search::Engine do
         before(:each) do
           @query = nil
         end
-        it "should return a Search::Results for company" do
+        it "should return a Search::Results for bla" do
           @full.search(:query => @query).should be_kind_of(Hash)
         end
         it "should return an empty Search::Results" do
@@ -105,7 +105,7 @@ describe Search::Engine do
         before(:each) do
           @query = ''
         end
-        it "should return a Search::Results for company" do
+        it "should return a Search::Results" do
           @full.search(:query => @query).should be_kind_of(Hash)
         end
         it "should return an empty Search::Results" do
@@ -117,7 +117,7 @@ describe Search::Engine do
 
   describe "Live" do
     before(:each) do
-      @live = Search::Engine::Live.new
+      @live = Picky::Client::Live.new
     end
     describe "defaults" do
       it "should set host to 'localhost'" do

data/spec/{search → picky-client}/serializer_spec.rb

@@ -1,13 +1,13 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-describe Search::Serializer do
+describe Picky::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 = Picky::Serializer.deserialize Picky::Serializer.serialize(results)
 
       deserialized.should == {}
     end
@@ -24,13 +24,13 @@ describe Search::Serializer do
         :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|"
+      Picky::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 = Picky::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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Florian Hanke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-10 00:00:00 +02:00
+date: 2010-09-29 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -25,16 +25,16 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.textile
+- README.rdoc
 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
+- lib/picky-client/convenience.rb
+- lib/picky-client/engine.rb
+- lib/picky-client/serializer.rb
+- lib/picky-client.rb
+- spec/picky-client/convenience_spec.rb
+- spec/picky-client/engine_spec.rb
+- spec/picky-client/serializer_spec.rb
+- README.rdoc
 has_rdoc: true
 homepage: http://floere.github.com/picky
 licenses: []
@@ -68,6 +68,6 @@ 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
+- spec/picky-client/convenience_spec.rb
+- spec/picky-client/engine_spec.rb
+- spec/picky-client/serializer_spec.rb

data/README.textile

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

data/lib/search-engine.rb

@@ -1,10 +0,0 @@
-$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')