httperfrb 0.0.1 → 0.0.2

data/HISTORY.md

@@ -1,6 +1,10 @@
 HTTPerf.rb
 ==========
 
+### 0.0.2
+
+* fix a few critical bugs with params - 0.0.1 is bad
+
 ### 0.0.1
 
 * Initial release.

data/lib/httperf.rb

@@ -1,12 +1,55 @@
+# @author Joshua Mervine <joshua@mervine.net>
 class HTTPerf
-  VERSION = "0.0.1"
+  # gem version
+  VERSION = "0.0.2"
 
+  # availbe instance methods
   @options, @command = nil
 
   # initialize with (optional):
-  # - options: see 'man httperf'
+  # - options: see below for options
+  #   - see 'man httfperf' for details
   # - path: path to httperf
   #   - e.g. /usr/bin/httperf
+  #
+  # available options:
+  #   -  add-header
+  #   -  burst-length
+  #   -  client
+  #   -  close-with-reset
+  #   -  debug
+  #   -  failure-status
+  #   -  hog
+  #   -  http-version
+  #   -  max-connections
+  #   -  max-piped-calls
+  #   -  method
+  #   -  no-host-hdr
+  #   -  num-calls
+  #   -  num-conns
+  #   -  period
+  #   -  port
+  #   -  print-reply
+  #   -  print-request
+  #   -  rate
+  #   -  recv-buffer
+  #   -  retry-on-failure
+  #   -  send-buffer
+  #   -  server
+  #   -  server-name
+  #   -  session-cookies
+  #   -  ssl
+  #   -  ssl-ciphers
+  #   -  ssl-no-reuse
+  #   -  think-timeout
+  #   -  timeout
+  #   -  uri
+  #   -  verbose
+  #   -  version
+  #   -  wlog
+  #   -  wsess
+  #   -  wsesslog
+  #   -  wset
   def initialize options={}, path=nil
     options.each_key do |k|
       raise "#{k} is an invalid httperf param" unless params.keys.include?(k)
@@ -39,6 +82,7 @@ class HTTPerf
   end
 
   private
+  # build commandline options string
   def options
     opts = ""
     @options.each do |key,val|
@@ -47,6 +91,7 @@ class HTTPerf
     opts
   end
 
+  # define httperf available options
   def params
     {
       "add-header" => nil,
@@ -63,10 +108,10 @@ class HTTPerf
       "no-host-hdr" => nil,
       "num-calls" => nil,
       "num-conns" => nil,
-      "period [d|u|e" => nil,
+      "period" => nil,
       "port" => nil,
-      "print-reply [header|body" => nil,
-      "print-request [header|body" => nil,
+      "print-reply" => nil,
+      "print-request" => nil,
       "rate" => nil,
       "recv-buffer" => nil,
       "retry-on-failure" => nil,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httperfrb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16582700 !ruby/object:Gem::Requirement
+  requirement: &13560160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16582700
+  version_requirements: *13560160
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &16581880 !ruby/object:Gem::Requirement
+  requirement: &13559120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16581880
+  version_requirements: *13559120
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &16580940 !ruby/object:Gem::Requirement
+  requirement: &13558220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16580940
+  version_requirements: *13558220
 description: Simple interface for calling httperf via ruby.
 email:
 - joshua@mervine.net
@@ -69,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1274722979085222874
+      hash: -759597460562503080
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: