praline 0.1.3 → 0.1.4

data/lib/praline.rb

@@ -21,41 +21,64 @@
 
 require 'selenium-webdriver'
 
+# @author Antoine d'Otreppe
 module Praline
+    # Load the given URL in the browser
+    # @param [String] url the url to open
     def open(url)
         Praline::browser.get(url)
     end
     
+    # Fill an input with the given text.
+    # Also works with <select> and checkbox elements
+    # @param [String] name the html name attribute of the target input
+    # @param [String] value the text to be put
     def input(name, value)
         Praline::browser.find_element(:name, name).send_keys(value)
     end
     
+    # Get the current page title
+    # @return [String] the contents of the <title> tag of the current page
     def title
         Praline::browser.title
     end
     
+    # Get the text of the <h1> of the current page.
+    # Will fail if there are several such tags
+    # @return [String] the text of the single <h1> tag of the current page
     def h1
         Praline::browser.find_element(:xpath, "//h1")
     end
     
+    # Get the options' text from a specified select
+    # @param [String] select_name name of the select you want to poll
+    # @return [Array] array of the text values of the options in this select
     def options(select_name)
         select = Praline::browser.find_element(:name, select_name)
         options = select.find_elements(:tag_name, 'option')
         options.map {|option| option.text }
     end
     
+    # Follow the specified link
+    # @param [String] link_text the text of the link to follow
     def follow(link_text)
         Praline::browser.find_element(:link, link_text).click
     end
     
+    # Submit the specified form
+    # @param [String] form_name the html name of the form to submit
     def submit(form_name)
         Praline::browser.find_element(:name, form_name).submit
     end
     
+    # Get the WebDriver itself, for in-depth manipulation
+    # @return [Selenium::WebDriver::Driver] the driver
     def browser
         Praline::browser
     end
     
+    # Kill the browser.
+    # Call this when you are done with your script
     def kill_browser
         Praline::kill_browser
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praline
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
+date: 2012-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver