api-tester 0.1.0 → 1.1.1

data/lib/tester/method_case_test.rb

@@ -1,67 +0,0 @@
-require 'tester/util/response_evaluator.rb'
-
-class MethodCaseTest
-    attr_accessor :expected_response
-    attr_accessor :payload
-    attr_accessor :response
-    attr_accessor :reports
-    attr_accessor :url
-    attr_accessor :module_name
-
-    def initialize response, payload, expected_response, url, verb, module_name
-        self.payload = payload
-        self.response = response
-        self.expected_response = expected_response
-        self.reports = []
-        self.url = "#{verb} #{url}"
-        self.module_name = module_name
-    end
-
-    def response_code_report
-        report = StatusCodeReport.new "#{module_name} - Incorrect response code", self.url, self.payload, self.expected_response.code, self.response.code
-        self.reports << report
-        nil
-    end
-
-    def missing_field_report field
-        report = Report.new "#{module_name} - Missing field #{field}", self.url, self.payload, self.expected_response, self.response
-        self.reports << report
-        nil
-    end
-
-    def extra_field_report field
-        report = Report.new "#{module_name} - Found extra field #{field}", self.url, self.payload, self.expected_response, self.response
-        self.reports << report
-        nil
-    end
-
-    def check
-        if check_response_code
-            evaluator = ResponseEvaluator.new json_parse(self.response.body), self.expected_response
-            evaluator.missing_fields.map{|field| missing_field_report(field)}
-            evaluator.extra_fields.map{|field| extra_field_report(field)}
-            increment_fields evaluator.seen_fields
-        end
-        return self.reports
-    end
-
-    def check_response_code
-        if response.code != expected_response.code
-            response_code_report
-            return false
-        end
-        return true
-    end
-
-    def increment_fields seen_fields
-        seen_fields.each do |field|
-            field.seen
-        end
-    end
-
-    def json_parse body
-        JSON.parse!(body)
-      rescue JSON::ParserError
-        body
-    end
-end

data/lib/tester/modules/extra_verbs.rb

@@ -1,25 +0,0 @@
-require 'tester/modules/module'
-require 'tester/util/supported_verbs'
-
-class ExtraVerbs < Module
-  def go(endpoint, report)
-    super
-
-    extras = SupportedVerbs.all - endpoint.verbs
-    extras.each do |verb|
-      verb_case = BoundaryCase.new("Verb check with #{verb} for #{endpoint.name}", {}, {})
-      method = ApiMethod.new verb, Response.new, Request.new
-      response = endpoint.call method, verb_case.payload, verb_case.headers
-      test = VerbClass.new response, verb_case.payload, endpoint.not_allowed_response, endpoint.url, verb
-      reports = test.check
-      self.report.reports.concat reports
-    end
-    self.report.reports == []
-  end
-end
-
-class VerbClass < MethodCaseTest
-    def initialize response, payload, expected_response, url, verb
-        super response, payload, expected_response, url, verb, "VerbModule"
-    end
-end

data/lib/tester/modules/format.rb

@@ -1,26 +0,0 @@
-require 'tester/reporter/status_code_report'
-require 'tester/modules/module'
-require 'tester/method_case_test'
-
-class Format < Module
-  def go definition, report
-    super
-
-    definition.methods.each do |method|
-      cases = method.request.cases
-      cases.each do |format_case|
-        response = definition.call method, format_case.payload, format_case.headers
-        test = FormatTest.new response, format_case.payload, definition.bad_request_response, definition.url, method.verb
-        self.report.reports.concat test.check
-      end
-    end
-
-    report.reports == []
-  end
-end
-
-class FormatTest < MethodCaseTest
-    def initialize response, payload, expected_response, url, verb
-        super response, payload, expected_response, url, verb, "FormatModule"
-    end
-end

data/lib/tester/modules/good_case.rb

@@ -1,29 +0,0 @@
-require 'tester/reporter/status_code_report'
-require 'tester/modules/module'
-require 'tester/method_case_test'
-
-class GoodCase < Module
-    def go endpoint, report
-        super
-
-        endpoint.methods.each do |method|
-            default_case = BoundaryCase.new endpoint.url, method.request.default_payload, method.request.default_headers
-            response = endpoint.call method, default_case.payload, default_case.headers
-            test = GoodCaseTest.new response, endpoint.url, method
-            self.report.reports.concat test.check
-        end
-
-        self.report.reports == []
-    end
-
-    def order
-        1
-    end
-end
-
-
-class GoodCaseTest < MethodCaseTest
-    def initialize response, url, method
-        super response, method.request.default_payload, method.expected_response, url, method.verb, "GoodCaseModule"
-    end
-end

data/lib/tester/modules/module.rb

@@ -1,18 +0,0 @@
-require 'tester/reporter/status_code_report'
-require 'tester/test_helper'
-
-class Module
-  attr_accessor :report
-
-  def set_report report
-    self.report = report
-  end
-
-  def go definition, report
-    set_report report
-  end
-
-  def order
-    5
-  end
-end

data/lib/tester/modules/typo.rb

@@ -1,41 +0,0 @@
-require 'tester/reporter/status_code_report'
-require 'tester/modules/module'
-require 'tester/util/supported_verbs'
-
-class Typo < Module
-    def go(endpoint, report)
-        super
-
-        allowances(endpoint).each do |verbs|
-            check_typo_url endpoint
-        end
-
-        report.reports == []
-    end
-
-    def check_typo_url endpoint
-        bad_url = "#{endpoint.url}gibberishadsfasdf"
-        bad_endpoint = Endpoint.new "Bad URL", bad_url
-        typo_case = BoundaryCase.new("Typo URL check", {}, {})
-        method = ApiMethod.new SupportedVerbs::GET, Response.new(200), Request.new
-        response = bad_endpoint.call method, typo_case.payload, typo_case.headers
-
-        test = TypoClass.new response, typo_case.payload, endpoint.not_found_response, bad_url, SupportedVerbs::GET
-            reports = test.check
-        self.report.reports.concat reports
-    end
-
-    def allowances(endpoint)
-        allowances = []
-        endpoint.methods.each do |method|
-            allowances << method.verb
-        end
-        allowances.uniq
-    end
-end
-
-class TypoClass < MethodCaseTest
-    def initialize response, payload, expected_response, url, verb
-        super response, payload, expected_response, url, verb, "TypoModule"
-    end
-end

data/lib/tester/modules/unused_fields.rb

@@ -1,22 +0,0 @@
-require 'tester/reporter/missing_response_field_report'
-require 'tester/modules/module'
-
-class UnusedFields < Module
-  def go definition, report
-    super
-
-    definition.methods.each do |method|
-      method.expected_response.body.each do |field|
-        if field.is_seen == 0
-          report.add_new_report MissingResponseFieldReport.new(definition.url, method.verb, field.name, "UnusedFieldsModule")
-        end
-      end
-    end
-
-    report.reports == []
-  end
-
-  def order
-    99
-  end
-end

data/lib/tester/reporter/api_report.rb

@@ -1,33 +0,0 @@
-require 'tester/reporter/report'
-
-class ApiReport
-  attr_accessor :reports
-
-  def initialize
-    self.reports = []
-  end
-
-  def add_new url, request, expected_response, actual_response, description="A case"
-    report = Report.new description, url, request, expected_response, actual_response
-    self.reports << report
-  end
-
-  def add_new_report report
-    self.reports << report
-  end
-
-  def print
-    if self.reports.size > 0
-      puts "Issues discovered: #{self.reports.size}"
-      self.reports.each do |report|
-        report.print
-        puts "\n"
-        puts "\n"
-      end
-      puts ""
-      puts "Issues discovered: #{self.reports.size}"
-    else
-      puts "No issues found"
-    end
-  end
-end

data/lib/tester/reporter/missing_field_report.rb

@@ -1,23 +0,0 @@
-class MissingFieldReport
-  attr_accessor :description
-  attr_accessor :url
-  attr_accessor :request
-  attr_accessor :expected_field
-  attr_accessor :actual_response
-
-  def initialize(description, url, request, expected_field)
-    self.description = description
-    self.url = url
-    self.request = request
-    self.expected_field = expected_field
-    self.actual_response = ''
-  end
-
-  def print
-    puts "#{self.description}: "
-    puts "   Requested #{self.url} with payload:"
-    puts "      #{self.request}"
-    puts '   Missing field: '
-    puts "      #{self.expected_field}"
-  end
-end

data/lib/tester/reporter/missing_response_field_report.rb

@@ -1,19 +0,0 @@
-class MissingResponseFieldReport
-  attr_accessor :url
-  attr_accessor :verb
-  attr_accessor :expected_field
-  attr_accessor :description
-
-  def initialize(url, verb, expected_field, description)
-    self.url = url
-    self.verb = verb
-    self.expected_field = expected_field
-    self.description = description
-  end
-
-  def print
-    puts "#{self.description}:"
-    puts "   #{self.verb} #{self.url} is missing response field:"
-    puts "      #{self.expected_field}"
-  end
-end

data/lib/tester/reporter/report.rb

@@ -1,25 +0,0 @@
-class Report
-  attr_accessor :description
-  attr_accessor :url
-  attr_accessor :request
-  attr_accessor :expected_response
-  attr_accessor :actual_response
-
-  def initialize description, url, request, expected_response, actual_response
-    self.description = description
-    self.url = url
-    self.request = request
-    self.expected_response = expected_response
-    self.actual_response = actual_response
-  end
-
-  def print
-    puts "#{self.description}: "
-    puts "   Requested #{self.url} with payload:"
-    puts "      #{self.request.to_json}"
-    puts "   Expecting: "
-    puts "      " + self.expected_response.to_s
-    puts "   Receiving: "
-    puts "      #{self.actual_response}"
-  end
-end

data/lib/tester/reporter/status_code_report.rb

@@ -1,12 +0,0 @@
-require 'tester/reporter/report'
-
-class StatusCodeReport < Report
-  attr_accessor :expected_status_code
-  attr_accessor :actual_status_code
-
-  def initialize description, url, request, expected_status_code, actual_status_code
-    super description, url, request, expected_status_code, actual_status_code
-    self.expected_status_code = expected_status_code
-    self.actual_status_code = actual_status_code
-  end
-end

data/lib/tester/test_helper.rb

@@ -1,10 +0,0 @@
-class TestHelper
-    def before
-    end
-
-    def retrieve_param key       
-    end
-
-    def after
-    end
-end

data/lib/tester/util/response_evaluator.rb

@@ -1,73 +0,0 @@
-class ResponseEvaluator
-    attr_accessor :response_body
-    attr_accessor :expected_response
-
-    def initialize(actual_response_body, expected_response_fields)
-        self.response_body = actual_response_body
-        self.expected_response = expected_response_fields
-    end
-
-    def response_field_array
-        field_array self.response_body
-    end
-
-    def expected_fields
-        expected_fields_hash.keys
-    end
-
-    def seen_fields
-        seen = []
-        fields = response_field_array - extra_fields
-        expected = expected_fields_hash
-        fields.each do |field_key|
-            seen << expected[field_key]
-        end
-        seen
-    end
-
-    def expected_fields_hash
-        expected_field_array self.expected_response.body
-    end
-
-    def extra_fields
-        response_field_array - expected_fields
-    end
-
-    def missing_fields
-        expected_fields - response_field_array
-    end
-
-    def expected_field_array expected_fields
-        fields = {}
-        expected_fields.each do |field|
-            fields[field.name] = field
-            fields = fields.merge inner_expected_field(field.fields, field.name)
-        end
-        fields
-    end
-
-    def inner_expected_field expected_fields, name
-        fields = {}
-        expected_fields.each do |field|
-            inner_name = "#{name}.#{field.name}"
-            fields[inner_name] = field
-            fields = fields.merge inner_expected_field(field.fields, inner_name)
-        end
-        fields
-    end
-
-    def field_array object
-        fields = []
-        object.each do |key, value|
-            if(value)
-                fields << key.to_s
-                fields.concat(field_array(value).map{|i| "#{key}.#{i}"})
-            else
-                fields.concat(field_array(key))
-            end
-        end
-        fields
-       rescue NoMethodError
-        fields
-    end
-end

data/lib/tester/util/supported_verbs.rb

@@ -1,34 +0,0 @@
-class SupportedVerbs
-  def SupportedVerbs.add_item(key, value)
-    @hash ||= {}
-    @hash[key] = value
-  end
-
-  def SupportedVerbs.const_missing(key)
-    @hash[key]
-  end
-
-  def SupportedVerbs.each
-    @hash.each {|key,value| yield(key,value)}
-  end
-
-  def SupportedVerbs.all
-    @hash.values
-  end
-
-  SupportedVerbs.add_item :COPY, :copy
-  SupportedVerbs.add_item :DELETE, :delete
-  SupportedVerbs.add_item :GET, :get
-  SupportedVerbs.add_item :HEAD, :head
-  SupportedVerbs.add_item :LOCK, :lock
-  SupportedVerbs.add_item :MKCOL, :mkcol
-  SupportedVerbs.add_item :MOVE, :move
-  SupportedVerbs.add_item :OPTIONS, :options
-  SupportedVerbs.add_item :PATCH, :patch
-  SupportedVerbs.add_item :POST, :post
-  SupportedVerbs.add_item :PROPFIND, :propfind
-  SupportedVerbs.add_item :PROPPATCH, :proppatch
-  SupportedVerbs.add_item :PUT, :put
-  SupportedVerbs.add_item :TRACE, :trace
-  SupportedVerbs.add_item :UNLOCK, :unlock
-end