merb_threshold 0.1.4

data/spec/frequency_spec.rb

@@ -0,0 +1,136 @@
+describe Frequency do  
+  before(:each) do
+    now = Time.now.to_i
+    @history = [
+      now - 301, 
+      now - 121, 
+      now - 61, 
+      now - 31,
+      now - 20
+    ]
+  end
+  
+  it 'should be able to initialize a frequency' do
+    @freq = Frequency.new(5,30,:seconds)
+    @freq.should be_an_instance_of(Frequency)
+  end
+  
+  it 'should be able to initialize a frequency without the units' do
+    @freq1 = Frequency.new 1, 30, :seconds
+    @freq2 = Frequency.new 1, 30.seconds
+    
+    @freq1.interval.should be(@freq2.interval)
+    @freq1.occurrence.should be(@freq2.occurrence)
+    @freq1.units.should == @freq2.units
+    @freq1.period.should be(@freq2.period)
+  end
+  
+  it 'should create frequencies properly when using floats' do
+    @freq = Frequency.new 1, 3.3, :minutes
+    @freq.period.to_i == 198
+  end
+
+  it 'should cast the units automatically if not provided' do
+    @freq = Frequency.new 5, 5.minutes
+    @freq.period.should == 300
+    @freq.interval.should == 5.0
+    @freq.units.should == :minutes
+  end
+  
+  it 'should cast the units automatically if not provided' do
+    @freq = Frequency.new 5, 5.hours
+    @freq.units.should == :hours
+  end
+  
+  it 'should provide #to_s' do
+    @freq = Frequency.new 5, 5.minutes
+    @freq.to_s == "5 times per 5.0 minutes"
+  end
+  
+  it 'should be able to load a list of events' do
+    @freq = Frequency.new 5, 5, :minutes
+    @freq.load @history
+    
+    @freq.events.length.should be(5)
+  end
+  
+  it 'should be able to determine the rate of events over a period in seconds' do
+    @freq = Frequency.new 1, 2, :minutes
+    @freq.load @history
+    
+    # 3 fall within 2 minutes
+    projected_rate = 3 / 120.0
+    @freq.rate.should == projected_rate
+  end
+  
+  it 'should always determine an event is not permissable when the period is zero' do
+    @freq = Frequency.new 1, 0
+    @freq2 = Frequency.new 1, 0, :seconds
+    @freq3 = Frequency.new 1, 0, :minutes
+    @freq4 = Frequency.new 0, 0
+    
+    @freq.permit?.should be(false)
+    @freq2.permit?.should be(false)
+    @freq3.permit?.should be(false)
+    @freq4.permit?.should be(false)
+  end
+  
+  it 'should be able to determine if an additional event is permissable' do
+    @freq = Frequency.new 1, 2, :minutes
+    @freq.load [Time.now.to_i - 30]
+    @freq.permit?.should be(false)
+    
+    @freq2 = Frequency.new 5, 5, :minutes
+    @freq2.load @history
+    @freq2.permit?.should be(true)
+  end
+  
+  it 'should be able to add a single event' do
+    @freq = Frequency.new 5, 2.minutes
+    @freq.add(Time.now.to_i).length.should be(1)
+  end
+  
+  it 'should be able to determine if there is no wait for an available resource' do
+    @freq = Frequency.new 5, 5.minutes
+    @freq.load @history
+    @freq.wait.should be(0)
+  end
+  
+  it 'should be able to determine the wait time in seconds when unavailable' do
+    @freq = Frequency.new 2, 1.minute
+    @freq.load @history
+    
+    # Treshold is 1 minute
+    # Oldest happend 31 seconds ago
+    # in 29 more seconds it will fall out of the period (60 seconds)
+    @freq.wait.should be(29)
+  end
+  
+  it 'should be able to flush the currently loaded events' do
+    @freq = Frequency.new 2, 1.minute
+    @freq.load @history
+    @freq.respond_to? :flush
+    @freq.flush
+    @freq.events.should be_empty
+  end
+  
+  it 'should be able to load! events' do
+    @freq = Frequency.new 2, 1.minute
+    @freq.load @history
+    @freq.load @history
+    @freq.events.length.should be(10)
+    @freq.load!([Time.now.to_i])
+    @freq.events.length.should be(1)
+  end
+  
+  it 'should be able to determine the wait tiem in seconds when unavailable (part 2)' do
+    @freq = Frequency.new 2, 1.minute
+    @freq.load @history
+    @freq.flush
+    
+    @freq.add(Time.now.to_i)
+    @freq.add(Time.now.to_i)
+    
+    @freq.wait.should be(60)
+  end
+end

data/spec/helpers/recaptcha_helper_spec.rb

@@ -0,0 +1,29 @@
+describe Merb::Threshold::Helpers do
+  before do
+    class CaptchaController < Merb::Controller
+      register_threshold :index
+      GhettoSessionStore = {}
+
+      def session
+        GhettoSessionStore[params[:session_id]] ||={}
+        GhettoSessionStore[params[:session_id]]        
+      end
+      
+      def index
+        if !permit_access?(:index)
+          @partial =File.join(File.expand_path("."),"lib/merb_threshold/templates/recaptcha_partial")
+          captcha :partial => @partial, :partial_opts => {:format => :html}
+        end
+      end
+    end
+  end
+  
+  it 'should display a captcha if the threshold is exceeded' do
+    @response = dispatch_to(CaptchaController, :index,{
+      :session_id=>"display-captcha"
+    })
+
+    @response.should be_successful
+    @response.body.should =~ /api.recaptcha/
+  end
+end

data/spec/helpers/wait_helper_spec.rb

@@ -0,0 +1,32 @@
+describe Merb::Threshold::Helpers do
+  before do
+    class WaitController < Merb::Controller
+      register_threshold :index, :limit => 1.per(30.seconds)
+      
+      GhettoSessionStore = {}
+      def session
+        GhettoSessionStore[params[:session_id]] ||={}
+        GhettoSessionStore[params[:session_id]]        
+      end
+      
+      def index
+        if !permit_access?(:index)
+          wait :partial => File.join(
+            File.expand_path("."),"lib/merb_threshold/templates/wait_partial"
+          ), :partial_opts => {:format => :html}
+        end
+      end
+    end
+  end
+  
+  it 'should display a wait message if the threshold is exceeded' do
+    dispatch_to(WaitController, :index,{:session_id=>"display-wait-msg"})
+    
+    @response = dispatch_to(WaitController, :index,{
+      :session_id=>"display-wait-msg"
+    })
+    
+    @response.should be_successful
+    @response.body.should =~ /This resource will be available in 30 seconds/
+  end
+end

data/spec/per_spec.rb

@@ -0,0 +1,9 @@
+describe Per do
+  it 'should provide the per method' do
+    3.should respond_to :per
+  end
+  
+  it 'should return a frequency object' do
+    3.per(30.seconds).should be_instance_of(Frequency)
+  end
+end

data/spec/recaptcha_client_spec.rb

@@ -0,0 +1,35 @@
+include Merb::Threshold
+describe RecaptchaClient do
+  it 'should provide API_SERVER' do
+    defined?(RecaptchaClient::API_SERVER).should ==('constant')
+  end
+  
+  it 'should provide API_SSL_SERVER' do
+    defined?(RecaptchaClient::API_SSL_SERVER).should ==('constant')
+  end
+  
+  it 'should provide API_VERIFY_SERVER' do
+    defined?(RecaptchaClient::API_VERIFY_SERVER).should ==('constant')
+  end
+  
+  it 'should provide accessors for a public key' do
+    RecaptchaClient.should respond_to :public_key
+    RecaptchaClient.should respond_to :public_key=
+    RecaptchaClient.public_key = "key"
+    RecaptchaClient.public_key.should == "key"    
+  end
+
+  it 'should provide accessors for a private key' do  
+    RecaptchaClient.should respond_to :private_key
+    RecaptchaClient.should respond_to :private_key=
+    RecaptchaClient.private_key = "key"
+    RecaptchaClient.private_key.should == "key"
+  end
+  
+  it 'should be able to submit a captcha response' do
+    result = RecaptchaClient.solve("127.0.0.1","fake_challenge","fake_response")
+    result.should be_instance_of(Array)
+    result.first.should be(false)
+    result.last.should == ("invalid-site-private-key")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'merb-helpers/time_dsl'
+
+require 'merb-core'
+require 'merb-core/test'
+
+Merb::Config.use do |c|
+  c[:use_mutex] = false
+  c[:session_store] = 'cookie'
+  c[:session_secret_key]  = 'f1e532d42a798511504907cf28d9c660fe51ac91'
+  c[:session_id_key] = '_merb_threshold_session_id'
+  c[:reload_classes] = false
+end
+
+Merb::Plugins.config[:merb_threshold] = {
+# TODO remove global catpcha keys
+  :public_key           => nil,
+  :private_key          => nil,
+  :recaptcha            => true,
+  :wait_partial         => 'shared/wait_partial',
+  :captcha_partial      => 'shared/recaptcha_partial'
+}
+require File.join(File.dirname(__FILE__), '..', 'lib', 'merb_threshold')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'merb_threshold','frequency')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'merb_threshold','controller','merb_controller')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'merb_threshold','recaptcha_client')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'merb_threshold','helpers','recaptcha_helper')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'merb_threshold','helpers','wait_helper')
+
+module Merb  
+  class Controller
+    include Merb::Threshold::Helpers
+  end
+end
+Numeric.send :include, Merb::Threshold::Per
+
+include Merb::Threshold
+
+class Hash
+  def to_json
+    result = "{"
+    result << self.map do |k, v|
+      if ! v.is_a?(String)
+        "\"#{k}\": #{v}"
+      else
+        "\"#{k}\": \"#{v}\""
+      end
+    end.join(", ")
+    result << "}"
+  end
+end
+  
+
+
+RecaptchaClient.public_key  = '6LcnNgUAAAAAABrFyM-LuC53axOzHbE27afV4gxP'
+RecaptchaClient.private_key = '6LcnNgUAAAAAAEqnr9HP9ofrChZTcuTjl_0FFnxF'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: merb_threshold
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Cory O'Daniel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.7.1
+    version: 
+description: Merb plugin that provides resource access rate limits and captcha'ing
+email: contact@coryodaniel.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb_threshold
+- lib/merb_threshold/controller
+- lib/merb_threshold/controller/merb_controller.rb
+- lib/merb_threshold/frequency.rb
+- lib/merb_threshold/helpers
+- lib/merb_threshold/helpers/recaptcha_helper.rb
+- lib/merb_threshold/helpers/wait_helper.rb
+- lib/merb_threshold/merbtasks.rb
+- lib/merb_threshold/per.rb
+- lib/merb_threshold/recaptcha_client.rb
+- lib/merb_threshold/templates
+- lib/merb_threshold/templates/_recaptcha_partial.html.erb
+- lib/merb_threshold/templates/_wait_partial.html.erb
+- lib/merb_threshold.rb
+- spec/controller
+- spec/controller/merb_controller_spec.rb
+- spec/frequency_spec.rb
+- spec/helpers
+- spec/helpers/recaptcha_helper_spec.rb
+- spec/helpers/wait_helper_spec.rb
+- spec/per_spec.rb
+- spec/recaptcha_client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/coryodaniel
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: merb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Merb plugin that provides resource access rate limits and captcha'ing
+test_files: []
+