acts_as_cleo 1.2.0 → 2.0.0

data/README.rdoc

@@ -65,7 +65,18 @@ This gem is still in beta.
 * Cleo.delete
 * Cleo.create
 
-As of this moment you need to pass a constructed Cleo::Result object to the above methods for them to function correctly.
+= Installing
+
+Add acts_as_cleo to your Gemfile
+  gem 'acts_as_cleo'
+
+After running bundle install execute the generate script to install acts_as_cleo
+  rails g acts_as_cleo:install
+
+Verify server settings in config/cleo.yml
+
+Run migrations
+  rake db:migrate
 
 Feel free to use this gem and provide feedback / patch requests.
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+2.0.0

data/acts_as_cleo.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "acts_as_cleo"
-  s.version = "1.2.0"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert R. Meyer"]
@@ -23,22 +23,22 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "acts_as_cleo.gemspec",
-    "config/cleo_example.yml",
     "lib/acts_as_cleo.rb",
+    "lib/acts_as_cleo/acts_methods.rb",
+    "lib/acts_as_cleo/class_methods.rb",
+    "lib/acts_as_cleo/instance_methods.rb",
     "lib/acts_as_cleo/result.rb",
     "lib/acts_as_cleo/version.rb",
-    "lib/acts_methods.rb",
-    "lib/class_methods.rb",
     "lib/cleo.rb",
-    "lib/cleo/jobs/create.rb",
-    "lib/cleo/jobs/delete.rb",
-    "lib/cleo/jobs/update.rb",
     "lib/cleo/reference.rb",
     "lib/cleo/result.rb",
     "lib/cleo/server.rb",
-    "lib/generators/acts_as_cleo/install_generator.rb",
-    "lib/generators/acts_as_cleo/templates/install.rb",
-    "lib/instance_methods.rb",
+    "lib/generators/acts_as_cleo/install/install_generator.rb",
+    "lib/generators/acts_as_cleo/install/templates/cleo.yml",
+    "lib/generators/acts_as_cleo/install/templates/install.rb",
+    "lib/generators/acts_as_cleo/install/templates/jobs/create.rb",
+    "lib/generators/acts_as_cleo/install/templates/jobs/delete.rb",
+    "lib/generators/acts_as_cleo/install/templates/jobs/update.rb",
     "test/config/cleo.yml",
     "test/data/xml/cleo/element.xml",
     "test/data/xml/cleo/elements.xml",

data/lib/{instance_methods.rb → acts_as_cleo/instance_methods.rb}

@@ -4,7 +4,7 @@ module ActsAsCleo
     def create_cleo
       set_cleo_id
       if Cleo::Server.async?
-        Resque.enqueue(Cleo::Resque::Create, self.record_type.classify, self.id)
+        Resque.enqueue(Cleo::ResqueCreate, record_type.classify, self.id)
       else
         Cleo.create(self)
       end
@@ -12,7 +12,7 @@ module ActsAsCleo
 
     def update_cleo
       if Cleo::Server.async?
-        Resque.enqueue(Cleo::Resque::Update, self.record_type.classify, self.id)
+        Resque.enqueue(Cleo::ResqueUpdate, record_type.classify, self.id)
       else
         Cleo.update(self)
       end
@@ -20,7 +20,7 @@ module ActsAsCleo
 
     def remove_from_cleo
       if Cleo::Server.async?
-        Resque.enqueue(Cleo::Resque::Delete, self.record_type.classify, self.id)
+        Resque.enqueue(Cleo::ResqueDelete, record_type.classify, self.id)
       else
         Cleo.delete(self.cleo_id)
         cr = cleo_reference

data/lib/acts_as_cleo.rb

@@ -2,12 +2,14 @@
 require File.dirname(__FILE__) + '/cleo'
 
 #Load ActsAsCleo method load
-require File.dirname(__FILE__) + '/acts_methods'
-require File.dirname(__FILE__) + '/class_methods'
-require File.dirname(__FILE__) + '/instance_methods'
+require File.dirname(__FILE__) + '/acts_as_cleo/acts_methods'
+require File.dirname(__FILE__) + '/acts_as_cleo/class_methods'
+require File.dirname(__FILE__) + '/acts_as_cleo/instance_methods'
 
 module ActsAsCleo
   include ActsMethods
+
+  require 'rails/railtie' if defined?(Rails)
 end
 
 ActiveRecord::Base.extend ActsAsCleo

data/lib/cleo/server.rb

@@ -13,11 +13,6 @@ module Cleo
 
       env = ENV['QUEUE'] || ''
       ENV['QUEUE'] = (env.split(',') << @@configuration[:queue]).uniq.join(',')
-
-      if @@configuration[:run_async]
-        require 'resque'
-        %w{create update delete}.each{|life| require File.dirname(__FILE__) + "/jobs/#{life}" }
-      end
     end
 
     def self.load_configuration
@@ -25,8 +20,6 @@ module Cleo
 
       if File.exists?( cleo_file_path )
         Cleo::Server.configure(YAML::load_file( cleo_file_path )[Rails.env].symbolize_keys)
-      else
-        raise LoadError.new("No cleo.yml found. Please viery that you have a copy of cleo.yml in your config directory.")
       end
     end
 

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

@@ -0,0 +1,35 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+
+module ActsAsCleo
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    def copy_migration_and_config
+
+      #Config file
+      copy_file 'cleo.yml', "config/cleo.yml"
+
+      #Resque workers
+      %w{update create delete}.each do |life|
+        copy_file "jobs/#{life}.rb", "app/jobs/#{life}.rb"
+      end
+
+      #create migration
+      migration_template 'install.rb', 'db/migrate/install_acts_as_audited.rb'
+    end
+
+    def self.next_migration_number(dirname)
+      next_migration_number = current_migration_number(dirname) + 1
+      if ActiveRecord::Base.timestamped_migrations
+        [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+      else
+        "%.3d" % next_migration_number
+      end
+    end
+  end
+end

data/{config/cleo_example.yml → lib/generators/acts_as_cleo/install/templates/cleo.yml}

@@ -1,6 +1,8 @@
 # Config file for the acts_as_cleo plugin.
 development:
   url: "http://localhost:8080/cleo-primer/"
+  run_async: true
+  queue: "cleo"
 
 test:
   url: "http://localhost:8080/cleo-primer/"

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

@@ -0,0 +1,10 @@
+module Cleo
+  module ResqueCreate
+    @queue = Cleo::Server.queue
+
+    def self.perform(klass, klass_id)
+      to_create = Kernel.const_get(klass).find(klass_id)
+      Cleo.create(to_create)
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Cleo
+  module ResqueDelete
+    @queue = Cleo::Server.queue
+
+    def self.perform(klass, klass_id)
+      to_delete = Kernel.const_get(klass).find(klass_id)
+      Cleo.delete(to_delete.cleo_id)
+      cr = Cleo::Reference.find(:first, :conditions => ["record_type = ? and record_id = ?", klass, to_delete.id])
+      cr.delete
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Cleo
+  module ResqueUpdate
+    @queue = Cleo::Server.queue
+
+    def self.perform(klass, klass_id)
+      to_update = Kernel.const_get(klass).find(klass_id)
+      Cleo.update(to_update)
+    end
+  end
+end

data/test/helper.rb

@@ -2,6 +2,7 @@ require 'simplecov'
 SimpleCov.start
 
 require 'rails'
+require 'resque'
 require 'rubygems'
 require 'bundler'
 require 'active_record'
@@ -35,5 +36,8 @@ require sqlite
 models_dir = File.join(file_dirname, 'models')
 Dir[ models_dir + '/*.rb'].each { |m| require m }
 
+server_config = {:url => "http://localhost:8080/cleo-primer/", :run_async => false}
+Cleo::Server.configure server_config
+
 class Test::Unit::TestCase
 end

data/test/test_install_generator.rb

@@ -1,10 +1,10 @@
 require 'helper'
-require 'generators/acts_as_cleo/install_generator'
+require 'generators/acts_as_cleo/install/install_generator'
 
 class InstallGeneratorTest < Rails::Generators::TestCase
   destination File.expand_path('../../tmp', __FILE__)
   setup :prepare_destination
-  tests ActsAsCleo::Generators::InstallGenerator
+  tests ActsAsCleo::InstallGenerator
 
   should "generate a migration" do
     run_generator %w(install)

data/test/unit/test_cleo.rb

@@ -58,13 +58,17 @@ class TestCleo < Test::Unit::TestCase
   end
 
   should "change the configuration of the server" do
-    root_path = Rails.root.nil? ? "#{File.dirname(File.expand_path(__FILE__))}/../"  : Rails.root
-    cleo_file_path = File.join( root_path, 'config', 'cleo.yml' )
+    server_config = {:url => "http://localhost:8080/cleo-primer/", :run_async => true, :queue => "cleo"}
 
-    Cleo::Server.configure YAML::load_file( cleo_file_path )['async_test'].symbolize_keys
+    Cleo::Server.configure server_config
     assert Cleo::Server.async?
     assert "cleo", Cleo::Server.queue.to_s
 
+
+    server_config = {:url => "http://localhost:8080/cleo-primer/", :run_async => false}
+    Cleo::Server.configure server_config
+    assert_same false, Cleo::Server.async?
+    assert "cleo", Cleo::Server.queue.to_s
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_cleo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: happymapper
-  requirement: &70251794879380 !ruby/object:Gem::Requirement
+  requirement: &70294157456900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70251794879380
+  version_requirements: *70294157456900
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70251794878900 !ruby/object:Gem::Requirement
+  requirement: &70294157456420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70251794878900
+  version_requirements: *70294157456420
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70251794878420 !ruby/object:Gem::Requirement
+  requirement: &70294157455940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70251794878420
+  version_requirements: *70294157455940
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70251794877940 !ruby/object:Gem::Requirement
+  requirement: &70294157455460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251794877940
+  version_requirements: *70294157455460
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70251794877460 !ruby/object:Gem::Requirement
+  requirement: &70294157454980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70251794877460
+  version_requirements: *70294157454980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70251794876980 !ruby/object:Gem::Requirement
+  requirement: &70294157454500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70251794876980
+  version_requirements: *70294157454500
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70251794876500 !ruby/object:Gem::Requirement
+  requirement: &70294157454020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70251794876500
+  version_requirements: *70294157454020
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70251794876020 !ruby/object:Gem::Requirement
+  requirement: &70294157453540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251794876020
+  version_requirements: *70294157453540
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70251794875540 !ruby/object:Gem::Requirement
+  requirement: &70294157453060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251794875540
+  version_requirements: *70294157453060
 - !ruby/object:Gem::Dependency
   name: fixtures
-  requirement: &70251794875060 !ruby/object:Gem::Requirement
+  requirement: &70294157452580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251794875060
+  version_requirements: *70294157452580
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70251794874580 !ruby/object:Gem::Requirement
+  requirement: &70294157452100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251794874580
+  version_requirements: *70294157452100
 description: LinkedIn Open Source type ahead tool's REST API as a ruby gem
 email: Blue.Dog.Archolite@gmail.com
 executables: []
@@ -146,22 +146,22 @@ files:
 - Rakefile
 - VERSION
 - acts_as_cleo.gemspec
-- config/cleo_example.yml
 - lib/acts_as_cleo.rb
+- lib/acts_as_cleo/acts_methods.rb
+- lib/acts_as_cleo/class_methods.rb
+- lib/acts_as_cleo/instance_methods.rb
 - lib/acts_as_cleo/result.rb
 - lib/acts_as_cleo/version.rb
-- lib/acts_methods.rb
-- lib/class_methods.rb
 - lib/cleo.rb
-- lib/cleo/jobs/create.rb
-- lib/cleo/jobs/delete.rb
-- lib/cleo/jobs/update.rb
 - lib/cleo/reference.rb
 - lib/cleo/result.rb
 - lib/cleo/server.rb
-- lib/generators/acts_as_cleo/install_generator.rb
-- lib/generators/acts_as_cleo/templates/install.rb
-- lib/instance_methods.rb
+- lib/generators/acts_as_cleo/install/install_generator.rb
+- lib/generators/acts_as_cleo/install/templates/cleo.yml
+- lib/generators/acts_as_cleo/install/templates/install.rb
+- lib/generators/acts_as_cleo/install/templates/jobs/create.rb
+- lib/generators/acts_as_cleo/install/templates/jobs/delete.rb
+- lib/generators/acts_as_cleo/install/templates/jobs/update.rb
 - test/config/cleo.yml
 - test/data/xml/cleo/element.xml
 - test/data/xml/cleo/elements.xml

data/lib/cleo/jobs/create.rb

@@ -1,12 +0,0 @@
-module Cleo
-  module Resque
-    module Update
-      @queue = Cleo::Server.queue
-
-      def self.perform(klass, klass_id)
-        to_create = Kernel.const_get(klass).find(klass_id)
-        Cleo.create(to_create)
-      end
-    end
-  end
-end

data/lib/cleo/jobs/delete.rb

@@ -1,14 +0,0 @@
-module Cleo
-  module Resque
-    module Update
-      @queue = Cleo::Server.queue
-
-      def self.perform(klass, klass_id)
-        to_delete = Kernel.const_get(klass).find(klass_id)
-        Cleo.delete(to_delete.cleo_id)
-        cr = Cleo::Reference.find(:first, :conditions => ["record_type = ? and record_id = ?", klass, to_delete.id])
-        cr.delete
-      end
-    end
-  end
-end

data/lib/cleo/jobs/update.rb

@@ -1,12 +0,0 @@
-module Cleo
-  module Resque
-    module Update
-      @queue = Cleo::Server.queue
-
-      def self.perform(klass, klass_id)
-        to_update = Kernel.const_get(klass).find(klass_id)
-        Cleo.update(to_update)
-      end
-    end
-  end
-end

data/lib/generators/acts_as_cleo/install_generator.rb

@@ -1,28 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-require 'active_record'
-require 'rails/generators/active_record'
-
-module ActsAsCleo
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-
-      source_root File.expand_path("../templates", __FILE__)
-
-      # Implement the required interface for Rails::Generators::Migration.
-      def self.next_migration_number(dirname) #:nodoc:
-        next_migration_number = current_migration_number(dirname) + 1
-        if ActiveRecord::Base.timestamped_migrations
-          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
-        else
-          "%.3d" % next_migration_number
-        end
-      end
-
-      def copy_migration
-        migration_template 'install.rb', 'db/migrate/install_acts_as_audited.rb'
-      end
-    end
-  end
-end