ralphttp 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d344444821e96147867cfe55109abb3fe969b735
+  data.tar.gz: e9efdef028dc48d5516293bb7ac5668f6a13ce31
+SHA512:
+  metadata.gz: 0d0dc864c04f77651e56e2328166ea5823afda718a9e4803c67448a25b7513f4919b57614cc8229b5f803c47c3055a2f183b9623be5c1d5dfe866c78bb0d64ad
+  data.tar.gz: 0ff831ae9bfb8b914ae6ae02151c33dbdc7975595271ab834b64b55579aef09ad889cbe45f2019ac535b36c11c95417ae754afd96f60b4717f8f2eb5d6e7a60f

data/.gitignore

@@ -0,0 +1,18 @@
+*.swp
+*.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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Antun Krasic
+
+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,29 @@
+# Ralphttp
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ralphttp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ralphttp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/ralphttp

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+#$LOAD_PATH << File.join(File.dirname(__FILE__), '../lib')
+$:.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+
+require 'ralphttp'
+
+Ralphttp::Starter.new.start

data/lib/ralphttp.rb

@@ -0,0 +1,9 @@
+require 'net/http'
+require 'optparse'
+require 'uri'
+
+require 'ralphttp/version'
+require 'ralphttp/csvexport'
+require 'ralphttp/starter'
+require 'ralphttp/fixit'
+require 'ralphttp/wreckit'

data/lib/ralphttp/csvexport.rb

@@ -0,0 +1,74 @@
+module Ralphttp
+  class CsvExport
+    attr_accessor :header
+    attr_accessor :data
+
+    # Public - Start the class and pass the header fields along with the data
+    #
+    # header - Array holding the header field values
+    #
+    # Example:
+    #   csv = Ralphttp::CsvExport( %w(Time Latency Response) )
+    # Returns nil
+    def initialize(header = nil)
+      @data = []
+      add_header(header)
+    end
+
+    # Public - Print out the CSV data
+    #
+    # Example:
+    #   csv = Ralphttp::CsvExport.new
+    #   csv.add_header(%w(Title Name Location)
+    #   csv.add_row(%(CEO Khan Nebula))
+    #   csv.print
+    #   # => Title,Name,Location
+    #   # => CEO,Khan,Nebula
+    #
+    # Returns String list in CSV format
+    def print
+      @data.unshift(@header)
+
+      @data.each do |d|
+        puts d
+      end
+    end
+
+    # Public - Write the parsed data to a specified file
+    #
+    # file - String File location
+    #
+    # Example:
+    #   csv.write('/tmp/file.csv')
+    #
+    # Returns nil
+    def write(file)
+      @data.unshift(@header)
+      storage = File.open(file, 'w')
+
+      @data.each do |d|
+        storage.write("#{d}\n")
+      end
+      storage.close
+    end
+    #
+    # Public - Add header description for the CSV fields
+    #
+    # header - Array of field data
+    #
+    # Retuns nil
+    def add_header(header)
+      @header =  header.join(',') if header.kind_of?(Array)
+    end
+
+    # Public - Add a row to the data Array
+    #
+    # row - Array holding field values
+    #
+    # Returns nil
+    def add_row(row)
+      @data << row.join(',')  if row.kind_of?(Array)
+    end
+
+  end
+end

data/lib/ralphttp/fixit.rb

@@ -0,0 +1,131 @@
+module Ralphttp
+  # Public: Format data for a reasonable output
+  class Fixit
+    attr_accessor :detailed
+    attr_accessor :csv
+    attr_accessor :csvexport
+    attr_accessor :bucket
+    attr_accessor :total_time
+    attr_accessor :status
+    attr_accessor :error
+    attr_accessor :req
+
+    # Public: Start the class based on selected options
+    #
+    # options - Hash containing settings
+    #
+    # Returns nil
+    def initialize(options)
+      @status = {}
+      @error = []
+      @detailed = options[:detail]
+
+      unless options[:csv].nil?
+        @csv = options[:csv]
+        assign_csv_report
+      end
+    end
+
+    # Public: Analyze collected data and show reasonable output
+    #
+    # Return Text output
+    def analyze
+      if @error.empty?
+        display_results
+      else
+        puts 'Errors encountered when connecting:'
+        @error.each do |e|
+          puts e
+        end
+      end
+    end
+
+    # Public - Displays the results of the parsed data
+    #
+    # Returns nil
+    def display_results
+      print_header
+      print_detailed_report
+      write_csv_report
+      display_status
+    end
+
+    # Public: Output the header information
+    #
+    # Returns nil
+    def print_header
+      unless @detailed.nil?
+        puts sprintf('%-30s %-10s %-10s', 'Time', 'Req/s', 'Avg resp (ms)')
+      end
+    end
+
+    private
+
+    # Private - Print the status banner
+    #
+    # Returns nil
+    def display_status
+      reqs_per_sec = sprintf('%.2f',
+                             (@req.inject(:+).to_f / @req.length.to_f))
+
+      puts "\nRequests per second: #{reqs_per_sec}"
+      @status.map do |status_code, status_count|
+        puts "HTTP Status #{status_code}: #{status_count}"
+      end
+      puts "Total time: #{@total_time} s"
+    end
+
+    #
+    # Private - Assign Ralphttp::CsvExport class if report is asked for
+    #
+    # Returns nil
+    def assign_csv_report
+      unless @csv.nil?
+        csv_header = ['Time', 'Req/s', 'Avg. resp. (ms)']
+        @csvexport = Ralphttp::CsvExport.new(csv_header)
+      end
+    end
+
+    # Private - Write down the CSV report
+    #
+    # Returns nil
+    def write_csv_report
+      unless @csv.nil?
+        @csvexport.write(@csv)
+      end
+    end
+
+    # Private - Prints out a detailed report, if asked for
+    #
+    # Returns Array containing summarized data
+    def print_detailed_report
+      @req = []
+      @bucket.map do |time, data|
+        reqs = data.length
+        @req << reqs
+        date = Time.at(time)
+        ms = calc_response(data)
+
+        @csvexport.add_row([date, reqs, ms]) unless @csv.nil?
+
+        puts sprintf('%-30s %-10s %-20s',
+                     date, reqs, ms) unless @detailed.nil?
+      end
+    end
+
+    # Private: Calculate average response time in ms
+    #
+    # resp - Array
+    #
+    # Returns Float of average ms
+    def calc_response(resp)
+      r = []
+
+      resp.each do |re|
+        r << re[1]
+      end
+      sprintf('%.2f', (r.inject(:+).to_f / r.length.to_f))
+    end
+
+  end # EOC
+end

data/lib/ralphttp/starter.rb

@@ -0,0 +1,94 @@
+module Ralphttp
+  #
+  # Loading class
+  class Starter
+    PROTOCOLS = %w(http https)
+    attr_accessor :params
+
+    # Public - Initialize the start with new
+    def start
+      options = arguments
+
+      if options[:url].nil? || options[:concurrent].nil? ||
+        options[:requests].nil?
+        puts @params
+        exit
+      end
+
+      wreckit = Ralphttp::Wreckit.new(options)
+      wreckit.blast
+      wreckit.analyze
+    end
+
+    # Public - Parse arguments for the script
+    #
+    # Returns Hash of arguments
+    def arguments
+      options = {}
+
+      begin
+        params = OptionParser.new do |opts|
+          opts.banner = 'Usage: ralphttp [OPTIONS]'
+
+          opts.on('-c', '--concurrent NUM',
+                  'Number of concurrent connections')do |concurrent|
+            options[:concurrent] = concurrent
+          end
+
+          opts.on('-n', '--requests NUM',
+                  'Total number of requests to use') do |reqs|
+            options[:requests] = reqs
+          end
+
+          opts.on('-u', '--url URL', 'URL of the page to benchmark') do |url|
+            options[:url] = url
+          end
+
+          opts.on('-a', '--user-agent STRING', 'User Agent to use') do |ua|
+            options[:useragent] = ua
+          end
+
+          opts.on('-d', '--detail', 'Show detailed report') do |d|
+            options[:detail] = d
+          end
+
+          opts.on('-s', '--csv FILE', 'Output CSV data into file') do |c|
+            options[:csv] = c
+          end
+
+          opts.on('-h', '--help', 'Show help') do
+            puts opts
+            exit
+          end
+        end
+        params.parse!
+        options[:url] = url_parse(options[:url]) unless options[:url].nil?
+        @params = params
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+       puts params
+       exit
+      end # End begin
+
+      options
+    end
+
+    private
+
+    # Private - Checks and corrects the entered URL to proper syntax
+    #
+    # Returns String Parsed URL
+    def url_parse(url)
+      begin
+        uri = URI.parse(url)
+
+        uri = URI.parse("http://#{url}") if uri.class == URI::Generic
+        uri.path = '/' unless uri.path.match(/^\//)
+
+        uri if PROTOCOLS.include?(uri.scheme)
+      rescue URI::InvalidURIError
+        puts "Bad URL: #{url}"
+      end
+
+    end
+  end # EOC
+end # EOM

data/lib/ralphttp/version.rb

@@ -0,0 +1,3 @@
+module Ralphttp
+  VERSION = "0.0.2"
+end

data/lib/ralphttp/wreckit.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+# rubocop:disable MethodLength
+
+module Ralphttp
+
+  # Public;  Get benchmarking information for a HTTP server
+  class Wreckit < Ralphttp::Fixit
+  attr_accessor :domain
+  attr_accessor :hammer
+  attr_accessor :ua
+
+  # Public: Start the class and assign the domain anem to start
+  #
+  # options - Hash containing URL and number of concurrent/total connections
+  #
+  # Example:
+  #     options = { url: 'http://domain.tld',
+  #                 concurrent: 10,
+  #                 total: 100
+  #                 }
+  #     pwong = Ralphttp::Wreckit.new(options)
+  #
+  # Returns Nil
+  def initialize(options)
+    super(options)
+    @domain = options[:url]
+    @ua = options[:useragent]
+    @hammer = { :concurrent =>  options[:concurrent],
+                :total => options[:requests] }
+    @bucket = {}
+  end
+
+  # Public: Worker method, builds threads for querying the server
+  #
+  # Returns nil
+  def blast
+    arr = []
+    start = Time.now
+    num_loops = calculate_loops
+
+    (1..num_loops.to_i).each do |f|
+      Thread.abort_on_exception = false
+      (1..@hammer[:concurrent].to_i).each do |s|
+        arr[s] = Thread.new do
+          start_http
+        end
+      end
+
+      arr.shift
+      arr.each do |t|
+        t.join
+      end
+    end
+    @total_time = sprintf('%.2f', (Time.now - start))
+    @bucket.keys.sort
+  end
+
+    private
+
+  # Private: Calculate number of loops based on total number of connections
+  # opposed to the total number of concurrent connections
+  #
+  def calculate_loops
+    @hammer[:total].to_i / @hammer[:concurrent].to_i
+  end
+
+  # Private: Opens the domain for testing and gathers the performance info
+  #
+  # Returns Hash with response code and time in ms
+  def start_http
+    begin
+      Net::HTTP.start(@domain.host, @domain.port) do |http|
+        start_request = Time.now
+        request = Net::HTTP::Get.new(@domain.request_uri)
+        request.add_field('User-Agent', return_user_agent)
+        end_request = sprintf('%.4f', ((Time.now - start_request) * (10**6)))
+
+        response = http.request request
+        http_status_counter(response.code)
+        apply_processed_data([response.code, end_request])
+      end
+    rescue Errno::ECONNREFUSED
+      @error << 'Connection refused'
+    rescue Errno::ETIMEDOUT
+      @error << 'Can not connect to the provided URL'
+    rescue Net::ReadTimeout
+      @error << 'ReadTimeout'
+    rescue SocketError
+      @error << 'Non resolvable domain!'
+    end
+  end
+
+  # Private - Set the User Agent string for the Net::HTTP module
+  #
+  # Returns String User Agent
+  def return_user_agent
+    if @ua.nil?
+      user_agent = { 'User-Agent' => 'Ralphttp-Wreck' }
+    else
+      user_agent = { 'User-Agent' => @ua }
+    end
+  end
+
+  # Private - Fill @bucket with statistical data, the response code received
+  # and the time that took to complete the HTTP request.
+  #
+  # droplet - Array holding the HTTP reponse code and HTTP request duration
+  #
+  # Returns nil
+  def apply_processed_data(droplet)
+      unless @bucket[Time.now.to_i].kind_of?(Array)
+        @bucket[Time.now.to_i] = []
+      end
+      @bucket[Time.now.to_i] << droplet
+  end
+
+  # Private: Get number of HTTP status codes and their count
+  #
+  # code - Integer status code
+  #
+  # Returns nil
+  def http_status_counter(code)
+    if @status[code].nil?
+      @status[code] = 0
+    end
+
+    @status[code] = (@status[code].to_i + 1)
+  end
+  end
+end

data/ralphttp.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ralphttp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ralphttp"
+  spec.version       = Ralphttp::VERSION
+  spec.authors       = ["Antun Krasic"]
+  spec.email         = ["antun@martuna.co"]
+  spec.description   = %q{HTTP performance testing tool}
+  spec.summary       = %q{Test the HTTP performance}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ralphttp
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Antun Krasic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HTTP performance testing tool
+email:
+- antun@martuna.co
+executables:
+- ralphttp
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ralphttp
+- lib/ralphttp.rb
+- lib/ralphttp/csvexport.rb
+- lib/ralphttp/fixit.rb
+- lib/ralphttp/starter.rb
+- lib/ralphttp/version.rb
+- lib/ralphttp/wreckit.rb
+- ralphttp.gemspec
+homepage: ''
+licenses:
+- MIT
+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.7
+signing_key: 
+specification_version: 4
+summary: Test the HTTP performance
+test_files: []