ripplr 0.0.4.beta → 0.0.5.beta

data/lib/ripplr/errors.rb

@@ -1 +1 @@
-  require File.join("ripplr", "errors", "key_not_specified_error")
+  require File.join("ripplr", "errors", "field_not_queryable_error")

data/lib/ripplr/errors/field_not_queryable_error.rb

@@ -0,0 +1,13 @@
+require 'ripplr/translation'
+
+class Ripplr::FieldNotQueryableError
+  include Ripplr::Translation
+
+  def initialize(field_name)
+    @field_name = field_name
+  end
+
+  def exception(message=t("errors.field_not_queryable", :field => @field_name))
+    RuntimeError.new message
+  end
+end

data/lib/ripplr/indexers/ripple.rb

@@ -4,6 +4,11 @@ module Ripplr
       def self.index(queryable_obj)
         ::Ripple.client.index queryable_obj.bucket_name, queryable_obj.indexes_as
       end
+
+      def self.search(klass, query)
+        results = ::Ripple.client.search(klass.bucket.name, query)["response"]["docs"]
+        results.map{|result| klass.find(result["id"])}.reject{|obj| obj.nil?}
+      end
     end
   end
 end

data/lib/ripplr/locale/en.yml

@@ -1,3 +1,4 @@
 en:
   ripplr:
-    key_not_specified: "Cannot index an object that does not specify a key."
+    errors:
+      field_not_queryable: "\"%{field}\" is not a queryable field."

data/lib/ripplr/query_field.rb

@@ -2,16 +2,19 @@ module Ripplr
   class QueryField
     def initialize(type, property_name)
       @type = type
-      @property = property_name
+      @property_name = property_name
     end
 
     def indexes_as(queryable_object)
-      return { index_name(@type, @property) => queryable_object.send(@property) }
+      return { index_name => queryable_object.send(@property_name) }
     end
 
-    private
-    def index_name(type, property_name)
-      "#{property_name.to_s}_#{type.to_s}".to_sym
+    def for?(property_name)
+      @property_name == property_name
+    end
+
+    def index_name
+      "#{@property_name.to_s}_#{@type.to_s}".to_sym
     end
   end
 end

data/lib/ripplr/queryable.rb

@@ -1,7 +1,7 @@
 module Ripplr
   module Queryable
-    def index(indexer=Ripple.client)
-      indexer.index(self)
+    def index(indexer=Ripplr::Indexers::Ripple)
+      indexer.index self
     end
 
     def remove_index(indexer=Ripple.client)
@@ -29,6 +29,10 @@ module Ripplr
     end
 
     module QueryableClassMethods
+      def find(property, query, indices=Ripplr::Indexers::Ripple)
+        indices.search self, "#{queryable_field(property)}: \"#{query}\""
+      end
+
       def query_fields
         @query_fields ||= Array.new
         @query_fields
@@ -49,6 +53,14 @@ module Ripplr
           query_fields << Ripplr::QueryField.new(:text, name)
         end
       end
+
+      protected
+      def queryable_field(property_name)
+        matches = query_fields.select{|f| f.for? property_name}
+        raise Ripplr::FieldNotQueryableError.new(property_name) if matches.empty?
+
+        matches.first.index_name
+      end
     end
   end
 end

data/lib/ripplr/version.rb

@@ -1,3 +1,3 @@
 module Ripplr
-  VERSION = "0.0.4.beta"
+  VERSION = "0.0.5.beta"
 end

data/spec/ripplr/indexers/ripple_spec.rb

@@ -8,4 +8,47 @@ describe Ripplr::Indexers::Ripple do
     Then { Ripplr::Indexers::Ripple.index(model).should be_true }
   end
 
+  describe "#search" do
+    context "when no documents match" do
+      Given (:results) { {"response" => {"docs" => []} }  }
+      Given { Ripple.client.should_receive(:search).with('people', 'query string').and_return results }
+      When(:result) { Ripplr::Indexers::Ripple.search Person, 'query string' }
+      Then { result.should be_empty }
+    end
+
+    context "when one document matches" do
+      Given (:results) { {"response" => {"docs" => [ { "id" => "12345"} ]} }  }
+      Given { Person.should_receive(:find).with("12345").and_return "yo dawg" }
+      Given { Ripple.client.should_receive(:search).with('people', 'query string').and_return results }
+      When(:result) { Ripplr::Indexers::Ripple.search Person, 'query string' }
+      Then { result.first.should == "yo dawg" }
+    end
+
+    context "when one document matches but it doesnt exist" do
+      Given (:results) { {"response" => {"docs" => [ { "id" => "12345"} ]} }  }
+      Given { Person.should_receive(:find).with("12345").and_return nil }
+      Given { Ripple.client.should_receive(:search).with('people', 'query string').and_return results }
+      When(:result) { Ripplr::Indexers::Ripple.search Person, 'query string' }
+      Then { result.should be_empty }
+    end
+  end
 end
+
+
+## EXAMPLE SEARCH RESULT ##
+###########################
+# {"responseHeader"=>
+# {"status"=>0, "QTime"=>2, "params"=>{"q"=>"title_text: Skrillex", "q.op"=>"or", "filter"=>"", "wt"=>"json"}},
+# {"response" =>
+# {
+#   "numFound"=>3,
+#   "start"=>0,
+#   "maxScore"=>"0.353553",
+#   "docs"=>[
+#            { "id"=>"GDdq2m1xI2URV34HTWC1UfBRC3n",
+#              "index"=>"vera_access_checklists",
+#              "fields"=>
+#              {"created_at_dt"=>"2012-09-06 19:17:20 UTC",
+#                "title_text"=>"skrillex"},
+#              "props"=>{}} ]
+# }

data/spec/ripplr/queryable_spec.rb

@@ -15,10 +15,34 @@ describe Ripplr::Queryable do
     Then { Person.new.bucket_name.should == "people" }
   end
 
-  describe "#indexing" do
-    Given (:friend) { Person.new }
-    Given (:service) { mock :index => true }
-    Then { friend.index(service).should be_true }
+  describe "#find" do
+    context "when using a field that has been defiend as queryable" do
+      Given (:indexer) { mock }
+      Given { indexer.should_receive(:search).with(Person,"first_name_text: \"Dan\"").and_return ["Dan Auerbach"] }
+      When (:result) { Person.find :first_name, "Dan", indexer }
+      Then { result.should == [ "Dan Auerbach" ] }
+    end
+
+    context "when using a field that has not been defined as queryable" do
+      Then { expect { Person.find :full_name, "val" }.to raise_error RuntimeError }
+    end
+
+    context "when the object does not have any queryable fields" do
+      Then { expect { Unqueryable.find :something, "what what" }.to raise_error RuntimeError }
+    end
+  end
+
+  describe "#index" do
+    context "overide indexer" do
+      Given (:friend) { Person.new }
+      Given (:service) { mock :index => true }
+      Then { friend.index(service).should be_true }
+    end
+    context "default indexer" do
+      Given (:rg3) { Person.new }
+      Given { Ripplr::Indexers::Ripple.should_receive(:index).with(rg3).and_return true }
+      Then { rg3.index.should be_true }
+    end
   end
 
   describe "#indexes_as" do

data/spec/support/models.rb

@@ -1,3 +1,9 @@
-require File.join("support", "models", "person")
-require File.join("support", "models", "lift")
-require File.join("support", "models", "log_entry")
+%w[
+   person
+   lift
+   log_entry
+   unqueryable
+  ].each do |file|
+  require File.join("support", "models", file)  
+end
+

data/spec/support/models/unqueryable.rb

@@ -0,0 +1,4 @@
+class Unqueryable
+  include Ripple::Document
+  include Ripplr::Queryable
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ripplr
 version: !ruby/object:Gem::Version
-  version: 0.0.4.beta
+  version: 0.0.5.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-07 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-given
@@ -70,7 +70,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
-- lib/ripplr/errors/key_not_specified_error.rb
+- lib/ripplr/errors/field_not_queryable_error.rb
 - lib/ripplr/errors.rb
 - lib/ripplr/formatters/riak.rb
 - lib/ripplr/formatters.rb
@@ -93,6 +93,7 @@ files:
 - spec/support/models/lift.rb
 - spec/support/models/log_entry.rb
 - spec/support/models/person.rb
+- spec/support/models/unqueryable.rb
 - spec/support/models.rb
 - .gitignore
 homepage: https://github.com/validas/Ripplr
@@ -128,5 +129,6 @@ test_files:
 - spec/support/models/lift.rb
 - spec/support/models/log_entry.rb
 - spec/support/models/person.rb
+- spec/support/models/unqueryable.rb
 - spec/support/models.rb
 - .gitignore

data/lib/ripplr/errors/key_not_specified_error.rb

@@ -1,9 +0,0 @@
-require 'ripplr/translation'
-
-class Ripplr::KeyNotSpecifiedError
-  include Ripplr::Translation
-
-  def exception(message=t("key_not_specified"))
-    RuntimeError.new message
-  end
-end