throttle 0.0.1 → 0.0.2

data/.rbenv-version

@@ -0,0 +1 @@
+1.8.7-p352

data/README.md

@@ -12,7 +12,7 @@ At the moment the code is REAAAAAAL ugly and needs much improvement. There are a
 ### Prerequisites 
 
 *  Mac OSX 10.5, 10.6, 10.7
-*  ruby 1.8.7
+*  ruby >= 1.8.7
 *  rubygems
 
 ### Installation 
@@ -27,8 +27,9 @@ From the command line:
 #### Start throttling
 
 Limit traffic to 100 Kilobits per second
+
 ```
-throttle limit 100Kbit/s
+throttle limit 100Kbps
 ```
 
 #### Current Status
@@ -39,6 +40,12 @@ List all current limits in place.
 throttle status
 ```
 
+#### Remove all limits
+
+```
+throttle reset
+```
+
 
 #### Bandwidth
 

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.libs.push 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end

data/lib/throttle/bandwidth.rb

@@ -4,7 +4,7 @@ module Throttle
       amount = nil
       units  = "KBp/s"
             
-      if /(\d*)/.match(str)
+      if !(/(\d*)/.match(str).to_s.empty?)
         amount = Regexp.last_match(0).to_i
         
         if /((K|M|k|m)(b|B)(p|P))/.match(str)
@@ -14,14 +14,32 @@ module Throttle
           units += '/s'
         end  
         
-        # Maximum allowed MBps
-        amount = 268 if units == "MBp/s" && amount > 268
+        # Maximum allowed by ipfw
+        if over_limit?(amount, units)
+          amount = 268
+          units  = "MBp/s"
+        end  
         
         "#{amount}#{units}"
       else
         nil
       end    
     end  
+    
+    private
+    
+    def over_limit?(amount, units)
+      case units
+      when "MBp/s"
+        true if amount > 268
+      when "Mbp/s"
+        true if amount > 2144
+      when "KBp/s"
+        true if amount > 268000
+      when "Kbp/s"
+        true if amount > 2144000
+      end       
+    end  
   end  
 end
   

data/lib/throttle/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+require 'minitest/autorun'
+require 'mocha'
+
+require 'lib/throttle'

data/spec/throttle/bandwidth_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Throttle::Bandwidth do
+  before do
+    class Bandwidth
+      extend Throttle::Bandwidth
+    end  
+  end  
+  
+  it "should return nil on invalid string" do
+    Bandwidth.parse_bandwidth('notabandwidthstring').must_be_nil
+  end
+  
+  it "should return correct bandwidth on properly formed string" do
+    Bandwidth.parse_bandwidth('400 Kbps').must_equal('400Kbp/s')
+  end  
+  
+  it "should cap at 268MBp/s" do
+    Bandwidth.parse_bandwidth('10000 MBps').must_equal('268MBp/s')
+    Bandwidth.parse_bandwidth('9999999 KBps').must_equal('268MBp/s')
+  end  
+  
+  it "should properly format a messy string" do
+    Bandwidth.parse_bandwidth('5  Kbp').must_equal('5Kbp/s')
+  end  
+end

data/spec/throttle/client_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Throttle::Client do
+  before do
+    @client = Throttle::Client.new
+    @pipe   = Throttle::Pipe.new( {:id => 1, :bandwidth => '100Kbp/s'} )
+  end  
+  
+  it "should return current pipe limit" do
+    Throttle::Pipe.stubs(:all).returns( [ @pipe ] )
+    
+    @client.status.must_equal('100Kbp/s')
+  end 
+  
+  it "should return no limits if there are no pipes" do
+    Throttle::Pipe.stubs(:all).returns([])
+    
+    @client.status.must_equal('No Limits.')
+  end   
+  
+  it "should return status after reset" do
+    Throttle::Pipe.stubs(:reset).returns(nil)
+    Throttle::Pipe.stubs(:all).returns([])
+    
+    @client.status.must_equal('No Limits.')
+  end  
+  
+  it "should return status after limit" do
+    bandwidth = '100Kbps'
+    @pipe.bandwidth = bandwidth
+    
+    Throttle::Pipe.stubs(:reset).returns(nil)
+    Throttle::Pipe.any_instance.stubs(:set).returns(nil)
+    
+    Throttle::Pipe.stubs(:all).returns( [ @pipe ] )
+    
+    @client.limit(bandwidth).must_equal(bandwidth)
+  end  
+end  

data/spec/throttle/ipfw_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Throttle::Ipfw do
+  before do
+    class Ipfw
+      extend Throttle::Ipfw
+    end  
+  end  
+  
+  it "should return pipe id" do
+    Ipfw.parse_pipe_id('00200 pipe 1 ip from any to any').must_equal(1)
+  end
+  
+  it "should return nil when there is no pipe id" do
+    Ipfw.parse_pipe_id("00200 pipe ip from any to any").must_be_nil
+  end  
+end

data/spec/throttle/pipe_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Throttle::Pipe do
+  before do
+    @list_output = <<EOF
+00100 fwd 127.0.0.1,20559 tcp from any to me dst-port 80 in
+00200 pipe 1 ip from any to any
+65535 allow ip from any to any
+EOF
+
+    @show_output = <<EOF
+show_output = <<EOF
+00001:  12.000 Mbit/s    0 ms   50 sl. 1 queues (1 buckets) droptail
+    mask: 0x00 0x00000000/0x0000 -> 0x00000000/0x0000
+BKT Prot ___Source IP/port____ ____Dest. IP/port____ Tot_pkt/bytes Pkt/Byte Drp
+  0 tcp   199.47.217.146/80           10.0.1.2/59964 7938  4287713  0    0  66
+EOF
+  
+    @pipe = Throttle::Pipe.new({:id => 100, :bandwidth => '12Mbp/s'})
+  end
+  
+  it "should return pipe" do
+    Throttle::Pipe.expects(:ipfw).with('list').returns(@list_output)
+    Throttle::Pipe.expects(:ipfw).with('pipe 1 show').returns(@show_output)
+    
+    pipe = Throttle::Pipe.all[0]
+    
+    pipe.id.must_equal(1)
+    pipe.bandwidth.must_equal("12.000 Mbit/s")
+  end
+  
+  it "should return correct bandwidth" do
+    Throttle::Pipe.expects(:ipfw).with('pipe 1 show').returns(@show_output)
+    
+    Throttle::Pipe.bandwidth(1).must_equal("12.000 Mbit/s")
+  end
+  
+  it "should return nil for unknown pipe" do
+    Throttle::Pipe.expects(:ipfw).with('pipe 2 show').returns("ipfw: getsockopt(IP_DUMMYNET_GET): No buffer space available")
+    
+    Throttle::Pipe.bandwidth(2).must_be_nil
+  end     
+end  

data/spec/throttle_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Throttle do
+  before do
+    @throttle = Throttle.new
+  end  
+  
+  it "should instansiate a Client class" do
+    @throttle.must_be_kind_of(Throttle::Client)
+  end
+end

data/throttle.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "mocha"
 end

metadata

@@ -1,25 +1,77 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: throttle
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
-authors:
+authors: 
 - brookemckim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-09 00:00:00.000000000Z
-dependencies: []
+
+date: 2011-11-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Throttle your local bandwidth with IPFW on OSX
-email:
+email: 
 - brooke.mckim@gmail.com
-executables:
+executables: 
 - throttle
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- .rbenv-version
 - Gemfile
 - README.md
 - Rakefile
@@ -30,29 +82,51 @@ files:
 - lib/throttle/ipfw.rb
 - lib/throttle/pipe.rb
 - lib/throttle/version.rb
+- spec/spec_helper.rb
+- spec/throttle/bandwidth_spec.rb
+- spec/throttle/client_spec.rb
+- spec/throttle/ipfw_spec.rb
+- spec/throttle/pipe_spec.rb
+- spec/throttle_spec.rb
 - throttle.gemspec
+has_rdoc: true
 homepage: https://github.com/brookemckim/throttle
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: throttle
-rubygems_version: 1.8.10
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Throttle bandwidth on OS X
-test_files: []
+test_files: 
+- spec/spec_helper.rb
+- spec/throttle/bandwidth_spec.rb
+- spec/throttle/client_spec.rb
+- spec/throttle/ipfw_spec.rb
+- spec/throttle/pipe_spec.rb
+- spec/throttle_spec.rb