acts_as_cleo 2.1.2 → 2.2.0

data/README.rdoc

@@ -1,47 +1,42 @@
 = acts_as_cleo
 
-=== To enable
-
-Create a cleo.yml in your config directory.
+Acts As Cleo now has support for Redis backed asynchronous operations.
 
-  development:
-    url: "http://localhost:8080/cleo-primer/"
 
-  production:
-    url: "http://localhost:8080/cleo-primer/"
 
+Optional parameters are:
+  queue: "my_queue_to_process"
 
-Acts As Cleo now has support for Redis backed asynchronous operations.
+queue defaults to "cleo"
 
-To enable this, change your cleo.yml to include
+To enable Redis, change your cleo.yml to include
  async: true
 
 async defaults to false
 
-Optional parameters are:
-  queue: "my_queue_to_process"
+To disable auto flushing of indexer queue
+  auto_flush: false
 
-queue defaults to "cleo"
+By default, auto indexer flushing is enabled
 
 === 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
+  Cleo.query(string)          # Takes string search param and returns array of Cleo::Result objects
 
 To enable on an ActiveRecord::Base model:
 
-  acts_as_cleo
+  class MyObject < ActiveRecord::Base
+    acts_as_cleo
+  end
 
+Or add optional parameters
   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.
@@ -85,7 +80,7 @@ This generate command will install the following files:
 * config/initalizers/cleo_initalizer.rb
 
 === Database migration
-* db/migrate/#{timestamp or sequence number}_install_acts_as_audited.rb
+* db/migrate/#{timestamp or sequence number}_install_acts_as_cleo.rb
 
 
 Verify server settings in config/cleo.yml

data/VERSION

@@ -1 +1 @@
-2.1.2
+2.2.0

data/acts_as_cleo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "acts_as_cleo"
-  s.version = "2.1.2"
+  s.version = "2.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert R. Meyer"]
-  s.date = "2012-03-23"
+  s.date = "2012-03-26"
   s.description = "LinkedIn Open Source type ahead tool's REST API as a ruby gem. Now with Reddis support."
   s.email = "Blue.Dog.Archolite@gmail.com"
   s.extra_rdoc_files = [

data/lib/cleo.rb

@@ -78,9 +78,16 @@ module Cleo
   end
 
   private
+  def self.flush
+    uri = URI.parse Cleo::Server.url + "flush"
+    request = Net::HTTP::Post.new(uri.path)
+    Net::HTTP.new(uri.host, uri.port).start { |http| http.request request }
+  end
+
   def self.good_response_code?(response)
     case response
     when Net::HTTPOK
+      flush if Cleo::Server.auto_flush?
       true   # success response
     when Net::HTTPClientError, Net::HTTPInternalServerError
       false  # non-success response

data/lib/cleo/server.rb

@@ -8,7 +8,15 @@ module Cleo
       parts +=  %w{rest elements}
       @@configuration[:url] = parts.join('/') + '/'
 
-      @@configuration[:run_async] = new_config.has_key?(:run_async) ? new_config[:run_async] : false
+      if new_config.has_key?(:async)
+        @@configuration[:async] = new_config[:async]
+      elsif new_config.has_key?(:run_async)
+        @@configuration[:async] = new_config[:run_async]
+      else
+        @@configuration[:async] = false
+      end
+
+      @@configuration[:auto_flush] = new_config.has_key?(:auto_flush) ? new_config[:auto_flush] : true
       @@configuration[:queue] = new_config.has_key?(:queue) ? new_config[:queue] : "cleo"
 
       env = ENV['QUEUE'] || ''
@@ -28,8 +36,12 @@ module Cleo
       @@configuration[:url]
     end
 
+    def self.auto_flush?
+      @@configuration[:auto_flush]
+    end
+
     def self.async?
-      @@configuration[:run_async]
+      @@configuration[:async]
     end
 
     def self.queue

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

@@ -21,7 +21,7 @@ module ActsAsCleo
       end
 
       #create migration
-      migration_template 'install.rb', 'db/migrate/install_acts_as_audited.rb'
+      migration_template 'install.rb', 'db/migrate/install_acts_as_cleo.rb'
     end
 
     def self.next_migration_number(dirname)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_cleo
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-23 00:00:00.000000000Z
+date: 2012-03-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: happymapper
-  requirement: &70094839813820 !ruby/object:Gem::Requirement
+  requirement: &70187991206160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094839813820
+  version_requirements: *70187991206160
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70094839813340 !ruby/object:Gem::Requirement
+  requirement: &70187991205680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70094839813340
+  version_requirements: *70187991205680
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70094839812860 !ruby/object:Gem::Requirement
+  requirement: &70187991205200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094839812860
+  version_requirements: *70187991205200
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70094839812380 !ruby/object:Gem::Requirement
+  requirement: &70187991204720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70094839812380
+  version_requirements: *70187991204720
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70094839811900 !ruby/object:Gem::Requirement
+  requirement: &70187991204240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70094839811900
+  version_requirements: *70187991204240
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70094839811420 !ruby/object:Gem::Requirement
+  requirement: &70187991203760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70094839811420
+  version_requirements: *70187991203760
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70094839810940 !ruby/object:Gem::Requirement
+  requirement: &70187991203280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70094839810940
+  version_requirements: *70187991203280
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70094839810460 !ruby/object:Gem::Requirement
+  requirement: &70187991202800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70094839810460
+  version_requirements: *70187991202800
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70094839809980 !ruby/object:Gem::Requirement
+  requirement: &70187991202320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70094839809980
+  version_requirements: *70187991202320
 - !ruby/object:Gem::Dependency
   name: fixtures
-  requirement: &70094839809500 !ruby/object:Gem::Requirement
+  requirement: &70187991201840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70094839809500
+  version_requirements: *70187991201840
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70094839809020 !ruby/object:Gem::Requirement
+  requirement: &70187991201360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70094839809020
+  version_requirements: *70187991201360
 description: LinkedIn Open Source type ahead tool's REST API as a ruby gem. Now with
   Reddis support.
 email: Blue.Dog.Archolite@gmail.com