kronk 1.4.0 → 1.5.0

data/lib/kronk/cmd.rb

@@ -6,7 +6,7 @@ class Kronk
   class Cmd
 
     ##
-    # Start an IRB console with the given http response object.
+    # Start an IRB console with the given Kronk::Response object.
 
     def self.irb resp
       require 'irb'
@@ -18,11 +18,11 @@ class Kronk
                     resp.body
                   end
 
-      puts "\nHTTP Response is in $http_response"
-      puts "Response data is in $response\n\n"
+      $stdout.puts "\nHTTP Response is in $http_response"
+      $stdout.puts "Response data is in $response\n\n"
 
       IRB.start
-      exit 1
+      false
     end
 
 
@@ -47,21 +47,6 @@ class Kronk
     end
 
 
-    ##
-    # Moves the old config file to the new directory structure.
-
-    def self.move_config_file
-      require 'fileutils'
-
-      kronk_tmp_config = ".kronk.tmp"
-      File.rename Kronk::CONFIG_DIR, kronk_tmp_config
-
-      Dir.mkdir Kronk::CONFIG_DIR
-
-      FileUtils.mv kronk_tmp_config, Kronk::DEFAULT_CONFIG_FILE
-    end
-
-
     ##
     # Parse ARGV
 
@@ -69,6 +54,7 @@ class Kronk
       options = {
         :auth         => {},
         :no_body      => false,
+        :player       => {},
         :proxy        => {},
         :uris         => [],
         :with_headers => false
@@ -115,8 +101,10 @@ Parse and run diffs against data from live and cached http responses.
 
 
         opt.on('--completion', 'Print bash completion file path and exit') do
-          file = File.join(File.dirname(__FILE__), "../script/kronk_completion")
-          puts File.expand_path(file)
+          file = File.join(File.dirname(__FILE__),
+                    "../../script/kronk_completion")
+
+          $stdout.puts File.expand_path(file)
           exit 2
         end
 
@@ -138,7 +126,7 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('-i', '--include [header1,header2]', Array,
+        opt.on('-i', '--include [HEADER1,HEADER2]', Array,
                'Include all or given headers in response') do |value|
           options[:with_headers] ||= []
 
@@ -148,10 +136,12 @@ Parse and run diffs against data from live and cached http responses.
           else
             options[:with_headers] = true
           end
+
+          options[:no_body] = false
         end
 
 
-        opt.on('-I', '--head [header1,header2]', Array,
+        opt.on('-I', '--head [HEADER1,HEADER2]', Array,
                'Use all or given headers only in the response') do |value|
           options[:with_headers] ||= []
 
@@ -187,7 +177,7 @@ Parse and run diffs against data from live and cached http responses.
 
 
         opt.on('-P', '--parser STR', String,
-               'Override default parser') do |value|
+               'Override default response body parser') do |value|
           options[:parser] = value
         end
 
@@ -202,13 +192,18 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('-r', '--require lib1,lib2', Array,
+        opt.on('-r', '--require LIB1,LIB2', Array,
                'Require a library or gem') do |value|
           options[:requires] ||= []
           options[:requires].concat value
         end
 
 
+        opt.on('--ruby', 'Use legacy Ruby renderer') do
+          Kronk.config[:render_lang] = 'ruby'
+        end
+
+
         opt.on('--struct', 'Run diff on the data structure') do
           options[:struct] = true
         end
@@ -219,6 +214,51 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.separator <<-STR
+
+  Player Options:
+        STR
+
+        opt.on('-c', '--concurrency NUM', Integer,
+               'Number of concurrent requests to make; default: 1') do |num|
+          options[:player][:concurrency] = num
+        end
+
+
+        opt.on('-n', '--number NUM', Integer,
+               'Total number of requests to make') do |num|
+          options[:player][:number] = num
+        end
+
+
+        opt.on('-o', '--replay-out [FORMAT]',
+               'Output format used by --replay; default: stream') do |output|
+          options[:player][:output] = output || :stream
+        end
+
+
+        opt.on('-p', '--replay [FILE]',
+                'Replay the given file or STDIN against URIs') do |file|
+          options[:player][:io]   = File.open(file, "r") if file
+          options[:player][:io] ||= $stdin if !$stdin.tty?
+          options[:player][:output] ||= :suite
+        end
+
+
+        opt.on('--benchmark [FILE]', 'Same as -p [FILE] -o benchmark') do |file|
+          options[:player][:io]   = File.open(file, "r") if file
+          options[:player][:io] ||= $stdin if !$stdin.tty?
+          options[:player][:output] = :benchmark
+        end
+
+
+        opt.on('--stream [FILE]', 'Same as -p [FILE] -o stream') do |file|
+          options[:player][:io]   = File.open(file, "r") if file
+          options[:player][:io] ||= $stdin if !$stdin.tty?
+          options[:player][:output] = :stream
+        end
+
+
         opt.separator <<-STR
 
   HTTP Options:
@@ -240,8 +280,8 @@ Parse and run diffs against data from live and cached http responses.
                'Header to pass to the server request') do |value|
           options[:headers] ||= {}
 
-          key, value = value.split ": ", 2
-          options[:headers][key] = value.strip
+          key, value = value.split /:\s*/, 2
+          options[:headers][key] = value.to_s.strip
         end
 
 
@@ -274,7 +314,7 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('--timeout INT', Integer,
+        opt.on('-t', '--timeout INT', Integer,
                'Timeout for http connection in seconds') do |value|
           Kronk.config[:timeout] = value
         end
@@ -314,7 +354,14 @@ Parse and run diffs against data from live and cached http responses.
 
       opts.parse! argv
 
-      unless $stdin.tty?
+      unless options[:player].empty?
+        options[:player] = Player.new options[:player]
+      else
+        options.delete :player
+      end
+
+      if !$stdin.tty? && !(options[:player] && options[:player].input.io)
+        io = $stdin
         io = StringIO.new $stdin.read
         options[:uris] << io
       end
@@ -322,22 +369,22 @@ Parse and run diffs against data from live and cached http responses.
       options[:uris].concat argv
       options[:uris].slice!(2..-1)
 
-      if options[:uris].empty? && File.file?(Kronk.config[:cache_file])
+      if options[:uris].empty? && File.file?(Kronk.config[:cache_file]) &&
+       options[:player].nil?
         verbose "No URI specified - using kronk cache"
         options[:uris] << Kronk.config[:cache_file]
       end
 
       argv.clear
 
-      raise OptionParser::MissingArgument, "You must enter at least one URI" if
-        options[:uris].empty?
+      raise "You must enter at least one URI" if options[:uris].empty?
 
       options
 
     rescue => e
-      $stderr << "\nError: #{e.message}\n"
-      $stderr << "See 'kronk --help' for usage\n\n"
-      exit 1
+      error e.message, e.backtrace
+      $stderr.puts "See 'kronk --help' for usage\n\n"
+      exit 2
     end
 
 
@@ -354,15 +401,6 @@ Parse and run diffs against data from live and cached http responses.
       data_paths.each do |path|
         if path[0,1] == "-"
           (options[:ignore_data] ||= []) << path[1..-1]
-
-        elsif path[0,2] == ":-"
-          warn "The :path notation is deprecated, use path/.."
-          (options[:ignore_data_with] ||= []) << path[2..-1]
-
-        elsif path[0,1] == ":"
-          warn "The :path notation is deprecated, use path/.."
-          (options[:only_data_with] ||= []) << path[1..-1]
-
         else
           (options[:only_data] ||= []) << path
         end
@@ -395,17 +433,9 @@ Parse and run diffs against data from live and cached http responses.
 
       rescue Errno::ENOENT
         make_config_file
-
-        $stderr << "\nNo config file was found.\n"
-        $stderr << "Created default config in #{DEFAULT_CONFIG_FILE}\n"
-        $stderr << "Edit file if necessary and try again.\n"
-        exit 2
-
-      rescue Errno::ENOTDIR
-        move_config_file
-
-        $stderr << "\nOld config file was moved to #{DEFAULT_CONFIG_FILE}\n"
-        $stderr << "Edit file if necessary and try again.\n"
+        error "No config file was found.\n" +
+              "Created default config in #{DEFAULT_CONFIG_FILE}\n" +
+              "Edit file if necessary and try again.\n"
         exit 2
       end
 
@@ -413,7 +443,7 @@ Parse and run diffs against data from live and cached http responses.
 
       Kronk.load_cookie_jar
 
-      load_requires options[:requires]
+      load_requires options.delete(:requires)
 
       at_exit do
         Kronk.save_cookie_jar
@@ -424,32 +454,115 @@ Parse and run diffs against data from live and cached http responses.
         exit 2
       end
 
+      uri1, uri2 = options.delete :uris
+      runner     = options.delete(:player) || self
+
+      success =
+        if uri1 && uri2
+          runner.compare uri1, uri2, options
+        else
+          runner.request uri1, options
+        end
+
+      exit 1 unless success
+
+    rescue Kronk::Exception, Response::MissingParser, Errno::ECONNRESET => e
+      error e.message, e.backtrace
+      exit 2
+    end
+
+
+    ##
+    # Performs a Kronk compare and renders it to $stdout.
+
+    def self.compare uri1, uri2, options={}
+      kronk = Kronk.new options
+      kronk.compare uri1, uri2
+      render kronk, options
+    end
+
+
+    ##
+    # Performs a single Kronk request and renders it to $stdout.
+
+    def self.request uri, options={}
+      kronk = Kronk.new options
+      kronk.retrieve uri
+      render kronk, options
+    end
+
+
+    ##
+    # Renders the results of a Kronk compare or retrieve
+    # to $stdout.
+
+    def self.render kronk, options={}
+      cache_response kronk.response
+
+      if options[:irb]
+        irb kronk.response
+
+      elsif kronk.diff
+        render_diff kronk.diff
+
+      elsif kronk.response
+        render_response kronk.response, kronk.options
+      end
+    end
+
+
+    ##
+    # Renders a Diff instance to $stdout
 
-      options[:cache_response] =
-        Kronk.config[:cache_file] if Kronk.config[:cache_file]
+    def self.render_diff diff
+      $stdout.puts diff.formatted unless Kronk.config[:brief]
 
-      uri1, uri2 = options.delete :uris
+      if Kronk.config[:verbose] || Kronk.config[:brief]
+        $stdout.puts "Found #{diff.count} diff(s)."
+      end
 
-      if uri1 && uri2
-        diff = Kronk.compare uri1, uri2, options
+      diff.count == 0
+    end
 
-        puts "#{diff.formatted}\n" unless Kronk.config[:brief]
 
-        if Kronk.config[:verbose] || Kronk.config[:brief]
-          $stdout << "Found #{diff.count} diff(s).\n"
-        end
+    ##
+    # Output a Kronk::Response instance. Returns true if response code
+    # is in the 200 range.
 
-        exit 1 if diff.count > 0
+    def self.render_response response, options={}
+      str = response.stringify options
+      str = Diff.insert_line_nums str if Kronk.config[:show_lines]
+      $stdout.puts str
 
-      else
-        out = Kronk.retrieve_data_string uri1, options
-        out = Diff.insert_line_nums out if Kronk.config[:show_lines]
-        puts out
+      verbose "\nResp. Time: #{response.time.to_f}"
+
+      response.success?
+    end
+
+
+    ##
+    # Saves the raw http response to a cache file.
+
+    def self.cache_response resp, filepath=nil
+      filepath ||= Kronk.config[:cache_file]
+      return unless filepath
+
+      begin
+        File.open(filepath, "wb+") do |file|
+          file.write resp.raw
+        end
+      rescue => e
+        error "#{e.class}: #{e.message}"
       end
+    end
 
-    rescue Request::Exception, Response::MissingParser, Errno::ECONNRESET => e
-      $stderr << "\nError: #{e.message}\n"
-      exit 2
+
+    ##
+    # Print and error string
+
+    def self.error str, more=nil
+      $stderr.puts "\nError: #{str}"
+      $stderr.puts more if Kronk.config[:verbose] && more
     end
 
 
@@ -473,7 +586,8 @@ Parse and run diffs against data from live and cached http responses.
     # Returns true if kronk is running on ruby for windows.
 
     def self.windows?
-      !!(RUBY_PLATFORM.downcase =~ /mswin|mingw|cygwin/)
+      $RUBY_PLATFORM ||= RUBY_PLATFORM
+      !!($RUBY_PLATFORM.downcase =~ /mswin|mingw|cygwin/)
     end
   end
 end

data/lib/kronk/constants.rb

@@ -0,0 +1,90 @@
+class Kronk
+
+  # Generic Request exception.
+  class Exception < ::Exception; end
+
+  # Raised when the URI was not resolvable.
+  class NotFoundError < Exception; end
+
+  # Raised when HTTP times out.
+  class TimeoutError < Exception; end
+
+  # Raised when a missing (but non-mandatory) dependency can't be loaded.
+  class MissingDependency < Exception; end
+
+
+  # Config directory.
+  CONFIG_DIR = File.expand_path "~/.kronk"
+
+  # Default config file to load. Defaults to ~/.kronk.
+  DEFAULT_CONFIG_FILE = File.join CONFIG_DIR, "rc"
+
+  # Default cache file.
+  DEFAULT_CACHE_FILE = File.join CONFIG_DIR, "cache"
+
+  # Default cookies file.
+  DEFAULT_COOKIES_FILE = File.join CONFIG_DIR, "cookies"
+
+  # Default file with history of unique URIs. (Used for autocomplete)
+  DEFAULT_HISTORY_FILE = File.join CONFIG_DIR, "history"
+
+
+  # Default Content-Type header to parser mapping.
+  DEFAULT_CONTENT_TYPES = {
+    'js'      => 'JSON',
+    'json'    => 'JSON',
+    'plist'   => 'PlistParser',
+    'xml'     => 'XMLParser'
+  }
+
+
+  # Recursive Hash merge proc.
+  DEEP_MERGE =
+    proc do |key,v1,v2|
+      Hash === v1 && Hash === v2 ? v1.merge(v2,&DEEP_MERGE) : v2
+    end
+
+
+  # Aliases for various user-agents. Thanks Mechanize! :)
+  USER_AGENTS = {
+    'kronk'         =>
+    "Kronk/#{VERSION} (http://github.com/yaksnrainbows/kronk)",
+    'iphone'        =>
+    "Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1C28 Safari/419.3",
+    'linux_firefox' =>
+    "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.1) Gecko/20100122 firefox/3.6.1",
+    'linux_mozilla' =>
+    "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.4) Gecko/20030624",
+    'mac_mozilla'   =>
+    "Mozilla/5.0 (Macintosh; U; PPC Mac OS X Mach-O; en-US; rv:1.4a) Gecko/20030401",
+    'linux_konqueror' =>
+    "Mozilla/5.0 (compatible; Konqueror/3; Linux)",
+    'mac_firefox'   =>
+    "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2) Gecko/20100115 Firefox/3.6",
+    'mac_safari'    =>
+    "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_2; de-at) AppleWebKit/531.21.8 (KHTML, like Gecko) Version/4.0.4 Safari/531.21.10",
+    'win_ie6'       =>
+    "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)",
+    'win_ie7'       =>
+    "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)",
+    'win_mozilla'   =>
+    "Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.4b) Gecko/20030516 Mozilla Firebird/0.6"
+  }
+
+
+  # Default config to use.
+  DEFAULT_CONFIG = {
+    :content_types  => DEFAULT_CONTENT_TYPES.dup,
+    :cache_file     => DEFAULT_CACHE_FILE,
+    :cookies_file   => DEFAULT_COOKIES_FILE,
+    :default_host   => "http://localhost:3000",
+    :diff_format    => :ascii_diff,
+    :history_file   => DEFAULT_HISTORY_FILE,
+    :indentation    => 1,
+    :requires       => [],
+    :show_lines     => false,
+    :uri_options    => {},
+    :use_cookies    => true,
+    :user_agents    => USER_AGENTS.dup
+  }
+end