kronk 1.8.0 → 1.8.1

data/History.rdoc

@@ -1,4 +1,18 @@
-=== 1.8.0 / 2011-12
+=== 1.8.1 / 2012-02-07
+
+* Enhancements:
+
+  * Support max number of history items.
+
+  * Support --form option to set form-encoded content type.
+
+  * Support file uploads.
+
+* Bugfixes:
+
+  * Don't override Cookies set via the -H option.
+
+=== 1.8.0 / 2012-01-05
 
 * Major Enhancements:
 

data/TODO.rdoc

@@ -16,6 +16,12 @@
 
 == Done
 
+* Support --form option and set Content-Type to application/x-www-form-urlencoded
+
+* Support file/IO uploads
+
+* Only record a limited number of history items.
+
 * GNU-Plot support.
 
 * Parsed cookie diffing.

data/bin/kronk

@@ -2,5 +2,5 @@
 
 $: << File.join(File.dirname(__FILE__), "../lib") if $0 == "bin/kronk"
 
-require 'kronk'
+require 'kronk/cmd'
 Kronk::Cmd.run

data/lib/kronk.rb

@@ -1,21 +1,18 @@
-require 'rubygems'
+require 'rubygems' if RUBY_VERSION =~ /1.8/
 
 require 'json'
 require 'cookiejar'
 
 require 'thread'
 require 'stringio'
-require 'base64'
 
-require 'net/https'
-require 'zlib'
-require 'optparse'
+require 'net/http'
 require 'yaml'
 
 class Kronk
 
   # This gem's version.
-  VERSION = '1.8.0'
+  VERSION = '1.8.1'
 
   require 'kronk/constants'
   require 'kronk/queue_runner'
@@ -26,7 +23,6 @@ class Kronk
   require 'kronk/player/tsv'
   require 'kronk/player/request_parser'
   require 'kronk/player/input_reader'
-  require 'kronk/cmd'
   require 'kronk/path'
   require 'kronk/path/match'
   require 'kronk/path/matcher'
@@ -225,7 +221,7 @@ class Kronk
   # Writes the URL history to the history file.
 
   def self.save_history
-    history_str = self.history.uniq.join($/)
+    history_str = self.history.uniq[0..self.config[:max_history]].join($/)
 
     File.open self.config[:history_file], "w" do |file|
       file.write history_str
@@ -342,7 +338,10 @@ class Kronk
       req = Request.new uri, options
       Cmd.verbose "Retrieving URL:  #{req.uri}\n"
       resp = req.retrieve options
-      Kronk.history << uri
+
+      hist_uri = req.uri.to_s[0..-req.uri.request_uri.length]
+      hist_uri = hist_uri[(req.uri.scheme.length + 3)..-1]
+      Kronk.history << hist_uri
     end
 
     resp.parser         = options[:parser] if options[:parser]

data/lib/kronk/cmd.rb

@@ -1,3 +1,6 @@
+require 'kronk'
+require 'optparse'
+
 class Kronk
 
   ##
@@ -185,6 +188,12 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('-h', '--help', 'Print this help screen') do
+          puts opt
+          exit
+        end
+
+
         opt.on('-i', '--include [HEADER1,HEADER2]', Array,
                'Include all or given headers in response') do |value|
           options[:show_headers] ||= []
@@ -283,6 +292,12 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('-v', '--version', 'Output Kronk version and exit') do
+          puts Kronk::VERSION
+          exit
+        end
+
+
         opt.separator <<-STR
 
   Player Options:
@@ -363,6 +378,12 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('-F', '--form STR', String,
+               'Set request body with form headers; overrides -d') do |value|
+          options[:form] = value
+        end
+
+
         opt.on('-H', '--header STR', String,
                'Header to pass to the server request') do |value|
           options[:headers] ||= {}
@@ -372,12 +393,6 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('-A', '--user-agent STR', String,
-               'User-Agent to send to server or a valid alias') do |value|
-          options[:user_agent] = value
-        end
-
-
         opt.on('-L', '--location [NUM]', Integer,
                'Follow the location header always or num times') do |value|
           options[:follow_redirects] = value || true
@@ -396,12 +411,27 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
+        opt.on('-U', '--proxy-user STR', String,
+               'Set proxy user and/or password: usr[:pass]') do |value|
+          options[:proxy][:username], options[:proxy][:password] =
+            value.split ":", 2
+
+          options[:proxy][:password] ||= query_password "Proxy password:"
+        end
+
+
         opt.on('-?', '--query STR', String,
                'Append query to URLs') do |value|
           options[:query] = value
         end
 
 
+        opt.on('-X', '--request STR', String,
+               'The HTTP request method to use') do |value|
+          options[:http_method] = value
+        end
+
+
         opt.on('--suff STR', String,
                'Add common path items to the end of each URL') do |value|
           options[:uri_suffix] = value
@@ -414,12 +444,10 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('-U', '--proxy-user STR', String,
-               'Set proxy user and/or password: usr[:pass]') do |value|
-          options[:proxy][:username], options[:proxy][:password] =
-            value.split ":", 2
-
-          options[:proxy][:password] ||= query_password "Proxy password:"
+        opt.on('-T', '--upload-file FILE', String,
+               'Transfer file in HTTP body') do |file|
+          options[:data] = File.open(file, 'rb')
+          options[:http_method] ||= 'POST'
         end
 
 
@@ -432,9 +460,9 @@ Parse and run diffs against data from live and cached http responses.
         end
 
 
-        opt.on('-X', '--request STR', String,
-               'The HTTP request method to use') do |value|
-          options[:http_method] = value
+        opt.on('-A', '--user-agent STR', String,
+               'User-Agent to send to server or a valid alias') do |value|
+          options[:user_agent] = value
         end
 
 

data/lib/kronk/constants.rb

@@ -88,6 +88,7 @@ class Kronk
     :diff_format    => 'ascii',
     :history_file   => DEFAULT_HISTORY_FILE,
     :indentation    => 1,
+    :max_history    => 100,
     :requires       => [],
     :show_lines     => false,
     :uri_options    => {},

data/lib/kronk/request.rb

@@ -199,14 +199,15 @@ class Kronk
     end
 
 
-    attr_accessor :body, :headers, :proxy, :response, :timeout
+    attr_accessor :headers, :proxy, :response, :timeout
 
-    attr_reader :http_method, :uri, :use_cookies
+    attr_reader :body, :http_method, :uri, :use_cookies
 
     ##
     # Build an http request to the given uri and return a Response instance.
     # Supports the following options:
-    # :data:: Hash/String - the data to pass to the http request
+    # :data:: Hash/String - the data to pass to the http request body
+    # :form:: Hash/String - similar to :data but sets content-type header
     # :query:: Hash/String - the data to append to the http request path
     # :user_agent:: String - user agent string or alias; defaults to 'kronk'
     # :auth:: Hash - must contain :username and :password; defaults to nil
@@ -221,12 +222,10 @@ class Kronk
     def initialize uri, opts={}
       @auth = opts[:auth]
 
-      @body = nil
-      @body = self.class.build_query opts[:data] if opts[:data]
-
       @connection = nil
-      @response = nil
-      @_req     = nil
+      @response   = nil
+      @body       = nil
+      @_req       = nil
 
       @headers = opts[:headers] || {}
 
@@ -243,6 +242,9 @@ class Kronk
       @proxy = opts[:proxy] || {}
       @proxy = {:host => @proxy} unless Hash === @proxy
 
+      self.body      = opts[:data] if opts[:data]
+      self.form_data = opts[:form] if opts[:form]
+
       self.user_agent ||= opts[:user_agent]
 
       self.http_method = opts[:http_method] || (@body ? "POST" : "GET")
@@ -259,6 +261,7 @@ class Kronk
       @auth ||= Hash.new
 
       if !@auth[:username] && @headers['Authorization']
+        require 'base64'
         str = Base64.decode64 @headers['Authorization'].split[1]
         username, password = str.split(":", 2)
         @auth = {:username => username, :password => password}.merge @auth
@@ -268,6 +271,30 @@ class Kronk
     end
 
 
+    ##
+    # Assign request body. Supports String, Hash, and IO.
+
+    def body= data
+      case data
+      when Hash
+        self.form_data = data
+
+      when String
+        dont_chunk!
+        @body = data
+
+      else
+        if data.respond_to?(:read)
+          @headers['Transfer-Encoding'] = 'chunked'
+          @body = data
+        else
+          dont_chunk!
+          @body = data.to_s
+        end
+      end
+    end
+
+
     ##
     # Reference to the HTTP connection instance.
 
@@ -277,7 +304,11 @@ class Kronk
 
       @connection = http_class.new @uri.host, @uri.port
       @connection.open_timeout = @connection.read_timeout = @timeout if @timeout
-      @connection.use_ssl      = true if @uri.scheme =~ /^https$/
+
+      if @uri.scheme =~ /^https$/
+        require 'net/https'
+        @connection.use_ssl = true
+      end
 
       @connection
     end
@@ -291,6 +322,16 @@ class Kronk
     end
 
 
+    ##
+    # Assigns body of the request with form headers.
+
+    def form_data= data
+      dont_chunk!
+      @headers['Content-Type'] = "application/x-www-form-urlencoded"
+      @body = self.class.build_query data
+    end
+
+
     ##
     # Assigns the http method.
 
@@ -307,7 +348,7 @@ class Kronk
         cookie = Kronk.cookie_jar.get_cookie_header @uri.to_s
         @headers['Cookie'] = cookie unless cookie.empty?
 
-      else
+      elsif !bool
         @headers.delete 'Cookie'
       end
 
@@ -365,7 +406,7 @@ class Kronk
 
       @response = connection.start do |http|
         start_time = Time.now
-        res = http.request http_request, @body, opts, &block
+        res = http.request http_request, nil, opts, &block
         res.body # make sure to read the full body from io
         res.time    = Time.now - start_time
         res.request = self
@@ -442,7 +483,7 @@ class Kronk
 
 
     ##
-    # Returns the HTTP request object.
+    # Returns the Net::HTTPRequest subclass instance.
 
     def http_request
       req = VanillaRequest.new @http_method, @uri.request_uri, @headers
@@ -450,6 +491,8 @@ class Kronk
       req.basic_auth @auth[:username], @auth[:password] if
         @auth && @auth[:username]
 
+      @body.respond_to?(:read) ? req.body_stream = @body : req.body = @body
+
       req
     end
 
@@ -473,6 +516,13 @@ class Kronk
       Kronk::HTTP::Proxy host, port, user, pass
     end
 
+    private
+
+
+    def dont_chunk!
+      @headers.delete('Transfer-Encoding') if
+        @headers['Transfer-Encoding'].to_s.downcase == 'chunked'
+    end
 
 
     ##

data/lib/kronk/response.rb

@@ -122,6 +122,8 @@ class Kronk
 
       raise IOError, 'Socket closed.' if @io.closed?
 
+      require 'zlib' if gzip? || deflated?
+
       error    = false
       last_pos = 0
 

data/script/kronk_completion

@@ -4,15 +4,23 @@ export COMP_WORDBREAKS=${COMP_WORDBREAKS/\:/}
 
 _kronk() 
 {
-  local cur kronk_keys
+  local cur kronk_keys kronk_words
 
   cur="${COMP_WORDS[COMP_CWORD]}"
 
   kronk_keys="$HOME/.kronk/history"
   test -f "$kronk_keys" || kronk_keys="$HOME/.kronk_history"
 
+  kronk_words="$(cat $kronk_keys | sed 's/^http*:\/\///')"
+
+  if [[ ${cur:0:1} == "h" ]]; then
+    kronk_words="$(echo "$kronk_words" | sed 's/^/http:\/\//')
+$(echo "$kronk_words" | sed 's/^/https:\/\//')
+$(echo "$kronk_words")"
+  fi
+
   if [ -f "$kronk_keys" ]; then
-    COMPREPLY=( $(compgen -W "$(cat $kronk_keys $old_kronk_keys)" -- ${cur}) )
+    COMPREPLY=( $(compgen -W "$kronk_words" -- ${cur}) )
     return 0
   fi
 

data/test/test_cmd.rb

@@ -352,14 +352,15 @@ class TestCmd < Test::Unit::TestCase
 
   def test_parse_args_http_options
     opts = Kronk::Cmd.parse_args %w{uri -A foo -L --no-cookies -? bar
-            --suff /tail -X PUT -x example.com:2000}
-
-    assert_equal "foo",   opts[:user_agent]
-    assert_equal true,    opts[:follow_redirects]
-    assert_equal true,    opts[:no_cookies]
-    assert_equal "bar",   opts[:query]
-    assert_equal "/tail", opts[:uri_suffix]
-    assert_equal "PUT",   opts[:http_method]
+            --suff /tail -X PUT -x example.com:2000 --form foo=bar}
+
+    assert_equal "foo",     opts[:user_agent]
+    assert_equal true,      opts[:follow_redirects]
+    assert_equal true,      opts[:no_cookies]
+    assert_equal "bar",     opts[:query]
+    assert_equal "/tail",   opts[:uri_suffix]
+    assert_equal "PUT",     opts[:http_method]
+    assert_equal "foo=bar", opts[:form]
     assert_equal({:host => "example.com", :port => "2000"}, opts[:proxy])
 
     opts = Kronk::Cmd.parse_args %w{uri -L 3}

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 require "test/unit"
 require "mocha"
-require "kronk"
+require "kronk/cmd"
 
 Kronk.config[:context] = nil
 
@@ -176,6 +176,7 @@ def expect_request req_method, url, options={}
   headers['User-Agent'] ||= Kronk::DEFAULT_USER_AGENT
 
   req.expects(:start).yields(http).returns resp
+  req.expects(:body=).with(data)
 
   Kronk::Request::VanillaRequest.expects(:new).
     with(req_method.to_s.upcase, uri.request_uri, headers).returns req
@@ -183,7 +184,7 @@ def expect_request req_method, url, options={}
   Kronk::HTTP.expects(:new).with(uri.host, uri.port).returns req
 
   http.expects(:request).
-    with(req, data, has_entry(:request => instance_of(Kronk::Request))).
+    with(req, nil, has_entry(:request => instance_of(Kronk::Request))).
     returns resp
 
   yield http, req, resp if block_given?

data/test/test_helper_methods.rb

@@ -10,8 +10,10 @@ class TestHelperMethods < Test::Unit::TestCase
     @mock_resp  = Kronk::Response.new io
     @mock_resp2 = Kronk::Response.new \
                     StringIO.new mock_resp("200_response.json")
-    @mock_req   = stub("mock_req", :retrieve => @mock_resp,  :uri => "host.com")
-    @mock_req2  = stub("mock_req", :retrieve => @mock_resp2, :uri => "host.com")
+    @mock_req   = stub("mock_req", :retrieve => @mock_resp,
+                        :uri => URI.parse("http://host.com"))
+    @mock_req2  = stub("mock_req", :retrieve => @mock_resp2,
+                        :uri => URI.parse("http://host.com"))
 
     @mock_thread = stub("mock_thread", :join => true,
                          :abort_on_exception= => true)
@@ -140,7 +142,8 @@ class TestHelperMethods < Test::Unit::TestCase
 
   def test_retrieve_unparsable
     mock_resp = Kronk::Response.new StringIO.new(mock_200_response)
-    mock_req  = stub("mock_req", :retrieve => mock_resp, :uri => "host.com")
+    mock_req  = stub("mock_req", :retrieve => mock_resp,
+                      :uri => URI.parse("http://host.com"))
 
     Kronk::Request.expects(:new).
       with("host.com", :foo => "bar").returns mock_req

data/test/test_kronk.rb

@@ -16,9 +16,10 @@ class TestKronk < Test::Unit::TestCase
       :cache_file   => Kronk::DEFAULT_CACHE_FILE,
       :cookies_file => Kronk::DEFAULT_COOKIES_FILE,
       :history_file => Kronk::DEFAULT_HISTORY_FILE,
-      :indentation => 1,
+      :indentation  => 1,
       :default_host => "http://localhost:3000",
       :diff_format  => 'ascii',
+      :max_history  => 100,
       :show_lines   => false,
       :use_cookies  => true,
       :requires     => [],
@@ -43,6 +44,7 @@ class TestKronk < Test::Unit::TestCase
         :cookies_file => Kronk::DEFAULT_COOKIES_FILE,
         :history_file => Kronk::DEFAULT_HISTORY_FILE,
         :indentation => 1,
+        :max_history => 100,
         :show_lines  => false,
         :use_cookies => true,
         :requires    => [],
@@ -78,6 +80,7 @@ class TestKronk < Test::Unit::TestCase
         :cookies_file => Kronk::DEFAULT_COOKIES_FILE,
         :history_file => Kronk::DEFAULT_HISTORY_FILE,
         :indentation => 1,
+        :max_history => 100,
         :requires    => [],
         :show_lines  => false,
         :use_cookies => true,

data/test/test_player.rb

@@ -522,11 +522,11 @@ class TestPlayer < Test::Unit::TestCase
     end
 
     req.each_with_index do |r, i|
-      mock_req = "mock request"
       mock_res = Kronk::Response.new resp[i]
+      mock_req = stub("mock_req", :retrieve => mock_res,
+                        :uri => URI.parse("http://host.com"))
+
       Kronk::Request.stubs(:new).with(req[i], opts).returns mock_req
-      mock_req.stubs(:retrieve).returns mock_res
-      mock_req.stubs(:uri).returns nil
     end
   end
 end

data/test/test_request.rb

@@ -140,6 +140,51 @@ class TestRequest < Test::Unit::TestCase
   end
 
 
+  def test_body_hash
+    req = Kronk::Request.new "foo.com"
+    req.headers['Transfer-Encoding'] = "chunked"
+    req.body = {:foo => :bar}
+
+    assert_equal "foo=bar", req.body
+    assert_equal nil, req.headers['Transfer-Encoding']
+    assert_equal "application/x-www-form-urlencoded",
+                 req.headers['Content-Type']
+  end
+
+
+  def test_body_string
+    req = Kronk::Request.new "foo.com", :form => "blah"
+    req.headers['Transfer-Encoding'] = "chunked"
+    req.body = "foo=bar"
+
+    assert_equal "foo=bar", req.body
+    assert_equal nil, req.headers['Transfer-Encoding']
+    assert_equal "application/x-www-form-urlencoded",
+                 req.headers['Content-Type']
+  end
+
+
+  def test_body_io
+    req = Kronk::Request.new "foo.com"
+    req.body = str_io = StringIO.new "foo=bar"
+
+    assert_equal str_io,    req.body
+    assert_equal 'chunked', req.headers['Transfer-Encoding']
+    assert_equal nil,       req.headers['Content-Type']
+  end
+
+
+  def test_body_other
+    req = Kronk::Request.new "foo.com"
+    req.headers['Transfer-Encoding'] = "chunked"
+    req.body = 12345
+
+    assert_equal "12345", req.body
+    assert_equal nil,     req.headers['Transfer-Encoding']
+    assert_equal nil,     req.headers['Content-Type']
+  end
+
+
   def test_retrieve_get
     expect_request "GET", "http://example.com/request/path?foo=bar"
     resp =
@@ -329,6 +374,26 @@ class TestRequest < Test::Unit::TestCase
   end
 
 
+  def test_form_option
+    req = Kronk::Request.new("http://example.com", :data => "foo",
+                              :form => "bar")
+
+    assert_equal "bar", req.body
+    assert_equal "application/x-www-form-urlencoded",
+                  req.headers['Content-Type']
+  end
+
+
+  def test_form_data
+    req = Kronk::Request.new("http://example.com", :data => "foo",
+                              :form => "bar")
+
+    assert_equal "bar", req.body
+    assert_equal "application/x-www-form-urlencoded",
+                  req.headers['Content-Type']
+  end
+
+
   def test_retrieve_user_agent_default
     expect_request "GET", "http://example.com",
     :headers => {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kronk
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-05 00:00:00.000000000 Z
+date: 2012-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70357826961820 !ruby/object:Gem::Requirement
+  requirement: &70313458309720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70357826961820
+  version_requirements: *70313458309720
 - !ruby/object:Gem::Dependency
   name: cookiejar
-  requirement: &70357826961200 !ruby/object:Gem::Requirement
+  requirement: &70313459885080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70357826961200
+  version_requirements: *70313459885080
 - !ruby/object:Gem::Dependency
   name: plist
-  requirement: &70357826960660 !ruby/object:Gem::Requirement
+  requirement: &70313459883680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 3.1.0
   type: :development
   prerelease: false
-  version_requirements: *70357826960660
+  version_requirements: *70313459883680
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70357826960080 !ruby/object:Gem::Requirement
+  requirement: &70313459881520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *70357826960080
+  version_requirements: *70313459881520
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70357826959520 !ruby/object:Gem::Requirement
+  requirement: &70313459880540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *70357826959520
+  version_requirements: *70313459880540
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70357826958980 !ruby/object:Gem::Requirement
+  requirement: &70313459878740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *70357826958980
+  version_requirements: *70313459878740
 description: ! 'Kronk runs diffs against data from live and cached http responses.
 
   Kronk was made possible by the sponsoring of AT&T Interactive.'