diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..f9c83799 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# Contributing to WPScan + +## Licensing + +By submitting code contributions to the WPScan development team via Github Pull Requests, or any other method, it is understood that the contributor is offering the WPScan company (company number 83421476900012), which is registered in France, the unlimited, non-exclusive right to reuse, modify, and relicense the code. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..3be0fa9e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,27 @@ +### Subject of the issue +Describe your issue here. + +### Your environment +* Version of WPScan: +* Version of Ruby: +* Operating System (OS): + +### Steps to reproduce +Tell us how to reproduce this issue. + +### Expected behavior +Tell us what should happen. + +### Actual behavior +Tell us what happens instead. + +### What have you already tried +Tell us what you have already tried to do to fix the issue you are having. + +Things you have tried (where relevant): + +* Update WPScan to the latest version [ ] +* Update Ruby to the latest version [ ] +* Ensure you can reach the target site using cURL [ ] +* Proxied WPScan through a HTTP proxy to view the raw traffic [ ] +* Ensure you are using a supported Operating System (Linux and macOS) [ ] \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..b6b8d04c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,3 @@ +## Licensing + +By submitting code contributions to the WPScan development team via Github Pull Requests, or any other method, it is understood that the contributor is offering the WPScan company (company number 83421476900012), which is registered in France, the unlimited, non-exclusive right to reuse, modify, and relicense the code. \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..b02894e1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +*.gem +*.rbc +.bundle +.config +coverage +pkg +rdoc +Gemfile.lock + +# YARD artifacts +.yardoc +_yardoc +doc/ +.wpscan/ diff --git a/.rspec b/.rspec new file mode 100644 index 00000000..ba44b749 --- /dev/null +++ b/.rspec @@ -0,0 +1,2 @@ +--color +--fail-fast diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 00000000..6d8218d1 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,28 @@ +AllCops: + TargetRubyVersion: 2.3 + Exclude: + - '*.gemspec' + - 'vendor/**/*' +ClassVars: + Enabled: false +LineLength: + Max: 120 +MethodLength: + Max: 20 +Lint/UriEscapeUnescape: + Enabled: false +Metrics/AbcSize: + Max: 25 +Metrics/BlockLength: + Exclude: + - 'spec/**/*' +Metrics/ClassLength: + Max: 150 +Metrics/CyclomaticComplexity: + Max: 8 +Style/Documentation: + Enabled: false +Style/FrozenStringLiteralComment: + Enabled: false +Style/FormatStringToken: + Enabled: false diff --git a/.ruby-gemset b/.ruby-gemset new file mode 100644 index 00000000..49662630 --- /dev/null +++ b/.ruby-gemset @@ -0,0 +1 @@ +wpscanv3 diff --git a/.ruby-version b/.ruby-version new file mode 100644 index 00000000..437459cd --- /dev/null +++ b/.ruby-version @@ -0,0 +1 @@ +2.5.0 diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..31a083ae --- /dev/null +++ b/.travis.yml @@ -0,0 +1,31 @@ +language: ruby +sudo: false +cache: bundler +rvm: + - 2.3.0 + - 2.3.1 + - 2.3.2 + - 2.3.3 + - 2.3.4 + - 2.3.5 + - 2.3.6 + - 2.3.7 + - 2.4.1 + - 2.4.2 + - 2.4.3 + - 2.4.4 + - 2.5.0 + - 2.5.1 + - ruby-head +before_install: + - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc" + - "gem update --system" +matrix: + allow_failures: + - rvm: ruby-head +script: + - bundle exec rubocop + - bundle exec rspec +notifications: + email: + - team@wpscan.org