https://github.com/hahwul/zaproxy-ruby
A Ruby Implementation and Library for Easy Utilization of ZAP API
https://github.com/hahwul/zaproxy-ruby
ruby ruby-gem security zap zaproxy
Last synced: about 1 month ago
JSON representation
A Ruby Implementation and Library for Easy Utilization of ZAP API
- Host: GitHub
- URL: https://github.com/hahwul/zaproxy-ruby
- Owner: hahwul
- Created: 2023-10-29T15:13:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-19T15:35:20.000Z (over 1 year ago)
- Last Synced: 2025-04-30T17:52:17.225Z (about 1 month ago)
- Topics: ruby, ruby-gem, security, zap, zaproxy
- Language: Ruby
- Homepage: https://rubygems.org/gems/zaproxy
- Size: 127 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# zaproxy-ruby
A Ruby Implementation and Library for Easy Utilization of [ZAP API](https://www.zaproxy.org/docs/api/#introduction).
```ruby
require 'zaproxy'
instance = ZAPv2.new(endpoint: 'http://localhost:8090')
instance.core.sites
# ["https://www.hahwul.com", "https://github.com"]},
# @success=true>
instance.spider.scan('https://www.hahwul.com','','','','')
# "0"}, @success=true>
```
## Getting started
The `zaproxy` gem provides Ruby bindings to the ZAP(Zed Attack Proxy) tool, allowing you to automate security testing and scanning of web applications. You can install the gem using either `gem` or `bundler`.
### Gem
```bash
gem install zaproxy
```
### Bundler
If you are managing dependencies with Bundler, you can add the zaproxy gem to your project's Gemfile and then use Bundler to install it.
Create a Gemfile in your project directory. and Open the Gemfile and add the following line to specify the zaproxy gem
```ruby
# Gemfile
gem 'zaproxy'
```
In your terminal, navigate to your project directory and run the following command to install the gem and its dependencies using Bundler
```bash
bundle install
```
## Documents
- [RubyDocs](https://rubydoc.info/gems/zaproxy)