requests_counter 0.1.5

data/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+= Version 0.1.5
+* Added initializers
+= Version 0.1.0
+* Gem existence started

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Maciej Mensfeld
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,13 @@
+CHANGELOG.rdoc
+Gemfile
+MIT-LICENSE
+Manifest
+README.md
+Rakefile
+init.rb
+lib/generators/my_requests_counter/install_generator.rb
+lib/generators/my_requests_counter/templates/create_requests_counters_migration.rb
+lib/generators/my_requests_counter/templates/requests_counter_init.rb
+lib/requests_counter.rb
+spec/requests_counter_spec.rb
+spec/spec_helper.rb

data/README.md

@@ -0,0 +1,72 @@
+# Requests Counter
+
+## Install
+
+    gem install requests_counter
+
+and in your Gemfile:
+    
+    gem 'requests_counter'
+
+## About
+
+Requests Counter allows you to count attemps to get resource. You can then decide if attemp should be stopped (banned).
+
+When you want to limit attemps to something (for example to login form), you can count attemps and decide whether to show or not to show login form.
+
+Works with Ruby 1.8.7, 1.8.7 EE, 1.9.2
+
+## Requirements
+
+    ActiveRecord
+
+## Simple example
+
+    # Example with IP
+    10.times { RequestsCounter.with_token('127.0.0.1').permitted? } ==> true
+    RequestsCounter.with_token('127.0.0.1').permit? ==> false
+
+    # You can also use
+    req = RequestsCounter.find_by_token('127.0.0.1')
+    reg.permit? ==> true
+
+Wait 1 hour and then
+
+    RequestsCounter.with_token('127.0.0.1').permit? ==> true
+    
+Class methods:
+
+* with_token(token, resource = nil, params ={}) - will give you back resource counter (if not found - will create one)
+* permitted?(token, resource = nil, params ={}) - will tell you is token permitted to resource - without counting attempts
+* permit?(token, resource = nil, params ={}) - same as above, but will count attempts
+* remaining(token, resource = nil, params ={}) - how much attempts left
+
+Instance methods:
+
+* permitted? - will tell you is token permitted to resource - without counting attempts
+* permit? - same as above, but will count attempts
+* reset! - will reset counter
+* remaining - how much attempts left
+
+For more examples view rspec.
+
+## Setup
+
+    rails generate my_requests_counter:install
+
+## Tests
+
+    rspec requests_counter_spec.rb
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Maciej Mensfeld. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('requests_counter', '0.1.5') do |p|
+  p.description    = "Requests Counter allows you to count attemps to get resource. You can then decide if attemp should be stopped (banned)."
+  p.url            = "https://github.com/mensfeld/Requests-Counter"
+  p.author         = "Maciej Mensfeld"
+  p.email          = "maciej@mensfeld.pl"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = ["rspec >=2.0.0"]
+  p.dependencies = ["activerecord"]
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'requests_counter'

data/lib/generators/my_requests_counter/install_generator.rb

@@ -0,0 +1,21 @@
+module MyRequestsCounter
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def add_my_migration
+      timestamp = Time.now.strftime("%Y%m%d%H%M%S")
+      source = "create_requests_counters_migration.rb"
+      target = "db/migrate/#{timestamp}_create_requests_counters.rb"
+      copy_file source, target
+    end
+
+    def add_initializer
+      source = "requests_counter_init.rb"
+      target = "config/initializers/requests_counter.rb"
+      copy_file source, target
+    end
+
+  end
+end
+
+

data/lib/generators/my_requests_counter/templates/create_requests_counters_migration.rb

@@ -0,0 +1,21 @@
+class CreateRequestsCounters < ActiveRecord::Migration
+  def self.up
+
+    create_table :requests_counters do |t|
+      t.string   :token
+      t.string   :resource
+      t.integer  :attempts,           :default => 0
+      t.integer  :available_attempts, :default => 10
+      t.string   :wait_time,          :default => '1h'
+      t.datetime :last_logged
+    end
+
+    add_index :requests_counters, :resource
+    add_index :requests_counters, :token
+
+  end
+
+  def self.down
+    drop_table :requests_counters
+  end
+end

data/lib/generators/my_requests_counter/templates/requests_counter_init.rb

@@ -0,0 +1,2 @@
+RequestsCounter.wait_time = "1h"
+RequestsCounter.available_attempts = 10

data/lib/requests_counter.rb

@@ -0,0 +1,104 @@
+class RequestsCounter < ActiveRecord::Base
+
+  after_initialize :check_defaults
+
+  before_save :init_available_attempts
+
+  class << self
+    attr_accessor :available_attempts
+    attr_accessor :wait_time
+  end
+
+  class AvailableAttemptsNotInitialized < StandardError; end
+  class WaitTimeNotInitialized          < StandardError; end
+
+  validates :token, :presence => true
+
+  # Searches for instance element with provided token and resource
+  # and if it does not find one - will create new and return it to us
+  def self.with_token(token, resource = nil, params = {})
+    unless el = self.where(:token => token, :resource => resource).first
+      el = self.create({
+          :token => token,
+          :resource => resource
+        }.merge(params))
+    end
+    el
+  end
+
+  def self.permitted?(token, resource = nil, params = {})
+    self.with_token(token, resource, params).permitted?
+  end
+
+  def permitted?
+    if attempts < available_attempts
+      true
+    else
+      if time_permitted?
+        reset!
+        true
+      else
+        false
+      end
+    end
+  end
+
+  def self.permit?(token, resource = nil, params = {})
+    self.with_token(token, resource, params).permit?
+  end
+
+  def permit?
+    perm = permitted?
+    incr!
+    perm
+  end
+
+  def reset!
+    self.update_attributes(:attempts => 0)
+  end
+
+  def self.remaining(token, resource = nil, params = {})
+    self.with_token(token, resource, params).remaining
+  end
+
+  def remaining
+    r = available_attempts - attempts
+    r = 0 if r < 0
+    r
+  end
+
+  private
+
+  def init_available_attempts
+    if self.available_attempts.nil? || self.available_attempts < 1
+      self.available_attempts = self.class.available_attempts
+    end
+  end
+
+  def time_permitted?
+    time = case self.wait_time
+      when /^(\d+)m$/ then Time.now - $1.to_i.minute
+      when /^(\d+)h$/ then Time.now - $1.to_i.hour
+      when /^(\d+)d$/ then Time.now - $1.to_i.day
+      else Time.now - 1.hour
+    end
+    self.last_logged < time
+  end
+
+  # Refreshes our internal timestamp
+  def refresh!
+    self.update_attributes(:last_logged => Time.now)
+  end
+
+  # Increments our internatl attempts counter
+  def incr!
+    self.update_attributes(:attempts => self.attempts+1, :last_logged => Time.now)
+  end
+
+  # Default values should be initialized
+  def check_defaults
+    raise AvailableAttemptsNotInitialized unless self.class.available_attempts
+    raise WaitTimeNotInitialized          unless self.class.wait_time
+  end
+
+end

data/requests_counter.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{requests_counter}
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Maciej Mensfeld"]
+  s.cert_chain = ["/home/mencio/.cert_keys/gem-public_cert.pem"]
+  s.date = %q{2011-06-01}
+  s.description = %q{Requests Counter allows you to count attemps to get resource. You can then decide if attemp should be stopped (banned).}
+  s.email = %q{maciej@mensfeld.pl}
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.md", "lib/generators/my_requests_counter/install_generator.rb", "lib/generators/my_requests_counter/templates/create_requests_counters_migration.rb", "lib/generators/my_requests_counter/templates/requests_counter_init.rb", "lib/requests_counter.rb"]
+  s.files = ["CHANGELOG.rdoc", "Gemfile", "MIT-LICENSE", "Manifest", "README.md", "Rakefile", "init.rb", "lib/generators/my_requests_counter/install_generator.rb", "lib/generators/my_requests_counter/templates/create_requests_counters_migration.rb", "lib/generators/my_requests_counter/templates/requests_counter_init.rb", "lib/requests_counter.rb", "spec/requests_counter_spec.rb", "spec/spec_helper.rb", "requests_counter.gemspec"]
+  s.homepage = %q{https://github.com/mensfeld/Requests-Counter}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Requests_counter", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{requests_counter}
+  s.rubygems_version = %q{1.5.2}
+  s.signing_key = %q{/home/mencio/.cert_keys/gem-private_key.pem}
+  s.summary = %q{Requests Counter allows you to count attemps to get resource. You can then decide if attemp should be stopped (banned).}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
+  end
+end

data/spec/requests_counter_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+ROOT = File.expand_path(File.dirname(__FILE__))
+
+
+RequestsCounter.wait_time = "10m"
+RequestsCounter.available_attempts = 10
+
+describe RequestsCounter do
+  subject { RequestsCounter }
+  after(:each){ RequestsCounter.destroy_all }
+
+  context "when we want to have subject instance" do
+    context "but we don't have any with corresponding ip" do
+      it "should create one and return it to use" do
+        subject.count.should == 0
+        subject.with_token('127.0.0.1').should_not == nil
+        subject.count.should == 1
+      end
+    end
+
+    context "and we have one already" do
+      it "should fetch it and return to us" do
+        subject.count.should == 0
+        subject.with_token('127.0.0.1')
+        subject.count.should == 1
+        subject.with_token('127.0.0.1')
+        subject.with_token('127.0.0.1')
+        subject.count.should == 1
+      end
+    end
+
+    context "with additional key" do
+      context "but we don't have any with corresponding ip" do
+        it "should create one and return it to use" do
+          subject.count.should == 0
+          subject.with_token('127.0.0.1', :test).should_not == nil
+          subject.count.should == 1
+        end
+      end
+
+      context "and we have one but with different key" do
+        it "should fetch a new one and return to us" do
+          subject.count.should == 0
+          subject.with_token('127.0.0.1')
+          subject.with_token('127.0.0.1', :test).should_not == nil
+          subject.count.should == 2
+        end
+      end
+    
+      context "and we have one with good key" do
+        it "should return it to us" do
+          subject.count.should == 0
+          subject.with_token('127.0.0.1', :test).should_not == nil
+          subject.count.should == 1
+        end
+      end
+
+    end
+
+    context "and we want one with different available_attempts" do
+      it "should create it for us" do
+        el = subject.with_token('127.0.0.1', :resource, {:available_attempts => 12})
+        el.available_attempts.should == 12
+      end
+    end
+
+    context "and we want one with different wait_time" do
+      it "should create it for us" do
+        el = subject.with_token('127.0.0.1', :resource, {:wait_time => '4h'})
+        el.wait_time.should == '4h'
+      end
+    end
+
+  end
+
+  context "when we check if new ip is permitted" do
+    context "when we use class interface" do
+      it "should return true and should not count attempts" do
+        subject.permitted?('127.0.0.1').should == true
+        subject.permitted?('127.0.0.1', :resource).should == true
+        subject.with_token('127.0.0.1', :resource).attempts.should == 0
+      end
+    end
+
+    context "when we use instance interface" do
+      it "should return true and should not count attempts" do
+        el = subject.with_token('127.0.0.1', :resource)
+        el.permitted?.should == true
+        el.reload
+        el.attempts.should == 0
+      end
+    end
+  end
+
+  context "when we check if we can permit resource" do
+    context "when we use class interface" do
+      it "should return true and should count attempts" do
+        subject.permit?('127.0.0.1').should == true
+        subject.permit?('127.0.0.1', :resource).should == true
+        subject.with_token('127.0.0.1', :resource).attempts.should == 1
+      end
+    end
+
+    context "when we use instance interface" do
+      it "should return true and should count attempts" do
+        el = subject.with_token('127.0.0.1', :resource)
+        el.permit?.should == true
+        el.permit?.should == true
+        el.reload
+        el.attempts.should == 2
+      end
+    end
+  end
+
+  context "when we request smthng 2 many times" do
+    it "should ban us" do
+      10.times { subject.permit?('127.0.0.1').should == true }
+      subject.permit?('127.0.0.1').should == false
+      subject.with_token('127.0.0.1').permit?.should == false
+    end
+
+    context "but time has passed ..." do
+      it "should unban us" do
+        10.times { subject.permit?('127.0.0.1').should == true }
+        subject.permit?('127.0.0.1').should == false
+        subject.with_token('127.0.0.1').update_attributes(:last_logged => 2.hours.ago)
+        subject.permit?('127.0.0.1').should == true
+        subject.with_token('127.0.0.1').attempts.should == 1
+      end
+    end
+
+  end
+
+  context "when we make first request" do
+    it "should return us 9 remaining requests left" do
+      subject.permit?('127.0.0.1')
+      subject.with_token('127.0.0.1').remaining.should == 9
+    end
+  end
+
+  context "when we request something a lot of times" do
+    it "should not left us any remaining requests" do
+      20.times { subject.permit?('127.0.0.1') }
+      subject.with_token('127.0.0.1').remaining.should == 0
+      subject.remaining('127.0.0.1').should == 0
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'sqlite3'
+require 'active_record'
+require 'requests_counter'
+
+ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database  => ":memory:"
+)
+
+ActiveRecord::Schema.define do
+  ActiveRecord::Base.connection.create_table(:requests_counters) do |t|
+    t.column :token,              :string
+    t.column :resource,           :string
+    t.column :attempts,           :integer, :default => 0
+    t.column :available_attempts, :integer, :default => 10
+    t.column :wait_time,          :string,  :default => '1h'
+    t.column :last_logged,        :datetime
+  end
+
+  add_index :requests_counters, :resource
+  add_index :requests_counters, :token
+end
+

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: requests_counter
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Maciej Mensfeld
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MQ8wDQYDVQQDDAZtYWNp
+  ZWoxGDAWBgoJkiaJk/IsZAEZFghtZW5zZmVsZDESMBAGCgmSJomT8ixkARkWAnBs
+  MB4XDTExMDQwOTA5NDcyMloXDTEyMDQwODA5NDcyMlowPzEPMA0GA1UEAwwGbWFj
+  aWVqMRgwFgYKCZImiZPyLGQBGRYIbWVuc2ZlbGQxEjAQBgoJkiaJk/IsZAEZFgJw
+  bDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL0+nG3V4/exIeiJ0IN+
+  wVfq8Utcu4Qpo+58EIVMIu3FiK+8w6MBvatZnUrRu12pqWLw9xrUkCiYeRErD+jF
+  AmdggIM/tu9CcjvURXH7VeTzOVA+pnV+eJWMD61o8HljFVcb/nyEYYVKErtr9/O4
+  QrIGv5lnszq1PMj2sBMy2gOP1YnzawncMLmkpp/T5SU4JZ5gAktGMRVz8RxmZzF5
+  6NVqFLbuqSRSU5U//WJvZVJt8dycCGgQzBM4Vi3nkOWyjIF0BANf1TqnlU2u6s8d
+  UK1AoDZfg5feef5e8eqoomHebX1opNGM/SOQhu3LRgax4rJfnl6VS3I2wighohsf
+  AgcCAwEAAaM5MDcwCQYDVR0TBAIwADAdBgNVHQ4EFgQUGlrWBqxVieAPk7NEzBDp
+  kM+iAMMwCwYDVR0PBAQDAgSwMA0GCSqGSIb3DQEBBQUAA4IBAQAJMoyBaJs8boiz
+  lFpbw6MWjk+7ZhqoHpFrWEV4nzb5GzyHZ7GU/pa1fSEQR0SCs+LnTLQbAYNQyUTT
+  O+UsTuA7xzI//v6cSodv3Q9NbfoDlou74xv1NXorWoosQFMpVWrXv+c/1RqU3cq4
+  WUr+rRiveEXG4tXOwkrpX8KH8xVp2vQZcGw3AXPqhzfqDGzpHd6ws3lk+8HoSrSo
+  2L68tDoxraF2Z2toAg9vfFw1+mOeDk1xVIPVcBy3tJxstHfHGHlQuMiRiDQX2b2D
+  YYU8UWVt2841IwB5Dgl4O+atXhe9ZTBO0W32pl4Bq5CP9lhQRT1KL7sxfznJlF7Y
+  BH3YFsdk
+  -----END CERTIFICATE-----
+
+date: 2011-06-01 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+description: Requests Counter allows you to count attemps to get resource. You can then decide if attemp should be stopped (banned).
+email: maciej@mensfeld.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- README.md
+- lib/generators/my_requests_counter/install_generator.rb
+- lib/generators/my_requests_counter/templates/create_requests_counters_migration.rb
+- lib/generators/my_requests_counter/templates/requests_counter_init.rb
+- lib/requests_counter.rb
+files: 
+- CHANGELOG.rdoc
+- Gemfile
+- MIT-LICENSE
+- Manifest
+- README.md
+- Rakefile
+- init.rb
+- lib/generators/my_requests_counter/install_generator.rb
+- lib/generators/my_requests_counter/templates/create_requests_counters_migration.rb
+- lib/generators/my_requests_counter/templates/requests_counter_init.rb
+- lib/requests_counter.rb
+- spec/requests_counter_spec.rb
+- spec/spec_helper.rb
+- requests_counter.gemspec
+has_rdoc: true
+homepage: https://github.com/mensfeld/Requests-Counter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Requests_counter
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+requirements: []
+
+rubyforge_project: requests_counter
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Requests Counter allows you to count attemps to get resource. You can then decide if attemp should be stopped (banned).
+test_files: []
+

metadata.gz.sig

@@ -0,0 +1,4 @@
+=�(�.���x]H�g��&(��
+�.^����
W
+�M�{��F����
+���9�*�!i���;���M���(�N�����+'���]��#ip{�)|�1