api-tester 1.0.0 → 1.1.1

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

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 require 'api-tester/definition/fields/field'
 
 module ApiTester
+  # Class for defining enumerators
   class EnumField < Field
     attr_accessor :acceptable_values
 
-    def initialize name:, acceptable_values:, default_value: nil
+    def initialize(name:, acceptable_values:, default_value: nil, required: false)
       if default_value
-        super name: name, default_value: default_value
+        super name: name, default_value: default_value, required: required
       else
-        super name: name, default_value: acceptable_values[0]
+        super name: name, default_value: acceptable_values[0], required: required
       end
 
       self.acceptable_values = acceptable_values
@@ -16,14 +19,14 @@ module ApiTester
 
     def negative_boundary_values
       super +
-          [
-              123,
-              0,
-              1,
-              true,
-              false,
-              {}
-          ]
+        [
+          123,
+          0,
+          1,
+          true,
+          false,
+          {}
+        ]
     end
   end
 end

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

@@ -1,49 +1,50 @@
+# frozen_string_literal: true
+
 module ApiTester
+  # Base class for field definitions
   class Field
-      attr_accessor :name
-      attr_accessor :default_value
-      attr_accessor :required
-      attr_accessor :is_seen
-
-      def initialize name:, required:false, default_value:"string"
-          self.name = name
-          self.default_value = default_value
-          self.required = required
-          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
+    attr_accessor :name
+    attr_accessor :default_value
+    attr_accessor :required
+    attr_accessor :is_seen
+
+    def initialize(name:, required: false, default_value: 'string')
+      self.name = name
+      self.default_value = default_value
+      self.required = required
+      self.is_seen = 0
+    end
+
+    def is_required
+      self.required = true
+      self
+    end
+
+    def is_not_required
+      self.required = false
+      self
+    end
+
+    def subfields?
+      false
+    end
+
+    def fields
+      []
+    end
+
+    def negative_boundary_values
+      cases = []
+      cases << nil if required
+      cases
+    end
+
+    def seen
+      self.is_seen += 1
+    end
+
+    def display_class
+      self.class
+    end
   end
 end

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

@@ -1,19 +1,22 @@
+# frozen_string_literal: true
+
 require 'api-tester/definition/fields/field'
 
 module ApiTester
+  # Class for defining numeric fields in contracts
   class NumberField < Field
-    def initialize name:, default_value: 5
-      super name: name, default_value: default_value
+    def initialize(name:, default_value: 5, required: false)
+      super name: name, default_value: default_value, required: required
     end
 
     def negative_boundary_values
       super +
-      [
-        "string",
-        true,
-        false,
-        {}
-      ]
+        [
+          'string',
+          true,
+          false,
+          {}
+        ]
     end
   end
 end

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

@@ -1,44 +1,47 @@
+# frozen_string_literal: true
+
 require 'api-tester/definition/fields/field'
 
 module ApiTester
+  # Class for defining objects in a contract
   class ObjectField < Field
-      attr_accessor :fields
-
-      def initialize name:
-          super name: name
-          self.fields = []
-      end
+    attr_accessor :fields
 
-      def with_field newField
-          self.fields << newField
-          self
-      end
+    def initialize(name:, required: false)
+      super name: name, required: required
+      self.fields = []
+    end
 
-      def has_subfields?
-          true
-      end
+    def with_field(new_field)
+      fields << new_field
+      self
+    end
 
-      def default_value
-          obj = Hash.new
+    def subfields?
+      true
+    end
 
-          self.fields.each do |field|
-              obj[field.name] = field.default_value
-          end
+    def default_value
+      obj = {}
 
-          obj
+      fields.each do |field|
+        obj[field.name] = field.default_value
       end
 
-      def negative_boundary_values
-          super +
-            [
-              "string",
-              [],
-              123,
-              1,
-              0,
-              true,
-              false
-            ]
-      end
+      obj
+    end
+
+    def negative_boundary_values
+      super +
+        [
+          'string',
+          [],
+          123,
+          1,
+          0,
+          true,
+          false
+        ]
+    end
   end
 end

data/lib/api-tester/definition/fields/plain_array_field.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'api-tester/definition/fields/field'
+
+module ApiTester
+  # Class for defining plain arrays
+  class PlainArrayField < Field
+    def initialize(name:, default_value: [], required: false)
+      super name: name, default_value: default_value, required: required
+    end
+
+    def negative_boundary_values
+      super +
+        [
+          'string',
+          123,
+          0,
+          1,
+          {},
+          true,
+          false
+        ]
+    end
+  end
+end

data/lib/api-tester/definition/method.rb

@@ -1,17 +1,22 @@
+# frozen_string_literal: true
+
 module ApiTester
+  # Class for defining methods as part of an endpoint
   class Method
     attr_accessor :request
     attr_accessor :expected_response
     attr_accessor :verb
 
-    def initialize verb, response, request
+    def initialize(verb:, response:, request:)
       self.verb = verb
       self.request = request
       self.expected_response = response
     end
 
     def default_request
-      {:method => self.verb, :payload => request.default_payload, :headers => request.default_headers}
+      { method: verb,
+        payload: request.default_payload,
+        headers: request.default_headers }
     end
   end
 end

data/lib/api-tester/definition/request.rb

@@ -1,30 +1,46 @@
+# frozen_string_literal: true
+
 require 'api-tester/definition/boundary_case'
 
 module ApiTester
+  # Class for defining requests in a contract
   class Request
     attr_accessor :definition
     attr_accessor :header_fields
     attr_accessor :fields
+    attr_accessor :query_params
 
     def initialize
       self.fields = []
       self.header_fields = []
+      self.query_params = []
     end
 
     def add_field(new_field)
-      self.fields << new_field
+      fields << new_field
+      self
+    end
+
+    def add_query_param(new_query_param)
+      query_params << new_query_param
       self
     end
 
-    def add_header_field new_header
-      self.header_fields << new_header
+    def default_query
+      query_params.map { |param| "#{param.name}=#{param.default_value}" }.join('&')
+    end
+
+    def add_header_field(new_header)
+      header_fields << new_header
       self
     end
 
     def payload
-      response = Hash.new
-      self.fields.each do |field|
-        response[field.name] = field.default_value
+      response = {}
+      fields.each do |field|
+        if field.required == true
+          response[field.name] = field.default_value
+        end
       end
       response
     end
@@ -34,36 +50,47 @@ module ApiTester
     end
 
     def default_headers
-      if self.header_fields != []
-        self.headers
+      if header_fields != []
+        headers
       else
-        {content_type: :json, accept: :json}
+        { content_type: :json, accept: :json }
       end
     end
 
     def headers
       header_response = {}
-      self.header_fields.each do |header|
-        header_response[header.name] = header.default_value
+      header_fields.each do |header_field|
+        header_response[header_field.name] = header_field.default_value
       end
       header_response
     end
 
     def cases
-      boundary_cases = Array.new
-      self.fields.each do |field|
+      boundary_cases = []
+      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)
+          bcase = BoundaryCase.new description: "Setting #{field.name} to #{value}",
+                                   payload: altered_payload(field_name: field.name,
+                                                            value: value),
+                                   headers: default_headers
+          boundary_cases.push bcase
         end
       end
       boundary_cases
     end
 
-    def altered_payload field_name, value
+    def altered_payload(field_name:, value:)
       body = payload
       body[field_name] = value
       body
     end
+
+    def altered_payload_with(fields)
+      body = payload
+      fields.each do |field|
+        body[field[:name]] = field[:value]
+      end
+      body
+    end
   end
 end

data/lib/api-tester/definition/response.rb

@@ -1,36 +1,39 @@
+# frozen_string_literal: true
+
 module ApiTester
+  # Class for defining expected responses
   class Response
-      attr_accessor :code
-      attr_accessor :body
+    attr_accessor :code
+    attr_accessor :body
 
-      def initialize(status_code=200)
-          self.code = status_code
-          self.body = []
-      end
+    def initialize(status_code: 200)
+      self.code = status_code
+      self.body = []
+    end
 
-      def add_field(new_field)
-          self.body << new_field
-          self
-      end
+    def add_field(new_field)
+      body << new_field
+      self
+    end
 
-      def to_s
-          des = {}
-          self.body.map do |f|
-              des[f.name] = field_display f
-          end
-          des.to_json
+    def to_s
+      des = {}
+      body.map do |f|
+        des[f.name] = field_display f
       end
+      des.to_json
+    end
 
-      def field_display field
-          des = field.display_class
-          if field.has_subfields?
-            des = {}
-            field.fields.map do |f|
-              des[f.name] = field_display f
-            end
-            des.to_json
-          end
-          des
+    def field_display(field)
+      des = field.display_class
+      if field.subfields?
+        des = {}
+        field.fields.map do |f|
+          des[f.name] = field_display f
+        end
+        des.to_json
       end
+      des
+    end
   end
 end