kronk 1.1.2 → 1.2.0

data/History.rdoc

@@ -1,3 +1,17 @@
+=== 1.2.0 / 2011-01-20
+
+* Enhancements:
+
+  * Added IRB option to manipulate retrieved data in IRB console.
+
+* Bugfixes:
+
+  * Updated encoding of binary data to force_encode to binary encoding.
+
+  * Moved gem requires to avoid preloading unneeded libs.
+
+  * Added Windows support.
+
 === 1.1.2 / 2011-01-17
 
 * Bugfixes:

data/README.rdoc

@@ -19,6 +19,8 @@ Kronk was made possible by the sponsoring of AT&T Interactive.
 
 * Support for custom data parsers and diff formatters.
 
+* Launch IRB console with the retrieved response data.
+
 * Support for proxies, ssl, and basic auth.
 
 * Cookie/session handling.
@@ -65,6 +67,10 @@ Run it to display raw data with headers:
 
   $ kronk http://host.com/path.json --raw -i
 
+Parse the data and run an IRB console with the response:
+
+  $ kronk http://host.com/path.json --irb
+
 == CONFIGURATION:
 
 Kronk pulls it's config from $HOME/.kronk and supports the following:

data/lib/kronk.rb

@@ -1,18 +1,9 @@
 require 'rubygems'
-require 'plist'
+
 require 'json'
-require 'nokogiri'
 require 'cookiejar'
 require 'rack'
 
-# Support for new and old versions of ActiveSupport
-begin
-  require 'active_support/inflector'
-rescue LoadError => e
-  raise unless e.message =~ /-- active_support/
-  require 'activesupport'
-end
-
 require 'net/https'
 require 'optparse'
 require 'yaml'
@@ -20,7 +11,15 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
+
+
+  ##
+  # Returns true if kronk is running on ruby for windows.
+
+  def self.windows?
+    !!(RUBY_PLATFORM.downcase =~ /mswin|mingw|cygwin/)
+  end
 
 
   require 'kronk/data_set'
@@ -299,6 +298,7 @@ class Kronk
   # Supports the following options:
   # :data:: Hash/String - the data to pass to the http request
   # :query:: Hash/String - the data to append to the http request path
+  # :follow_redirects:: Integer/Bool - number of times to follow redirects
   # :headers:: Hash - extra headers to pass to the request
   # :http_method:: Symbol - the http method to use; defaults to :get
   # :user_agent:: String - user agent string or alias; defaults to 'kronk'
@@ -314,9 +314,9 @@ class Kronk
   #
   # Returns a diff object.
 
-  def self.compare query1, query2, options={}
-    str1 = retrieve_data_string query1, options
-    str2 = retrieve_data_string query2, options
+  def self.compare uri1, uri2, options={}
+    str1 = retrieve_data_string uri1, options
+    str2 = retrieve_data_string uri2, options
 
     Diff.new str1, str2
   end
@@ -326,25 +326,52 @@ class Kronk
   # Return a data string, parsed or raw.
   # See Kronk.compare for supported options.
 
-  def self.retrieve_data_string query, options={}
-    options = merge_options_for_uri query, options
+  def self.retrieve_data_string uri, options={}
+    options = merge_options_for_uri uri, options
+
+    resp = Request.retrieve uri, options
 
-    resp = Request.retrieve query, options
+    if options[:irb]
+      irb resp
 
-    if options[:raw]
+    elsif options[:raw]
       resp.selective_string options
+
     else
       begin
         data = resp.selective_data options
         Diff.ordered_data_string data, options[:struct]
+
       rescue Response::MissingParser
-        verbose "Warning: No parser for #{resp['Content-Type']} [#{query}]"
+        verbose "Warning: No parser for #{resp['Content-Type']} [#{uri}]"
         resp.selective_string options
       end
     end
   end
 
 
+
+  ##
+  # Start an IRB console with the given http response object.
+
+  def self.irb resp
+    require 'irb'
+
+    $http_response = resp
+    $response = begin
+                  resp.parsed_body
+                rescue Response::MissingParser
+                  resp.body
+                end
+
+    puts "\nHTTP Response is in $http_response"
+    puts "Response data is in $response\n\n"
+
+    IRB.start
+    exit 1
+  end
+
+
   ##
   # Runs the kronk command with the given terminal args.
 
@@ -501,6 +528,11 @@ Kronk runs diffs against data from live and cached http responses.
       end
 
 
+      opt.on('--irb', 'Start an IRB console') do
+        options[:irb] = true
+      end
+
+
       opt.on('--lines', 'Show line numbers') do
         config[:show_lines] = true
       end
@@ -636,13 +668,17 @@ Kronk runs diffs against data from live and cached http responses.
     options[:uris].concat argv
     options[:uris].slice!(2..-1)
 
-    if options[:uris].empty?
-      $stderr << "\nError: You must enter at least one URI\n\n"
-      $stderr << opts.to_s
-      exit 1
-    end
+    argv.clear
+
+    raise OptionParser::MissingArgument, "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
   end
 
 

data/lib/kronk/diff.rb

@@ -43,7 +43,18 @@ class Kronk
 
     class ColorFormat
 
+      def self.require_win_color
+        begin
+          require 'Win32/Console/ANSI'
+        rescue LoadError
+          puts "Warning: You must gem install win32console to use color"
+        end
+      end
+
+
       def self.lines line_nums, col_width
+        require_win_color if Kronk.windows?
+
         out =
           [*line_nums].map do |lnum|
             lnum.to_s.rjust col_width
@@ -54,11 +65,13 @@ class Kronk
 
 
       def self.deleted str
+        require_win_color if Kronk.windows?
         "\033[31m#{str}\033[0m"
       end
 
 
       def self.added str
+        require_win_color if Kronk.windows?
         "\033[32m#{str}\033[0m"
       end
 

data/lib/kronk/plist_parser.rb

@@ -9,6 +9,7 @@ class Kronk
     # Alias for Plist.parse_xml
 
     def self.parse plist
+      require 'plist'
       Plist.parse_xml plist
     end
   end

data/lib/kronk/request.rb

@@ -6,6 +6,7 @@ class Kronk
   class Request
 
 
+    # Raised when the URI was not resolvable.
     class NotFoundError < Exception; end
 
     ##
@@ -57,7 +58,7 @@ class Kronk
         end
 
       begin
-        File.open(options[:cache_response], "w+") do |file|
+        File.open(options[:cache_response], "wb+") do |file|
           file.write resp.raw
         end if options[:cache_response]
       rescue => e
@@ -89,7 +90,12 @@ class Kronk
       path = Kronk::DEFAULT_CACHE_FILE if path == :cache
       resp = nil
 
-      File.open(path, "r") do |file|
+      File.open(path, "rb") do |file|
+
+        # On windows, read the full file and insert contents into
+        # a StringIO to avoid failures with IO#read_nonblock
+        file = StringIO.new file.read if Kronk.windows?
+
         begin
           resp = Response.read_new file
 
@@ -291,7 +297,7 @@ class Kronk
         out.join "&"
 
       when Hash
-        out = data.sort.map do |key, value|
+        out = data.map do |key, value|
           key = param.nil? ? key : "#{param}[#{key}]"
           build_query value, key
         end

data/lib/kronk/response.rb

@@ -71,15 +71,12 @@ class Kronk
     module Helpers
 
       ##
-      # Assigns the raw http response value. Sets the encoding to ASCII-8BIT
-      # and replaces invalid characters with '?' if the encoding is invalid
-      # in Ruby 1.9.x
+      # Assigns the raw http response value. Sets the encoding to binary
+      # if the encoding is invalid in Ruby 1.9.x
 
       def raw= value
         if value.respond_to?(:valid_encoding?) && !value.valid_encoding?
-          value.encode! "ASCII-8BIT", :invalid => :replace,
-                                      :undef   => :replace,
-                                      :replace => "?"
+          value.force_encoding "binary"
         end
 
         @raw = value
@@ -194,14 +191,14 @@ class Kronk
         data = nil
 
         unless options[:no_body]
-          data = DataSet.new(parsed_body(options[:parser])).modify options
+          data = parsed_body options[:parser]
         end
 
         if options[:with_headers]
           data = [parsed_header(options[:with_headers]), data].compact
         end
 
-        data
+        DataSet.new(data).modify options
       end
     end
   end

data/lib/kronk/xml_parser.rb

@@ -5,11 +5,28 @@ class Kronk
 
   class XMLParser
 
+    ##
+    # Load required gems.
+
+    def self.require_gems
+      require 'nokogiri'
+
+      # Support for new and old versions of ActiveSupport
+      begin
+        require 'active_support/inflector'
+      rescue LoadError => e
+        raise unless e.message =~ /-- active_support/
+        require 'activesupport'
+      end
+    end
+
     ##
     # Takes an xml string and returns a data hash.
     # Ignores blank spaces between tags.
 
     def self.parse str
+      require_gems
+
       root_node = Nokogiri.XML str do |config|
         config.default_xml.noblanks
       end

data/test/test_request.rb

@@ -82,7 +82,7 @@ class TestRequest < Test::Unit::TestCase
 
 
   def test_retrieve_file_cache
-    File.expects(:open).with(Kronk::DEFAULT_CACHE_FILE, "r").
+    File.expects(:open).with(Kronk::DEFAULT_CACHE_FILE, "rb").
       yields StringIO.new(mock_200_response)
 
     resp = Kronk::Request.retrieve_file :cache
@@ -467,7 +467,7 @@ class TestRequest < Test::Unit::TestCase
     }
 
     assert_equal "a[]=one&a[]=two&b[b1][]=1&b[b1][]=2&b[b2]=test&foo=bar",
-                  Kronk::Request.build_query(hash)
+                  Kronk::Request.build_query(hash).split("&").sort.join("&")
   end
 
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kronk
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
   - 2
-  version: 1.1.2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Jeremie Castagna
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 -08:00
+date: 2011-01-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency