api-tester 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83ee0d9e20fbd649a77f024ef5c59374598defdb
+  data.tar.gz: e940bd076054a3a8fef1d64cdeac36692622dec8
+SHA512:
+  metadata.gz: 1917a357518a7d848197699e4ef169b409668954f3054c1259835a5424270d815cceae899c841d994eccf8fdb28dfe48d2e7c6955fad2649d4a1c994e933a81b
+  data.tar.gz: f791aa624ebbcd765073765a3949714ad851ffac7a8fd3f50df5bd66ad5c0f82588fca83e86bdd0c446d3f5bd793c5c7b8dd5f08a38ef53aaa1382f975238864

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 2.2.1
+  
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api-tester.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 araneforseti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,182 @@
+# Api::Tester
+[![Build Status](https://travis-ci.org/araneforseti/api-tester.svg?branch=master)](https://travis-ci.org/araneforseti/api-tester)
+
+Work in Progress! Use at own risk, definitely not ready 
+for prime time!
+
+This gem is intended to enable easy creation of tests for 
+RESTful API services when given a contract.
+
+Check out [API Tester Example](https://github.com/araneforseti/example_api-tester) for an example in action
+
+# Feature Plan
+## Under Development
+Check out our [Trello Board](https://trello.com/b/R3RtsJ2A/api-tester) to see progress and where we are headed!
+Feel free to leave feedback through github's issue tracker
+
+- Format module: 
+     - Checks syntax problems with the request and 
+        ensuring a consistent response
+- Typo module:
+     - Tests incorrect verbs and simulates typos in the url
+- Good Case (name pending) module: 
+     - Checks expected good requests will work 
+        (eg, number field should accept integers 
+        between 1 - 100)
+- Unused Fields module:
+    - A module which runs after all the others and reports on any response fields which were never returned
+    
+## Intended Features Before "Release"
+
+- Other Param Testing
+    - Path
+    - Query
+    - Headers
+- Endpoint Testing
+    - Unused Response Fields
+    - Invalid method names
+    - Invalid method types
+- Documentation
+    - Generate Swagger-compliant documentation
+    - Generate definitions from Swagger documentation
+    
+## What is this not intended for?
+
+- Logic testing (eg, if X is between A and B, then Y is 
+required)
+
+# Usage
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api-tester'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api-tester
+
+## Usage in Code
+
+Warning: This gem is still in alpha stage. Use at own risk 
+understanding the contract will change until the first 
+stable release
+
+Define your endpoints using
+```ruby
+endpoint = Endpoint.new "Some name which is currently unused"
+```
+
+Define methods on endpoints
+
+```ruby
+get_method = ApiGet.new "http://yourbase.com/api/method"
+```
+Note: Currently only GET and POST have been created, but 
+you can make your own so long as it has `call` and `verb` methods 
+which will execute the method given parameters
+
+Define fields used by the method (both Request and Response)
+```ruby
+request = Request.new.add_field(Field.new "fieldName")
+```
+Note: Similar to methods, you can create your own fields. 
+They need to repond to:
+```ruby
+field.has_subfields?
+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")
+get_method = ApiGet.new "http://yourbase.com/api/method"
+get_method.request = request
+get_method.expected_response = expected_response
+endpoint = Endpoint.new "Unused Name Sorry"
+endpoint.add_method get_method
+tester = ApiTester.new(endpoint).with_module(Format.new)
+expect(tester.go).to be true
+
+```
+
+## Dependencies
+
+If your API has some setup which needs to happen before or after each call for a particular endpoint, you can use the TestHelper interface:
+
+```ruby
+class InfoCreator < TestHelper
+  def before
+    puts "This code runs before every call"
+  end
+
+  def after
+    puts "This code runs after every call"
+  end
+end
+
+tester = ApiTester.new(endpoint)
+tester.test_helper = InfoCreator.new
+expect(tester.go).to be true
+```  
+
+# Modules
+## Boundary
+This module will test out various edge cases and 
+ensure error handling is consistent
+
+## Good Case
+This module ensures your 'default request' works 
+appropriately
+
+## Typo
+This module checks for common integration issues when an 
+API is first being worked against such as urls which don't 
+exist and HTTP Verb against a url which does not support it
+
+## Unused Fields
+If any response fields are not returned during tests run
+by previous modules, this will fail with a report 
+detailing unreturned response fields. When using this 
+module, it is recommended the good case module is also 
+used.
+
+# Reporting
+Right now the default reporting mechanism prints out to 
+the console all the issues which were found. You can 
+create your own reporting class (so long as it responds 
+to the same methods) or just extend the current one and 
+override the print method. Then set the tester's report 
+tool:
+```ruby
+tester.with_reporter(new_reporter)
+```
+
+# Development
+
+After checking out the repo, run `bin/setup` to install 
+dependencies. Then, run `rake spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt 
+that will allow you to experiment.
+
+To install this gem onto your local machine, 
+run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/araneforseti/api-tester.
+
+
+# License
+
+The gem is available as open source under the terms 
+of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/api-tester.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tester/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api-tester"
+  spec.version       = Tester::VERSION
+  spec.authors       = ["arane"]
+  spec.email         = ["arane9@gmail.com"]
+
+  spec.summary       = %q{Tool to help test APIs}
+  spec.description   = %q{Tool to test APIs which will eventually do boundary testing and other sorts of testing automatically given a contract}
+  spec.homepage      = "https://github.com/araneforseti/api-tester"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency "rest-client"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api/tester"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tester.rb

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

data/lib/tester/api_tester.rb

@@ -0,0 +1,48 @@
+require "tester/modules/format"
+require 'tester/modules/good_case'
+require 'tester/modules/unused_fields'
+require 'tester/modules/typo'
+require 'rest-client'
+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.modules.sort_by{ |mod| mod.order }.each do |mod|
+      mod.test_helper = self.test_helper
+      mod.go self.definition, self.report
+    end
+
+    self.report.print
+    self.report.reports.size == 0
+  end
+end

data/lib/tester/definition/boundary_case.rb

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,22 @@
+require 'tester/definition/response'
+
+class Endpoint
+  attr_accessor :methods
+  attr_accessor :name
+  attr_accessor :bad_request_response
+  attr_accessor :not_allowed_response
+  attr_accessor :not_found_response
+
+  def initialize name
+    self.name = name
+    self.methods = []
+    self.bad_request_response = Response.new 400
+    self.not_allowed_response = Response.new 415
+    self.not_found_response = Response.new 404
+  end
+
+  def add_method(new_method)
+    self.methods << new_method
+    self
+  end
+end

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

@@ -0,0 +1,44 @@
+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