velocity_check 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjYyMTMzOGUxOTQ2MzU5MWVhYTE3NTUxNDczMmRlNDBmNDRkMzFhNw==
+  data.tar.gz: !binary |-
+    YjMwNTM0NGMwYzY0OGEwMjZlMTdlYjhlYTkzZTU5MDlhMzYyMmRlNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NGQ5YWYzYmRjYTdiYWJkYTdjMDcyM2E5YWM1MzQyOTVhMjQzNjMyOGU0Nzk5
+    YzQxNmYzZTQzZWIzMWQ4YTEwZDc2OWM1YmE5ODZjMTFkYjExMzJlN2Y3NDQ1
+    ZmUyNzU4NDQ3OGMzNDI3NWY5ODU4MzVlZWYzZGFjODdhYjhmNDg=
+  data.tar.gz: !binary |-
+    ZjY5MzMwMzBhMjE4NDU3ZDMwYWZhMzRlZGMxYzBkMWJkMTE3MjAyYjZhY2Q0
+    MGE0OGMwZTRhOTY2ZTNiNjYyNGU5YjQ1NDdhZWJjZjNlNWJiZWY1MGJjZmE3
+    MDA2MjhjMDRhOTUwY2U4NzM5NWQ0N2FjMmMyZTA4NGI3Mzg5NmE=

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-head
+  - ree

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.0.1
+=======
+
+Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Fairley
+
+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,43 @@
+# VelocityCheck
+
+Lets you know if something is happening too often.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'velocity_check'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install velocity_check
+
+## Usage
+
+```ruby
+SNEEZE_CHECK = VelocityCheck.new(:name => "sneeze", :limit => 10, :time_period => 600, :client => DALLI_CLIENT)
+
+class Person
+  def initialize(name)
+    @name = name
+  end
+
+  def sneeze!
+    if SNEEZE_CHECK.check(@name)
+      puts "#{@name} has sneezed too much recently"
+    end
+  end
+end
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/velocity_check.rb

@@ -0,0 +1,34 @@
+require "velocity_check/version"
+
+class VelocityCheck
+  def initialize(options)
+    raise ArgumentError, ":name is required" unless options[:name]
+    raise ArgumentError, ":name must only contain letters, numbers, and underscore" unless options[:name] =~ /\A\w+\z/
+    raise ArgumentError, ":limit is required" unless options[:limit]
+    raise ArgumentError, ":time_period is required" unless options[:time_period]
+    raise ArgumentError, ":client is required" unless options[:client]
+
+    known_options = [:name, :limit, :time_period, :client]
+    unknown_options = options.keys - known_options
+    raise ArgumentError, "Unknown options: #{unknown_options.map(&:to_s).sort.join(', ')}"  unless unknown_options.empty?
+
+    @name = options[:name]
+    @client = options[:client]
+    @time_period = options[:time_period]
+    @limit = options[:limit]
+  end
+
+  def check(key)
+    full_key = "#{@name}_#{key}"
+
+    # It would nice if we could incr + touch, but touch is buggy
+    # in most versions of memcached (and doesn't even exist in
+    # debian squeeze's version).
+    previous = @client.get(full_key) || 0
+    @client.set(full_key, previous + 1, @time_period)
+
+    previous >= @limit
+  rescue Dalli::RingError
+    false
+  end
+end

data/lib/velocity_check/version.rb

@@ -0,0 +1,3 @@
+class VelocityCheck
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'dalli'
+
+require 'velocity_check'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/velocity_check_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe VelocityCheck do
+  before(:all) do
+    Dalli.logger.level = Logger::FATAL
+  end
+
+  let(:client) { Dalli::Client.new("127.0.0.1:#{ENV.fetch('BOXEN_MEMCACHED_PORT', 11211)}") }
+  before(:each) { client.flush }
+
+  let(:options) do
+    {
+      :name => rand(10**10).to_s,
+      :limit => 10,
+      :time_period => 2,
+      :client => client,
+    }
+  end
+
+  describe '.new' do
+    it "constructs with the default options" do
+      VelocityCheck.new(options)
+    end
+
+    it "requires a name" do
+      expect do
+        VelocityCheck.new(options.merge(:name => nil))
+      end.to raise_error(ArgumentError, /:name is required/)
+    end
+
+    it "requires the name only have contain word characters" do
+      expect do
+        VelocityCheck.new(options.merge(:name => "hello!"))
+      end.to raise_error(ArgumentError, /name/)
+      expect do
+        VelocityCheck.new(options.merge(:name => "hello"))
+      end.to_not raise_error
+    end
+
+    it "requires a limit" do
+      expect do
+        VelocityCheck.new(options.merge(:limit => nil))
+      end.to raise_error(ArgumentError, ":limit is required")
+    end
+
+    it "requires a time_period" do
+      expect do
+        VelocityCheck.new(options.merge(:time_period => nil))
+      end.to raise_error(ArgumentError, ":time_period is required")
+    end
+
+    it "requires a client" do
+      expect do
+        VelocityCheck.new(options.merge(:client => nil))
+      end.to raise_error(ArgumentError, ":client is required")
+    end
+
+    it "does not allow extra parameters" do
+      expect do
+        VelocityCheck.new(options.merge(:extra => "hello", :more => "junk"))
+      end.to raise_error(ArgumentError, "Unknown options: extra, more")
+    end
+  end
+
+  describe "#check" do
+    subject(:checker) do
+      VelocityCheck.new(options)
+    end
+
+    it "returns false until the limit has been passed" do
+      10.times do
+        checker.check("test").should be_false
+      end
+    end
+
+    it "returns true after the limit has been passed" do
+      10.times { checker.check("test") }
+      checker.check("test").should be_true
+    end
+
+    it "returns false again after time_period has passed without a check" do
+      10.times { checker.check("test") }
+      checker.check("test").should be_true
+
+      sleep 2
+
+      checker.check("test").should be_false
+    end
+
+    it "returns true as long as a check happens within every time_limit after the threshold has been bassed" do
+      10.times { checker.check("test") }
+      10.times do
+        checker.check("test").should be_true
+        sleep 1
+      end
+    end
+
+    it "returns false if time_period passes before the threshold check" do
+      10.times { checker.check("test") }
+
+      sleep 2
+
+      checker.check("test").should be_false
+    end
+
+    it "isolates across the key passed in" do
+      10.times { checker.check("test") }
+      checker.check("test2").should be_false
+      checker.check("test").should be_true
+    end
+
+    it "isolates across the name of the VelocityCheck" do
+      checker2 = VelocityCheck.new(options.merge(:name => "Check2"))
+
+      10.times { checker.check("test") }
+      checker2.check("test").should be_false
+      checker.check("test").should be_true
+    end
+
+    it "fails open if there's an error talking to memcached" do
+      checker = VelocityCheck.new(options.merge(:client => Dalli::Client.new('127.0.0.1:5315')))
+
+      100.times { checker.check("test").should be_false }
+    end
+  end
+end

data/velocity_check.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'velocity_check/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "velocity_check"
+  gem.version       = VelocityCheck::VERSION
+  gem.authors       = ["Michael Fairley"]
+  gem.email         = ["michael.fairley@getbraintree.com"]
+  gem.description   = %q{Velocity checking}
+  gem.summary       = %q{Lets you know if something is happening too often}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "dalli", ">= 2"
+
+  gem.add_development_dependency "rspec", "~> 2.14"
+  gem.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: velocity_check
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Fairley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Velocity checking
+email:
+- michael.fairley@getbraintree.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/velocity_check.rb
+- lib/velocity_check/version.rb
+- spec/spec_helper.rb
+- spec/velocity_check_spec.rb
+- velocity_check.gemspec
+homepage: ''
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Lets you know if something is happening too often
+test_files:
+- spec/spec_helper.rb
+- spec/velocity_check_spec.rb
+has_rdoc: