api-tester 0.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 41988c02130d7463e08e3d41c50f17a60fc3e562
-  data.tar.gz: 19dc7c39a0156c600029ba34d2f533ffe0934bde
+SHA256:
+  metadata.gz: 2f8866f2783c0595b22817fbd6fbaaab7a77531bf55358a50f6e0b3a62fec22a
+  data.tar.gz: 7aa5c6d1d261f322a8190781b62b3bc235641a7c0eec625afb1f9a9900cb4abe
 SHA512:
-  metadata.gz: 7e7d21836ff7dc8928b68f50b3d6e117f3823bd24fff3e2145dbaee0a0f0367fc7b317bf365a2ae41657ab636b214e9a73b909023f88a8f471c6ed8a6b11140b
-  data.tar.gz: d2b4ccb62ee4907c327a45a5bde32fbc8e6f8a0afe7d1d936725a77e6acbcb39c4911ea480240d933986399d23bff43d1cc3ad262dfe4227f34b3eaa8328168f
+  metadata.gz: 52da12901f51389ca9a4fb37d775aa8974e7514571d900fcbcfb660b6174f8251d42f6a0bb7fa9b23b3d61b01d64aa7c116c2128badf7390e2dfe106e8703ec3
+  data.tar.gz: 8ae063b4473b4f1fb75ceb203dc569f0e8cc16b8e9963f434bd85aad1c618daecfff77caf4a93d876b7af24cf037118635351ac98bbf82af1491b012c5c5804f

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# Set update schedule for GitHub Actions
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every weekday
+      interval: "daily"
+
+  - package-ecosystem: "bundler"
+    directory: '/'
+    schedule:
+      interval: 'daily'

data/.github/workflows/push.yml

@@ -0,0 +1,39 @@
+name: Publish Gem
+
+on:
+  workflow_dispatch
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY rubygems --host https://rubygems.org *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}

data/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@a195098f6b1e9074390215a49c1c14e82151a289
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run lint
+      run: bundle exec rake rubocop
+    - name: Run tests
+      run: bundle exec rake spec

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,61 @@
+AllCops:
+  Exclude:
+    - 'Guardfile'
+    - '*.gemspec'
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'bin/*'
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/NilComparison:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/MultipleComparison:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/EmptyLiteral:
+  Enabled: false
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in api-tester.gemspec

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -1,6 +1,7 @@
 # Api::Tester
+
 [![Gem Version](https://badge.fury.io/rb/api-tester.svg)](https://badge.fury.io/rb/api-tester)
-[![Build Status](https://travis-ci.org/araneforseti/api-tester.svg?branch=master)](https://travis-ci.org/araneforseti/api-tester)
+[![Build Status](https://github.com/araneforseti/api-tester/workflows/Test/badge.svg)](https://github.com/araneforseti/api-tester/actions?query=workflow%3ATest+branch%3Amaster)
 
 Work in Progress! Use at own risk, definitely not ready
 for prime time! To isolate your project from the changes, be sure to specify which gem version you use.
@@ -8,114 +9,96 @@ for prime time! To isolate your project from the changes, be sure to specify whi
 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
+When using, be sure to follow the documentation for the version of the gem you use. The documentation below
+relates to the unpublished gem version actively under development
 
-# 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 simulates typos in the url
-- Extra Verbs module:
-     - Checks all the supported verbs to ensure no vulnerabilities are exposed
-- 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"
+Check out [API Tester Example](https://github.com/araneforseti/example_api-tester) for an example in action
 
-- Other Param Testing
-    - Path params
-    - Query
-    - Headers
-- Endpoint Testing
-    - Unused Response Fields
-    - Invalid method names
-    - Invalid method types
-- Documentation
-    - Generate Swagger-compliant documentation
-    - Generate definitions from Swagger documentation
+## Out of Project Scope
 
-## What is this not intended for?
+- Logic testing (eg, if X is between A and B, then Y is required)
 
-- Logic testing (eg, if X is between A and B, then Y is
-required)
+## Usage
 
-# Usage
-## Installation
+### Installation
 
 Add this line to your application's Gemfile (Note: specify your version due to gem's currently volatile nature):
 
 ```ruby
-gem 'api-tester', '0.0.3'
+gem 'api-tester', '1.0.0'
 ```
 
 And then execute:
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
-    $ gem install api-tester
+    gem install api-tester
 
-## Usage in Code
+### 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 contract and endpoints using
+
 ```ruby
-require 'tester/definition/api_contract'
-require 'tester/definition/endpoint'
-contract = ApiContract.new "API Name"
-endpoint = Endpoint.new "Some name which is currently unused", "http://yourbase.com/api/endpoint"
+require 'api-tester/definition/contract'
+require 'api-tester/definition/endpoint'
+contract = ApiTester::Contract.new "API Name", "http://yourbase.com/api"
+endpoint = ApiTester::Endpoint.new "Some name which is currently unused", "/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:
+They need to respond to:
+
 ```ruby
 field.has_subfields?
 values_array = field.negative_boundary_values
 ```
 
+Define which modules you want to use through a config
+
+```ruby
+config = ApiTester::Config().with_module(Format)
+```
+
 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
-contract = ApiContract.new "API Name"
+request = ApiTester::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", "/endpoint"
+endpoint.add_method ApiTester::SupportedVerbs::GET, expected_response, request
+contract = Contract.new "API Name", "http://yourbase.com/api"
 contract.add_endpoint endpoint
-tester = ApiTester.new(contract).with_module(Format.new)
-expect(tester.go).to be true
+config = ApiTester::Config().with_module(Format)
+expect(ApiTester.go(contract, config)).to be true
 
 ```
 
-## Dependencies
+### Dependencies
 
 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,48 +112,86 @@ 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
 ```  
 
-# Modules
-## Boundary
+## Modules
+
+### Boundary
+
 This module will test out various edge cases and
 ensure error handling is consistent
 
-## Good Case
+### Good Case
+
 This module ensures your 'default request' works
 appropriately
 
-## Typo
+### Typo
+
 This module checks for common integration issues when an
 API is first being worked against such as urls which don't
 exist
 
-## Extra Verbs
+### Extra Verbs
+
 This module checks to ensure consistency in response when
 the api receives verbs it doesn't explicitly support
 
-## Unused Fields
+### 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
+### Required Fields
+
+This module tests out all the various invalid combinations of required fields to ensure consistent response
+
+### Unexpected Fields
+
+This module calls out if the API returns anything unexpected in its response
+
+### Custom Modules
+
+Do you want to do something with the definition which this gem currently does not support?
+You can create your own test module and add it to the config instance class!
+Just make sure it adheres to the following interface:
+
+```ruby
+module CustomModule
+  def self.go contract
+    # Your test code here
+    # the contract object is the full definition created
+  end
+
+  def self.order
+    # If your module needs to run first, put 0, if last, put 100.
+    # Otherwise this can just be any number
+  end
+end  
+
+config.with_module(CustomModule)
+```
+
+## 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:
+override the print method. Then set the report
+tool in the config:
+
 ```ruby
-tester.with_reporter(new_reporter)
+config.with_reporter(new_reporter)
 ```
 
-# Development
+## Development
 
 After checking out the repo, run `bin/setup` to install
 dependencies. Then, run `rake spec` to run the tests.
@@ -182,11 +203,22 @@ run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/araneforseti/api-tester.
+Bug reports and pull requests are welcome on [GitHub repo](https://github.com/araneforseti/api-tester).
 
+## Future Features 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
+
+- Other Param Testing
+  - Path params
+  - Query
+  - Headers
+- Documentation
+  - Generate Swagger-compliant documentation
+  - Generate definitions from Swagger documentation
 
-# License
+## License
 
 The gem is available as open source under the terms
 of the [MIT License](http://opensource.org/licenses/MIT).