api-tester 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41988c02130d7463e08e3d41c50f17a60fc3e562
-  data.tar.gz: 19dc7c39a0156c600029ba34d2f533ffe0934bde
+  metadata.gz: d7fd0c363094e175b8c3a28f0b208c6a5202f496
+  data.tar.gz: fd8349e6d3f62ab34f34f95f6dd82c1c77dcd62a
 SHA512:
-  metadata.gz: 7e7d21836ff7dc8928b68f50b3d6e117f3823bd24fff3e2145dbaee0a0f0367fc7b317bf365a2ae41657ab636b214e9a73b909023f88a8f471c6ed8a6b11140b
-  data.tar.gz: d2b4ccb62ee4907c327a45a5bde32fbc8e6f8a0afe7d1d936725a77e6acbcb39c4911ea480240d933986399d23bff43d1cc3ad262dfe4227f34b3eaa8328168f
+  metadata.gz: 0f99743ce48fb7157e50d6cb2fac17ab7256a6dffb8c3abaf370ae85c6866385087684932899d973388a23758da73079f55eb87946fa39267783db19f533d77d
+  data.tar.gz: c74c4a8c90395deeed9f2a3520a67e3a279f5e011a54fbcdad13be5aa1c799e81f70d519a9fe63e3e9bc4e0306ddc990ff8e9d5cb333a850bda303bc2fab5ffc

data/README.md

@@ -73,22 +73,22 @@ stable release
 
 Define your contract and endpoints using
 ```ruby
-require 'tester/definition/api_contract'
-require 'tester/definition/endpoint'
+require 'api-tester/definition/api_contract'
+require 'api-tester/definition/endpoint'
 contract = ApiContract.new "API Name"
-endpoint = Endpoint.new "Some name which is currently unused", "http://yourbase.com/api/endpoint"
+endpoint = ApiTester::Endpoint.new "Some name which is currently unused", "http://yourbase.com/api/endpoint"
 ```
 
 Define methods on endpoints
 
 ```ruby
-endpoint.add_method SupportedVerbs::GET, expected_response, expected_request
+endpoint.add_method ApiTester::SupportedVerbs::GET, expected_response, expected_request
 ```
-Note: While an extensive list of verbs exists in SupportedVerbs, you can define your own (with the caveat they have to be supported by RestClient)
+Note: While an extensive list of verbs exists in ApiTester::SupportedVerbs, you can define your own (with the caveat they have to be supported by RestClient)
 
 Define fields used by the method (both Request and Response)
 ```ruby
-expected_request = Request.new.add_field(Field.new "fieldName")
+expected_request = Request.new.add_field(ApiTester::Field.new "fieldName")
 ```
 Note: Similar to methods, you can create your own fields.
 They need to repond to:
@@ -99,10 +99,10 @@ values_array = field.negative_boundary_values
 
 Put them together and call go and off you go!
 ```ruby
-request = Request.new.add_field(Field.new "fieldName")
-expected_response = Response.new(200).add_field(Field.new "fieldName")
-endpoint = Endpoint.new "Unused Name", "http://yourbase.com/api/endpoint"
-endpoint.add_method SupportedVerbs::GET, expected_response, request
+request = Request.new.add_field(ApiTester::Field.new "fieldName")
+expected_response = ApiTester::Response.new(200).add_field(ApiTester::Field.new "fieldName")
+endpoint = ApiTester::Endpoint.new "Unused Name", "http://yourbase.com/api/endpoint"
+endpoint.add_method ApiTester::SupportedVerbs::GET, expected_response, request
 contract = ApiContract.new "API Name"
 contract.add_endpoint endpoint
 tester = ApiTester.new(contract).with_module(Format.new)
@@ -115,7 +115,7 @@ expect(tester.go).to be true
 If any of your API endpoints have some setup which needs to happen before or after each call (eg, path param represents resource which needs to be created), you can use the TestHelper interface:
 
 ```ruby
-class InfoCreator < TestHelper
+class InfoCreator < ApiTester::TestHelper
   def before
     puts "This code runs before every call"
   end
@@ -129,7 +129,7 @@ class InfoCreator < TestHelper
   end
 end
 
-endpoint = Endpoint.new "Endpoint Name", "www.endpoint-url.com"
+endpoint = ApiTester::Endpoint.new "Endpoint Name", "www.endpoint-url.com"
 endpoint.test_helper = InfoCreator.new
 expect(tester.go).to be true
 ```  

data/api-tester.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tester/version'
+require 'api-tester/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "api-tester"
-  spec.version       = Tester::VERSION
+  spec.version       = ApiTester::VERSION
   spec.authors       = ["arane"]
   spec.email         = ["arane9@gmail.com"]
 

data/changelog.txt

@@ -1,3 +1,8 @@
+0.2.0
+
+- Finally fixing the naming scheme
+- Splitting configuration into its own class
+
 0.1.0
 
 - Moving call to endpoint for path param support

data/lib/api-tester.rb

@@ -0,0 +1,14 @@
+module ApiTester
+  def self.go definition, config
+    reporter = config.reporter
+
+    definition.endpoints.each do |endpoint|
+      config.modules.sort_by{ |mod| mod.order }.each do |mod|
+        mod.go endpoint, reporter
+      end
+    end
+
+    reporter.print
+    reporter.reports.size == 0
+  end
+end

data/lib/api-tester/config.rb

@@ -0,0 +1,40 @@
+require 'api-tester/reporter/api_report'
+
+module ApiTester
+  class Config
+    attr_accessor :reporter
+    attr_accessor :modules
+
+    def initialize reporter=ApiTester::ApiReport.new
+      self.reporter = reporter
+      self.modules = []
+    end
+
+    def with_reporter reporter
+      self.reporter = reporter
+      self
+    end
+
+    def with_module new_module
+      self.modules << new_module
+      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 with_all_modules
+      self.modules << Format.new
+      self.modules << ExtraVerbs.new
+      self.modules << GoodCase.new
+      self.modules << Typo.new
+      self.modules << UnusedFields.new
+      self
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -0,0 +1,61 @@
+require 'api-tester/definition/response'
+require 'api-tester/definition/api_method'
+require 'api-tester/test_helper'
+require 'rest-client'
+
+module ApiTester
+  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 = ApiTester::TestHelper.new
+      self.bad_request_response = ApiTester::Response.new 400
+      self.not_allowed_response = ApiTester::Response.new 415
+      self.not_found_response = ApiTester::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 << ApiTester::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
+end

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

@@ -0,0 +1,46 @@
+require 'api-tester/definition/fields/field'
+
+module ApiTester
+  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
+end

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

@@ -0,0 +1,20 @@
+require 'api-tester/definition/fields/field'
+
+module ApiTester
+  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
+end

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

@@ -0,0 +1,22 @@
+require 'api-tester/definition/fields/field'
+
+module ApiTester
+  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
+end

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

@@ -0,0 +1,29 @@
+require 'api-tester/definition/fields/field'
+
+module ApiTester
+  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
+end

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

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

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

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