zaproxy 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3095ddde4abca34f1e4e4f178fb336d6945becc2e9d88cc15230209e4670b302
-  data.tar.gz: 3ca82263c062f3d0aa00cf9c170d8d3243b0e15064dde7ac8e7e88ddb44e9d43
+  metadata.gz: 7a7b42822cb0a62967e19adca8d3e95b48130326eb83e341800c2444f10584a1
+  data.tar.gz: 304679bf6e8f56dcb4a4970183a94e9e1bd734bfeb610ae68ea87a6fd092a162
 SHA512:
-  metadata.gz: c68be8db5eec6a43f6a12d8ad06d0a643f6aeebecbba728110d8d713b095821b1171430ebf3116961b98a245da5d2f71afd7977fea983d839edfe15ce964164f
-  data.tar.gz: fb31a558e8757deb5e0dd0c22548ac61d7c4dfe148cb481ac61b8b8e3fd548fb4f3b115965f39979fce8d918c9727d8e071130cf6310fc5466994d2e332b1258
+  metadata.gz: 307ffb225136f156106af51203e4ed3ba8614e43da79a391687f8fbc36ba9d46386aed2ffd585e0dc8f4cb9186fdd2405b495b753eea8f5f0c88c4783f5c17e3
+  data.tar.gz: b6e0c7694e9f50d7117bbb334a8e8362c445be1dd8b951f4a661fddc5ba08d8152a9ee419a2f6b98d411afa078a9ee9aa998d8a7e7d9289fdbe5c622cafc794d

data/README.md

@@ -3,3 +3,36 @@
 # zaproxy-ruby
 
 A Ruby Implementation and Library for Easy Utilization of [ZAP API](https://www.zaproxy.org/docs/api/#introduction).
+
+```ruby
+require 'zapv2'
+
+
+```
+
+## 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)

data/lib/zap/result.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'json'
+
+class Result
+  attr_accessor :success, :message, :object
+
+  def initialize(success, message)
+    @success = success
+    @message = message
+    @object = JSON.parse(message) if message.is_a?(String)
+  end
+end

data/lib/{zap.rb → zap/zap.rb}

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'net/http'
+require_relative 'result'
 
 class ZAP
   API_KEY_DEFAULT = ''
@@ -21,24 +22,44 @@ class ZAP
 
     def get(path)
       request = build_request(Net::HTTP::Get, path)
-      send_request(request)
+      response = send_request(request)
+      if response.code == '200'
+        Result.new(true, response.body)
+      else
+        Result.new(false, response.body)
+      end
     end
 
     def post(path, data)
       request = build_request(Net::HTTP::Post, path)
       request.set_form_data(data)
-      send_request(request)
+      response = send_request(request)
+      if response.code == '200'
+        Result.new(true, response.body)
+      else
+        Result.new(false, response.body)
+      end
     end
 
     def delete(path)
       request = build_request(Net::HTTP::Delete, path)
-      send_request(request)
+      response = send_request(request)
+      if response.code == '200'
+        Result.new(true, response.body)
+      else
+        Result.new(false, response.body)
+      end
     end
 
     def put(path, data)
       request = build_request(Net::HTTP::Put, path)
       request.set_form_data(data)
-      send_request(request)
+      response = send_request(request)
+      if response.code == '200'
+        Result.new(true, response.body)
+      else
+        Result.new(false, response.body)
+      end
     end
 
     private

data/lib/zaproxy.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'zap/zapv2'

data/zaproxy.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = 'zaproxy'
-  spec.version = '0.0.2'
+  spec.version = '0.0.3'
   spec.authors = ['hahwul']
   spec.email = ['hahwul@gmail.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaproxy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - hahwul
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-05 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby Implementation and Library for Easy Utilization of ZAP API
 email:
@@ -22,54 +22,56 @@ files:
 - README.md
 - Rakefile
 - SECURITY.md
-- lib/v2apis/_template.rb
-- lib/v2apis/access_control.rb
-- lib/v2apis/acsrf.rb
-- lib/v2apis/ajax_spider.rb
-- lib/v2apis/alert.rb
-- lib/v2apis/alert_filter.rb
-- lib/v2apis/ascan.rb
-- lib/v2apis/authentication.rb
-- lib/v2apis/authorization.rb
-- lib/v2apis/automation.rb
-- lib/v2apis/autoupdate.rb
-- lib/v2apis/break.rb
-- lib/v2apis/client.rb
-- lib/v2apis/context.rb
-- lib/v2apis/core.rb
-- lib/v2apis/exim.rb
-- lib/v2apis/forced_user.rb
-- lib/v2apis/graphql.rb
-- lib/v2apis/http_sessions.rb
-- lib/v2apis/hud.rb
-- lib/v2apis/import_urls.rb
-- lib/v2apis/keyboard.rb
-- lib/v2apis/local_proxies.rb
-- lib/v2apis/network.rb
-- lib/v2apis/openapi.rb
-- lib/v2apis/params.rb
-- lib/v2apis/pnh.rb
-- lib/v2apis/postman.rb
-- lib/v2apis/pscan.rb
-- lib/v2apis/quickstartlaunch.rb
-- lib/v2apis/replacer.rb
-- lib/v2apis/reports.rb
-- lib/v2apis/retest.rb
-- lib/v2apis/reveal.rb
-- lib/v2apis/revisit.rb
-- lib/v2apis/rule_config.rb
-- lib/v2apis/script.rb
-- lib/v2apis/search.rb
-- lib/v2apis/selenium.rb
-- lib/v2apis/session_management.rb
-- lib/v2apis/soap.rb
-- lib/v2apis/spider.rb
-- lib/v2apis/stats.rb
-- lib/v2apis/users.rb
-- lib/v2apis/wappalyzer.rb
-- lib/v2apis/websocket.rb
-- lib/zap.rb
-- lib/zapv2.rb
+- lib/zap/result.rb
+- lib/zap/v2apis/_template.rb
+- lib/zap/v2apis/access_control.rb
+- lib/zap/v2apis/acsrf.rb
+- lib/zap/v2apis/ajax_spider.rb
+- lib/zap/v2apis/alert.rb
+- lib/zap/v2apis/alert_filter.rb
+- lib/zap/v2apis/ascan.rb
+- lib/zap/v2apis/authentication.rb
+- lib/zap/v2apis/authorization.rb
+- lib/zap/v2apis/automation.rb
+- lib/zap/v2apis/autoupdate.rb
+- lib/zap/v2apis/break.rb
+- lib/zap/v2apis/client.rb
+- lib/zap/v2apis/context.rb
+- lib/zap/v2apis/core.rb
+- lib/zap/v2apis/exim.rb
+- lib/zap/v2apis/forced_user.rb
+- lib/zap/v2apis/graphql.rb
+- lib/zap/v2apis/http_sessions.rb
+- lib/zap/v2apis/hud.rb
+- lib/zap/v2apis/import_urls.rb
+- lib/zap/v2apis/keyboard.rb
+- lib/zap/v2apis/local_proxies.rb
+- lib/zap/v2apis/network.rb
+- lib/zap/v2apis/openapi.rb
+- lib/zap/v2apis/params.rb
+- lib/zap/v2apis/pnh.rb
+- lib/zap/v2apis/postman.rb
+- lib/zap/v2apis/pscan.rb
+- lib/zap/v2apis/quickstartlaunch.rb
+- lib/zap/v2apis/replacer.rb
+- lib/zap/v2apis/reports.rb
+- lib/zap/v2apis/retest.rb
+- lib/zap/v2apis/reveal.rb
+- lib/zap/v2apis/revisit.rb
+- lib/zap/v2apis/rule_config.rb
+- lib/zap/v2apis/script.rb
+- lib/zap/v2apis/search.rb
+- lib/zap/v2apis/selenium.rb
+- lib/zap/v2apis/session_management.rb
+- lib/zap/v2apis/soap.rb
+- lib/zap/v2apis/spider.rb
+- lib/zap/v2apis/stats.rb
+- lib/zap/v2apis/users.rb
+- lib/zap/v2apis/wappalyzer.rb
+- lib/zap/v2apis/websocket.rb
+- lib/zap/zap.rb
+- lib/zap/zapv2.rb
+- lib/zaproxy.rb
 - openapi.yaml
 - zaproxy.gemspec
 homepage: https://github.com/hahwul/zaproxy-ruby