tap-mechanize 0.5.0

data/views/tap/mechanize/capture/index.erb

@@ -0,0 +1,11 @@
+<p>Captures:</p>
+<ul>
+<% if captures.empty? %>
+  <li>(none)</li>
+<% end %>
+<% captures.each do |capture| %>
+  <li><a href="<%= uri("show/#{capture}") %>"><%= capture %></a> (<a href="<%= uri("destroy/#{capture}") %>">x</a>)</li>
+<% end %>
+</ul>
+
+<p>See the <a href="<%= uri(:tutorial) %>">Tutorial</a> for help.</p>

data/views/tap/mechanize/capture/redirect.css

@@ -0,0 +1,28 @@
+div#<%= prefix %> {
+  position:relative;
+  top:0;
+  left:0;
+  background-color:#EFE3BC;
+  border: thin solid white;
+  font-family: arial;
+  font-size: 16px;
+  padding:0.3em;
+}
+
+span#<%= prefix %>message { 
+  font-weight:bold;
+}
+
+a#<%= prefix %>revert { 
+  position:absolute;
+  top:0.3em;
+  right:0.3em;
+  font-size:0.8em;
+  font-weight:normal;
+  text-decoration:none;
+}
+
+/* form and link notifications */
+input[type=submit] {
+  border: medium solid #EFE3BC; 
+}

data/views/tap/mechanize/capture/redirect.js

@@ -0,0 +1,184 @@
+var RedirectHttp = {
+  submit_request: false,
+  keep_content: false,
+  name: 'request',
+  
+  /* Returns the target uri for redirection */
+  redirect_uri: function() {
+    return '<%= redirect_action %>/' + escape(RedirectHttp.name) + "/" + RedirectHttp.keep_content;
+  },
+  
+  /* Redirects forms and then submits the form if submit is true. */
+  redirect_form: function(form, submit) {
+    if(typeof submit == 'undefined') { submit = true };
+    
+    if(submit) {
+      
+      // form.submit() raises an error if an input is named submit
+      // (note you're hosed if the input is not type=submit)
+      var submit_inputs = [];
+      var inputs = document.getElementsByTagName('input');
+      for(i=0; i<inputs.length; i++) {
+        var input = inputs[i];
+        if(input.getAttribute('type') == 'submit' && input.getAttribute('name') == 'submit') {
+          input.setAttribute('name', '<%= prefix %>submit');
+          submit_inputs.push(input);
+        }
+      }
+      
+      // this works without recursing to redirect_form because the onsubmit
+      // event handler is not executed when a form is submitted by Javascript
+      form.setAttribute('action', RedirectHttp.redirect_uri());
+      form.submit();
+      
+      if(RedirectHttp.submit_request) {
+        this.revert();
+        form.submit();
+      };
+      
+      // reset the submit inputs
+      for(i=0; i<submit_inputs.length; i++) {
+        var input = submit_inputs[i];
+        input.setAttribute('name', 'submit');
+      }
+    };
+  },
+  
+  /* Redirects links and then submits the link if submit is true. */
+  redirect_link: function(link, submit) {
+    if(typeof submit == 'undefined') { submit = true };
+    
+    if(submit) {
+      var original_href = link.getAttribute('<%= prefix %>original_href');
+      location.href = RedirectHttp.redirect_uri() + '?<%= redirect_parameter %>=' + escape(original_href);
+      
+      if(RedirectHttp.submit_request) {
+        this.revert();
+        location.href = link.getAttribute("href");
+      };
+    };
+  },
+  
+  /* Wraps the current onX event so that it may be called without interfering
+   * with the redirection (ie wrapper). */
+  wrap: function(current, wrapper) {
+    return "try {" +
+    "  var <%= prefix %>result = function(<%= prefix %>this) { " + 
+        current.replace(/(\W)this(?=\W)/g, "$1<%= prefix %>this") +
+    "  }(this);" + 
+    "  RedirectHttp." + wrapper + "(this, <%= prefix %>result);" +
+    "} catch(ex) {" +
+      "alert('Error during redirection: ' + ex.message + '\\nOriginal onsubmit: " + current.replace(/'/g, "\\'") + "');" +
+    "}; return false;"
+  },
+  
+  /* Redirects forms and links to '<%= redirect_action %>' */
+  redirect: function() {    
+    try {
+      
+      // redirect forms to the redirect_action
+      var forms = document.getElementsByTagName('form');
+      for(i=0; i<forms.length; i++) {
+        var form = forms[i];
+        
+        // do not redirect forms related to <%= prefix %>
+        if(form.getAttribute("class") != "<%= prefix %>form") {
+          
+          // store the original action
+          var input = document.createElement("input"); 
+          input.setAttribute("id", '<%= redirect_parameter %>_' + i);
+          input.setAttribute("name", '<%= redirect_parameter %>');
+          input.setAttribute("type", 'hidden');
+          input.setAttribute("value", form.getAttribute('action'));
+        
+          form.setAttribute('<%= prefix %>index', i);
+          form.appendChild(input);
+        
+          // redirect onSubmit
+          var current_on_submit = '';
+          if(form.hasAttribute("onSubmit")) current_on_submit = form.getAttribute("onSubmit");
+          var on_submit = RedirectHttp.wrap(current_on_submit, 'redirect_form');
+        
+          form.setAttribute("onSubmit", on_submit);
+          form.setAttribute("<%= prefix %>original_callback", current_on_submit);
+        }
+      }
+      
+      // redirect links to the redirect_action
+      var links = document.getElementsByTagName('a');
+      for(i=0; i<links.length; i++) {
+        var link = links[i];
+        
+        // do not redirect links related to <%= prefix %>
+        if(link.getAttribute("class") != "<%= prefix %>link") {
+          
+          // store the original href
+          link.setAttribute("<%= prefix %>original_href", link.getAttribute("href"));
+        
+          // redirect onClick
+          var current_on_click = '';
+          if(link.hasAttribute("onClick")) current_on_click = link.getAttribute("onClick");
+          var on_click = RedirectHttp.wrap(current_on_click, 'redirect_link');
+        
+          link.setAttribute("onClick", on_click);
+          link.setAttribute("<%= prefix %>original_callback", current_on_click);
+        };
+      }
+      
+    } catch(ex) {
+      alert_error(ex);
+    }
+  },
+  
+  /* Reverts redirection and removes the redirection div */
+  revert: function() {
+    try {
+      
+      // redirect forms back to original actions
+      var forms = document.getElementsByTagName('form');
+      for(i=0; i<forms.length; i++) {
+        var form = forms[i];
+      
+        // check in case the form was not redirected
+        if(form.hasAttribute('<%= prefix %>index')) {
+          var index = form.getAttribute('<%= prefix %>index');
+          var input = document.getElementById("<%= redirect_parameter %>_" + index);
+          
+          form.setAttribute('action', input.value);
+          form.removeAttribute('<%= prefix %>index');
+          form.removeChild(input);
+          
+          form.setAttribute('onSubmit', form.getAttribute('<%= prefix %>original_callback'));
+          form.removeAttribute('<%= prefix %>original_callback');
+        }
+      }
+      
+      // redirect links back to original hrefs
+      var links = document.getElementsByTagName('a');
+      for(i=0; i<links.length; i++) {
+        var link = links[i];
+        
+        // check in case the link was not redirected
+        if(link.hasAttribute('<%= prefix %>original_href')) {
+          link.setAttribute('href', link.getAttribute('<%= prefix %>original_href'));
+          link.removeAttribute('<%= prefix %>original_href');
+          
+          link.setAttribute('onClick', link.getAttribute('<%= prefix %>original_callback'));
+          link.removeAttribute('<%= prefix %>original_callback');
+        }
+      }
+      
+    } catch(ex) {
+      alert_error(ex);
+    }
+    
+    // remove self
+    var redirect_http = document.getElementById("<%= prefix %>")
+    if(redirect_http) document.body.removeChild(redirect_http);
+  },
+  
+  // Alerts of errors due to RedirectHttp
+  alert_error: function(ex) {
+    alert("Redirect HTTP Error: " + ex.message + "\n\n The webpage may have been corrupted; be sure to refresh.");
+  }
+};

data/views/tap/mechanize/capture/redirect_http.erb

@@ -0,0 +1,15 @@
+<span id='<%= prefix %>message'>Redirecting HTTP Requests</span>
+<ul id='<%= prefix %>controls' >
+  <li><input id='<%= prefix %>name' type='text' value='' onchange='javascript:RedirectHttp.name=this.value;'>name</input></li>
+  <li><input id='<%= prefix %>submit_request' type='checkbox' onchange='javascript:RedirectHttp.submit_request=this.checked;'>submit after capture</input></li>
+  <li><input id='<%= prefix %>keep_content' type='checkbox' onchange='javascript:RedirectHttp.keep_content=this.checked;'>capture uploaded data</input></li>
+</ul>
+<a id='<%= prefix %>revert' href='javascript:RedirectHttp.revert();' class="<%= prefix %>link">close</a>
+
+<style type="text/css">
+<%= css %>
+</style>
+
+<script type="text/javascript">
+<%= script %>
+</script>

data/views/tap/mechanize/capture/test.erb

@@ -0,0 +1,108 @@
+<h1>Redirection Tests</h1>
+
+<p>
+Redirection occurs onSubmit for forms, and onClick for links.  The redirection
+wraps the current hook, if it exists, and ensures that it executes properly.
+References to 'this' and return statements should be handled properly, but
+naturally it's hard to handle all cases.
+</p>
+
+<p>
+Run tests by redirecting, then submitting the forms to see if the correct
+actions occur.
+</p>
+
+<% 
+def assert(message, *javascripts)
+  assert_literal message, *javascripts.collect {|js| "'#{js}'"}
+end
+def assert_literal(message, *javascripts)
+  rows = javascripts.collect do |javascript|
+%Q{<tr>
+<td><a href='/capture/say?words=link+was+clicked' onclick=#{javascript.gsub(/action/, "href")}>#{javascript[1...-1]}</a></td>
+<td>
+<form action='/capture/say' onsubmit=#{javascript}>
+<input name='words' value="form was submitted"/>
+<input type="submit" value="submit" />
+</form>
+</td>
+</tr>
+} end
+%Q{<h3>#{message}</h3>
+<table>
+#{rows.join("\n")}
+</table>
+}
+end
+%>
+
+<script>
+function submit_form(form) {
+  alert(form.action || form.href);
+  return true;
+};
+function thisthisthis_with_this(form) {
+  alert(form.action || form.href);
+  return true;
+};
+</script>
+<%= assert("Alerts form action then redirects", 
+  "alert(this.action);",
+  "javascript:alert(this.action);",
+  "this;alert(this.action);this;",
+  "alert(this.action); return true;",
+  "submit_form(this);",
+  "submit_form(this); return true;",
+  "return submit_form(this);",
+  "return thisthisthis_with_this(this);"
+)%>
+
+<%= assert_literal("Alerts form action then redirects", 
+  "\"alert('hello');\"",
+  "'alert(\"hello\");'"
+)%>
+
+
+<script>
+function do_not_submit_form(form) {
+  alert(form.action || form.href);
+  return false;
+};
+</script>
+<%= assert("Alerts form action and does not redirect", 
+  "alert(this.action); return false;",
+  "do_not_submit_form(this); return false;",
+  "return do_not_submit_form(this);"
+)%>
+
+<script>
+function throw_error(form) {
+  throw "Error!"
+};
+</script>
+<%= assert("Alerts error and does not redirect", 
+  "throw \"Error!\"",
+  "throw_error(this); return true;"
+)%>
+
+<h3>Check when an input is named submit...</h3>
+<p>Which can cause the error: <a href="http://www.spiration.co.uk/post/1232/Submit%20is%20not%20a%20function">(Submit is not a function)</a></p>
+<form action='/capture/say'>
+<input name='words' value="button named submit"/>
+<input type="submit" name="submit" value="submit" />
+</form>
+
+<p>Now check for multiple submit buttons</p>
+<form action='/capture/say'>
+<input name='words' value="button named submit"/>
+<input type="submit" name="submit" value="submit" />
+<input type="submit" name="submit" value="submit" />
+<input type="submit" name="submit" value="submit" />
+</form>
+
+<p>When a non-submit input is named submit, you're hosed.  This should raise an error:</p>
+<form action='/capture/say'>
+<input name="submit" type="hidden"/>
+<input name="words" value="input named submit"/>
+<input type="submit" value="submit" />
+</form>

data/views/tap/mechanize/capture/tutorial.erb

@@ -0,0 +1,57 @@
+<p>
+This is a tutorial for capturing http requests for modification and/or
+resubmission at a later date.  First, get the environment right:
+</p>
+
+<ul>
+<li>Be sure you're viewing this in <a href="http://www.mozilla.com/en-US/firefox/">Firefox</a></li>
+<li>Install <a href="http://labs.mozilla.com/2008/08/introducing-ubiquity/">Ubiquity</a></li>
+<li>Subscribe to the redirect-http command on this page</li>
+</ul>
+
+<p>
+Now capture the request from this page (use the same procedure wherever
+else you need to capture the parameters of a form):
+</p>
+
+<ul>
+<li>Bring up Ubiquity in Firefox by pressing 'option+space'</li>
+<li>Enter the command: redirect_http</li>
+</ul>
+
+<p>
+You should now see some notification that you're redirecting this page.
+Write what you want to say, hit submit, and you'll be asked to save a
+configuration file for the request.  Save it, then on the command line
+execute this:
+</p>
+
+<pre><code>  % tap run -- load/yaml --:s submit --: dump &lt; request.yml</code></pre>
+
+<p>
+The request will be submitted and you'll get a printout of the response
+body. To prove everything worked right, click the close link in the
+redirection bar and resubmit the form.
+</p>
+
+<a href="/capture/say?words=link+was+clicked">Link</a>
+<form action='/capture/say'>
+Form: <input name='words' value="form was submitted"/>
+<input type="submit" value="submit" />
+</form>
+
+<p>
+Redirection occurs via the on-click and on-submit callbacks for links and
+forms, respectively.  The existing behavior is preserved, as can be
+demonstrated below:
+</p>
+
+<pre>
+  &lt;form action='/capture/say' onsubmit='alert("Form was submitted!")'>
+</pre>
+
+<a href="/capture/say?words=link+was+clicked" onclick='alert("Link was clicked!")'>Link with OnClick</a>
+<form action='/capture/say' onsubmit='alert("Form was submitted!")'>
+Form with OnSubmit: <input name='words' value="form was submitted"/>
+<input type="submit" value="submit" />
+</form>

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: tap-mechanize
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Simon Chiang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-23 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tap-ubiquity
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tap-tasks
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: 
+email: simon.a.chiang@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+- History
+files: 
+- lib/tap/mechanize/agent.rb
+- lib/tap/mechanize/capture.rb
+- lib/tap/mechanize/get.rb
+- lib/tap/mechanize/request.rb
+- lib/tap/mechanize/submit.rb
+- lib/tap/mechanize/utils.rb
+- lib/tap/mechanize/test.rb
+- lib/tap/mechanize/test/echo_server.rb
+- lib/tap/mechanize/test/mock_server.rb
+- tap.yml
+- views/tap/mechanize/capture/http.erb
+- views/tap/mechanize/capture/index.erb
+- views/tap/mechanize/capture/redirect.css
+- views/tap/mechanize/capture/redirect.js
+- views/tap/mechanize/capture/redirect_http.erb
+- views/tap/mechanize/capture/test.erb
+- views/tap/mechanize/capture/tutorial.erb
+- README
+- MIT-LICENSE
+- History
+has_rdoc: true
+homepage: http://tap.rubyforge.org/tap-mechanize
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+- -S
+- -N
+- --title
+- Tap Mechanize
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: tap
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A task library for submitting http requests using Tap.
+test_files: []
+