api-tester 0.1.0 → 0.2.0

data/lib/api-tester/reporter/missing_response_field_report.rb

@@ -0,0 +1,21 @@
+module ApiTester
+  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
+end

data/lib/api-tester/reporter/report.rb

@@ -0,0 +1,27 @@
+module ApiTester
+  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
+end

data/lib/api-tester/reporter/status_code_report.rb

@@ -0,0 +1,14 @@
+require 'api-tester/reporter/report'
+
+module ApiTester
+  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
+end

data/lib/api-tester/test_helper.rb

@@ -0,0 +1,12 @@
+module ApiTester
+  class TestHelper
+    def before
+    end
+
+    def retrieve_param key
+    end
+
+    def after
+    end
+  end
+end

data/lib/api-tester/util/response_evaluator.rb

@@ -0,0 +1,75 @@
+module ApiTester
+  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
+end

data/lib/api-tester/util/supported_verbs.rb

@@ -0,0 +1,36 @@
+module ApiTester
+  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
+end

data/lib/api-tester/version.rb

@@ -0,0 +1,3 @@
+module ApiTester
+  VERSION = "0.2.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-tester
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - arane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,37 +99,37 @@ files:
 - bin/console
 - bin/setup
 - changelog.txt
-- lib/tester.rb
-- lib/tester/api_tester.rb
-- lib/tester/definition/api_contract.rb
-- lib/tester/definition/api_method.rb
-- lib/tester/definition/boundary_case.rb
-- lib/tester/definition/endpoint.rb
-- lib/tester/definition/fields/array_field.rb
-- lib/tester/definition/fields/boolean_field.rb
-- lib/tester/definition/fields/email_field.rb
-- lib/tester/definition/fields/enum_field.rb
-- lib/tester/definition/fields/field.rb
-- lib/tester/definition/fields/number_field.rb
-- lib/tester/definition/fields/object_field.rb
-- lib/tester/definition/request.rb
-- lib/tester/definition/response.rb
-- lib/tester/method_case_test.rb
-- lib/tester/modules/extra_verbs.rb
-- lib/tester/modules/format.rb
-- lib/tester/modules/good_case.rb
-- lib/tester/modules/module.rb
-- lib/tester/modules/typo.rb
-- lib/tester/modules/unused_fields.rb
-- lib/tester/reporter/api_report.rb
-- lib/tester/reporter/missing_field_report.rb
-- lib/tester/reporter/missing_response_field_report.rb
-- lib/tester/reporter/report.rb
-- lib/tester/reporter/status_code_report.rb
-- lib/tester/test_helper.rb
-- lib/tester/util/response_evaluator.rb
-- lib/tester/util/supported_verbs.rb
-- lib/tester/version.rb
+- lib/api-tester.rb
+- lib/api-tester/config.rb
+- lib/api-tester/definition/api_contract.rb
+- lib/api-tester/definition/api_method.rb
+- lib/api-tester/definition/boundary_case.rb
+- lib/api-tester/definition/endpoint.rb
+- lib/api-tester/definition/fields/array_field.rb
+- lib/api-tester/definition/fields/boolean_field.rb
+- lib/api-tester/definition/fields/email_field.rb
+- lib/api-tester/definition/fields/enum_field.rb
+- lib/api-tester/definition/fields/field.rb
+- lib/api-tester/definition/fields/number_field.rb
+- lib/api-tester/definition/fields/object_field.rb
+- lib/api-tester/definition/request.rb
+- lib/api-tester/definition/response.rb
+- lib/api-tester/method_case_test.rb
+- lib/api-tester/modules/extra_verbs.rb
+- lib/api-tester/modules/format.rb
+- lib/api-tester/modules/good_case.rb
+- lib/api-tester/modules/module.rb
+- lib/api-tester/modules/typo.rb
+- lib/api-tester/modules/unused_fields.rb
+- lib/api-tester/reporter/api_report.rb
+- lib/api-tester/reporter/missing_field_report.rb
+- lib/api-tester/reporter/missing_response_field_report.rb
+- lib/api-tester/reporter/report.rb
+- lib/api-tester/reporter/status_code_report.rb
+- lib/api-tester/test_helper.rb
+- lib/api-tester/util/response_evaluator.rb
+- lib/api-tester/util/supported_verbs.rb
+- lib/api-tester/version.rb
 homepage: https://github.com/araneforseti/api-tester
 licenses:
 - MIT

data/lib/tester.rb

@@ -1,7 +0,0 @@
-require "tester/version"
-require 'rest-client'
-require 'json'
-
-module Tester
-
-end

data/lib/tester/api_tester.rb

@@ -1,50 +0,0 @@
-require "tester/modules/format"
-require 'tester/modules/good_case'
-require 'tester/modules/unused_fields'
-require 'tester/modules/typo'
-require 'rest-client'
-require 'tester/reporter/api_report'
-require 'json'
-
-class ApiTester
-  attr_accessor :report
-  attr_accessor :modules
-  attr_accessor :definition
-  attr_accessor :test_helper
-
-  def initialize(definition)
-    self.report = ApiReport.new
-    self.modules = []
-    self.definition = definition
-    self.test_helper = TestHelper.new
-  end
-
-  def with_module(new_module)
-    self.modules << new_module
-    self
-  end
-
-  def with_reporter(reporter)
-    self.report = reporter
-    self
-  end
-
-  def with_default_modules
-    self.modules << Format.new
-    self.modules << GoodCase.new
-    self.modules << Typo.new
-    self.modules << UnusedFields.new
-    self
-  end
-
-  def go
-    self.definition.endpoints.each do |endpoint|
-      self.modules.sort_by{ |mod| mod.order }.each do |mod|
-        mod.go endpoint, self.report
-      end
-    end
-
-    self.report.print
-    self.report.reports.size == 0
-  end
-end

data/lib/tester/definition/api_contract.rb

@@ -1,13 +0,0 @@
-class ApiContract
-  attr_accessor :name
-  attr_accessor :endpoints
-
-  def initialize name
-    self.name = name
-    self.endpoints = []
-  end
-
-  def add_endpoint endpoint
-    self.endpoints << endpoint
-  end
-end

data/lib/tester/definition/api_method.rb

@@ -1,11 +0,0 @@
-class ApiMethod
-  attr_accessor :request
-  attr_accessor :expected_response
-  attr_accessor :verb
-
-  def initialize verb, response, request
-    self.verb = verb
-    self.request = request
-    self.expected_response = response
-  end
-end

data/lib/tester/definition/boundary_case.rb

@@ -1,11 +0,0 @@
-class BoundaryCase
-  attr_accessor :payload
-  attr_accessor :headers
-  attr_accessor :description
-
-  def initialize description, payload, headers
-    self.description = description
-    self.payload = payload
-    self.headers = headers
-  end
-end

data/lib/tester/definition/endpoint.rb

@@ -1,57 +0,0 @@
-require 'tester/definition/response'
-require 'tester/definition/api_method'
-
-class Endpoint
-  attr_accessor :name
-  attr_accessor :base_url
-  attr_accessor :path_params
-  attr_accessor :methods
-  attr_accessor :test_helper
-  attr_accessor :bad_request_response
-  attr_accessor :not_allowed_response
-  attr_accessor :not_found_response
-
-  def initialize name, url
-    self.base_url = url
-    self.name = name
-    self.methods = []
-    self.path_params = []
-    self.test_helper = TestHelper.new
-    self.bad_request_response = Response.new 400
-    self.not_allowed_response = Response.new 415
-    self.not_found_response = Response.new 404
-  end
-
-  def url
-    temp_url = self.base_url
-    self.path_params.each do |param|
-      temp_url.sub! "{#{param}}", self.test_helper.retrieve_param(param)
-    end
-    temp_url
-  end
-
-  def call method, payload={}, headers={}
-    self.test_helper.before
-    begin      
-      response = RestClient::Request.execute(method: method.verb, url: self.url, payload: payload, headers: headers)
-    rescue RestClient::ExceptionWithResponse => e
-      response = e.response
-    end
-    self.test_helper.after
-    response
-  end
-
-  def add_method verb, response, request=Request.new()
-    self.methods << ApiMethod.new(verb, response, request)
-    self
-  end
-
-  def add_path_param param
-    self.path_params << param
-    self
-  end
-
-  def verbs
-    self.methods.map(&:verb)
-  end
-end

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

@@ -1,44 +0,0 @@
-require 'tester/definition/fields/field'
-
-class ArrayField < 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
-    if self.fields.size == 0
-      return []
-    end
-
-    obj = Hash.new
-    self.fields.each do |field|
-      obj[field.name] = field.default_value
-    end
-    [obj]
-  end
-
-  def negative_boundary_values
-    super +
-    [
-      "string",
-      123,
-      0,
-      1,
-      true,
-      false,
-      {}
-    ]
-  end
-end