apireaper 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a52bdd4fbf202bceeb870138ad230d5e8233f8a
+  data.tar.gz: f236587dcbf0655e2e9477af21090aca0aa898a8
+SHA512:
+  metadata.gz: 66c2db95b9bd16449b86ef56af70cc9d711dd7df561efaaf0f8d86e848ad325d00c415d2309b4bba92acb531add97725d63885fd9e171e08b1b980a9079f955c
+  data.tar.gz: 9c6e7797822e3eb3890941dee57f0c63dd9a7d824eab0414e23d22de05416ab4705c240a68a72733f767e81fd59aa991cbed2bf57ff5c48bb62735baa00969cd

data/.gitignore

@@ -0,0 +1,4 @@
+apireaper*.gem
+test-*
+Gemfile.lock
+coverage

data/.gitlab-ci.yml

@@ -0,0 +1,52 @@
+rubocop:
+  tags:
+    - docker
+  image: yueyehua/debian-ruby
+  stage: test
+  script:
+    - rubocop
+
+lines_length:
+  stage: test
+  script:
+    - >
+      bash <(curl -s
+      https://gitlab.com/yue-script/checks/raw/master/check_lines_length.sh)
+      80 README.md spec/files/*
+
+git_history:
+  stage: test
+  script:
+    - >
+      bash <(curl -s
+      https://gitlab.com/yue-script/checks/raw/master/check_git_history.sh)
+
+before_script:
+  - bundle install
+
+rspec:
+  tags:
+    - docker
+  image: yueyehua/debian-ruby
+  stage: test
+  script:
+    - rspec
+  artifacts:
+    paths:
+      - coverage/
+
+pages:
+  tags:
+    - docker
+  stage: deploy
+  image: yueyehua/debian-ruby
+  dependencies:
+    - rspec
+  script:
+    - mv coverage/ public/
+  artifacts:
+    paths:
+      - public
+    expire_in: 30 days
+  only:
+    - develop

data/.rspec

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

data/CHANGELOG

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+1.0.0
+-----
+
+- Initial version

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+Contributing
+------------
+
+You are more than welcome to submit issues and merge requests to this project.
+
+### Tests
+
+Your commits must not break any tests.
+
+### Commits format
+
+Your commits must pass `git log --check` and messages should be formated
+like this (based on this excellent
+[post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)):
+
+```
+Summarize change in 50 characters or less
+
+Provide more detail after the first line. Leave one blank line below the
+summary and wrap all lines at 72 characters or less.
+
+If the change fixes an issue, leave another blank line after the final
+paragraph and indicate which issue is fixed in the specific format
+below.
+
+Fix #42
+```
+
+Also do your best to factor commits appropriately, ie not too large with
+unrelated things in the same commit, and not too small with the same small
+change applied N times in N different commits. If there was some accidental
+reformatting or whitespace changes during the course of your commits, please
+rebase them away before submitting the MR.
+
+### Files
+
+All files must be 80 columns width formatted (actually 79), exception only
+when it is really not possible.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,66 @@
+# APIReaper
+![License][license-img]
+[![build status](https://gitlab.com/vp-noc/apireaper/badges/develop/build.svg)](https://gitlab.com/vp-noc/apireaper/commits/develop)
+[![coverage report](https://gitlab.com/vp-noc/apireaper/badges/develop/coverage.svg)](https://gitlab.com/vp-noc/apireaper/commits/develop)
+
+1. [Overview](#overview)
+2. [Description](#role-description)
+3. [Setup](#setup)
+4. [Usage](#usage)
+5. [Limitations](#limitations)
+6. [Development](#development)
+7. [Miscellaneous](#miscellaneous)
+
+## Overview
+
+`APIReaper` is a simple tool to assess an API and its answer.
+
+## Description
+
+This tool validate if an API is able to reply to an incoming request and check
+if the data structure sent back is valid. It requires a valid schema to compare
+the data against.
+
+## Setup
+
+    $ gem install apireaper
+
+## Usage
+
+An interactive help is available with:
+
+    $ apireaper help
+
+## Examples
+
+To check an API:
+
+    $ apireaper check POST "<API_URL>" -h "<HEADER_KEY>:<HEADER_VALUE>" \
+     -d "<DATA_KEY>=<DATA_VALUE>" -S '<JSON_SCHEMA_OBJECT_AS_STRING>'
+
+To check an API with a schema in a file:
+
+    $ apireaper check POST "<API_URL>" -h "<HEADER_KEY>:<HEADER_VALUE>" \
+     -d "<DATA_KEY>=<DATA_VALUE>" -F '<PATH_TO_JSON_SCHEMA_FILE>'
+
+## Limitations
+
+It is currently only available to validate JSON data structure.
+More data structure may be available later.
+
+## Development
+
+Please read carefully [CONTRIBUTING.md](CONTRIBUTING.md) before making a merge
+request.
+
+```
+    ╚⊙ ⊙╝
+  ╚═(███)═╝
+ ╚═(███)═╝
+╚═(███)═╝
+ ╚═(███)═╝
+  ╚═(███)═╝
+   ╚═(███)═╝
+```
+
+[license-img]: https://img.shields.io/badge/license-Apache-blue.svg

data/Rakefile

@@ -0,0 +1,22 @@
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) { |task| task.verbose = false }
+
+task default: :spec

data/apireaper.gemspec

@@ -0,0 +1,62 @@
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apireaper/version'
+
+dev_deps = {
+  'bundler' => '~> 1.12',
+  'rspec' => '~> 3.5',
+  'rake' => '~> 11.2',
+  'rubocop' => '~> 0.43',
+  'webmock' => '~> 2.1',
+  'simplecov' => '~> 0.12'
+}
+
+deps = {
+  'json-schema' => '~> 2.8',
+  'thor' => '~> 0.19'
+}
+
+Gem::Specification.new do |s|
+  s.name = 'apireaper'
+  s.version = APIReaper::VERSION
+  s.authors = ['Richard Delaplace']
+  s.email = 'rdelaplace@vente-privee.com'
+  s.license = 'Apache-2.0'
+
+  s.summary = 'Tool to request and check an API.'
+  s.description = 'APIReaper is a simple tool to assess an API and its answer.'
+  s.homepage = 'https://github.com/vpgrp/apireaper'
+
+  s.files = `git ls-files`.lines.map(&:chomp)
+  s.bindir = 'bin'
+  s.executables = `git ls-files bin/*`.lines.map do |exe|
+    File.basename(exe.chomp)
+  end
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.0'
+
+  dev_deps.each_pair do |deps_gem, deps_version|
+    s.add_development_dependency deps_gem, deps_version
+  end
+
+  deps.each_pair do |deps_gem, deps_version|
+    s.add_dependency deps_gem, deps_version
+  end
+end

data/bin/apireaper

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+Signal.trap('INT') { exit 1 }
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w[.. lib])
+require 'rubygems'
+require 'apireaper'
+
+APIReaper.start

data/lib/apireaper/checker.rb

@@ -0,0 +1,132 @@
+#!/usr/bin/ruby
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'net/http'
+require 'uri'
+require 'json'
+require 'json-schema'
+
+module APIReaper
+  # This is an API response and data structure checker.
+  class Checker
+    # Class constructor method
+    def initialize(method, url, opts)
+      @method = method
+      @uri = URI.parse(url)
+      @opts = opts
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = @uri.scheme.eql?('https')
+    end
+
+    # Main method to run the check
+    def check
+      res = select_request
+      check_response_code(res.code)
+      check_data_structure(res.body)
+      puts 'All checks passed' unless @opts['quiet']
+    end
+
+    # Check data structure
+    def check_data_structure(data)
+      JSON::Validator.validate!(find_schema_source, data)
+      puts 'Response body is valid' unless @opts['quiet']
+    rescue JSON::Schema::ValidationError => e
+      exit_with_error(10, e.message)
+    end
+
+    # Check respose code
+    def check_response_code(code)
+      if code.to_i.between?(200, 299)
+        puts "Response code is valid: #{code}" unless @opts['quiet']
+      else
+        exit_with_error(11, "Response code is invalid: #{code}")
+      end
+    end
+
+    # Exit with the specified errno and message
+    def exit_with_error(errno, message)
+      puts message unless @opts['quiet']
+      exit errno
+    end
+
+    # Get the data structure schema source
+    def find_schema_source
+      if @opts['schema_file'].nil?
+        JSON.parse(
+          @opts['schema'].gsub(/:([a-zA-z]+)/, '"\\1"').gsub('=>', ': ')
+        )
+      else
+        @opts['schema_file']
+      end
+    end
+
+    # Split the data string into a hash
+    def format_data
+      data = {}
+      unless @opts['data'].nil?
+        pairs = @opts['data'].split('&')
+        pairs.each do |pair|
+          (key, value) = pair.split('=')
+          data[key] = value
+        end
+      end
+      data
+    end
+
+    # DELETE method
+    def rest_request_delete
+      exit_with_error(5, 'DELETE is not yet implemented')
+      # TODO
+    end
+
+    # GET method
+    def rest_request_get
+      exit_with_error(5, 'GET is not yet implemented')
+      # TODO
+    end
+
+    # POST method
+    def rest_request_post
+      req = Net::HTTP::Post.new(@uri.request_uri)
+      unless @opts['header'].nil?
+        @opts['header'].split(',').each do |h|
+          (key, value) = h.split(':')
+          req[key] = value
+        end
+      end
+      req.set_form_data(format_data)
+      @http.request(req)
+    end
+
+    # PUT method
+    def rest_request_put
+      exit_with_error(5, 'PUT is not yet implemented')
+      # TODO
+    end
+
+    # Select request method
+    def select_request
+      case @method.upcase
+      when 'DELETE' then rest_request_delete
+      when 'GET' then rest_request_get
+      when 'POST' then rest_request_post
+      when 'PUT' then rest_request_put
+      else raise "#{@method.upcase} is an unknown method"
+      end
+    end
+  end
+end

data/lib/apireaper/cli.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/ruby
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'thor'
+
+module APIReaper
+  # Simple CLI for apireaper
+  class CLI < Thor
+    desc 'version', 'Print apireaper current version'
+    def version
+      puts "APIReaper version #{APIReaper::VERSION}"
+    end
+
+    desc('check METHOD URL [options]',
+         'Send a request to an API and catch the reply in order to validate '\
+         'the data structure.')
+    option(
+      :header,
+      aliases: ['-h'],
+      desc: 'Http headers used with the request (comma separated). ' \
+            '<key>:<value>[,<key>:<value>[,...]]'
+    )
+    option(
+      :data,
+      aliases: ['-d'],
+      desc: 'Set of data sent with the request'
+    )
+    option(
+      :schema,
+      aliases: ['-S'],
+      default: '{"type"=>"object"}',
+      desc: 'Data structure description as formated schema'
+    )
+    option(
+      :schema_file,
+      aliases: ['-F'],
+      desc: 'Data structure description as formated schema in local file'
+    )
+    option(
+      :quiet,
+      aliases: ['-q'],
+      type: :boolean,
+      default: false,
+      desc: 'Silently do the job'
+    )
+    option(
+      :simulation,
+      aliases: ['-s'],
+      type: :boolean,
+      default: false,
+      desc: 'Simulation mode. Do nothing'
+    )
+    def check(method, url)
+      opts = options.dup
+      checker = APIReaper::Checker.new(method, url, opts)
+      checker.check unless opts['simulation']
+    end
+  end
+end

data/lib/apireaper/version.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module APIReaper
+  VERSION = '1.0.1'.freeze
+end

data/lib/apireaper.rb

@@ -0,0 +1,32 @@
+#!/urs/bin/ruby
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# APIReaper class
+module APIReaper
+  class << self
+    Dir[File.join(File.dirname(__FILE__), '*', '*.rb')].each do |file|
+      require file
+    end
+
+    def start(args = ARGV)
+      APIReaper::CLI.start(args)
+    rescue => e
+      $stderr.puts e
+      exit(1)
+    end
+  end
+end

data/spec/apireaper/checker_spec.rb

@@ -0,0 +1,102 @@
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+def print_out(code)
+  case code
+  when 200, 201, 202
+    "Response code is valid: #{code}\n" \
+    "Response body is valid\n" \
+    "All checks passed\n"
+  end
+end
+
+describe APIReaper::Checker do # rubocop:disable Metrics/BlockLength
+  %w[delete get put].each do |method|
+    context "check #{method} http://api.test.yueyehua.net/ -q" do
+      it 'tries unimplemented commands.' do
+        expect { start(self) }.to raise_error(SystemExit)
+      end
+    end
+  end
+
+  context 'check notexistingcmd http://api.test.yueyehua.net/ -q' do
+    it 'tries unimplemented commands.' do
+      expect { start(self) }.to raise_error(SystemExit)
+    end
+  end
+
+  context 'check post http://api.test.yueyehua.net/' do
+    it 'requests an API without extra arguments.' do
+      expect { start(self) }.to output(print_out(200)).to_stdout
+    end
+  end
+
+  context 'check post http://api.test.yueyehua.net/ -d k=v' do
+    it 'requests an API with datas.' do
+      expect { start(self) }.to output(print_out(201)).to_stdout
+    end
+  end
+
+  context 'check post http://api.test.yueyehua.net/ -h k:v' do
+    it 'requests an API with headers.' do
+      expect { start(self) }.to output(print_out(202)).to_stdout
+    end
+  end
+
+  context 'check post http://api.test.yueyehua.net/ -q' do
+    it 'requests an API with quiet option.' do
+      expect { start(self) }.to output('').to_stdout
+    end
+  end
+
+  context 'check post http://api.fail.yueyehua.net/ -h l:w -d l=w -q' do
+    it 'requests an API and receive 404 status code.' do
+      expect { start(self) }.to raise_error(SystemExit)
+    end
+  end
+
+  context 'check post http://api.test.yueyehua.net/ -h k:v -d k=v' do
+    it 'requests an API and test the response body without defined schema.' do
+      expect { start(self) }.to output(print_out(203)).to_stdout
+    end
+  end
+
+  schema_file = 'spec/files/schema'
+  opts1 = "-h k:v -d k=v -F #{schema_file}"
+  context "check post http://api.test.yueyehua.net/ #{opts1}" do
+    it 'requests an API and test the response body with schema file.' do
+      expect { start(self) }.to output(print_out(203)).to_stdout
+    end
+  end
+
+  schema_file = 'spec/files/schema'
+  opts2 = "-h k:v -d k=v -q -F #{schema_file}"
+  context "check post http://api.fail.yueyehua.net/ #{opts2}" do
+    it 'requests an API and test the response body with schema file.' do
+      expect { start(self) }.to raise_error(SystemExit)
+    end
+  end
+
+  schema = JSON.parse(File.read('spec/files/schema'))
+  opts3 = "-h k:v -d k=v -S #{JSON.dump(schema)}"
+  context "check post http://api.test.yueyehua.net/ #{opts3}" do
+    it 'requests an API and test the response body with a schema as option.' do
+      expect { start(self) }.to output(print_out(203)).to_stdout
+    end
+  end
+end

data/spec/apireaper/cli_spec.rb

@@ -0,0 +1,33 @@
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe APIReaper::CLI do
+  context 'version' do
+    it 'prints the version.' do
+      out = "APIReaper version #{APIReaper::VERSION}\n"
+      expect { start(self) }.to output(out).to_stdout
+    end
+  end
+
+  context 'notexistingcmd' do
+    it 'is an unknown command and does nothing.' do
+      out = "Could not find command \"notexistingcmd\".\n"
+      expect { start(self) }.to output(out).to_stderr
+    end
+  end
+end

data/spec/apireaper/stubs/servers_stubs.rb

@@ -0,0 +1,44 @@
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+def body_file(file)
+  dir = File.dirname(__FILE__)
+  File.read(File.join(dir, '..', '..', 'files', file))
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:post, 'http://api.test.yueyehua.net/')
+      .to_return('status' => 200, 'body' => '{}', 'headers' => {})
+    stub_request(:post, 'http://api.test.yueyehua.net/')
+      .with('body' => { 'k' => 'v' })
+      .to_return('status' => 201, 'body' => '{}', 'headers' => {})
+    stub_request(:post, 'http://api.test.yueyehua.net/')
+      .with('headers' => { 'k' => 'v' })
+      .to_return('status' => 202, 'body' => '{}', 'headers' => {})
+    stub_request(:post, 'http://api.test.yueyehua.net/')
+      .with('body' => { 'k' => 'v' }, 'headers' => { 'k' => 'v' })
+      .to_return('status' => 203, 'body' => body_file('body'), 'headers' => {})
+    stub_request(:post, 'http://api.fail.yueyehua.net/')
+      .with('body' => { 'k' => 'v' }, 'headers' => { 'k' => 'v' })
+      .to_return('status' => 204, 'body' => body_file('fail'), 'headers' => {})
+    stub_request(:post, 'http://api.fail.yueyehua.net/')
+      .with('body' => { 'l' => 'w' }, 'headers' => { 'l' => 'w' })
+      .to_return('status' => 404, 'body' => '{}', 'headers' => {})
+  end
+end

data/spec/apireaper_spec.rb

@@ -0,0 +1,23 @@
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe APIReaper do
+  it 'has a version number' do
+    expect(APIReaper::VERSION).not_to be nil
+  end
+end

data/spec/files/body

@@ -0,0 +1 @@
+{"h":{},"a":[],"i":10,"s":"azerty","b":true,"n":null}

data/spec/files/fail

@@ -0,0 +1 @@
+{"h":null,"a":[],"i":10,"s":"azerty","b":true,"n":null}

data/spec/files/schema

@@ -0,0 +1 @@
+{"type":"object","properties":{"a":{"type":"array"},"b":{"type":"boolean"},"h":{"type":"object"},"i":{"type":"integer"},"n":{"type":"null"},"s":{"type":"string"}}}

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+#
+# Copyright (c) 2017 Richard Delaplace, Vente-Privee.Com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'apireaper'
+require 'webmock/rspec'
+
+# Force expect syntax over should
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+dir = File.dirname(__FILE__)
+# Load helpers
+Dir[File.join(dir, 'helpers', '*.rb')].each { |file| require file }
+
+def now
+  Time.new.strftime('%Y-%m-%dT%H:%M:%S%z').insert(-3, ':')
+end
+
+# Load stubs
+files = File.join(dir, 'apireaper', 'stubs', '*.rb')
+Dir[files].each { |file| require file }
+
+# To test the cli
+def start(caller_object, subcommand = nil)
+  cmd = caller_object.class.description.split(' ')
+  args = [subcommand, *cmd].compact
+  APIReaper.start(args)
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: apireaper
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Richard Delaplace
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: APIReaper is a simple tool to assess an API and its answer.
+email: rdelaplace@vente-privee.com
+executables:
+- apireaper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- CHANGELOG
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- apireaper.gemspec
+- bin/apireaper
+- lib/apireaper.rb
+- lib/apireaper/checker.rb
+- lib/apireaper/cli.rb
+- lib/apireaper/version.rb
+- spec/apireaper/checker_spec.rb
+- spec/apireaper/cli_spec.rb
+- spec/apireaper/stubs/servers_stubs.rb
+- spec/apireaper_spec.rb
+- spec/files/body
+- spec/files/fail
+- spec/files/schema
+- spec/spec_helper.rb
+homepage: https://github.com/vpgrp/apireaper
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Tool to request and check an API.
+test_files: []