limited 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9760e85bf1a3b2c89385bdcbd8076ff30e0cbd4
+  data.tar.gz: f1bec62f986e779c66f70a01c06e6e8136de4861
+SHA512:
+  metadata.gz: 7c0936a592fd48b030c5bbaac2851fc058c0ba8e4242de3efe0a710704f37e28c7a8dfe86384800095834e9c425eee87453e43972176ca59508b527d719a79ce
+  data.tar.gz: 1e39cf4620ba29bd06a3bf471fb43e52ccfd5592ba2016028b47fbdd2dd6bb6f17c3d4936abcf2edd0d9c8e783a09f97e2dda37a83ab2eb21cead18dd9cc8a27

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in limited.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Moritz Küttel
+
+MIT License
+
+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/README.md

@@ -0,0 +1,60 @@
+# Limited
+
+Some utility functions to help you limit some actions in your applications
+(like logins, contact forms, posting of comments, etc.) to stop spammers
+to absue your services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'limited'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install limited
+
+## Usage
+
+You need to define your actions somewhere in your application like this:
+
+    Limited.configure do
+      action :name_of_action, 1337
+      action :login, 20
+      action :sending_contact_email, 123
+    end
+
+The second parameter given to action defines how many times the action
+can be executed.
+
+After defining an Action you can directly call a method on the `Limited`
+module to access your Action like this:
+
+    Limited.name_of_action 
+    Limited.login
+    Limited.sending_contact_email
+
+Here are a few commonly used methods which every Action provides:
+
+<table>
+  <tr>
+    <td>`executed`</td>
+    <td>Call this method everytime the specified action is being executed</td>
+  </tr>
+  <tr>
+    <td>`limit_reached`</td>
+    <td>Wheter the limit has been reached or not</td>
+  </tr>
+</table>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/limited/action.rb

@@ -0,0 +1,55 @@
+module Limited
+
+  # This class represents an action which
+  # can be executed a limited amount of
+  # times
+  class Action
+    # a symbol for the name of the action
+    attr_reader :name
+    # the amount of times the action can be executed
+    attr_reader :limit
+    # the amount of times the action already has been executed
+    attr_reader :num_executed
+
+    ##
+    # :call-seq:
+    #   Limited::Action.new(name, limit) -> Limited::Action
+    #
+    # constructor for an action
+    #
+    # === Example
+    #
+    #   Limited::Action.new :do_stuff, 1000
+    def initialize(name, limit)
+      raise ArgumentError.new("Limited::Action::name needs to be a Symbol") unless name.is_a?(Symbol)
+      raise ArgumentError.new("Limited::Action::limit needs to be an Integer") unless limit.is_a?(Integer)
+      raise ArgumentError.new("Limited::Action::limit needs to be positive") if limit < 0
+
+      @name = name
+      @limit = limit
+      @num_executed = 0
+    end
+
+    ##
+    # returns how many times the action can be executed
+    # until the given limit is reached
+    def num_left
+      @limit - @num_executed
+    end
+
+    ##
+    # should be called everytime
+    # the action gets executed
+    # so the internal counter is always up-to-date
+    def executed
+      @num_executed += 1
+    end
+
+    ##
+    # wheter the limit of executions
+    # has been exceeded
+    def limit_reached
+      @limit <= @num_executed
+    end
+  end
+end

data/lib/limited/config.rb

@@ -0,0 +1,35 @@
+module Limited
+
+  # defines all the functions which
+  # can be used to configure
+  # this gem
+  module Config
+
+    ##
+    # adds a new limited action to the list of actions
+    # takes the same paramerers as Limited::Action.new
+    #
+    # raises an ArgumentError if the same name
+    # for an action is not unique
+    def self.action(name, limit)
+      action = Limited::Action.new(name, limit)
+      raise ArgumentError.new("action with name :#{name.to_s} has already been added") if Limited.actions.has_key?(name)
+      Limited.actions[name] = action
+    end
+  end
+
+  ##
+  # executes a block inside Limited::Config
+  # so you can easily access the methods in it
+  # and configure the Limited gem
+  #
+  # === Example
+  #
+  #   Limited.configure do
+  #     action :sending_contact_email, 50
+  #     action :failed_login, 1337
+  #   end
+  def self.configure(&block)
+    Config.instance_eval &block
+  end
+end

data/lib/limited/version.rb

@@ -0,0 +1,3 @@
+module Limited
+  VERSION = "0.0.1"
+end

data/lib/limited.rb

@@ -0,0 +1,42 @@
+require "limited/version"
+require "limited/action"
+
+module Limited
+  # a hash containing all the 
+  # limited actions
+  # the name of the Action is used as key
+  @actions = {}
+
+  ##
+  # returns a hash containing all the 
+  # limited actions
+  def self.actions
+    @actions
+  end
+
+
+  ##
+  # :call-seq:
+  #   Limited.<action_name> -> Limited::Action
+  #
+  # adds the possibility to access
+  # every action directly via Limited.<actionanem>
+  #
+  # === Example
+  #
+  #   Limited.configure do
+  #     action :some_action, 123
+  #   end
+  #
+  #   Limited.some_action.executed
+  #   Limited.some_action.num_left # -> 122
+  def self.method_missing(method_id, *arguments)
+    if @actions.has_key?(method_id)
+      @actions[method_id]
+    else
+      super
+    end
+  end
+end
+
+require "limited/config"

data/limited.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'limited/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "limited"
+  spec.version       = Limited::VERSION
+  spec.authors       = ["Moritz Küttel"]
+  spec.email         = ["moritz.kuettel@gmail.com"]
+  spec.description   = %q{helps you limiting certain actions to prevent spam/dos}
+  spec.summary       = %q{
+    Some utility functions to help you limit some actions in your applications
+    (like logins, contact forms, posting of comments, etc.) to stop spammers
+    to absue your services.}
+
+  spec.homepage      = "https://github.com/mkuettel/limited"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "debugger"
+end

data/spec/limited_action_spec.rb

@@ -0,0 +1,75 @@
+require 'limited'
+require 'limited/action'
+
+describe Limited::Action do
+  before { @action = Limited::Action.new :do_some_stuff, 1337 }
+  subject { @action }
+
+  it { should respond_to(:name) }
+  it { should respond_to(:limit) }
+  it { should respond_to(:num_executed) }
+  it { should respond_to(:num_left) }
+
+  describe "constructor" do
+    it "should take a name" do
+      name = Limited::Action.new(:do_stuff, 15).name
+      name.should eq :do_stuff
+    end
+
+    it "should take a limit" do
+      limit = Limited::Action.new(:do_stuff, 15).limit
+      limit.should eq 15
+    end
+  end
+
+  describe "name" do
+    it "should be a symbol" do
+      expect do
+        Limited::Action.new "string", 123
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "limit" do
+    it "should be an integer" do
+      expect do
+        Limited::Action.new :asdasd, nil
+      end.to raise_error(ArgumentError)
+    end
+
+    it "should be positive" do
+      expect do
+        Limited::Action.new :asdasd, -1
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "num_executed" do
+    it "should be initialized to 0" do
+      @action.num_executed.should eq 0
+    end
+  end
+
+  describe "executed" do
+    before { @action.executed }
+    it "should increase the num_executed counter" do
+      @action.num_executed.should eq 1
+    end
+  end
+
+  describe "limit_reached" do
+    it "should not be reached when intialized" do
+      @action.limit_reached.should be_false
+    end
+    it "should be true when 'executed' has been called 'limit' times" do
+      @action.executed
+      @action.limit_reached.should be_false
+      1335.times { @action.executed }
+      @action.limit_reached.should be_false
+      @action.executed
+      @action.limit_reached.should be_true
+      @action.executed
+      @action.limit_reached.should be_true
+    end
+  end
+end

data/spec/limited_config_spec.rb

@@ -0,0 +1,30 @@
+require 'limited'
+require 'limited/config'
+
+describe Limited::Config do
+  it { Limited.should respond_to(:configure) }
+  it { Limited::Config.should respond_to(:action) }
+
+  it "should add an Limited::Action to Limited::actions when calling Limited::Config::action" do
+    expect do
+      Limited::Config.action :new, 123
+    end.to change(Limited, :actions)
+  end
+
+  it "should not be possible to add an action with the same name twice" do
+    expect do
+      Limited::Config.action :same_name, 123
+      Limited::Config.action :same_name, 123
+    end.to raise_error(ArgumentError)
+  end
+
+  describe "configure" do
+    it "should be possible to add actions via the Limited::configure method" do
+      expect do
+        Limited.configure do
+          action :some_action, 123
+        end
+      end.to change(Limited, :actions)
+    end
+  end
+end

data/spec/limited_spec.rb

@@ -0,0 +1,14 @@
+Limited.configure do
+  action :missing_method_test, 13
+end
+
+describe Limited do
+  it { Limited.should respond_to(:actions) }
+
+  describe "missing_method calls" do
+    it "should give access to the action object when calling method with its name" do
+      action = Limited.actions[:missing_method_test]
+      Limited.missing_method_test.should eq action
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: limited
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Moritz Küttel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: helps you limiting certain actions to prevent spam/dos
+email:
+- moritz.kuettel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/limited.rb
+- lib/limited/action.rb
+- lib/limited/config.rb
+- lib/limited/version.rb
+- limited.gemspec
+- spec/limited_action_spec.rb
+- spec/limited_config_spec.rb
+- spec/limited_spec.rb
+homepage: https://github.com/mkuettel/limited
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: Some utility functions to help you limit some actions in your applications
+  (like logins, contact forms, posting of comments, etc.) to stop spammers to absue
+  your services.
+test_files:
+- spec/limited_action_spec.rb
+- spec/limited_config_spec.rb
+- spec/limited_spec.rb