slowweb 0.1.0

data/README.md

@@ -0,0 +1,47 @@
+Slow Web - An HTTP Request Governor
+===================================
+
+## DESCRIPTION
+
+Slow Web is a way to limit the number of requests to a domain within a certain
+period of time.
+
+For example, the GitHub API only allows for 60 requests per minute. Slow Web can
+monitor the number of calls to that domain and will sleep on the next request
+that is over the limit.
+
+Slow Web follows the rules of [Semantic Versioning](http://semver.org/).
+
+
+## RUNNING
+
+To install Slow Web, simply install the gem:
+
+	$ [sudo] gem install slowweb
+
+And specify the domain to limit.
+
+	require 'slowweb'
+	SlowWeb.limit('github.com', 10, 60)
+
+This restricts the `github.com` domain to only allowing `10` requests every
+`60` seconds (or one minute).
+
+
+## CONTRIBUTE
+
+If you'd like to contribute to SlowWeb, start by forking the repository
+on GitHub:
+
+http://github.com/benbjohnson/slowweb
+
+Then follow these steps to send your changes:
+
+1. Clone down your fork
+1. Create a topic branch to contain your change
+1. Code
+1. All code must have MiniTest::Unit test coverage.
+1. If you are adding new functionality, document it in the README
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send me a pull request for your branch

data/lib/slow_web.rb

@@ -0,0 +1,58 @@
+require 'slow_web/version'
+require 'slow_web/limit'
+require 'slow_web/ext/net_http'
+
+class SlowWeb
+  ##############################################################################
+  # Static Initialization
+  ##############################################################################
+  
+  # A look up of limits by host.
+  @limits = {}
+  
+  
+  ##############################################################################
+  # Static Methods
+  ##############################################################################
+
+  # Limits the number of requests that can occur within a specified number of
+  # seconds.
+  #
+  # @param [String] host  the host to restrict.
+  # @param [Fixnum] count  the number of requests that can occur within a time period.
+  # @param [Fixnum] period  the number of seconds in the time period.
+  #
+  # @return [SlowWeb::Limit] the limit object.
+  def self.limit(host, count, period)
+    raise "Limit already exists for this host: #{host}" if @limits[host]
+    
+    limit = Limit.new(host, count, period)
+    @limits[host] = limit
+    return limit
+  end
+
+  # Retrieves the limit object for a given host.
+  #
+  # @param [String] host  the host associated with the limit.
+  #
+  # @return [SlowWeb::Limit] the limit object.
+  def self.get_limit(host)
+    return @limits[host]
+  end
+
+  # A flag stating if the limit for a given host has been exceeded.
+  #
+  # @param [String] host  the host that is being limited.
+  #
+  # @return [Boolean] a flag stating if the limit has been exceeded.
+  def self.limit_exceeded?(host)
+    limit = @limits[host]
+    return !limit.nil? && limit.exceeded?
+  end
+
+
+  # Removes all limits.
+  def self.reset
+    @limits = {}
+  end
+end

data/lib/slow_web/ext/net_http.rb

@@ -0,0 +1,25 @@
+require 'net/http'
+require 'net/https'
+
+module Net
+  class HTTP
+    def request_with_slowweb(request, body = nil, &block)
+      host = self.address
+      limit = SlowWeb.get_limit(host)
+      
+      # Wait until the request limit is no longer exceeded
+      while limit.exceeded?
+        sleep 1
+      end
+      
+      # Add request to limiter
+      limit.add_request(request)
+      
+      # Continue with the original request
+      request_without_slowweb(request, body, &block)
+    end
+
+    alias_method :request_without_slowweb, :request
+    alias_method :request, :request_with_slowweb
+  end
+end

data/lib/slow_web/limit.rb

@@ -0,0 +1,75 @@
+require 'slow_web/version'
+
+class SlowWeb
+  class Limit
+    ############################################################################
+    # Constructor
+    ############################################################################
+
+    # @param [String] host  the host to restrict.
+    # @param [Fixnum] count  the number of requests that can occur within a time
+    #                        period.
+    # @param [Fixnum] period  the number of seconds in the time period.
+    def initialize(host, count, period)
+      @host   = host
+      @count  = count
+      @period = period
+
+      @requests = []
+    end
+  
+
+    ############################################################################
+    # Public Attributes
+    ############################################################################
+
+    # The host to restrict.
+    attr_accessor :host
+
+    # The number of requests that are allowed within the time period.
+    attr_accessor :count
+
+    # The number of seconds in the time period.
+    attr_accessor :period
+
+    # The number of requests that have occurred within the current period.
+    def current_request_count
+      normalize_requests()
+      return @requests.length
+    end
+
+    # A flag stating if the number of requests within the period has been met.
+    def exceeded?
+      return current_request_count >= count
+    end
+
+
+    ############################################################################
+    # Public Methods
+    ############################################################################
+    
+    # Adds a request that is associated with this limit
+    #
+    # @param [Net::HTTPRequest] request  the request associated with this limit.
+    def add_request(request)
+      @requests << {:obj => request, :time => Time.now}
+      normalize_requests()
+      nil
+    end
+
+
+    ############################################################################
+    # Private Methods
+    ############################################################################
+    
+    private
+    
+    # Removes all items in the request list that are outside of the current 
+    # period.
+    def normalize_requests
+      @requests = @requests.find_all do |request|
+        (Time.now-request[:time]) < period
+      end
+    end
+  end
+end

data/lib/slow_web/version.rb

@@ -0,0 +1,3 @@
+class SlowWeb
+  VERSION = '0.1.0'
+end

data/lib/slowweb.rb

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

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: slowweb
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+description: 
+email: 
+- benbjohnson@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/slow_web/ext/net_http.rb
+- lib/slow_web/limit.rb
+- lib/slow_web/version.rb
+- lib/slow_web.rb
+- lib/slowweb.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/benbjohnson/slowweb
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: An HTTP Request Governor
+test_files: []
+