curbit 0.1.0 → 0.1.1

data/README.rdoc

@@ -16,8 +16,8 @@ to get to or replicate in those services.
 === Minimal configuration
 
 Quick setup inside your Rails controller.  ActionController::Base is
-already extended to include Curbit.  This will add a rate_limit "macro" to
-your controllers.
+already extended to include Curbit when installed as a plugin.  This
+will add a rate_limit "macro" to your controllers.
 
   class InvitesController < ApplicationController
     def invite
@@ -125,14 +125,14 @@ method.  This will ignore any :status argument set in the cofig options.
 
 === Gem install
 
-  $ gem install curbit --source http://gems.github.com
+  $ gem install curbit --source http://gemcutter.org
 
 === Rails dependency
 Specify the gem dependency in your config/environment.rb file:
 
   Rails::Initializer.run do |config|
     #...
-    config.gem "curbit", :source => "http://gems.github.com"
+    config.gem "curbit", :source => "http://gemcutter.org
     #...
   end
 
@@ -141,10 +141,20 @@ Then:
   $ rake gems:install
   $ rake gems:unpack
 
+Then include in your controllers:
+
+  class MyController < ApplicationController
+    include Curbit::Controller
+    #...
+  end
+
 == As a Plugin
 
   $ script/plugin install git://github.com/ssayles/curbit.git
 
+Curbit::Controller will automatically be added to your controllers so you
+can call the rate_limit macro whenever you want.
+
 = Requirements
 * Rails >= 2.0
 * memcached or other compatible caching support in Rails.  CurbIt has to store information about requests and assumes your cache implementation will be able to take calls like:

data/Rakefile

@@ -1,32 +1,21 @@
 require 'rubygems'
 require 'rake'
-require 'echoe'
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "curbit"
-    gem.summary = %Q{Rails plugin for application level rate limiting}
-    gem.description = %Q{TODO: longer description of your gem}
+    gem.summary = %Q{Rate limiting for Rails action controllers.}
+    gem.description = %Q{Rate limiting for Rails action controllers.}
     gem.email = "ssayles@users.sourceforge.net"
     gem.homepage = "http://github.com/ssayles/curbit"
     gem.authors = ["Scott Sayles"]
     gem.add_development_dependency "thoughtbot-shoulda"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-Echoe.new('curbit', '0.1.0') do |p|
-  p.description = "Application level rate limiting for Rails"
-  p.url = "http://github.com/ssayles/curbit"
-  p.author = "Scott Sayles"
-  p.email = "ssayles@users.sourceforge.net"
-  p.ignore_pattern = ["tmp/*"]
-  #p.develoment_dependencies = []
-end
-
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'

data/curbit.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{curbit}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Sayles"]

data/init.rb

@@ -1 +1,2 @@
-ActionController::Base.include(Curbit::Controller)
+# executed when included as a plugin
+ActionController::Base.send(:include, Curbit::Controller)

data/lib/curbit.rb

@@ -176,7 +176,7 @@ module Curbit
           render_curbit_message(message, opts)
         end
       else
-        message = "Too many requests within the allowed time.  Please wait #{opts[:wait_time]} before submitting your request again."
+        message = "Too many requests within the allowed time.  Please wait #{opts[:wait_time]} seconds before submitting your request again."
         render_curbit_message(message, opts)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: curbit
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Scott Sayles