tap-mechanize 0.5.1 → 0.6.0

data/History

@@ -1,3 +1,7 @@
+== 0.6.0 / 2009-05-25
+
+Updated to utilize Tap-0.17.0
+
 == 0.5.1 / 2009-03-30
 
 * updated dependency on tap-ubiquity to play well on

data/README

@@ -12,7 +12,7 @@ configuration files can be edited and resubmitted using a Request task.
 Multi-step actions, file uploads, and actions that require the use of HTTPS
 may all be automated in this way.
 
-* Lighthouse[http://bahuvrihi.lighthouseapp.com/projects/9908-tap-task-application/tickets]
+* Lighthouse[http://bahuvrihi.lighthouseapp.com/projects/20532-tap-mechanize/overview]
 * Github[http://github.com/bahuvrihi/tap-mechanize/tree/master]
 * {Google Group}[http://groups.google.com/group/ruby-on-tap]
 

data/lib/tap/mechanize/capture.rb

@@ -1,6 +1,7 @@
 require 'tap/controller'
 require 'tap/mechanize/utils'
 require 'tap/ubiquity/utils'
+require 'uri'
 
 module Tap
   module Mechanize
@@ -11,57 +12,57 @@ module Tap
       include Tap::Ubiquity::Utils
       
       PREFIX = '__redirect_http_'
-      REDIRECT_PARAMETER = '__redirect_http_original_action'
       
       # Brings up the tutorial.
       def index
-        render 'index.erb', :locals => {:captures => persistence.index }
+        render 'index.erb', :locals => {:captures => data.index(:data) }
       end
       
-      def create(id, keep_content=true)
-        persistence.create(id) do |io|
-          io << YAML.dump([parse_request(keep_content)])
+      def create(id)
+        data.create(:data, id) do |io|
+          io << YAML.dump([parse_request])
         end
         download(id)
       end
       
       def show(id)
         response['Content-Type'] = "text/plain"
-        persistence.read(id)
+        data.read(:data, id)
       end
       
       def download(id)
-        path = persistence.path(id)
+        path = data.path(:data, id)
         filename = id
         filename += ".yml" if File.extname(id) == ""
         
         response['Content-Type'] = "text/plain"
         response['Content-Disposition'] = "attachment; filename=#{filename};"
-        persistence.read(id)
+        data.read(:data, id)
       end
 
-      def update(id="request", keep_content=true)
-        path = persistence.path(id)
+      def update(id="request")
+        path = data.path(:data, id)
         requests = File.exists?(path) ? YAML.load_file(path) : []
-        requests << parse_request(keep_content)
+        requests << parse_request
         
-        persistence.update(id) do |io|
+        data.create_or_update(:data, id) do |io|
           io << YAML.dump(requests)
         end
         download(id)
       end
       
       def destroy(id)
-        persistence.destroy(id)
+        data.destroy(:data, id)
         redirect uri(:index)
       end
       
       # Brings up a tutorial teaching how to capture and resubmit forms.
       def tutorial
-        serve js_injection(:redirect_http) do |link|
-          content = render 'tutorial.erb'
-          content + link
-        end
+        render 'tutorial.erb'
+      end
+      
+      def command
+        serve js_injection(:redirect_http)
       end
       
       def test
@@ -75,15 +76,26 @@ module Tap
       
       # Returns the redirection script.
       def redirect_http
+        
+        # note configs are formatted into the javascript; keys MUST be valid
+        # names, but values can be anything that converts to json
+        configs = [
+          [:submit_request, false],
+          [:keep_content, false],
+          [:keep_headers, false],
+          [:name, 'request']
+        ]
+        
         css = render 'redirect.css'
         script = render 'redirect.js', :locals => {
-          :redirect_parameter => REDIRECT_PARAMETER,
           :redirect_action => uri(:update),
+          :configs => configs
         }
         
         content = render 'redirect_http.erb', :locals => {
           :css => css,
-          :script => script
+          :script => script,
+          :configs => configs
         }
         
         if request.get?
@@ -137,34 +149,81 @@ if(current = document.getElementById("#{prefix}")) {
         PREFIX
       end
       
-      def capture_overloaded_parameters # :nodoc:
-        # perform the actions of Rack::Request::POST, but capture
-        # overloaded parameter names
+      def data
+        server.data
+      end
+      
+      def uri(*args)
+        "http://#{server.host}:#{server.port}#{super}"
+      end
+      
+      # Returns the data recieved in the query string.
+      def get_params
+        env = request.env
+        if env["rack.request.query_string"] == request.query_string
+          env["rack.request.query_hash"]
+        else
+          env["rack.request.query_string"] = request.query_string
+          env["rack.request.query_hash"]   =
+            parse_query(request.query_string)
+        end
+      end
+      
+      # Returns the data recieved in the request body.
+      #
+      # This method support both application/x-www-form-urlencoded and
+      # multipart/form-data.
+      def post_params
         env = request.env
-        env["rack.request.form_input"] = env["rack.input"]
-        unless env["rack.request.form_hash"] = parse_multipart(env)
-          env["rack.request.form_vars"] = env["rack.input"].read
-          env["rack.request.form_hash"] = Rack::Utils.parse_query(env["rack.request.form_vars"])
-          env["rack.input"].rewind if env["rack.input"].respond_to?(:rewind)
+        if env["rack.request.form_input"].eql? env["rack.input"]
+          env["rack.request.form_hash"]
+        elsif request.form_data?
+          env["rack.request.form_input"] = env["rack.input"]
+          unless env["rack.request.form_hash"] =
+              Rack::Utils::Multipart.parse_multipart(env)
+            form_vars = env["rack.input"].read
+
+            # Fix for Safari Ajax postings that always append \0
+            form_vars.sub!(/\0\z/, '')
+
+            env["rack.request.form_vars"] = form_vars
+            env["rack.request.form_hash"] = parse_query(form_vars)
+
+            begin
+              env["rack.input"].rewind if env["rack.input"].respond_to?(:rewind)
+            rescue Errno::ESPIPE
+              # Handles exceptions raised by input streams that cannot be rewound
+              # such as when using plain CGI under Apache
+            end
+          end
+          env["rack.request.form_hash"]
+        else
+          {}
         end
       end
       
+      def capture_parameters # :nodoc:
+        get_params.update(post_params)
+      end
+      
       # helper to parse the request into a request hash for
       # use by a Tap::Mechanize::Submit task
-      def parse_request(keep_content=true) # :nodoc:
-        if keep_content.kind_of?(String)
-          keep_content = keep_content =~ /true/i
+      def parse_request
+        params = capture_parameters
+        capture_params = {}
+        params.each_key do |key|
+          if key =~ /#{prefix}/
+            normalize_params(capture_params, key, params.delete(key))
+          end
         end
-        
-        capture_overloaded_parameters
+        capture_params = capture_params[prefix]
         
         hash = {}
-        parse_rack_request(request, keep_content).each_pair do |key, value|
+        parse_rack_request(request, params, capture_params['keep_content'] == "true").each_pair do |key, value|
           hash[key.to_s] = value
         end
         
-        action = hash['params'].delete(REDIRECT_PARAMETER)
-        
+        action = capture_params['original_action']
         hash['uri'] = case action
         when /^http/
           # action is an href already
@@ -182,8 +241,10 @@ if(current = document.getElementById("#{prefix}")) {
           File.join(base, action)
         end
 
-        # remove extranous data
-        hash.delete('headers')
+        # remove extra data
+        unless capture_params['keep_headers'] == 'true'
+          hash.delete('headers')
+        end
         hash.delete('version')
         
         hash

data/lib/tap/mechanize/get.rb

@@ -2,7 +2,7 @@ require 'tap/mechanize/request'
 
 module Tap
   module Mechanize
-    # :startdoc::manifest gets the uri
+    # :startdoc::task gets the uri
     #
     # Submits an Http request to the specified uri and returns the message
     # body.

data/lib/tap/mechanize/request.rb

@@ -1,9 +1,10 @@
+require 'tap/task'
 require 'tap/mechanize/agent'
 
 module Tap
   module Mechanize
     class Request < Tap::Task
-      nest :mechanize, Agent        # the mechanize agent
+      nest :mechanize, Agent, :instance_reader => :mechanize  # the mechanize agent
       
       # Returns the mechanize agent.
       #--

data/lib/tap/mechanize/submit.rb

@@ -2,7 +2,7 @@ require 'tap/mechanize/request'
 
 module Tap
   module Mechanize
-    # :startdoc::manifest submits a captured http request
+    # :startdoc::task submits a captured http request
     #
     # Performs a series of HTTP requests and returns the content of the final
     # page.  Requests must be hashes that at least specify the uri of the next

data/lib/tap/mechanize/test/echo_server.rb

@@ -10,7 +10,7 @@ module Tap
         def self.call(env)
           body = env['rack.input'].read
           headers = {}
-          env.each_pair {|key, value| headers[key] = [value] unless key =~ /^rack/ }
+          env.each_pair {|key, value| headers[key] = value unless key =~ /^rack/ }
           
           [200, headers, [body]]
         end

data/lib/tap/mechanize/utils.rb

@@ -120,7 +120,7 @@ module Tap
       end
       
       # Parses a Rack::Request, with the same activity as parse_http_request.
-      def parse_rack_request(request, keep_content=true)
+      def parse_rack_request(request, request_params, keep_content=true)
         headers = {}
         request.env.each_pair do |key, value|
           key = case key
@@ -134,7 +134,7 @@ module Tap
         end
 
         params = {}
-        request.params.each_pair do |key, value|
+        request_params.each_pair do |key, value|
           params[key] = each_member(value) do |obj|
             if obj.kind_of?(Hash)
               file = {'Content-Type' => obj[:type], 'Filename' => obj[:filename]}

data/tap.yml

@@ -1 +0,0 @@
-gems: tap-tasks

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

@@ -1,14 +1,23 @@
 var RedirectHttp = {
-  submit_request: false,
-  keep_content: false,
-  name: 'request',
+<% configs.each do |(key, value)| %>
+  <%= key %>: <%= value.to_json %>,
+<% end %>
   
-  /* Returns the target uri for redirection */
-  redirect_uri: function() {
-    return '<%= redirect_action %>/' + escape(RedirectHttp.name) + "/" + RedirectHttp.keep_content;
+  // Generates a redirection input with the specified value.  Inputs
+  // have names like '<%= prefix %>[key]' to prevent collisions and
+  // facilitate parsing server-side.
+  redirect_input: function(key, value) {
+    var input = document.createElement("input"); 
+    input.setAttribute("id", '<%= prefix %>[' + key + ']');
+    input.setAttribute("name", '<%= prefix %>[' + key + ']');
+    input.setAttribute("type", 'hidden');
+    input.setAttribute("value", value);
+    return input;
   },
   
-  /* Redirects forms and then submits the form if submit is true. */
+  // Redirect the form, adds the redirection inputs, and then submits the
+  // form, if submit is true or undefined.  After submit, the redirection
+  // inputs are removed from the form.
   redirect_form: function(form, submit) {
     if(typeof submit == 'undefined') { submit = true };
     
@@ -26,11 +35,23 @@ var RedirectHttp = {
         }
       }
       
-      // 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());
+      // set redirection inputs
+      var original_action = form.getAttribute('<%= prefix %>original_action');
+      var redirect_inputs = [
+<% configs.each do |(key, value)| %>
+        RedirectHttp.redirect_input('<%= key %>', RedirectHttp.<%= key %>),
+<% end %>
+        RedirectHttp.redirect_input('original_action', original_action)
+      ];
+      form.setAttribute('action', '<%= redirect_action %>');
+      for(i=0; i<redirect_inputs.length; i++) { form.appendChild(redirect_inputs[i]); }
+      
       form.submit();
       
+      // reset redirection inputs
+      form.setAttribute('action', original_action);
+      for(i=0; i<redirect_inputs.length; i++) { form.removeChild(redirect_inputs[i]); }
+      
       if(RedirectHttp.submit_request) {
         this.revert();
         form.submit();
@@ -44,13 +65,20 @@ var RedirectHttp = {
     };
   },
   
-  /* Redirects links and then submits the link if submit is true. */
+  // Sumbits the redirected link with redirection parameters in the query
+  // string, if submit is true or undefined.
   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);
+      redirect_params = [
+<% configs.each do |(key, value)| %>
+        escape('<%= prefix %>[<%= key %>]') + "=" + escape(RedirectHttp.<%= key %>),
+<% end %>
+        '<%= prefix %>[original_action]=' + escape(original_href)
+      ];
+      location.href = '<%= redirect_action %>?' + redirect_params.join("&").replace(/%20/g, "+");
       
       if(RedirectHttp.submit_request) {
         this.revert();
@@ -59,8 +87,9 @@ var RedirectHttp = {
     };
   },
   
-  /* Wraps the current onX event so that it may be called without interfering
-   * with the redirection (ie wrapper). */
+  // Wraps the current onX event so that it may be called without interfering
+  // with the redirection (ie wrapper).  Note events are not called again
+  // when a form is submitted or a redirection is performed by the wrapper.
   wrap: function(current, wrapper) {
     return "try {" +
     "  var <%= prefix %>result = function(<%= prefix %>this) { " + 
@@ -72,7 +101,7 @@ var RedirectHttp = {
     "}; return false;"
   },
   
-  /* Redirects forms and links to '<%= redirect_action %>' */
+  // Redirects forms and links to '<%= redirect_action %>'
   redirect: function() {    
     try {
       
@@ -85,15 +114,8 @@ var RedirectHttp = {
         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);
-        
+          form.setAttribute("<%= prefix %>original_action",  form.getAttribute('action'));
+          
           // redirect onSubmit
           var current_on_submit = '';
           if(form.hasAttribute("onSubmit")) current_on_submit = form.getAttribute("onSubmit");
@@ -130,7 +152,7 @@ var RedirectHttp = {
     }
   },
   
-  /* Reverts redirection and removes the redirection div */
+  // Reverts redirection and removes the redirection div
   revert: function() {
     try {
       
@@ -140,13 +162,9 @@ var RedirectHttp = {
         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);
+        if(form.hasAttribute('<%= prefix %>original_action')) {
+          form.setAttribute('action', form.getAttribute('<%= prefix %>original_action'));
+          form.removeAttribute('<%= prefix %>original_action');
           
           form.setAttribute('onSubmit', form.getAttribute('<%= prefix %>original_callback'));
           form.removeAttribute('<%= prefix %>original_callback');
@@ -177,7 +195,7 @@ var RedirectHttp = {
     if(redirect_http) document.body.removeChild(redirect_http);
   },
   
-  // Alerts of errors due to RedirectHttp
+  // Alerts 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

@@ -1,8 +1,13 @@
 <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>
+<% configs.each do |(key, value)| %>
+<%    case value %>
+<%    when true, false %>
+  <li><input id='<%= prefix %><%= key %>' type='checkbox' <%= value ? "checked='true' " : '' %>onchange='javascript:RedirectHttp.<%= key %>=this.checked;'><%= key %></input></li>
+<%    else %>
+  <li><input id='<%= prefix %><%= key %>' type='text' value='<%= value %>' onchange='javascript:RedirectHttp.<%= key %>=this.value;'><%= key %></input></li>
+<%    end %>
+<% end %>
 </ul>
 <a id='<%= prefix %>revert' href='javascript:RedirectHttp.revert();' class="<%= prefix %>link">close</a>
 

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

@@ -55,3 +55,5 @@ demonstrated below:
 Form with OnSubmit: <input name='words' value="form was submitted"/>
 <input type="submit" value="submit" />
 </form>
+
+<%= command_link uri(:command) %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tap-mechanize
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-30 00:00:00 -06:00
+date: 2009-05-25 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.1
+        version: 0.3.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: tap-tasks
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.0
+        version: 0.2.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: mechanize