api-tester 0.0.1

data/lib/tester/definition/fields/boolean_field.rb

@@ -0,0 +1,18 @@
+require 'tester/definition/fields/field'
+
+class BooleanField < Field
+  def initialize(name, default_value=true)
+    super(name, default_value)
+  end
+
+  def negative_boundary_values
+    super +
+    [
+      "string",
+      123,
+      0,
+      1,
+      {}
+    ]
+  end
+end

data/lib/tester/definition/fields/email_field.rb

@@ -0,0 +1,20 @@
+require 'tester/definition/fields/field'
+
+class EmailField < Field
+  def initialize(name, default_value="test@test.com")
+    super(name, default_value)
+  end
+
+  def negative_boundary_values
+    super +
+    [
+      "string",
+      123,
+      1,
+      0,
+      true,
+      false,
+      {}
+    ]
+  end
+end

data/lib/tester/definition/fields/enum_field.rb

@@ -0,0 +1,27 @@
+require 'tester/definition/fields/field'
+
+class EnumField < Field
+  attr_accessor :acceptable_values
+
+  def initialize name, acceptable_values, default_value=nil
+    if default_value
+      super name, default_value
+    else
+      super name, acceptable_values[0]
+    end
+
+    self.acceptable_values = acceptable_values
+  end
+
+  def negative_boundary_values
+    super +
+        [
+            123,
+            0,
+            1,
+            true,
+            false,
+            {}
+        ]
+  end
+end

data/lib/tester/definition/fields/field.rb

@@ -0,0 +1,47 @@
+class Field
+    attr_accessor :name
+    attr_accessor :default_value
+    attr_accessor :required
+    attr_accessor :is_seen
+
+    def initialize name, default_value="string"
+        self.name = name
+        self.default_value = default_value
+        self.required = false
+        self.is_seen = 0
+    end
+
+    def is_required
+        self.required = true
+        self
+    end
+
+    def is_not_required
+        self.required = false
+        self
+    end
+
+    def has_subfields?
+        false
+    end
+
+    def fields
+        []
+    end
+
+    def negative_boundary_values
+        cases = []
+        if self.required
+            cases << nil
+        end
+        cases
+    end
+
+    def seen
+        self.is_seen += 1
+    end
+  
+    def display_class
+        self.class
+    end
+end

data/lib/tester/definition/fields/number_field.rb

@@ -0,0 +1,17 @@
+require 'tester/definition/fields/field'
+
+class NumberField < Field
+  def initialize(name, default_value=5)
+    super(name, default_value)
+  end
+
+  def negative_boundary_values
+    super +
+    [
+      "string",
+      true,
+      false,
+      {}
+    ]
+  end
+end

data/lib/tester/definition/fields/object_field.rb

@@ -0,0 +1,42 @@
+require 'tester/definition/fields/field'
+
+class ObjectField < Field
+    attr_accessor :fields
+
+    def initialize name
+        super(name)
+        self.fields = []
+    end
+
+    def with_field(newField)
+        self.fields << newField
+        self
+    end
+
+    def has_subfields?
+        true
+    end
+
+    def default_value
+        obj = Hash.new
+
+        self.fields.each do |field|
+            obj[field.name] = field.default_value
+        end
+
+        obj
+    end
+
+    def negative_boundary_values
+        super +
+          [
+            "string",
+            [],
+            123,
+            1,
+            0,
+            true,
+            false
+          ]
+    end
+end

data/lib/tester/definition/methods/api_get.rb

@@ -0,0 +1,21 @@
+require 'tester/definition/request'
+require 'tester/definition/response'
+require "tester/version"
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'json'
+require 'tester/definition/methods/api_method'
+
+class ApiGet < ApiMethod
+  def call params={}, headers={}
+    headers[:params] = params
+
+    RestClient.get(self.url, headers)  { |real_response, request, result|
+      real_response
+    }
+  end
+
+  def verb
+    SupportedVerbs::GET
+  end
+end

data/lib/tester/definition/methods/api_method.rb

@@ -0,0 +1,22 @@
+require 'tester/definition/request'
+require 'tester/definition/response'
+require 'tester/reporter/status_code_report'
+require 'tester/reporter/missing_field_report'
+require 'tester/reporter/api_report'
+require 'json'
+
+class ApiMethod
+  attr_accessor :request
+  attr_accessor :expected_response
+  attr_accessor :url
+
+  def initialize url
+    self.url = url
+    self.request = Request.new
+    self.expected_response = Response.new 200
+  end
+
+  def verb
+    "None"
+  end
+end

data/lib/tester/definition/methods/api_post.rb

@@ -0,0 +1,26 @@
+require 'tester/definition/request'
+require 'tester/definition/response'
+require "tester/version"
+require 'rest-client'
+require 'json'
+require 'tester/definition/methods/api_method'
+require 'tester/reporter/api_report'
+require 'tester/reporter/status_code_report'
+
+class ApiPost < ApiMethod
+  attr_accessor :syntax_error_response
+
+  def post json_payload, headers
+    RestClient.post(self.url, json_payload, headers)  { |real_response, request, result|
+      real_response
+    }
+  end
+
+  def call body_params={}, request_params={}
+    post body_params.to_json, request_params
+  end
+
+  def verb
+    SupportedVerbs::POST
+  end
+end

data/lib/tester/definition/request.rb

@@ -0,0 +1,49 @@
+require 'tester/definition/boundary_case'
+
+class Request
+  attr_accessor :definition
+  attr_accessor :headers
+  attr_accessor :fields
+
+  def initialize
+    self.fields = []
+  end
+
+  def add_field(new_field)
+    self.fields << new_field
+    self
+  end
+
+  def payload
+    response = Hash.new
+    self.fields.each do |field|
+      response[field.name] = field.default_value
+    end
+    response
+  end
+
+  def default_payload
+    payload
+  end
+
+  def default_headers
+    {content_type: :json, accept: :json}
+  end
+
+  def cases
+    boundary_cases = Array.new
+    self.fields.each do |field|
+      field.negative_boundary_values.each do |value|
+        bcase = BoundaryCase.new("Setting #{field.name} to #{value}", altered_payload(field.name, value), default_headers)
+        boundary_cases.push(bcase)
+      end
+    end
+    boundary_cases
+  end
+
+  def altered_payload field_name, value
+    body = payload
+    body[field_name] = value
+    body
+  end
+end

data/lib/tester/definition/response.rb

@@ -0,0 +1,29 @@
+class Response
+    attr_accessor :code
+    attr_accessor :body
+
+    def initialize(status_code)
+        self.code = status_code
+        self.body = []
+    end
+
+    def add_field(new_field)
+        self.body << new_field
+        self
+    end
+
+    def to_s
+        s = self.body.map do |f|
+            field_display f
+        end
+        s.to_s
+    end
+
+    def field_display field
+        if field.has_subfields?
+            "#{field.name}:#{field.fields.map{|f| field_display(f)}}"
+        else
+            "#{field.name}:#{field.display_class}"
+        end
+    end
+end

data/lib/tester/method_case_test.rb

@@ -0,0 +1,67 @@
+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/format.rb

@@ -0,0 +1,26 @@
+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 = self.call method, format_case
+        test = FormatTest.new response, format_case.payload, definition.bad_request_response, method.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

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