acts_as_cleo 2.1.1 → 2.1.2

data/README.rdoc

@@ -5,29 +5,33 @@
 Create a cleo.yml in your config directory.
 
   development:
-
     url: "http://localhost:8080/cleo-primer/"
 
   production:
-
     url: "http://localhost:8080/cleo-primer/"
 
 
+Acts As Cleo now has support for Redis backed asynchronous operations.
+
+To enable this, change your cleo.yml to include
+ async: true
+
+async defaults to false
+
+Optional parameters are:
+  queue: "my_queue_to_process"
+
+queue defaults to "cleo"
+
 === 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
@@ -54,16 +58,12 @@ 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
+  set_cleo_id, create_cleo, update_cleo, and remove_from_cleo
 
-= WARNING
+All three of these callbacks respect the async option on cleo.yml configuration.
 
-This gem is still in beta. 
-
-* Cleo.find
-* Cleo.update
-* Cleo.delete
-* Cleo.create
+= WARNING
+This gem is still in beta.
 
 = Installing
 
@@ -73,6 +73,21 @@ Add acts_as_cleo to your Gemfile
 After running bundle install execute the generate script to install acts_as_cleo
   rails g acts_as_cleo:install
 
+This generate command will install the following files:
+
+=== Background Job Processors
+* app/jobs/create.rb
+* app/jobs/update.rb
+* app/jobs/delete.rb
+
+=== Configuration and Initialization files
+* config/cleo.yml
+* config/initalizers/cleo_initalizer.rb
+
+=== Database migration
+* db/migrate/#{timestamp or sequence number}_install_acts_as_audited.rb
+
+
 Verify server settings in config/cleo.yml
 
 Run migrations

data/VERSION

@@ -1 +1 @@
-2.1.1
+2.1.2

data/acts_as_cleo.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "acts_as_cleo"
-  s.version = "2.1.1"
+  s.version = "2.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert R. Meyer"]

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

@@ -13,7 +13,7 @@ module ActsAsCleo
 
       #Config file
       copy_file 'cleo.yml', "config/cleo.yml"
-      copy_file 'cleo_initalizer.rb', 'app/initalizers/cleo_initalizer.rb'
+      copy_file 'cleo_initalizer.rb', 'config/initalizers/cleo_initalizer.rb'
 
       #Resque workers
       %w{update create delete}.each do |life|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_cleo
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: happymapper
-  requirement: &70147310726380 !ruby/object:Gem::Requirement
+  requirement: &70094839813820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70147310726380
+  version_requirements: *70094839813820
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70147310725900 !ruby/object:Gem::Requirement
+  requirement: &70094839813340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70147310725900
+  version_requirements: *70094839813340
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70147310725420 !ruby/object:Gem::Requirement
+  requirement: &70094839812860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70147310725420
+  version_requirements: *70094839812860
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70147310724940 !ruby/object:Gem::Requirement
+  requirement: &70094839812380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70147310724940
+  version_requirements: *70094839812380
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70147310724460 !ruby/object:Gem::Requirement
+  requirement: &70094839811900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70147310724460
+  version_requirements: *70094839811900
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70147310723980 !ruby/object:Gem::Requirement
+  requirement: &70094839811420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70147310723980
+  version_requirements: *70094839811420
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70147310723500 !ruby/object:Gem::Requirement
+  requirement: &70094839810940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70147310723500
+  version_requirements: *70094839810940
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70147310723020 !ruby/object:Gem::Requirement
+  requirement: &70094839810460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70147310723020
+  version_requirements: *70094839810460
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70147310722540 !ruby/object:Gem::Requirement
+  requirement: &70094839809980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70147310722540
+  version_requirements: *70094839809980
 - !ruby/object:Gem::Dependency
   name: fixtures
-  requirement: &70147310722060 !ruby/object:Gem::Requirement
+  requirement: &70094839809500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70147310722060
+  version_requirements: *70094839809500
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70147310721580 !ruby/object:Gem::Requirement
+  requirement: &70094839809020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70147310721580
+  version_requirements: *70094839809020
 description: LinkedIn Open Source type ahead tool's REST API as a ruby gem. Now with
   Reddis support.
 email: Blue.Dog.Archolite@gmail.com