limited 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9760e85bf1a3b2c89385bdcbd8076ff30e0cbd4
-  data.tar.gz: f1bec62f986e779c66f70a01c06e6e8136de4861
+  metadata.gz: e0c628b05e6dd3db011e8ae8aa7299da4ab0664a
+  data.tar.gz: c5185402f1a9f258c641276f36e640994b17c10e
 SHA512:
-  metadata.gz: 7c0936a592fd48b030c5bbaac2851fc058c0ba8e4242de3efe0a710704f37e28c7a8dfe86384800095834e9c425eee87453e43972176ca59508b527d719a79ce
-  data.tar.gz: 1e39cf4620ba29bd06a3bf471fb43e52ccfd5592ba2016028b47fbdd2dd6bb6f17c3d4936abcf2edd0d9c8e783a09f97e2dda37a83ab2eb21cead18dd9cc8a27
+  metadata.gz: 8a5dce139e3e678c083855773ac616ee638124fdce8d07dfa3c00ba1f5c2b634adfaefa43e36ca99f646f83d24addea085a1095a08904c6449cc2eeca6dbc2b4
+  data.tar.gz: bdcee5091e679f9cdd3f12bb05f9bd3df953d8f929b0921405091b8538e35921cf897eb720473a36492d2e1fe1321e1c0e32c67016e9fcf63a7b692078339851

data/README.md

@@ -23,9 +23,14 @@ Or install it yourself as:
 You need to define your actions somewhere in your application like this:
 
     Limited.configure do
+      # this action should only be 1337 times at most 
       action :name_of_action, 1337
-      action :login, 20
-      action :sending_contact_email, 123
+
+      # only 1 login all 10 seconds
+      action :login, 1, 10
+
+      # at maximum 123 contact emails a day
+      action :sending_contact_email, 123, :day
     end
 
 The second parameter given to action defines how many times the action
@@ -42,11 +47,11 @@ Here are a few commonly used methods which every Action provides:
 
 <table>
   <tr>
-    <td>`executed`</td>
+    <td>executed</td>
     <td>Call this method everytime the specified action is being executed</td>
   </tr>
   <tr>
-    <td>`limit_reached`</td>
+    <td>limit_reached</td>
     <td>Wheter the limit has been reached or not</td>
   </tr>
 </table>

data/lib/limited/action.rb

@@ -8,8 +8,6 @@ module Limited
     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:
@@ -20,7 +18,7 @@ module Limited
     # === Example
     #
     #   Limited::Action.new :do_stuff, 1000
-    def initialize(name, limit)
+    def initialize(name, limit, interval = nil)
       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
@@ -28,12 +26,30 @@ module Limited
       @name = name
       @limit = limit
       @num_executed = 0
+      @interval = Interval.new(interval.nil? ? :endless : interval)
+      check_new_interval
+    end
+
+    ##
+    # returns the interval for which the limit counts
+    def interval
+      check_new_interval
+      @interval
+    end
+
+    ##
+    # returns the amount of times the action already
+    # has been executed
+    def num_executed
+      check_new_interval
+      @num_executed
     end
 
     ##
     # returns how many times the action can be executed
     # until the given limit is reached
     def num_left
+      check_new_interval
       @limit - @num_executed
     end
 
@@ -42,6 +58,7 @@ module Limited
     # the action gets executed
     # so the internal counter is always up-to-date
     def executed
+      check_new_interval
       @num_executed += 1
     end
 
@@ -49,7 +66,22 @@ module Limited
     # wheter the limit of executions
     # has been exceeded
     def limit_reached
+      check_new_interval
       @limit <= @num_executed
     end
+
+    private
+
+    ##
+    # checks if the interval
+    # passes and resets the number
+    # of executions so
+    # the limit can be reached again
+    def check_new_interval
+      if @interval.passed?
+        @interval.reset_start
+        @num_executed = 0
+      end
+    end
   end
 end

data/lib/limited/config.rb

@@ -11,8 +11,8 @@ module Limited
     #
     # raises an ArgumentError if the same name
     # for an action is not unique
-    def self.action(name, limit)
-      action = Limited::Action.new(name, limit)
+    def self.action(name, limit, interval_length = nil)
+      action = Limited::Action.new(name, limit, interval_length)
       raise ArgumentError.new("action with name :#{name.to_s} has already been added") if Limited.actions.has_key?(name)
       Limited.actions[name] = action
     end

data/lib/limited/interval.rb

@@ -0,0 +1,60 @@
+module Limited
+  ##
+  # This represents a timespan within a limit counts
+  # after this timespan ends the limit
+  # should be reset
+  class Interval
+    # the length of the interval in seconds
+    attr_reader :length
+    # a timestamp when the last interval started
+    attr_reader :last_start
+    
+    # common lengths of the intervals
+    # and shortcuts for them
+    @@interval_lengths = {
+       second: 1,
+       minute: 60,
+         hour: 60 * 60,
+          day: 60 * 60 * 24,
+      endless: 1.0/0.0
+    }
+
+    ##
+    # initializes an interval
+    # by either supplying the length of the
+    # interval in seconds as an Numeric
+    # or by supplying one of the symbols
+    # :second, :minute, :hour or :day
+    def initialize(length)
+      is_sym = length.is_a?(Symbol) and @@interval_lengths.has_key?(length)
+      raise ArgumentError.new("Limited::Interval.length needs to be a Numeric or one of the symbols :second, :minute, :hour or :day") unless length.is_a?(Numeric) or is_sym
+      @length = is_sym ? @@interval_lengths[length] : length
+      reset_start
+    end
+
+    ##
+    # start a new interval and 
+    # reset the last_start variable
+    def reset_start
+      now = Time.now
+      @last_start = (now.to_f / @length).to_i * @length
+      @last_start = 0 if @last_start.is_a?(Float) and @last_start.nan?
+    end
+
+    ##
+    # calculate the amount of seconds remaining
+    # in seconds for the interval to end
+    #
+    # when the interval ended 0 is returned so
+    # this method never returns negative numbers
+    def time_left
+      [0, (last_start.to_f + length - Time.now.to_f)].max
+    end
+
+    ##
+    # wheter the interval has finished
+    def passed?
+      time_left == 0
+    end
+  end
+end

data/lib/limited/version.rb

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

data/lib/limited.rb

@@ -1,5 +1,6 @@
 require "limited/version"
 require "limited/action"
+require "limited/interval"
 
 module Limited
   # a hash containing all the 

data/spec/limited_action_spec.rb

@@ -1,3 +1,5 @@
+require 'spec_helper'
+
 require 'limited'
 require 'limited/action'
 
@@ -7,6 +9,7 @@ describe Limited::Action do
 
   it { should respond_to(:name) }
   it { should respond_to(:limit) }
+  it { should respond_to(:interval) }
   it { should respond_to(:num_executed) }
   it { should respond_to(:num_left) }
 
@@ -72,4 +75,26 @@ describe Limited::Action do
       @action.limit_reached.should be_true
     end
   end
+
+  describe "with an ending interval" do
+    before { @interval_action = Limited::Action.new :ending_interval, 5, :minute }
+    it "should be able to reach the limit before the interval ends" do
+      @interval_action.limit_reached.should be_false
+      @interval_action.executed
+      @interval_action.limit_reached.should be_false
+    end
+
+    describe "after the limit has been reached" do
+      before { 5.times { @interval_action.executed } }
+      it { @interval_action.limit_reached.should be_true }
+
+      describe "after the interval passed" do
+        before { Time.testing_offset += @interval_action.interval.time_left }
+        it "should reset num_executed" do
+          @interval_action.num_executed.should be 0
+          @interval_action.limit_reached.should be_false
+        end
+      end
+    end
+  end
 end

data/spec/limited_config_spec.rb

@@ -7,10 +7,32 @@ describe Limited::Config do
 
   it "should add an Limited::Action to Limited::actions when calling Limited::Config::action" do
     expect do
-      Limited::Config.action :new, 123
+      Limited::Config.action :new, 123, :day
     end.to change(Limited, :actions)
   end
 
+  describe "the Action objects in the Limited::actions array" do
+    before(:all) do
+      Limited::Config.action :value_check, 123, :day
+      Limited::Config.action :value_check1, 3
+    end
+
+    it "should have the correct name" do
+      Limited.actions[:value_check].name.should eq :value_check
+      Limited.actions[:value_check1].name.should eq :value_check1
+    end
+
+    it "should have the correct limit" do
+      Limited.actions[:value_check].limit.should eq 123
+      Limited.actions[:value_check1].limit.should eq 3
+    end
+
+    it "should have the correct interval" do
+      Limited.actions[:value_check].interval.length.should eq 24 * 60 * 60
+      Limited.actions[:value_check1].interval.length.should eq 1.0/0.0
+    end
+  end
+
   it "should not be possible to add an action with the same name twice" do
     expect do
       Limited::Config.action :same_name, 123

data/spec/limited_interval_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'limited'
+
+describe Limited::Interval do
+  let(:infinity) { 1.0/0.0 }
+  let(:endless) { Limited::Interval.new(:endless) }
+
+  subject { Limited::Interval.new 234 }
+
+  it { should respond_to(:length) }
+  it { should respond_to(:last_start) }
+  it { should respond_to(:time_left) }
+  it { should respond_to(:reset_start) }
+  it { should respond_to(:passed?) }
+
+
+  describe "length" do
+     it "should be set by the constructor" do
+       i = Limited::Interval.new(123)
+       i.length.should eq 123
+     end
+
+     describe "can also be set via symbols :second, :minute, :hour, :day" do
+       it { Limited::Interval.new(:second ).length.should eq            1 }
+       it { Limited::Interval.new(:minute ).length.should eq           60 }
+       it { Limited::Interval.new(:hour   ).length.should eq      60 * 60 }
+       it { Limited::Interval.new(:day    ).length.should eq 60 * 60 * 24 }
+       it {                         endless.length.should eq     infinity }
+     end
+
+     it "should raise error when no integer or symbol given" do
+       expect { Limited::Interval.new(nil) }.to raise_error(ArgumentError)
+     end
+  end
+
+  describe "time_left" do
+    it "should return a value equal or lower than length" do
+      Limited::Interval.new(541).time_left.should be <= 541
+    end
+
+    it "should be infinite if interval has the length Infinify" do
+      endless.time_left.should eq infinity
+    end
+  end
+
+  describe "reset_start" do
+    it "should be calculated to a time near Time.now which difference is shorter than length" do
+      c = Limited::Interval.new(100)
+      (Time.now.to_f - c.last_start.to_f).should be <= 100
+    end
+
+    it "should set last_start to 0 when interval is endless" do
+      endless.last_start.should eq 0
+    end
+  end
+
+  describe "passed" do
+    let(:i) { Limited::Interval.new(541) }
+    it "should return false if length seconds have not yet passed" do
+      i.passed?.should be_false
+      Time.testing_offset += i.time_left - 1
+      i.passed?.should be_false
+    end
+
+    it "should return true when enough time passed" do
+      Time.testing_offset += i.time_left
+      i.time_left.should eq 0
+      i.passed?.should be_true
+    end
+
+    it "should always return false when interval is endless" do
+      endless.passed?.should be_false
+      Time.testing_offset += i.time_left
+      endless.passed?.should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+class Time #:nodoc:
+  class <<self
+    attr_accessor :testing_offset
+    alias_method :real_now, :now
+    def now
+      real_now + testing_offset
+    end
+    alias_method :new, :now
+  end
+end
+
+Time.testing_offset = 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limited
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Moritz Küttel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,11 +81,14 @@ files:
 - lib/limited.rb
 - lib/limited/action.rb
 - lib/limited/config.rb
+- lib/limited/interval.rb
 - lib/limited/version.rb
 - limited.gemspec
 - spec/limited_action_spec.rb
 - spec/limited_config_spec.rb
+- spec/limited_interval_spec.rb
 - spec/limited_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mkuettel/limited
 licenses:
 - MIT
@@ -115,4 +118,6 @@ summary: Some utility functions to help you limit some actions in your applicati
 test_files:
 - spec/limited_action_spec.rb
 - spec/limited_config_spec.rb
+- spec/limited_interval_spec.rb
 - spec/limited_spec.rb
+- spec/spec_helper.rb