sakai-oae-test-api 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,53 @@
+# Sakai OAE Functional Testing API
+
+## Description:
+
+This is the development project for the Sakai OAE Functional Testing API gem for Ruby.
+
+This API provides a framework for interacting with web sites for Sakai-OAE, using
+Ruby and Watir-webdriver--but without needing to know either in detail.
+
+## Requirements:
+
+### 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.
+
+## A Basic Usage Example for OAE:
+
+````ruby
+#!/usr/bin/env ruby
+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
+````
+
+## Contribute
+
+* Fork the project.
+* Test drive your feature addition or bug fix. Adding specs is important and I will not accept a pull request that does not have tests.
+* Make sure you describe your new feature with a cucumber scenario.
+* Make sure you provide RDoc comments for any new public method you add. Remember, others will be using this gem.
+* Commit, do not mess with Rakefile, version, or ChangeLog.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+

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

@@ -20,7 +20,7 @@ require 'sakai-oae-test-api/page_classes'
 # create the @browser variable used throughout the page classes.
 class SakaiOAE
 
-  attr_reader :browser, :url
+  attr_reader :browser
 
   def initialize(web_browser, url)
 

data/sakai-oae-test-api.gemspec

@@ -1,11 +1,11 @@
 spec = Gem::Specification.new do |s|
   s.name = 'sakai-oae-test-api'
-  s.version = '0.0.1'
+  s.version = '0.0.2'
   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 = %w{"Abraham Heward"}
+  s.authors = ["Abraham Heward"]
   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'

metadata

@@ -1,12 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: sakai-oae-test-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
-- ! '"Abraham'
-- Heward"
+- Abraham Heward
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -93,6 +92,7 @@ files:
 - lib/sakai-oae-test-api/toolbars_and_menus.rb
 - lib/sakai-oae-test-api/widgets.rb
 - lib/sakai-oae-test-api.rb
+- README.md
 - sakai-oae-test-api.gemspec
 homepage: https://github.com/aheward/Kuali-Sakai-Functional-Test-Automation-Framework/tree/Sakai-CLE/Sakai/OAE/API
 licenses: []