kronk 1.1.0 → 1.1.1

data/History.rdoc

@@ -1,3 +1,17 @@
+=== 1.1.1 / 2010-12-22
+
+* Enhancements:
+
+  * Added diff-like brief option.
+
+  * Added support for loading alternate Kronk configs from the command line.
+
+* Bugfixes:
+
+  * Changed uri options config to allow matching of multiple keys.
+
+  * Implementing smart merging of uri options with command line options.
+
 === 1.1.0 / 2010-12-12
 
 * Enhancements:

data/README.rdoc

@@ -198,7 +198,7 @@ are supported:
 
 * | effectively works as an "OR" character, matches /^val1|val2$/
 
-* = is used to match values and may be used in conjuction with a key or not.
+* \= is used to match values and may be used in conjuction with a key or not.
 
 * Parentheses are ok to use if in conjunction with other special characters
   for a given path item, such as: /path(1|2)

data/Rakefile

@@ -17,6 +17,7 @@ Hoe.spec 'kronk' do
   self.extra_deps << ['i18n',          '~>0.5']
   self.extra_deps << ['activesupport', '>=2.0.0']
   self.extra_deps << ['cookiejar',     '~>0.3.0']
+  self.extra_deps << ['rack',          '~>1.0']
 
   self.extra_dev_deps << ['mocha', '~>0.9.10']
 end

data/lib/kronk.rb

@@ -3,6 +3,7 @@ require 'plist'
 require 'json'
 require 'nokogiri'
 require 'cookiejar'
+require 'rack'
 
 # Support for new and old versions of ActiveSupport
 begin
@@ -19,7 +20,7 @@ require 'yaml'
 class Kronk
 
   # This gem's version.
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 
 
   require 'kronk/data_set'
@@ -175,15 +176,64 @@ class Kronk
 
 
   ##
-  # Returns config-defined options for a given uri.
-  # Returns empty Hash if none found.
+  # Returns merged config-defined options for a given uri.
+  # Values in cmd_opts take precedence.
+  # Returns cmd_opts Hash if none found.
 
-  def self.options_for_uri uri
-    config[:uri_options].each do |key, options|
-      return options if uri == key || uri =~ %r{#{key}}
+  def self.merge_options_for_uri uri, cmd_opts={}
+    out_opts = Hash.new.merge cmd_opts
+
+    config[:uri_options].each do |matcher, options|
+      next unless (uri == matcher || uri =~ %r{#{matcher}}) && Hash === options
+
+      options.each do |key, val|
+        if !out_opts[key]
+          out_opts[key] = val
+          next
+        end
+
+
+        case key
+
+        # Hash or uri query String
+        when :data, :query
+          val = Rack::Utils.parse_nested_query val if String === val
+
+          out_opts[key] = Rack::Utils.parse_nested_query out_opts[key] if
+            String === out_opts[key]
+
+          out_opts[key] = val.merge out_opts[key], &DataSet::DEEP_MERGE
+
+        # Hashes
+        when :headers, :auth
+          out_opts[key] = val.merge out_opts[key]
+
+        # Proxy hash or String
+        when :proxy
+          if Hash === val && Hash === out_opts[key]
+            out_opts[key] = val.merge out_opts[key]
+
+          elsif Hash === val && String === out_opts[key]
+            val[:address] = out_opts[key]
+            out_opts[key] = val
+
+          elsif String === val && Hash === out_opts[key]
+            out_opts[key][:address] ||= val
+          end
+
+        # Response headers - Boolean, String, or Array
+        when :with_headers
+          next if out_opts[key] == true || out_opts[key] && val == true
+          out_opts[key] = [*out_opts[key]] | [*val]
+
+        # String or Array
+        when :only_data, :only_data_with, :ignore_data, :ignore_data_with
+          out_opts[key] = [*out_opts[key]] | [*val]
+        end
+      end
     end
 
-    Hash.new
+    out_opts
   end
 
 
@@ -218,8 +268,8 @@ class Kronk
 
   def self.save_cookie_jar file=nil
     file ||= config[:cookies_file]
-    File.open(file, "w") do |file|
-      file.write @cookie_jar.to_yaml
+    File.open(file, "w") do |f|
+      f.write @cookie_jar.to_yaml
     end
   end
 
@@ -255,9 +305,11 @@ class Kronk
   # :auth:: Hash - must contain :username and :password; defaults to nil
   # :proxy:: Hash/String - http proxy to use; defaults to nil
   # :only_data:: String/Array - extracts the data from given data paths
+  # :only_data_with:: String/Array - extracts the data from given parent paths
   # :ignore_data:: String/Array - defines which data points to exclude
+  # :ignore_data_with:: String/Array - defines which parent data to exclude
   # :with_headers:: Bool/String/Array - defines which headers to include
-  # :parser:: Object - The parser to use for the body; default nil
+  # :parser:: Object/String - The parser to use for the body; default nil
   # :raw:: Bool - run diff on raw strings
   #
   # Returns a diff object.
@@ -275,7 +327,7 @@ class Kronk
   # See Kronk.compare for supported options.
 
   def self.retrieve_data_string query, options={}
-    options = options.merge options_for_uri(query)
+    options = merge_options_for_uri query, options
 
     resp = Request.retrieve query, options
 
@@ -306,7 +358,7 @@ class Kronk
       $stderr << "\nNo config file was found.\n\n"
       $stderr << "Created default config in #{DEFAULT_CONFIG_FILE}\n"
       $stderr << "Edit file if necessary and try again.\n"
-      exit 1
+      exit 2
     end
 
     load_cookie_jar
@@ -325,8 +377,13 @@ class Kronk
 
     if uri1 && uri2
       diff = compare uri1, uri2, options
-      puts diff.formatted
-      verbose "\n\nFound #{diff.count} diff(s).\n"
+      puts "#{diff.formatted}\n" unless config[:brief]
+
+      if config[:verbose] || config[:brief]
+        $stdout << "Found #{diff.count} diff(s).\n"
+      end
+
+      exit 1 if diff.count > 0
 
     else
       out = retrieve_data_string uri1, options
@@ -399,6 +456,17 @@ Kronk runs diffs against data from live and cached http responses.
       end
 
 
+      opt.on('--config STR', String,
+             'Load the given Kronk config file') do |value|
+        load_config value
+      end
+
+
+      opt.on('-q', '--brief', 'Output only whether URI responses differ') do
+        config[:brief] = true
+      end
+
+
       opt.on('--format STR', String,
              'Use a custom diff formatter') do |value|
         config[:diff_format] = value

data/lib/kronk/data_set.rb

@@ -5,6 +5,13 @@ class Kronk
 
   class DataSet
 
+    # Deep merge proc for recursive Hash merging.
+    DEEP_MERGE =
+      proc do |key,v1,v2|
+        Hash === v1 && Hash === v2 ? v1.merge(v2,&DEEP_MERGE) : v2
+      end
+
+
     attr_accessor :data
 
     def initialize data
@@ -31,9 +38,9 @@ class Kronk
     ##
     # Modify the data object by passing inclusive or exclusive data paths.
     # Supports the following options:
-    # :only_data:: String/Array - keep data with that matches the paths
+    # :only_data:: String/Array - keep data that matches the paths
     # :only_data_with:: String/Array - keep data with a matched child
-    # :ignore_data:: String/Array - remove data with that matches the paths
+    # :ignore_data:: String/Array - remove data that matches the paths
     # :ignore_data_with:: String/Array - remove data with a matched child
     #
     # Note: the data is processed in the following order:

data/lib/kronk/diff.rb

@@ -235,7 +235,10 @@ class Kronk
 
     ##
     # Returns a formatted output as a string.
-    # Custom formats may be achieved by passing a block.
+    # Supported options are:
+    # :join_char:: String - The string used to join lines; default "\n"
+    # :show_lines:: Boolean - Insert line numbers or not; default @show_lines
+    # :formatter:: Object - The formatter to use; default @formatter
 
     def formatted options={}
       options = {

data/test/test_data_set.rb

@@ -47,9 +47,9 @@ class TestDataSet < Test::Unit::TestCase
   end
 
 
-  def test_modify_only_data
-    data = @dataset_mock.modify :only_data => "subs/1"
-    assert_equal({"subs" => [nil, "b"]}, data)
+  def test_modify_only_data_with
+    data = @dataset_mock.modify :only_data_with => "subs/1"
+    assert_equal({"subs" => ["a", "b"]}, data)
   end
 
 

data/test/test_kronk.rb

@@ -119,17 +119,180 @@ class TestKronk < Test::Unit::TestCase
   end
 
 
-  def test_options_for_uri
-    old_uri_opts = Kronk.config[:uri_options].dup
-    Kronk.config[:uri_options] = {
-      'example'     => 'options1',
-      'example.com' => 'options2'
+  def test_merge_options_for_uri
+    with_uri_options do
+      assert_equal mock_uri_options['example'],
+        Kronk.merge_options_for_uri("http://example.com/path")
+
+      assert_equal Hash.new,
+        Kronk.merge_options_for_uri("http://thing.com/path")
+    end
+  end
+
+
+  def test_merge_options_for_uri_query
+    data = {
+      "add" => "this",
+      "foo" => {
+        "bar1" => "one",
+        "bar2" => 2,
+        "bar3" => "three"},
+      "key"=>"otherval"}
+
+    expected = {:query => data, :data => data}
+
+    with_uri_options do
+      new_data = {
+        "add" => "this",
+        "foo" => {'bar2' => 2, 'bar3' => "three"},
+        "key" => "otherval"
+      }
+
+      %w{uri_query hash_query}.each do |qtype|
+        opts = Kronk.merge_options_for_uri("http://#{qtype}.com",
+                :query => data, :data => data)
+
+        assert_equal expected, opts
+      end
+
+      opts = Kronk.merge_options_for_uri("http://uri_query.com")
+      assert_equal mock_uri_options['uri_query'], opts
+    end
+  end
+
+
+  def test_merge_options_for_uri_headers
+    with_uri_options do
+      opts = Kronk.merge_options_for_uri("http://headers.example.com",
+              :headers => {'hdr2' => 2, 'hdr3' => 3})
+
+      expected = {
+        :headers => {
+          'hdr1' => 'one',
+          'hdr2' => 2,
+          'hdr3' => 3
+        },
+        :parser => "XMLParser"
+      }
+
+      assert_equal expected, opts
+    end
+  end
+
+
+  def test_merge_options_for_uri_auth
+    with_uri_options do
+      opts = Kronk.merge_options_for_uri("http://auth.example.com",
+              :auth => {:username => "bob"})
+
+      expected = {
+        :auth => {
+          :username => "bob",
+          :password => "pass"
+        },
+        :parser => "XMLParser"
+      }
+
+      assert_equal expected, opts
+    end
+  end
+
+
+  def test_merge_options_for_uri_proxy
+    with_uri_options do
+      expected = {
+        :proxy => {
+          :address  => "proxy.com",
+          :port     => 1234,
+          :username => "user",
+          :password => "pass"
+        }
+      }
+
+      opts = Kronk.merge_options_for_uri("http://proxy.com",
+              :proxy => "proxy.com")
+
+      assert_equal expected, opts
+
+      opts = Kronk.merge_options_for_uri("http://proxy.com",
+              :proxy => {:address => "proxy.com"})
+
+      assert_equal expected, opts
+    end
+  end
+
+
+  def test_merge_options_for_uri_str_proxy
+    with_uri_options do
+      expected = {
+        :proxy => {
+          :address  => "someproxy.com",
+          :username => "user",
+          :password => "pass"
+        }
+      }
+
+      opts = Kronk.merge_options_for_uri("http://strprox.com",
+              :proxy => {:username => "user", :password => "pass"})
+
+      assert_equal expected, opts
+
+      opts = Kronk.merge_options_for_uri("http://strprox.com",
+              :proxy => "proxy.com")
+
+      assert_equal "proxy.com", opts[:proxy]
+    end
+  end
+
+
+  def test_merge_options_for_uri_with_headers
+    with_uri_options do
+      %w{withhdrs withstrhdrs withtruehdrs}.each do |type|
+        opts = Kronk.merge_options_for_uri "http://#{type}.com",
+                :with_headers => true
+
+        assert_equal true, opts[:with_headers]
+      end
+    end
+  end
+
+
+  def test_merge_options_for_uri_with_headers_arr
+    with_uri_options do
+      %w{withhdrs withstrhdrs}.each do |type|
+        opts = Kronk.merge_options_for_uri "http://#{type}.com",
+                :with_headers => %w{hdr2 hdr3}
+
+        assert_equal %w{hdr1 hdr2 hdr3}.sort, opts[:with_headers].sort
+      end
+
+      opts = Kronk.merge_options_for_uri "http://withtruehdrs.com",
+              :with_headers => %w{hdr2 hdr3}
+
+      assert_equal %w{hdr2 hdr3}, opts[:with_headers]
+    end
+  end
+
+
+  def test_merge_options_for_uri_data_paths
+    expected = {
+      :only_data        => %w{path1 path2 path3},
+      :only_data_with   => %w{only1 only2},
+      :ignore_data      => "ign1",
+      :ignore_data_with => %w{ign2 ign3}
     }
 
-    assert_equal 'options1', Kronk.options_for_uri("http://example.com/path")
-    assert_equal Hash.new, Kronk.options_for_uri("http://thing.com/path")
+    with_uri_options do
+      opts = Kronk.merge_options_for_uri "http://focus_data.com",
+              :only_data        => %w{path2 path3},
+              :only_data_with   => "only2",
+              :ignore_data_with => %w{ign2 ign3}
 
-    Kronk.config[:uri_options] = old_uri_opts
+      opts[:only_data].sort!
+      opts[:only_data_with].sort!
+
+      assert_equal expected, opts
+    end
   end
 
 
@@ -326,4 +489,80 @@ STR
 
     assert_equal %w{this is --argv}, argv
   end
+
+
+  private
+
+  def mock_uri_options
+    {
+      'example'     => {
+        :parser => "XMLParser"
+      },
+      'example.com' => {
+        :parser => "PlistParser"
+      },
+      'uri_query'   => {
+        :query => "foo[bar1]=one&foo[bar2]=two&key=val",
+        :data  => "foo[bar1]=one&foo[bar2]=two&key=val"
+      },
+      'hash_query'  => {
+        :query => {
+          'foo' => {'bar1'=>'one', 'bar2'=>'two'},
+          'key' => "val"
+        },
+        :data  => {
+          'foo' => {'bar1'=>'one', 'bar2'=>'two'},
+          'key' => "val"
+        }
+      },
+      'headers'     => {
+        :headers => {
+          'hdr1' => 'one',
+          'hdr2' => 'two'
+        }
+      },
+      'auth'        => {
+        :auth => {
+          :username => "user",
+          :password => "pass"
+        }
+      },
+      'proxy'       => {
+        :proxy => {
+          :username => "user",
+          :password => "pass",
+          :address  => "someproxy.com",
+          :port     => 1234
+        }
+      },
+      'strprox'     => {
+        :proxy => "someproxy.com"
+      },
+      'withhdrs'    => {
+        :with_headers => %w{hdr1 hdr2 hdr3}
+      },
+      'withstrhdrs' => {
+        :with_headers => "hdr1"
+      },
+      'withtruehdrs' => {
+        :with_headers => true
+      },
+      'focus_data'   => {
+        :only_data      => %w{path1 path2},
+        :only_data_with => "only1",
+        :ignore_data    => "ign1"
+      }
+    }
+  end
+
+
+  def with_uri_options
+    old_uri_opts = Kronk.config[:uri_options].dup
+    Kronk.config[:uri_options] = mock_uri_options
+
+    yield if block_given?
+
+  ensure
+    Kronk.config[:uri_options] = old_uri_opts
+  end
 end

data/test/test_response.rb

@@ -258,7 +258,7 @@ class TestResponse < Test::Unit::TestCase
   end
 
 
-  def test_selective_data_multiple_only_data
+  def test_selective_data_multiple_ignore_data
     expected = JSON.parse @json_resp.body
     expected['business'].delete 'id'
     expected.delete 'request_id'

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: kronk
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Jeremie Castagna
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-12 00:00:00 -08:00
+date: 2010-12-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 3
         - 1
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 1
         - 2
@@ -57,7 +54,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 1
         - 3
@@ -72,7 +68,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
         segments: 
         - 0
         - 5
@@ -87,7 +82,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 2
         - 0
@@ -103,7 +97,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
         segments: 
         - 0
         - 3
@@ -112,37 +105,64 @@ dependencies:
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: rack
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 47
+        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 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
         segments: 
         - 0
         - 9
         - 10
         version: 0.9.10
   type: :development
-  version_requirements: *id007
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 47
         segments: 
         - 2
-        - 8
-        - 0
-        version: 2.8.0
+        - 6
+        - 2
+        version: 2.6.2
   type: :development
-  version_requirements: *id008
+  version_requirements: *id010
 description: |-
   Kronk runs diffs against data from live and cached http responses.
   Kronk was made possible by the sponsoring of AT&T Interactive.
@@ -198,7 +218,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: -1939027826967097857
       segments: 
       - 0
       version: "0"
@@ -207,7 +227,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"