owasp_zap 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a80255539473310bacf8733abfdc8f71b4abec7d
-  data.tar.gz: 508ea5d854379c64d306da68d08a577c90d207c9
+  metadata.gz: 0536baa69ad5457c793282408ccf7c8948a1c815
+  data.tar.gz: 2f53b51b051b6c902150091e5622cf7d434d6ee2
 SHA512:
-  metadata.gz: 3b9147943357fdd6fee21cc68375f419c2cbc46ca8fe6ac3cae2400f5dbdd18f49f755dbabd8a4819be1a82de0e71a25b52e5818a11d254675755c820dd95f1d
-  data.tar.gz: 56f636883c71f7399bf8008e7bc16f44adbb16bb6fd9a8512a8b5b9bd16bc73cc00f18e1163dac6c9bf1badcdf5cfd5983941d47e35275b2d0c4be4b12e0b291
+  metadata.gz: 677a0e20af2976aa15a22f3012dae413ddbeabed580f1eddcd0596635494dd3da6a9a9e682b241ae89832df2d7aae10ba6595682be511de45284f5bd0baf5dbd
+  data.tar.gz: b17f2db63579dcf64a237e41ebe2a9abb5b9906693357e2d337f6a96b7602850ef36b90d027ebe18a90ef65c2a176a2bd4c02cbe98f52c65ba56ab54b14aab91

data/README.md

@@ -1,6 +1,12 @@
 # OwaspZap
 
-TODO: Write a gem description
+
+A ruby client to access the HTTP API from Zap Proxy (http://code.google.com/p/zaproxy)
+
+if you need a rpm, check it here: https://build.opensuse.org/package/show/home:vpereirabr/owasp-zap
+
+[![Build Status](https://travis-ci.org/vpereira/owasp_zap.png?branch=master)](https://travis-ci.org/vpereira/owasp_zap)
+[![Code Climate](https://codeclimate.com/github/vpereira/owasp_zap.png)](https://codeclimate.com/github/vpereira/owasp_zap)
 
 ## Installation
 
@@ -18,7 +24,17 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    require 'owasp_zap'
+    
+    include OwaspZap 
+
+    z = Zap.new :target=>'http://xxx.xxx.xxx' #create new Zap instance with default params
+    z = Zap.new :target=>'http://yyy.yyy.yyy', :zap=>"/usr/share/owasp-zap/zap.sh" #if you got my obs package
+    z.start # start interactive
+    # TODO
+    # document it further :) 
+    z.start :daemon=>true # start in daemon mode
+    z.shutdown # stop the proxy
 
 ## Contributing
 

data/lib/owasp_zap.rb

@@ -67,9 +67,14 @@ module OwaspZap
 
         #TODO
         #DOCUMENT the step necessary: install ZAP under $home/ZAP or should be passed to new as :zap parameter
-        def start
+        def start(params = {})
+            cmd_line = if params.key? :daemon
+                "#{@zap_bin} -daemon"
+            else
+                @zap_bin
+            end
             fork do
-               exec @zap_bin 
+               exec cmd_line
             end
         end
 

data/lib/owasp_zap/auth.rb

@@ -32,30 +32,31 @@ module OwaspZap
         # post_data: an already encoded string like "email%3Dfoo%2540example.org%26passwd%3Dfoobar" 
         # TODO: offer a way to encode it, giving a hash?
         def set_login_url(args)
-            url = Addressable::URI.parse "#{@base}/auth/action/setLoginUrl/"
-            url.query_values = {:zapapiformat=>"JSON",:url=>args[:url],:postData=>args[:post_data],:contextId=>@ctx}
-            RestClient::get url.normalize.to_str
+            set_query "#{@base}/auth/action/setLoginUrl/",:postData=>args[:post_data]
         end
 
         def set_logout_url(args)
-            url = Addressable::URI.parse "#{@base}/auth/action/setLogoutUrl/"
-            url.query_values = {:zapapiformat=>"JSON",:url=>args[:url],:postData=>args[:post_data],:contextId=>@ctx}
-            RestClient::get url.normalize.to_str
+            set_query "#{@base}/auth/action/setLogoutUrl/",:postData=>args[:post_data]
         end
 
         def set_logged_in_indicator(args)
-            url = Addressable::URI.parse "#{@base}/auth/action/setLoggedInIndicator/"
-            url.query_values = {:zapapiformat=>"JSON",:url=>args[:url],:postData=>args[:indicator],:contextId=>@ctx}
-            RestClient::get url.normalize.to_str
+            set_query "#{@base}/auth/action/setLoggedInIndicator/",:postData=>args[:indicator]
         end
 
         def set_logged_out_indicator(args)
-            url = Addressable::URI.parse "#{@base}/auth/action/setLoggedOutIndicator/"
-            url.query_values = {:zapapiformat=>"JSON",:url=>args[:url],:indicator=>args[:indicator],:contextId=>@ctx}
-            RestClient::get url.normalize.to_str
+            set_query "#{@base}/auth/action/setLoggedOutIndicator/", :indicator=>args[:indicator]
         end
 
         private
+
+        # addr a string like #{@base}/auth/foo/bar
+        # params a hash with custom params that should be added to the query_values
+        def set_query(addr, params)
+            default_params = {:zapapiformat=>"JSON",:url=>args[:url],:contextId=>@ctx}
+            url Addressable::URI.parse addr
+            url.query_values = default_params.merge(params)
+            RestClient::get url.normalize.to_str
+        end
         def to_url(str)
             method_str = str.to_s
             method_str.extend OwaspZap::StringExtension # monkey patch just this instance

data/lib/owasp_zap/version.rb

@@ -1,3 +1,3 @@
 module OwaspZap
-  VERSION = "0.0.1"
+  VERSION = "0.0.5"
 end

data/spec/zap_spec.rb

@@ -120,3 +120,21 @@ describe "StringExtension" do
         assert_equal @str.snake_case,"foo_bar" 
     end
 end
+
+describe "status_for" do 
+    before do
+        @h = Zap::Zap.new :target=>"http://127.0.0.1"
+        stub_request(:get, "http://127.0.0.1:8080/JSON/spider/view/status/?zapapiformat=JSON").to_return(:status => 200, :body => {:status=>"100"}.to_json, :headers => {})
+        stub_request(:get, "http://127.0.0.1:8080/JSON/ascan/view/status/?zapapiformat=JSON").to_return(:status => 200, :body => {:status=>"100"}.to_json, :headers => {})
+    end
+
+    it "should create a ascan" do
+        @h.status_for(:ascan).wont_be :nil?
+    end
+    it "should create a spider" do
+        @h.status_for(:spider).wont_be :nil?
+    end
+    it "should return an unknown" do
+        @h.status_for(:foo).wont_be :nil?
+    end
+end 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owasp_zap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Victor Pereira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler