hot_or_not 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/hot_or_not/announcer.rb

@@ -6,7 +6,7 @@ module HotOrNot
     def announce_failure(result)
     end
 
-    def announce_error(url, error)
+    def announce_error(result)
     end
 
     def starting

data/lib/hot_or_not/announcers/console_announcer.rb

@@ -38,8 +38,8 @@ module HotOrNot
       print "N"
     end
 
-    def announce_error(url, error)
-      @results << { :status => :error, :url => url, :error => error }
+    def announce_error(result)
+      @results << { :status => :error, :result => result }
       print "E"
     end
 
@@ -54,7 +54,7 @@ module HotOrNot
     end
 
     def output_error result_hash
-      to_console "Error:#{$/}Retreiving #{result_hash[:url].url} raised error: #{result_hash[:error].message}#{$/}#{result_hash[:error].backtrace.join($/)}"
+      to_console "Error:#{$/}#{result_hash[:result].message}"
     end
     
     def to_console(message)

data/lib/hot_or_not/comparison_result.rb

@@ -1,17 +1,11 @@
 module HotOrNot
   class ComparisonResult
 
-    DEFAULT_OPTIONS = { :method => :get }
     class << self
       def for(compare_url)
-        options = DEFAULT_OPTIONS.merge compare_url.options
-        new compare_url, retreive(compare_url.side_a, options), retreive(compare_url.side_b, options)
-      end
-
-      private
-      def retreive(url, options)
-        options[:url] = url
-        RestClient::Request.execute(options).tap { |r| raise Exception.new("Invalid response code #{r.code} for '#{url}'") unless r.code.to_s == '200' }
+        side_a_result = UrlResult.retrieve_for compare_url.side_a, compare_url.options
+        side_b_result = UrlResult.retrieve_for compare_url.side_b, compare_url.options
+        new compare_url, side_a_result, side_b_result
       end
     end
 
@@ -20,11 +14,17 @@ module HotOrNot
     def initialize(compare_url, side_a_results, side_b_results)
       @compare_url, @side_a_results, @side_b_results = compare_url, side_a_results, side_b_results
       @message, @diff = '', ''
-      init
+      init_message unless success?
     end
 
     def success?
-      @success
+      !error? &&
+        @side_a_results.code == @side_b_results.code &&
+        side_a_body == side_b_body
+    end
+
+    def error?
+      @side_a_results.error? || @side_b_results.error?
     end
 
     def side_a_body
@@ -46,17 +46,24 @@ module HotOrNot
     end
 
     private
-    def init
-      return if @success = side_a_body == side_b_body
-      @message = "#{@compare_url.full_name}: #{@compare_url.url}: Body from #{@compare_url.base_a} did not match body from #{@compare_url.base_b}"
-      @diff = Diffy::Diff.new(side_a_body, side_b_body)
+    def init_message
+      @message = if error?
+                   message = "#{@compare_url.full_name}: #{@compare_url.url}: Error retrieving body"
+                   message += "#{$/}  #{@compare_url.base_a} => #{@side_a_results.error_message}" if @side_a_results.error?
+                   message += "#{$/}  #{@compare_url.base_b} => #{@side_b_results.error_message}" if @side_b_results.error?
+                   message
+                 else
+                   @diff = Diffy::Diff.new(side_a_body, side_b_body)
+                   "#{@compare_url.full_name}: #{@compare_url.url}: Body from #{@compare_url.base_a} did not match body from #{@compare_url.base_b}"
+                 end
     end
 
     def body_by_content_type(result)
       case result.headers[:content_type]
       when /json/i
-        h = JSON.parse result.body
-        JSON.pretty_generate h
+        json = JSON.parse result.body
+        json.sort!
+        JSON.pretty_generate json
       else
         result.body
       end

data/lib/hot_or_not/ext/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def <=> other
+    self.sort.to_s <=> other.sort.to_s
+  end
+end

data/lib/hot_or_not/runner.rb

@@ -11,15 +11,13 @@ module HotOrNot
     def run!
       @announcer.starting
       @urls.each do |url|
-        begin
-          result = ComparisonResult.for url
-          if result.success?
-            @announcer.announce_success result
-          else
-            @announcer.announce_failure result
-          end
-        rescue StandardError, Exception => e
-          @announcer.announce_error url, e
+        result = ComparisonResult.for url
+        if result.success?
+          @announcer.announce_success result
+        elsif result.error?
+          @announcer.announce_error result
+        else
+          @announcer.announce_failure result
         end
       end
       @announcer.ending

data/lib/hot_or_not/url_result.rb

@@ -0,0 +1,43 @@
+module HotOrNot
+  class UrlResult
+    extend Forwardable
+
+    DEFAULT_OPTIONS = { :method => :get }
+
+    class << self
+      def retrieve_for(url, options)
+        options = DEFAULT_OPTIONS.merge options
+        options[:url] = url
+        response, error = nil, nil
+        begin
+          response = RestClient::Request.execute(options)
+        rescue RestClient::Exception => e
+          error = e
+        end
+
+        new url, response, error
+      end
+    end
+
+    attr_reader :url
+    def_delegators :@response, :code, :body, :headers
+
+    def initialize(url, response, error)
+      @url, @error = url, error
+      @response = response || error.response
+    end
+
+    def success?
+      @error.nil?
+    end
+
+    def error?
+      !success?
+    end
+
+    def error_message
+      "The url #{@url} received error: #{@error.message}"
+    end
+
+  end
+end

data/lib/hot_or_not.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'forwardable'
 
 require 'rest-client'
 require 'diffy'

data/test/compare_url_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
 
 module HotOrNot
   class CompareUrlTest < Test::Unit::TestCase
@@ -62,7 +62,7 @@ module HotOrNot
         @compare_url = CompareUrl.new 'Foo Url', '/api/foo', 'http://side_a', 'http://side_b', :headers => { 'authorization' => 'baz321' }
       end
 
-      should "read provid options as passed in" do
+      should "read provided options as passed in" do
         expected_options = { :headers => { 'authorization' => 'baz321' } }
         assert_equal expected_options, @compare_url.options
       end

data/test/comparison_result_test.rb

@@ -1,51 +1,99 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
 
 module HotOrNot
   class ComparisonResultTest < Test::Unit::TestCase
-    context "comparing results" do
+    context "" do
       setup do
         @compare_url = CompareUrl.new 'Test People', '/api/people', 'http://side_a', 'http://side_b'
       end
 
-      context "500 error" do
-        setup do
-          RestClient::Request.expects(:execute).with(:method => :get, :url => @compare_url.side_a).returns FakeResponse.new('foo', 500)
-        end
-
-        should "raise error when response code is not 200" do
-          assert_raises(Exception) {  ComparisonResult.for @compare_url }
-        end
-      end
-
-      context "when results match" do
+      context "building from compare url" do
         setup do
+          @compare_url = CompareUrl.new 'Test People', '/api/people', 'http://side_a', 'http://side_b'
           RestClient::Request.expects(:execute).with(:method => :get, :url => @compare_url.side_a).returns FakeResponse.new 'foo'
           RestClient::Request.expects(:execute).with(:method => :get, :url => @compare_url.side_b).returns FakeResponse.new 'foo'
-          @result = ComparisonResult.for @compare_url
         end
 
-        should "return success" do
-          assert @result.success?
+        should "not throw an exception when building" do
+          assert_nothing_raised { ComparisonResult.for @compare_url }
         end
       end
 
-      context "when results don't match" do
-        setup do
-          RestClient::Request.expects(:execute).with(:method => :get, :url => @compare_url.side_a).returns FakeResponse.new 'side_a'
-          RestClient::Request.expects(:execute).with(:method => :get, :url => @compare_url.side_b).returns FakeResponse.new 'side_b'
-          @result = ComparisonResult.for @compare_url
-        end
+      context "comparing results" do
+
+        context "when results match" do
+          context "and are strings" do
+            setup do
+              response = FakeResponse.new 'foo'
+              side_a_results = UrlResult.new @compare_url.side_a, response, nil
+              side_b_results = UrlResult.new @compare_url.side_b, response, nil
+              @result = ComparisonResult.new @compare_url, side_a_results, side_b_results
+            end
 
-        should "not return success" do
-          assert_not @result.success?
+            should "return success" do
+              assert @result.success?
+            end
+          end
+
+          context "and are json" do
+            setup do
+              hash1 = {'a'=>1,'b'=>2}
+              hash2 = {'a'=>3,'b'=>4}
+              response_a = FakeResponse.new [hash1, hash2].to_json, 200, :content_type => 'application/json'
+              response_b = FakeResponse.new [hash2, hash1].to_json, 200, :content_type => 'application/json'
+              side_a_results = UrlResult.new @compare_url.side_a, response_a, nil
+              side_b_results = UrlResult.new @compare_url.side_b, response_b, nil
+              @result = ComparisonResult.new @compare_url, side_a_results, side_b_results
+            end
+
+            should "return success" do
+              assert @result.success?
+            end
+          end
         end
 
-        should "have test unit style failure message" do
-          assert_match @result.message, /Test People:.*?\/api\/people/
+        context "when results don't match" do
+          setup do
+            response_a = FakeResponse.new 'side_a'
+            response_b = FakeResponse.new 'side_b'
+            side_a_results = UrlResult.new @compare_url.side_a, response_a, nil
+            side_b_results = UrlResult.new @compare_url.side_b, response_b, nil
+            @result = ComparisonResult.new @compare_url, side_a_results, side_b_results
+          end
+
+          should "not return success" do
+            assert_not @result.success?
+          end
+
+          should "have test unit style failure message" do
+            assert_match /Test People:.*?\/api\/people/, @result.message
+          end
+
+          should "provide a diff" do
+            assert_present @result.diff
+          end
         end
 
-        should "provide a diff" do
-          assert_present @result.diff
+        context "when one result has an error" do
+          setup do
+            response_a = FakeResponse.new 'side_a'
+            error_b = RestClient::InternalServerError.new
+            side_a_results = UrlResult.new @compare_url.side_a, response_a, nil
+            side_b_results = UrlResult.new @compare_url.side_b, nil, error_b
+            @result = ComparisonResult.new @compare_url, side_a_results, side_b_results
+          end
+
+          should "not return success" do
+            assert_not @result.success?
+          end
+
+          should "return error" do
+            assert @result.error?
+          end
+
+          should "have a message containing the error" do
+            assert_match /#{@compare_url.side_b}.*?: Internal Server Error/, @result.message
+          end
         end
       end
     end

data/test/console_announcer_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
 
 module HotOrNot
   class ConsoleAnnouncerTest < Test::Unit::TestCase

data/test/runner_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
 
 module HotOrNot
   class RunnerTest < Test::Unit::TestCase
@@ -27,7 +27,7 @@ module HotOrNot
           @messages[:failure] = true
         end
 
-        def announce_error(url, error)
+        def announce_error(result)
           @messages[:error] = true
         end
       end.new
@@ -77,7 +77,7 @@ module HotOrNot
       end
     end
 
-    context "error during comparison" do
+    context "error during retreival" do
       setup do
         urls = [mock_compare_url('Foo', '/api/foo', 'foo', 'bar', 404)]
         Runner.new(urls, @announcer).run!

data/test/test_helper.rb

@@ -26,7 +26,7 @@ module HotOrNot
 end
 
 class Test::Unit::TestCase
-  def assert_false(truth, message=nil)
+  def assert_false(truth, message='')
     assert !truth, message
   end
   alias_method :assert_not, :assert_false
@@ -37,10 +37,24 @@ class Test::Unit::TestCase
   end
 
   private
-  def mock_compare_url(name, url, body_a, body_b, code='200')
+  def mock_compare_url(name, url, body_a, body_b, code_a=200, code_b=200)
     HotOrNot::CompareUrl.new(name, url, 'http://side_a', 'http://side_b').tap do |compare_url|
-      RestClient::Request.expects(:execute).with(:method => :get, :url => compare_url.side_a).returns HotOrNot::FakeResponse.new(body_a, code)
-      RestClient::Request.expects(:execute).with(:method => :get, :url => compare_url.side_b).returns HotOrNot::FakeResponse.new(body_b, code) if code.to_s == '200'
+      response_a, error_a = response_and_error_for body_a, code_a
+      response_b, error_b = response_and_error_for body_b, code_b
+      side_a_result = HotOrNot::UrlResult.new compare_url.side_a, response_a, error_a
+      side_b_result = HotOrNot::UrlResult.new compare_url.side_b, response_b, error_b
+      HotOrNot::ComparisonResult.expects(:for).with(compare_url).returns HotOrNot::ComparisonResult.new(compare_url, side_a_result, side_b_result)
     end
   end
+
+  def response_and_error_for(body, code)
+    response, error = nil, nil
+    code = code.to_i
+    if code == 200
+      response = HotOrNot::FakeResponse.new body
+    else
+      error = RestClient::Exceptions::EXCEPTIONS_MAP[code].new
+    end
+    [response, error]
+  end
 end

data/test/url_result_test.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
+
+module HotOrNot
+  class UrlResultTest < Test::Unit::TestCase
+    context "error" do
+      setup do
+        @url = 'http://url/request/test'
+        exception = RestClient::InternalServerError.new
+        RestClient::Request.expects(:execute).with(:method => :get, :url => @url).raises exception
+      end
+
+      should "not raise error on 500" do
+        assert_nothing_raised { UrlResult.retrieve_for @url, {} }
+      end
+
+      should "report as error" do
+        result = UrlResult.retrieve_for @url, {}
+        assert result.error?
+        assert_false result.success?
+      end
+
+      should "report the error message" do
+        result = UrlResult.retrieve_for @url, {}
+        assert_match /error: Internal Server Error/, result.error_message
+      end
+    end
+
+    context "successfull response" do
+      setup do
+        @url = 'http://url/request/test'
+        RestClient::Request.expects(:execute).with(:method => :get, :url => @url).returns FakeResponse.new 'hello', 200
+        @result = UrlResult.retrieve_for @url, {}
+      end
+
+      should "report success" do
+        assert @result.success?
+      end
+
+      should "return the body" do
+        assert_equal 'hello', @result.body
+      end
+
+      should "return the http response code" do
+        assert_equal 200, @result.code
+      end
+
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hot_or_not
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joel Friedman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 -05:00
+date: 2011-06-16 00:00:00 -05:00
 default_executable: hot_or_not
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -163,7 +163,9 @@ files:
 - lib/hot_or_not/announcers/console_announcer.rb
 - lib/hot_or_not/compare_url.rb
 - lib/hot_or_not/comparison_result.rb
+- lib/hot_or_not/ext/hash.rb
 - lib/hot_or_not/runner.rb
+- lib/hot_or_not/url_result.rb
 - test/compare_url_test.rb
 - test/comparison_result_test.rb
 - test/console_announcer_test.rb
@@ -171,6 +173,7 @@ files:
 - test/data/simple_urls.yml.erb
 - test/runner_test.rb
 - test/test_helper.rb
+- test/url_result_test.rb
 has_rdoc: true
 homepage: https://github.com/joelash/hot_or_not
 licenses: