sakai-oae-test-api 0.0.2 → 0.0.3

data/README.md

@@ -11,13 +11,9 @@ Ruby and Watir-webdriver--but without needing to know either in detail.
 
 ### Ruby 1.9.2 or higher
 
-### Ruby Gems:
-[Watir-Webdriver](http://www.watirwebdriver.com)
-[Page-Object](https://github.com/cheezy/page-object)
-
 If you're just going to use the API for testing, then simply install it as you would any other Ruby gem: `gem install sakai-oae-test-api`
 
-This repo is here if you're going to take part in extending the capabilities of the gem.
+This repo is here if you're going to take part in extending the API's capabilities--e.g., adding page elements, custom methods, or new page classes.
 
 ## A Basic Usage Example for OAE:
 
@@ -27,20 +23,60 @@ require 'sakai-oae-test-api'
 
 # Create an instance of the SakaiOAE class, specifying your test browser
 # and the URL of your test site's OAE welcome page.
-sakai = SakaiOAE.new(:firefox, "https://nightly.academic.rsmart.com/")
-
-# Log in to Sakai OAE with "username" and "password"...
-dashboard = sakai.login("username", "password") # See the LoginPage class and the HeaderFooterBar module in the RDocs.
-
-# Go to the course library page for "Econ 101"...
-course_library = dashboard.open_course "Econ 101"   # See the RDocs for info on the
-                                                    # MyDashboard and Library classes.
-
-# Store the contents of the course library in
-# an array called "library_contents"...
-library_contents = course_library.documents
+sakai = SakaiOAE.new(:firefox, "https://academic.rsmart.com/")
+
+# define the LoginPage class object, which allows you to interact with elements
+# on the login page. This is available via the SakaiOAE class, "page" method...
+login_page = sakai.page
+
+# Define the browser object using SakaiOAE's 'browser' method. This is Ruby/Watir's
+# representation of the test browser itself and is used by every page class in the
+# Sakai-OAE-test-api, so it *must* be explicitly defined here as "@browser"...
+@browser = sakai.browser
+
+# The above code is all necessary for proper setup and usage of the API. Below, we
+# present a short and simple example of how you can use the API to interact with
+# the Open Academic Environment...
+dash = login_page.login("username", "password")
+
+# There are two ways to invoke page classes. The first way, hinted at in the code
+# above, will be explained below. The second way uses the "on_page" method,
+# and is most useful when you are going to stay on the given page for a while. It
+# requires that you know the name of the relevant page class..
+on_page MyDashboard do |page|
+  page.add_content
+  page.upload_file=("filename.doc", "Full/Path/To/File")
+  page.file_title="Title"
+  page.file_description="This is a file description."
+  page.tags_and_categories="document"
+  page.add
+  page.done_add_collected
+end
+
+# So, back to the first way, which is most useful when you're doing lots of quick
+# navigating around the site, not staying on a given page for too long.
+# You'll notice by looking at the available methods in the page classes that those
+# methods involving navigating to new pages will return the target page's page class.
+# So, for example, going from My Dashboard to Explore Content (notice we're using
+# the "dash" object defined earlier, here...
+explore = dash.explore_content
+
+# Now we can use the "explore" object to interact with the "Explore Content" page...
+explore.search_for="Title"
+
+# A bit of verification code (use your own favorite test framework, here, if
+# writing Ruby conditionals isn't too your liking)...
+if explore.results.include?("Title")
+  puts "Passed"
+else
+  puts "Failed"
+end
+
+# Enjoy!
 ````
 
+For much more extensive usage examples, please see the OAE Cucumber directory in this repo.
+
 ## Contribute
 
 * Fork the project.

data/lib/sakai-oae-test-api.rb

@@ -5,13 +5,13 @@ require 'cgi'
 
 PageObject.javascript_framework = :jquery
 
-require 'sakai-oae-test-api/global_methods'
 require 'sakai-oae-test-api/gem_extensions'
-require 'sakai-oae-test-api/cle_frame_classes'
+require 'sakai-oae-test-api/global_methods'
 require 'sakai-oae-test-api/pop_up_dialogs'
 require 'sakai-oae-test-api/toolbars_and_menus'
 require 'sakai-oae-test-api/widgets'
 require 'sakai-oae-test-api/page_classes'
+require 'sakai-oae-test-api/cle_frame_classes'
 
 # Initialize this class at the start of your test cases to
 # open the specified test browser at the specified Sakai welcome page URL.
@@ -23,14 +23,13 @@ class SakaiOAE
   attr_reader :browser
 
   def initialize(web_browser, url)
-
-    @url = url
-
     @browser = Watir::Browser.new web_browser
     @browser.window.resize_to(1400,900)
-    @browser.goto @url
+    @browser.goto url
     @browser.button(:id=>"footer_logo_button").wait_until_present
+  end
 
+  def page
     LoginPage.new @browser
   end
 

data/lib/sakai-oae-test-api/page_classes.rb

@@ -1,10 +1,4 @@
 # coding: UTF-8
-require 'sakai-OAE/gem_extensions'
-require 'sakai-OAE/global_methods'
-require 'sakai-OAE/toolbars_and_menus'
-require 'sakai-OAE/pop_up_dialogs'
-require 'sakai-OAE/widgets'
-require 'sakai-OAE/cle_frame_classes'
 
 # The Login page for OAE.
 class LoginPage

data/sakai-oae-test-api.gemspec

@@ -1,12 +1,12 @@
 spec = Gem::Specification.new do |s|
   s.name = 'sakai-oae-test-api'
-  s.version = '0.0.2'
+  s.version = '0.0.3'
   s.summary = %q{Sakai-OAE functional testing API for rSmart Academic}
   s.description = %q{The Sakai-OAE gem provides an API for interacting with the web pages and page elements in rSmart's deployment of the Sakai Open Academic Environment.}
   s.files = Dir.glob("**/**/**")
   s.test_files = Dir.glob("test/*test_rb")
   s.authors = ["Abraham Heward"]
-  s.email = %w{"aheward@rsmart.com"}
+  s.email = %w{'aheward@rsmart.com'}
   s.homepage = 'https://github.com/aheward/Kuali-Sakai-Functional-Test-Automation-Framework/tree/Sakai-CLE/Sakai/OAE/API'
   s.add_dependency 'page-object', '>= 0.6.6'
   s.add_dependency 'watir-webdriver', '>= 0.5.5'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sakai-oae-test-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-12 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: page-object
@@ -78,7 +78,7 @@ dependencies:
 description: The Sakai-OAE gem provides an API for interacting with the web pages
   and page elements in rSmart's deployment of the Sakai Open Academic Environment.
 email:
-- ! '"aheward@rsmart.com"'
+- ! '''aheward@rsmart.com'''
 executables: []
 extensions: []
 extra_rdoc_files: []