throttle 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,50 @@
+# Throttle
+Uses ipfw on Mac OSX to simulate slower connection speed. 
+
+## Purpose
+Many times I've found myself needing to test applications on slower connections. However, that is never an easy task. Throttle allows you to simulate a slower connection by allowing you to specify an exact bandwidth you would like to experience.
+
+## Development
+At the moment the code is REAAAAAAL ugly and needs much improvement. There are also a lot more features I would like to add. Mostly being able to specify source and destination ip:port so you can filter which traffic will be throttled. Also the ability to have multiple filters going at once. Right now you can only have one.
+
+## Usage
+
+### Prerequisites 
+
+*  Mac OSX 10.5, 10.6, 10.7
+*  ruby 1.8.7
+*  rubygems
+
+### Installation 
+
+```
+gem install throttle
+```
+
+### Getting Started
+From the command line:
+
+#### Start throttling
+
+Limit traffic to 100 Kilobits per second
+```
+throttle limit 100Kbit/s
+```
+
+#### Current Status
+
+List all current limits in place.
+
+```
+throttle status
+```
+
+
+#### Bandwidth
+
+Bandwidth must be specified in [Kilo/Mega][bits/Bytes]/s.
+
+*  500Kbps - 500 Kilobytes per second
+*  1MBps  - 1 Megabyte per second
+
+IPFW doesn't allow bandwidth greater than 268 MBps.

data/Rakefile

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

data/bin/throttle

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'throttle'
+rescue LoadError
+  require 'rubygems'
+  require 'throttle'
+end
+
+#throttle limit 500Kbps
+#throttle limit 600Kbps
+#throttle status
+#throttle reset
+
+def error(str)
+  puts "Error: #{str}"
+end
+
+throttle = Throttle.new
+
+case ARGV[0]
+when "limit"
+  if ARGV[1]
+    throttle.limit(ARGV[1])
+    puts "Currently throttled at : #{throttle.status}"
+  else
+    error("Please provide a valid bit rate to limit.")
+  end    
+when "status"
+  puts throttle.status
+when "reset"    
+  throttle.reset
+  puts throttle.status
+else
+  puts "Throttle Help!"
+  
+  puts "\nThrottling: "
+  puts "throttle limit [bandwidth]"
+  puts "throttle limit 500KBps"
+  puts "throttle limit 12Mbps"
+  
+  puts "\nGet the current status:"
+  puts "throttle status"
+  
+  puts "\nTurn off:"
+  puts "throttle reset"  
+end  

data/lib/throttle/bandwidth.rb

@@ -0,0 +1,27 @@
+module Throttle
+  module Bandwidth
+    def parse_bandwidth(str)
+      amount = nil
+      units  = "KBp/s"
+            
+      if /(\d*)/.match(str)
+        amount = Regexp.last_match(0).to_i
+        
+        if /((K|M|k|m)(b|B)(p|P))/.match(str)
+          units  = Regexp.last_match(0)
+          units.gsub!('P', 'p')
+          units.gsub!('/s', '')
+          units += '/s'
+        end  
+        
+        # Maximum allowed MBps
+        amount = 268 if units == "MBp/s" && amount > 268
+        
+        "#{amount}#{units}"
+      else
+        nil
+      end    
+    end  
+  end  
+end
+  

data/lib/throttle/client.rb

@@ -0,0 +1,34 @@
+module Throttle
+  class Client 
+    include Bandwidth
+    
+    def status
+      pipes  = Pipe.all
+      status = ""
+      pipes.each do |p|
+        status += "#{p.bandwidth}"
+      end  
+      
+      status = "No Limits." if status.empty?
+      return status
+    end
+    
+    def reset
+      Pipe.reset
+      status
+    end    
+     
+    def limit(bandwidth)
+      Pipe.reset
+      
+      options = {
+        :id        => 1,
+        :bandwidth => parse_bandwidth(bandwidth)
+      }
+            
+      Pipe.new(options).set
+      status
+    end  
+  end  
+end
+  

data/lib/throttle/ipfw.rb

@@ -0,0 +1,15 @@
+module Throttle
+  module Ipfw
+    def ipfw(args)
+      `sudo ipfw #{args}`
+    end  
+    
+    def parse_pipe_id(str)
+      if /^\d{5} pipe (\d*) .*$/.match(str)
+        Regexp.last_match(1).to_i
+      else
+        nil
+      end    
+    end  
+  end  
+end  

data/lib/throttle/pipe.rb

@@ -0,0 +1,93 @@
+module Throttle
+  class Pipe
+    attr_accessor :id, :bandwidth, :rule_id
+
+    def self.all
+      pipes      = []
+      pipe_lines = []
+      
+      ipfw('list').split("\n").each do |line|
+        if /^\d{5} pipe.*$/.match(line)
+          pipe_lines << Regexp.last_match(0)
+        end  
+      end  
+      
+      pipe_lines.each do |line|
+        id        = parse_pipe_id(line)
+        bandwidth = Pipe.bandwidth(id)
+        
+        pipes << Pipe.new({
+          :id        => id,
+          :bandwidth => bandwidth
+        })
+      end  
+      
+      return pipes
+    end    
+
+    def self.bandwidth(id)
+      output = ipfw("pipe #{id} show")
+      
+      if /^\d{5}:\W*(\d*\.\d* \S*).*$/.match(output)
+        Regexp.last_match(1)
+      else
+        nil
+      end    
+    end  
+    
+    def self.reset
+      Pipe.all.each do |pipe|
+        pipe.delete
+      end  
+    end  
+    
+    def initialize(options = {})
+      @id        = options[:id]
+      @bandwidth = options[:bandwidth]
+    end
+    
+    def set
+      unless rule_id
+        ipfw("add pipe #{self.id} ip from any to any")
+      end
+        
+      ipfw("pipe #{id} config bw #{self.bandwidth}")
+    end  
+    
+    def bandwidth
+      @bandwidth || "Inactive"
+    end  
+    
+    def rule_id
+      @rule_id ||= set_rule_id
+    end  
+    
+    def set_rule_id
+      regex = "^(\d{5}) pipe #{self.id}.*$"
+      
+      if /^(\d{5}) pipe #{self.id}.*$/.match(ipfw("list"))
+        Regexp.last_match(1)
+      end  
+    end  
+    
+    def delete
+      delete_rule
+      
+      unless @bandwidth.nil?
+        ipfw("pipe #{@id} delete")
+      end
+    end  
+    
+    def delete_rule
+      if rule_id && rule_id != 0
+        ipfw("delete #{rule_id}")
+      end    
+    end  
+    
+    private
+        
+    include Ipfw  
+    extend  Ipfw
+  end  
+end
+  

data/lib/throttle/version.rb

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

data/lib/throttle.rb

@@ -0,0 +1,11 @@
+require 'throttle/version'
+require 'throttle/ipfw'
+require 'throttle/bandwidth'
+require 'throttle/pipe'
+require 'throttle/client'
+
+module Throttle
+  def self.new(*args)
+    Throttle::Client.new(*args)
+  end  
+end

data/throttle.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "throttle/version"
+
+Gem::Specification.new do |s|
+  s.name        = "throttle"
+  s.version     = Throttle::VERSION
+  s.authors     = ["brookemckim"]
+  s.email       = ["brooke.mckim@gmail.com"]
+  s.homepage    = "https://github.com/brookemckim/throttle"
+  s.summary     = %q{Throttle bandwidth on OS X}
+  s.description = %q{Throttle your local bandwidth with IPFW on OSX}
+
+  s.rubyforge_project = "throttle"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: throttle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- brookemckim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-09 00:00:00.000000000Z
+dependencies: []
+description: Throttle your local bandwidth with IPFW on OSX
+email:
+- brooke.mckim@gmail.com
+executables:
+- throttle
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/throttle
+- lib/throttle.rb
+- lib/throttle/bandwidth.rb
+- lib/throttle/client.rb
+- lib/throttle/ipfw.rb
+- lib/throttle/pipe.rb
+- lib/throttle/version.rb
+- throttle.gemspec
+homepage: https://github.com/brookemckim/throttle
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: throttle
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Throttle bandwidth on OS X
+test_files: []