apirunner 0.3.3 → 0.3.4

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/apirunner.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apirunner}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jan@moviepilot.com"]
-  s.date = %q{2010-10-01}
+  s.date = %q{2010-10-07}
   s.description = %q{apirunner is a testsuite to query your RESTful JSON API and match response with your defined expectations}
   s.email = %q{developers@moviepilot.com}
   s.extra_rdoc_files = [
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
     "lib/apirunner.rb",
     "lib/apirunner/railtie.rb",
     "lib/checker.rb",
+    "lib/core_extensions.rb",
     "lib/expectation_matcher.rb",
     "lib/http_client.rb",
     "lib/plugins/response_body_checker.rb",

data/lib/api_runner.rb

@@ -4,6 +4,8 @@ class ApiRunner
   require 'http_client'
   require 'api_configuration'
   require 'testcase'
+  require 'core_extensions'
+  include CoreExtensions
 
   CONFIG_FILE = "config/api_runner.yml"
   SPEC_PATH = "test/api_runner/"
@@ -41,15 +43,16 @@ class ApiRunner
   def run_tests
     puts "Running exactly #{@spec.size} tests."
     @spec.each do |test_case|
+      sleep test_case.wait_before_request
       response = send_request_for(test_case)
-      @expectation.test_types.each do |test_type|
-        result = @expectation.check(test_type, response, test_case)
-        if not result.succeeded
+      Checker.available_plugins.each do |plugin|
+        result = @expectation.check(plugin, response, test_case)
+        if not result.success?
           putc "F"
           @results << result
           break
         else
-          if test_type == @expectation.test_types.last
+          if plugin == Checker.available_plugins.last
             @results << result
             putc "."
           end

data/lib/checker.rb

@@ -1,5 +1,7 @@
 class Checker
 
+  @@children = []
+
   def initialize(testcase, response, excludes=nil)
     @testcase = testcase
     @response = response
@@ -12,7 +14,18 @@ class Checker
     result = Result.new(@testcase, @response)
   end
 
-private
+  # returns a list of symbolized plugin names
+  def self.available_plugins
+    return @@children.map{ |child| child.to_s }
+  end
+
+  private
+
+  # tracks all children of this class
+  # this way plugins can be loaded automagically
+  def self.inherited(child)
+    @@children << child
+  end
 
   # recursively parses the tree and returns a set of relative pathes
   # that can be used to match the both trees leafs

data/lib/core_extensions.rb

@@ -0,0 +1,17 @@
+module CoreExtensions
+  class String
+    # generates filenames from classnames the rails way
+    def underscore(string)
+      string.to_s.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
+    end
+
+    # opposites underscore defined above
+    def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+      if first_letter_in_uppercase
+        lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+      else
+        lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
+      end
+    end
+  end
+end

data/lib/expectation_matcher.rb

@@ -1,45 +1,30 @@
 class ExpectationMatcher
   require 'result'
   require 'checker'
-  require 'plugins/response_json_syntax_checker'
-  require 'plugins/response_header_checker'
-  require 'plugins/response_code_checker'
-  require 'plugins/response_body_checker'
+
+  # dynamically load plugins
+  dir = File.dirname(__FILE__) + '/plugins/'
+  $LOAD_PATH.unshift(dir)
+  Dir[File.join(dir, "*.rb")].each {|file| require File.basename(file) }
 
   def initialize(excludes=nil)
-    @test_types = [:response_code, :response_json_syntax, :response_header, :response_body]
     @excludes = excludes || []
   end
 
-  # returns the available test types if this matcher class
-  def test_types
-    return @test_types
-  end
-
   # dispatches incoming matching requests
-  def check(method, response, testcase)
-    self.send(method, response, testcase)
+  def check(plugin, response, testcase)
+    self.send(plugin.underscore, response, testcase)
   end
 
-private
-
-  # matches the given response code
-  def response_code(response, testcase)
-    ResponseCodeChecker.new(testcase, response).check
+  # dynamically generates methods that invoke "check" on all available plugins
+  def self.initialize_plugins
+    Checker.available_plugins.each do |plugin|
+      define_method(plugin.underscore) do |response, testcase|
+        eval(plugin).new(testcase, response, @excludes).check
+      end
+      private plugin.underscore.to_sym
+    end
   end
 
-  # checks the format of the given data of JSON conformity
-  def response_json_syntax(response, testcase)
-    ResponseJsonSyntaxChecker.new(testcase, response).check
-  end
-
-  # matches the given response header
-  def response_header(response, testcase)
-    ResponseHeaderChecker.new(testcase, response, @excludes).check
-  end
-
-  # matches the given attributes and values against the ones from the response body
-  def response_body(response, testcase)
-    ResponseBodyChecker.new(testcase, response, @excludes).check
-  end
+  initialize_plugins
 end

data/lib/plugins/response_body_checker.rb

@@ -1,64 +1,68 @@
 class ResponseBodyChecker < Checker
-require 'nokogiri'
+  require 'nokogiri'
 
   def check
     result = Result.new(@testcase, @response)
-
-    # special case: the whole body has to be matched via a regular expression
-    if is_regex?(@testcase.response_expectation['body'])
-      if not regex_matches?(@testcase.response_expectation['body'], @response.body)
-        result.succeeded = false
-        result.error_message = " expected the whole body to match regex --#{@testcase.response_expectation['body']}--\n got --#{@response.body}--"
-      end
-      return result
-    end
-
-    expected_body_hash = @testcase.response_expectation['body']
-
-    # in case we have no body expectation we simply return success
-    return result if expected_body_hash.nil?
-
-    # in case the response body is nil or damaged we return an error
     begin
-      responded_body_hash = JSON.parse(@response.body)
-    rescue
-      result = Result.new(@testcase, @response)
-      result.succeeded = false
-      result.error_message = " expected response to have a body\n got raw body --#{@response.body}-- which is nil or an unparseable hash"
-      return result
-    end
-
-    # else we build trees from both body structures...
-    expectation_tree = Nokogiri::XML(expected_body_hash.to_xml({ :indent => 0 }))
-    response_tree = Nokogiri::XML(responded_body_hash.to_xml({ :indent => 0 }))
+      # special case: the whole body has to be matched via a regular expression
+      if is_regex?(@testcase.response_expectation['body'])
+        if not regex_matches?(@testcase.response_expectation['body'], @response.body)
+          result.succeeded = false
+          result.error_message = " expected the whole body to match regex --#{@testcase.response_expectation['body']}--\n got --#{@response.body}--"
+        end
+        return result
+      end
 
-    # retrieve all the leafs pathes and match the leafs values using xpath
-    matcher_pathes_from(expectation_tree).each do |path|
-      expectation_node = expectation_tree.xpath(path).first
-      response_node = response_tree.xpath(path).first
+      expected_body_hash = @testcase.response_expectation['body']
 
-      # in some (not awesome) cases the root node occures as leaf, so we have to skip him here
-      next if expectation_node.name == "hash"
+      # in case we have no body expectation we simply return success
+      return result if expected_body_hash.nil?
 
-      # return error if response body does not have the expected entry
-      if response_node.nil?
+      # in case the response body is nil or damaged we return an error
+      begin
+        responded_body_hash = JSON.parse(@response.body)
+      rescue
+        result = Result.new(@testcase, @response)
         result.succeeded = false
-        result.error_message = " expected body to have identifier --#{expectation_node.name}--\n got nil"
+        result.error_message = " expected response to have a body\n got raw body --#{@response.body}-- which is nil or an unparseable hash"
         return result
       end
 
-      # last but not least try the regex or direct match and return errors in case of any
-      if is_regex?(expectation_node.text)
-        if not (excluded?(expectation_node.name) or regex_matches?(expectation_node.text, response_node.text))
+      # else we build trees from both body structures...
+      expectation_tree = Nokogiri::XML(expected_body_hash.to_xml({ :indent => 0 }))
+      response_tree = Nokogiri::XML(responded_body_hash.to_xml({ :indent => 0 }))
+
+      # retrieve all the leafs pathes and match the leafs values using xpath
+      matcher_pathes_from(expectation_tree).each do |path|
+        expectation_node = expectation_tree.xpath(path).first
+        response_node = response_tree.xpath(path).first
+
+        # in some (not awesome) cases the root node occures as leaf, so we have to skip him here
+        next if expectation_node.name == "hash"
+
+        # return error if response body does not have the expected entry
+        if response_node.nil?
           result.succeeded = false
-          result.error_message = " expected body identifier --#{expectation_node.name}-- to match regex --#{expectation_node.text}--\n got --#{response_node.text}--"
+          result.error_message = " expected body to have identifier --#{expectation_node.name}--\n got nil"
+          return result
         end
-      else
-        if not (excluded?(expectation_node.name) or string_matches?(expectation_node.text, response_node.text))
-          result.succeeded = false
-          result.error_message = " expected body identifier --#{expectation_node.name}-- to match --#{expectation_node.text}--\n got --#{response_node.text}--"
+
+        # last but not least try the regex or direct match and return errors in case of any
+        if is_regex?(expectation_node.text)
+          if not (excluded?(expectation_node.name) or regex_matches?(expectation_node.text, response_node.text))
+            result.succeeded = false
+            result.error_message = " expected body identifier --#{expectation_node.name}-- to match regex --#{expectation_node.text}--\n got --#{response_node.text}--"
+          end
+        else
+          if not (excluded?(expectation_node.name) or string_matches?(expectation_node.text, response_node.text))
+            result.succeeded = false
+            result.error_message = " expected body identifier --#{expectation_node.name}-- to match --#{expectation_node.text}--\n got --#{response_node.text}--"
+          end
         end
       end
+    rescue
+      result.succeeded = false
+      result.error_message = " unexpected error while parsing testcase/response. Check your testcase format!"
     end
     result
   end

data/lib/plugins/response_code_checker.rb

@@ -3,9 +3,14 @@ class ResponseCodeChecker < Checker
   # checks the given responses status code against the one in the expectation and returns result object
   def check
     result = Result.new(@testcase, @response)
-    if not @testcase.response_expectation['status_code'].to_s == @response.code.to_s
+    begin
+      if not @testcase.response_expectation['status_code'].to_s == @response.code.to_s
+        result.succeeded = false
+        result.error_message = " expected response code --#{@testcase.response_expectation['status_code']}--\n got response code --#{@response.code}--"
+      end
+    rescue
       result.succeeded = false
-      result.error_message = " expected response code --#{@testcase.response_expectation['status_code']}--\n got response code --#{@response.code}--"
+      result.error_message = " unexpected error while parsing testcase/response. Check your testcase format!"
     end
     result
   end

data/lib/plugins/response_header_checker.rb

@@ -3,19 +3,24 @@ class ResponseHeaderChecker < Checker
   # checks given header against the given expepctation and returns a result object
   def check
     result = Result.new(@testcase, @response)
-    @testcase.response_expectation['headers'].each_pair do |header_name, header_value|
-      if is_regex?(header_value)
-        if not (excluded?(header_name) or regex_matches?(header_value, @response.headers[header_name]))
-          result.succeeded = false
-          result.error_message = " expected header identifier --#{header_name}-- to match regex --#{header_value}--\n got --#{@response.headers[header_name]}--"
+    begin
+      @testcase.response_expectation['headers'].each_pair do |header_name, header_value|
+        if is_regex?(header_value)
+          if not (excluded?(header_name) or regex_matches?(header_value, @response.headers[header_name]))
+            result.succeeded = false
+            result.error_message = " expected header identifier --#{header_name}-- to match regex --#{header_value}--\n got --#{@response.headers[header_name]}--"
+          end
+        else
+          if not (excluded?(header_name) or string_matches?(header_value, @response.headers[header_name]))
+            result.succeeded = false
+            result.error_message = " expected header identifier --#{header_name}-- to match --#{header_value}--\n got --#{@response.headers[header_name]}--"
+          end
         end
-      else
-        if not (excluded?(header_name) or string_matches?(header_value, @response.headers[header_name]))
-          result.succeeded = false
-          result.error_message = " expected header identifier --#{header_name}-- to match --#{header_value}--\n got --#{@response.headers[header_name]}--"
-        end
-      end
-    end unless (@testcase.response_expectation['headers'].nil? or @testcase.response_expectation['headers'].empty?)
+      end unless (@testcase.response_expectation['headers'].nil? or @testcase.response_expectation['headers'].empty?)
+    rescue
+      result.succeeded = false
+      result.error_message = " unexpected error while parsing testcase/response. Check your testcase format!"
+    end
     result
   end
 

data/lib/result.rb

@@ -15,6 +15,10 @@ class Result
     self.send(verbosity.to_sym, index)
   end
 
+  def success?
+    return @succeeded
+  end
+
   private
 
   # yields out rspec like error messages only in case of an error

data/lib/testcase.rb

@@ -1,12 +1,13 @@
 class Testcase
 
-  attr_reader :raw, :name, :request, :response_expectation
+  attr_reader :raw, :name, :request, :response_expectation, :wait_before_request
 
   def initialize(raw)
     @raw = raw
     @name = raw['name']
     @request = @raw['request']
     @response_expectation = @raw['response_expectation']
+    @wait_before_request = @raw['wait_before_request'].nil? ? 0 : @raw['wait_before_request']
   end
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - jan@moviepilot.com
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-01 00:00:00 +02:00
+date: 2010-10-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -234,6 +234,7 @@ files:
 - lib/apirunner.rb
 - lib/apirunner/railtie.rb
 - lib/checker.rb
+- lib/core_extensions.rb
 - lib/expectation_matcher.rb
 - lib/http_client.rb
 - lib/plugins/response_body_checker.rb
@@ -262,7 +263,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4136234197952524477
+      hash: -3679568694912151594
       segments: 
       - 0
       version: "0"