acts_as_cleo 0.0.3 → 0.0.4

data/README.rdoc

@@ -1,9 +1,64 @@
 = acts_as_cleo
 
+=== To enable
+
+Create a cleo.yml in your config directory.
+
+  development:
+
+    url: "http://localhost:8080/cleo-primer/"
+
+  production:
+
+    url: "http://localhost:8080/cleo-primer/"
+
+
+=== Usage
+
+
+  Cleo.find(int)              # Find Cleo entry by Cleo native id
+
+  Cleo.update(Cleo::Result)   # Pass any acts_as_cleo object to this method to have it update the Cleo entry
+
+  Cleo.delete(int)            # Delete by Cleo id, also accepts any acts_as_cleo object or Cleo::Result
+
+  Cleo.create(obj)            # Creates new entry on Cleo index. Accepts any acts_as_cleo object or Cleo::Result
+
+  Cleo.query(string)          # Takes string search param and returns array of Cleo::Reference objects
+
+
+
+To enable on an ActiveRecord::Base model:
+
+  acts_as_cleo
+
+  acts_as_cleo :terms => %w{terms to be stored}
+
+  acts_as_cleo :except => %w{columns to be ignored}
+
+  acts_as_cleo :score=> "method or column to be used"
+
+  acts_as_cleo :terms => %w{name value other}, :score => "my_score_method"
+
+Default functionality takes all column_names and uses them as terms for Cleo search.
+
+To specify terms to be stored in Cleo, pass :terms => [] with the column and/or method names to be stored
+
+acts_as_cleo ignores updated_at, created_at, id by default.
+
+You can specify more columns to ignore by passing :except => [] with column names.
+
+By default, acts_as_cleo uses the column "name" from your model as the Cleo search name. To specify the name in Cleo, pass :name => "my_attribute_name"
+
+To specify a Cleo score, pass :score => "name of column or function"
+
+ActiveRecord::Base objects with acts_as_cleo get three callback functions:
+
+set_cleo_id, sync_with_cleo and remove_from_cleo
 
 = WARNING
 
-This gem is still in beta. The main Cleo functionality works but the hooks into active record objects are not done yet.
+This gem is still in beta. 
 
 * Cleo.find
 * Cleo.update

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/acts_as_cleo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "acts_as_cleo"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert R. Meyer"]
-  s.date = "2012-03-21"
+  s.date = "2012-03-22"
   s.description = "LinkedIn Open Source type ahead tool's REST API as a ruby gem"
   s.email = "Blue.Dog.Archolite@gmail.com"
   s.extra_rdoc_files = [
@@ -33,7 +33,6 @@ Gem::Specification.new do |s|
     "lib/cleo/reference.rb",
     "lib/cleo/result.rb",
     "lib/cleo/server.rb",
-    "lib/common_methods.rb",
     "lib/generators/acts_as_cleo/install_generator.rb",
     "lib/generators/acts_as_cleo/templates/install.rb",
     "lib/instance_methods.rb",

data/config/cleo.yml

@@ -1,8 +1,5 @@
-# Config file for the acts_as_solr plugin.
+# Config file for the acts_as_cleo plugin.
 #
-# If you change the host or port number here, make sure you update
-# them in your Solr config file
-
 development:
   url: "http://localhost:8080/cleo-primer/"
 

data/lib/acts_as_cleo.rb

@@ -5,7 +5,6 @@ require File.dirname(__FILE__) + '/cleo'
 require File.dirname(__FILE__) + '/acts_methods'
 require File.dirname(__FILE__) + '/class_methods'
 require File.dirname(__FILE__) + '/instance_methods'
-require File.dirname(__FILE__) + '/common_methods'
 
 module ActsAsCleo
   include ActsMethods

data/lib/acts_methods.rb

@@ -1,14 +1,13 @@
 module ActsAsCleo
   module ActsMethods
     def acts_as_cleo(opts = {})
+      #Common class methods added
       extend ClassMethods
-      extend CommonMethods
 
       #Instance Methods Correctly Included
       include InstanceMethods
 
-      before_create :set_cleo_id
-      after_commit :sync_with_cleo
+      after_commit  :set_cleo_id, :sync_with_cleo
       after_destroy :remove_from_cleo
 
       cattr_accessor :cleo_config

data/lib/class_methods.rb

@@ -1,4 +1,7 @@
 module ActsAsCleo
   module ClassMethods
+    def query(query, opts = {})
+      Cleo.query(query)
+    end
   end
 end

data/lib/cleo.rb

@@ -43,9 +43,7 @@ module Cleo
     return good_response_code?(response)
   end
 
-  def self.delete(obj)
-    obj = obj.to_cleo_result unless obj.is_a?(Cleo::Result)
-
+  def self.delete(cleo_id)
 =begin
 
 
@@ -189,7 +187,7 @@ module Cleo
 
 =end
 
-    result = `curl -v -X DELETE #{Cleo::Server.url}#{obj.id}`
+    result = `curl -v -X DELETE #{Cleo::Server.url}#{cleo_id}`
 
     #TODO I HATE THIS. Make this use Rails and not a fracking curl call
 #    uri = URI.parse Cleo::Server.url + "/#{obj.id}"
@@ -236,3 +234,4 @@ end
 #require Result Class
 require 'cleo/server'
 require 'cleo/result'
+require 'cleo/reference'

data/lib/generators/acts_as_cleo/templates/install.rb

@@ -3,7 +3,6 @@ class <%= migration_class_name %> < ActiveRecord::Migration
     create_table :cleo_references do
       t.timestamps
       t.string :record_type
-      t.integer :cleo_id
       t.integer :record_id
     end
   end

data/lib/instance_methods.rb

@@ -10,23 +10,24 @@ module ActsAsCleo
       #after_update send the data to cleo
     end
 
-    def set_cleo_id
-      #this needs to be rerolled to pull an Cleo::Reference record and persist it.
-    end
-
     def remove_from_cleo
       Cleo.delete(self) if self.persisted?
     end
     #end callback hooks
 
     def cleo_id
+      return nil if self.id.nil?
       record_type = self.cleo_config[:type]
-#      cr = Cleo::Reference.find_by_reference_and_id(record_type, self.id)
-#      return cr.nil? ? nil : cr.id
+      cr = Cleo::Reference.find(:first, :conditions => ["record_type = ? and record_id = ?", record_type, self.id])
+
+      return nil if cr.nil?
+      return cr.id
     end
 
-    def cleo_id=( new_id)
+    def set_cleo_id
       #this needs to be rerolled to pull an Cleo::Reference record and persist it.
+      cr = Cleo::Reference.find(:one, :conditions => ["record_type = ? and record_id = ?", record_type, self.id])
+      cr = Cleo::Reference.create(:record_type => record_type, :record_id => self.id) if cr.nil?
     end#
 
     def to_cleo_result

data/test/db/migrate/007_cleo_table.rb

@@ -3,7 +3,6 @@ class CleoTable < ActiveRecord::Migration
     create_table :cleo_references , :force => true do |t|
       t.timestamps
       t.string :record_type
-      t.integer :cleo_id
       t.integer :record_id
     end
   end

data/test/unit/test_cleo.rb

@@ -20,7 +20,7 @@ class TestCleo < Test::Unit::TestCase
     assert_not_nil wa
     assert_equal @wedge.id, wa.id
 
-    assert Cleo.delete(wa)
+    assert Cleo.delete(wa.id)
   end
 
   should "get google results from qery" do
@@ -54,7 +54,7 @@ class TestCleo < Test::Unit::TestCase
     wa_update = Cleo.find(@wedge.id)
     assert_equal "Luke Skywalker", wa_update.name
 
-    assert Cleo.delete(wa)
+    assert Cleo.delete(wa.id)
   end
 end
 

data/test/unit/test_common_methods.rb

@@ -4,4 +4,15 @@ class TestCommonMethods < Test::Unit::TestCase
   should "respond to query call" do
     assert Book.respond_to?("query")
   end
+
+  should "find record with book name" do
+    book = Book.create(:name => "Otherland", :author => "Tad Williams")
+    assert Cleo.create(book)
+    book_cleo_id = book.cleo_id
+    assert Cleo.find(book_cleo_id)
+
+    assert Cleo.delete(book_cleo_id)
+    assert_nil Cleo.find(book_cleo_id)
+  end
 end
+

data/test/unit/test_instance_methods.rb

@@ -4,9 +4,12 @@ class TestInstanceMethods < Test::Unit::TestCase
   def setup
     @b = Book.new
   end
+
   %w{cleo_id cleo_id= sync_with_cleo set_cleo_id remove_from_cleo to_cleo_result as_cleo}.each do |resp|
     should "respond to cleo_id and cleo_id=" do
       assert @b.respond_to?(resp), "ActiveRecord Model with acts_as_cleo should respond to #{resp}"
     end
   end
+
+  #TODO write tests for the functionality of each of the instance methods
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_cleo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-21 00:00:00.000000000Z
+date: 2012-03-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: happymapper
-  requirement: &70264219062420 !ruby/object:Gem::Requirement
+  requirement: &70303817396620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70264219062420
+  version_requirements: *70303817396620
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70264219061880 !ruby/object:Gem::Requirement
+  requirement: &70303817396140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70264219061880
+  version_requirements: *70303817396140
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70264219061000 !ruby/object:Gem::Requirement
+  requirement: &70303817395660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70264219061000
+  version_requirements: *70303817395660
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70264219060360 !ruby/object:Gem::Requirement
+  requirement: &70303817395180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70264219060360
+  version_requirements: *70303817395180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70264219059760 !ruby/object:Gem::Requirement
+  requirement: &70303817394700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70264219059760
+  version_requirements: *70303817394700
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70264219059200 !ruby/object:Gem::Requirement
+  requirement: &70303817394220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70264219059200
+  version_requirements: *70303817394220
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70264219058720 !ruby/object:Gem::Requirement
+  requirement: &70303817393740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70264219058720
+  version_requirements: *70303817393740
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70264219058220 !ruby/object:Gem::Requirement
+  requirement: &70303817393260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70264219058220
+  version_requirements: *70303817393260
 - !ruby/object:Gem::Dependency
   name: fixtures
-  requirement: &70264219057680 !ruby/object:Gem::Requirement
+  requirement: &70303817392780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70264219057680
+  version_requirements: *70303817392780
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70264219057120 !ruby/object:Gem::Requirement
+  requirement: &70303817392300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70264219057120
+  version_requirements: *70303817392300
 description: LinkedIn Open Source type ahead tool's REST API as a ruby gem
 email: Blue.Dog.Archolite@gmail.com
 executables: []
@@ -145,7 +145,6 @@ files:
 - lib/cleo/reference.rb
 - lib/cleo/result.rb
 - lib/cleo/server.rb
-- lib/common_methods.rb
 - lib/generators/acts_as_cleo/install_generator.rb
 - lib/generators/acts_as_cleo/templates/install.rb
 - lib/instance_methods.rb
@@ -194,9 +193,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1569020174324415562
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/common_methods.rb

@@ -1,7 +0,0 @@
-module ActsAsCleo
-  module CommonMethods
-    def query(query, opts = {})
-      Cleo.query(query)
-    end
-  end
-end