kronk 1.2.1 → 1.2.2

data/History.rdoc

@@ -1,3 +1,14 @@
+=== 1.2.2 / 2011-02-19
+
+* Enhancements:
+
+  * Added support for default host to avoid having to write out
+    the most commonly used host name (e.g. http://localhost:3000)
+
+  * Added support for bash completion of URIs.
+
+  * Explicitely passing the http protocol is now optional.
+
 === 1.2.1 / 2011-01-21
 
 * Enhancements:

data/Manifest.txt

@@ -11,6 +11,7 @@ lib/kronk/plist_parser.rb
 lib/kronk/request.rb
 lib/kronk/response.rb
 lib/kronk/xml_parser.rb
+script/kronk_completion
 test/mocks/200_response.json
 test/mocks/200_response.plist
 test/mocks/200_response.txt

data/README.rdoc

@@ -27,6 +27,8 @@ Kronk was made possible by the sponsoring of AT&T Interactive.
 
 * Easy-to-read output (color or ascii, line numbers, etc).
 
+* Yes, it works on Windows.
+
 == FUTURE:
 
 * Auto-queryer with optional param randomizing.
@@ -37,35 +39,37 @@ Kronk was made possible by the sponsoring of AT&T Interactive.
 
 Check if your json response returns the same data as your xml variety:
 
-  $ kronk http://host.com/path.json http://host.com/path.xml
+  $ kronk host.com/path.json host.com/path.xml
 
 Compare body structure only (uses datatypes instead of values):
 
-  $ kronk http://host.com/path.json http://host.com/path.xml --struct
+  $ kronk host.com/path.json host.com/path.xml --struct
 
 Call comparison with similar uri suffixes:
 
-  $ kronk http://host.com/path.json http://host.com/path.xml --suff '?page=1'
+  $ kronk host.com/path.json host.com/path.xml --suff '?page=1'
 
-Compare response with the previous call:
+Compare response over ssl with the previous call:
 
-  $ kronk http://host.com/path --prev
+  $ kronk https://host.com/path --prev
 
 Compare response with a local file:
 
-  $ kronk http://host.com/path.json ./saved_response.json
+  $ kronk host.com/path.json ./saved_response.json
 
 Do a simple text diff on the http response, including headers:
 
-  $ kronk http://host.com/A/path.json http://host.com/B/path.json --raw -i
+  $ kronk host.com/A/path.json host.com/B/path.json --raw -i
 
 Run it to display formatted data:
 
-  $ kronk http://host.com/path.json
+  $ kronk host.com/path.json
 
-Run it to display raw data with headers:
+Run it to display raw data with headers from the default host (localhost:3000).
+Default host is assumed when the path starts with "/" and no local files match
+the given path:
 
-  $ kronk http://host.com/path.json --raw -i
+  $ kronk /path.json --raw -i
 
 Parse the data and run an IRB console with the response:
 
@@ -135,6 +139,17 @@ Show line numbers in the output:
 
   :show_lines: true
 
+Assign a default host to use when none is specified:
+
+  :default_host: http://localhost:3000
+
+=== Bash Completion:
+
+Bash completion is available by sourcing the file returned by:
+
+  $ kronk --completion
+  [gem path]/script/kronk_completion
+
 == DATA TRAVERSING:
 
 One of Kronk's most powerful features is its ability to segregate data.
@@ -225,6 +240,10 @@ single quotes around some of your paths.
 
 * json gem
 
+* rack gem
+
+* cookiejar gem
+
 == INSTALL:
 
   $ sudo gem install kronk
@@ -242,7 +261,7 @@ and generate the RDoc.
 
 (The MIT License)
 
-Copyright (c) 2010 Jeremie Castagna
+Copyright (c) 2010, 2011 Jeremie Castagna
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/kronk.rb

@@ -11,7 +11,7 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 
 
   ##
@@ -42,6 +42,10 @@ class Kronk
   DEFAULT_COOKIES_FILE = File.expand_path "~/.kronk_cookies"
 
 
+  # Default file with history of unique URIs. (Used for autocomplete)
+  DEFAULT_HISTORY_FILE = File.expand_path "~/.kronk_history"
+
+
   # Default Content-Type header to parser mapping.
   DEFAULT_CONTENT_TYPES = {
     'js'      => 'JSON',
@@ -81,10 +85,12 @@ class Kronk
   # Default config to use.
   DEFAULT_CONFIG = {
     :content_types  => DEFAULT_CONTENT_TYPES.dup,
+    :default_host   => "http://localhost:3000",
     :diff_format    => :ascii_diff,
     :show_lines     => false,
     :cache_file     => DEFAULT_CACHE_FILE,
     :cookies_file   => DEFAULT_COOKIES_FILE,
+    :history_file   => DEFAULT_HISTORY_FILE,
     :use_cookies    => true,
     :requires       => [],
     :uri_options    => {},
@@ -290,6 +296,20 @@ class Kronk
   end
 
 
+  ##
+  # Writes the given URIs to the history file.
+
+  def self.save_history *uris
+    path = self.config[:history_file]
+
+    uris.concat File.readlines(path).map{|line| line.strip} if File.file?(path)
+
+    File.open path, "w" do |file|
+      file.write uris.uniq.join($/)
+    end
+  end
+
+
   ##
   # Make requests, parse the responses and compare the data.
   # Query arguments may be set to the special value :cache to use the
@@ -410,12 +430,15 @@ class Kronk
         $stdout << "Found #{diff.count} diff(s).\n"
       end
 
+      save_history uri1, uri2
       exit 1 if diff.count > 0
 
     else
       out = retrieve_data_string uri1, options
       out = Diff.insert_line_nums out if config[:show_lines]
       puts out
+
+      save_history uri1
     end
 
   rescue Request::NotFoundError, Response::MissingParser => e
@@ -452,7 +475,10 @@ class Kronk
       opt.release = nil
 
       opt.banner = <<-STR
-Kronk runs diffs against data from live and cached http responses.
+
+#{opt.program_name} #{opt.version}
+
+Parse and run diffs against data from live and cached http responses.
 
   Usage:
     #{opt.program_name} --help
@@ -483,6 +509,13 @@ Kronk runs diffs against data from live and cached http responses.
       end
 
 
+      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)
+        exit 2
+      end
+
+
       opt.on('--config STR', String,
              'Load the given Kronk config file') do |value|
         load_config value

data/lib/kronk/diff.rb

@@ -101,11 +101,6 @@ class Kronk
       when Hash
         output = "{\n"
 
-        key_width = 0
-        data.keys.each do |k|
-          key_width = k.inspect.length if k.inspect.length > key_width
-        end
-
         data_values =
           data.map do |key, value|
             pad = " " * indent

data/lib/kronk/request.rb

@@ -51,7 +51,7 @@ class Kronk
       resp =
         if IO === query || StringIO === query
           retrieve_io query, options
-        elsif local?(query)
+        elsif query == :cache || File.file?(query)
           retrieve_file query, options
         else
           retrieve_uri query, options
@@ -71,14 +71,6 @@ class Kronk
     end
 
 
-    ##
-    # Check if a URI should be treated as a local file.
-
-    def self.local? uri
-      !(uri =~ %r{^\w+://})
-    end
-
-
     ##
     # Read http response from a file and return a HTTPResponse instance.
 
@@ -178,15 +170,7 @@ class Kronk
     # :proxy:: Hash/String - http proxy to use; defaults to nil
 
     def self.call http_method, uri, options={}
-      suffix = options.delete :uri_suffix
-
-      uri = "#{uri}#{suffix}" if suffix
-      uri = URI.parse uri unless URI === uri
-
-      if options[:query]
-        query = build_query options[:query]
-        uri.query = [uri.query, query].compact.join "&"
-      end
+      uri = build_uri uri, options
 
       data   = options[:data]
       data &&= build_query data
@@ -240,6 +224,27 @@ class Kronk
     end
 
 
+    ##
+    # Build the URI to use for the request from the given uri or
+    # path and options.
+
+    def self.build_uri uri, options={}
+      suffix = options.delete :uri_suffix
+
+      uri = "http://#{uri}"   unless uri =~ %r{^(\w+://|/)}
+      uri = "#{uri}#{suffix}" if suffix
+      uri = URI.parse uri unless URI === uri
+      uri = URI.parse(Kronk.config[:default_host]) + uri unless uri.host
+
+      if options[:query]
+        query = build_query options[:query]
+        uri.query = [uri.query, query].compact.join "&"
+      end
+
+      uri
+    end
+
+
     ##
     # Checks if cookies should be used and set.
 

data/script/kronk_completion

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+_kronk() 
+{
+  local cur prev opts kronk_keys
+  COMPREPLY=()
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+
+  kronk_keys="$HOME/.kronk_history"
+
+
+  if [ -f "$kronk_keys" ]; then
+    opts=$(cat $kronk_keys)
+    COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+    return 0
+  fi
+
+  return 1
+}
+
+complete -d -X '.[^./]*' -F _kronk kronk

data/test/test_kronk.rb

@@ -12,6 +12,8 @@ class TestKronk < Test::Unit::TestCase
       },
       :cache_file   => Kronk::DEFAULT_CACHE_FILE,
       :cookies_file => Kronk::DEFAULT_COOKIES_FILE,
+      :history_file => Kronk::DEFAULT_HISTORY_FILE,
+      :default_host => "http://localhost:3000",
       :diff_format  => :ascii_diff,
       :show_lines   => false,
       :use_cookies  => true,
@@ -33,6 +35,7 @@ class TestKronk < Test::Unit::TestCase
       :ignore_headers => ["Content-Type"],
       :cache_file  => Kronk::DEFAULT_CACHE_FILE,
       :cookies_file => Kronk::DEFAULT_COOKIES_FILE,
+      :history_file => Kronk::DEFAULT_HISTORY_FILE,
       :show_lines  => false,
       :use_cookies => true,
       :requires    => [],
@@ -54,9 +57,11 @@ class TestKronk < Test::Unit::TestCase
         'plist' => "PlistParser",
         'xml'   => "XMLParser"
       },
+      :default_host => "http://localhost:3000",
       :diff_format => :ascii_diff,
       :cache_file  => Kronk::DEFAULT_CACHE_FILE,
       :cookies_file => Kronk::DEFAULT_COOKIES_FILE,
+      :history_file => Kronk::DEFAULT_HISTORY_FILE,
       :requires    => [],
       :show_lines  => false,
       :use_cookies => true,

data/test/test_request.rb

@@ -68,6 +68,7 @@ class TestRequest < Test::Unit::TestCase
   def test_retrieve_cached
     query   = "path/to/file.txt"
     options = {:foo => "bar"}
+    File.expects(:file?).with(query).returns true
     Kronk::Request.expects(:retrieve_file).with query, options
 
     Kronk::Request.retrieve query, options

data/test/test_xml_parser.rb

@@ -1,4 +1,5 @@
 require 'test/test_helper'
+require "nokogiri"
 
 class TestXmlParser < Test::Unit::TestCase
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kronk
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 1
   - 2
-  - 1
-  version: 1.2.1
+  - 2
+  version: 1.2.2
 platform: ruby
 authors: 
 - Jeremie Castagna
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-21 00:00:00 -08:00
+date: 2011-02-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 3
         - 1
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 1
         - 2
@@ -54,6 +57,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 1
         - 3
@@ -68,6 +72,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 1
         segments: 
         - 0
         - 5
@@ -82,6 +87,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 2
         - 0
@@ -97,6 +103,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 0
         - 3
@@ -112,57 +119,45 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 0
         version: "1.0"
   type: :runtime
   version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rubyforge
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 4
-        version: 2.0.4
-  type: :development
-  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 47
         segments: 
         - 0
         - 9
         - 10
         version: 0.9.10
   type: :development
-  version_requirements: *id009
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 47
         segments: 
         - 2
-        - 6
-        - 2
-        version: 2.6.2
+        - 8
+        - 0
+        version: 2.8.0
   type: :development
-  version_requirements: *id010
+  version_requirements: *id009
 description: |-
   Kronk runs diffs against data from live and cached http responses.
   Kronk was made possible by the sponsoring of AT&T Interactive.
@@ -190,6 +185,7 @@ files:
 - lib/kronk/request.rb
 - lib/kronk/response.rb
 - lib/kronk/xml_parser.rb
+- script/kronk_completion
 - test/mocks/200_response.json
 - test/mocks/200_response.plist
 - test/mocks/200_response.txt
@@ -218,7 +214,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -195272185281626433
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -227,13 +223,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: kronk
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Kronk runs diffs against data from live and cached http responses