polleverywhere 0.0.4 → 0.0.5

data/api/public/javascripts/jquery.tableofcontents.js

@@ -0,0 +1,312 @@
+/*
+	TableOfContents Plugin for jQuery
+	
+	Programmed by Doug Neiner
+	
+	Version: 0.8
+	
+	Based on code and concept by Janko Jovanovic 
+	  in his article: http://www.jankoatwarpspeed.com/post/2009/08/20/Table-of-contents-using-jQuery.aspx
+	
+	This plugin is offered under the MIT license:
+	
+	(c) 2009 by Doug Neiner, http://dougneiner.com
+	
+	Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+    
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+    
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+*/
+
+
+(function($){
+	
+    $.TableOfContents = function(el, scope, options){
+        // To avoid scope issues, use 'base' instead of 'this'
+        // to reference this class from internal events and functions.
+        var base = this;
+        
+        // Access to jQuery and DOM versions of element
+        base.$el = $(el);
+        base.el = el; 
+
+		base.toc = "";                               // We use this to build our TOC;
+		base.listStyle = null;                       // This will store the type of list
+		base.tags = ["h1","h2","h3","h4","h5","h6"]; // The six header tags
+
+        
+        base.init = function(){
+			// Merge the defaultOptions with any options passed in
+            base.options = $.extend({},$.TableOfContents.defaultOptions, options);
+
+			// Gets the scope. Defaults to the entire document if not specified
+            if(typeof(scope) == "undefined" || scope == null) scope = document.body;
+            base.$scope = $(scope);
+
+			// Find the first heading withing the scope
+			var $first = base.$scope.find(base.tags.join(', ')).filter(':first');
+			
+			// If no headings were found, stop building the TOC
+			if($first.length != 1) return; 
+			
+			// Set the starting depth
+			base.starting_depth = base.options.startLevel;
+
+			// Quick validation on depth
+			if(base.options.depth < 1) base.options.depth = 1;
+			
+			// Get only the tags starting with startLevel, and counting the depth
+			var filtered_tags = base.tags.splice(base.options.startLevel - 1, base.options.depth);
+			
+			// Cache all the headings that match our new filter
+			base.$headings = base.$scope.find(filtered_tags.join(', '));
+
+			
+			// If topLinks is enabled, set/get an id for the body element
+			if(base.options.topLinks !== false){
+				var id = $(document.body).attr('id');
+				if(id == "") {
+					id = base.options.topBodyId;
+					document.body.id = id;
+				};
+				
+				// Cache the id locally
+				base.topLinkId = id;
+			};
+
+
+			// Find out which list style to use
+			if(base.$el.is('ul')){
+				base.listStyle = 'ul';
+			} else if (base.$el.is('ol')){
+				base.listStyle = 'ol';
+			};
+
+
+			base.buildTOC();
+			
+			if(base.options.proportionateSpacing === true && !base.tieredList()){
+				base.addSpacing();
+			};
+			
+			return base; // Return this object for memory cleanup
+        };
+
+		// Helper function that returns true for both OL and UL lists
+		base.tieredList = function(){
+			return (base.listStyle == 'ul' || base.listStyle == 'ol');
+		};
+
+		base.buildTOC = function(){
+			base.current_depth = base.starting_depth;
+			
+			base.$headings.each(function(i,element){
+				// Get current depth base on h1, h2, h3, etc.
+				var depth = this.nodeName.toLowerCase().substr(1,1);
+				
+				// This changes depth, or adds separators, only if not the first item
+				if(i > 0 || ( i == 0 && depth != base.current_depth)){
+
+					base.changeDepth(depth)
+				};
+				
+				// Add the TOC link
+				base.toc += base.formatLink(this, depth, i) + "\n";
+				
+				// Add the topLink if enabled
+				if(base.options.topLinks !== false) base.addTopLink(this);
+			});
+			
+			// Close up any nested list
+			base.changeDepth(base.starting_depth, true);
+			
+			// Wrap entire TOC in an LI if item was nested.
+			if(base.tieredList()) base.toc = "<li>\n" + base.toc + "</li>\n";
+			
+			// Update the TOC element with the completed TOC
+			base.$el.html(base.toc);
+		};
+		
+		base.addTopLink = function(element){
+			// Get the text for the link (if topLinks === true, it defaults to "Top")
+			var text = (base.options.topLinks === true ? "Top" : base.options.topLinks );
+			var $a = $("<a href='#" + base.topLinkId + "' class='" + base.options.topLinkClass + "'></a>").html(text);
+			
+			// Append to the current Header element
+			$(element).append($a);
+		};
+		
+		base.formatLink = function(element, depth, index){	
+			// Get the current id of the header element
+			var id = element.id;
+			
+			// If no id exisits, create a unique one
+			if(id == ""){
+				id = base.buildSlug($(element).text());
+				element.id = id;
+			};
+			
+			// Start building the a link
+			var a = "<a href='#" + id + "'";
+			
+			// If this isn't a tiered list, we need to add the depth class
+			if(!base.tieredList()) a += " class='" + base.depthClass(depth) + "'";
+			
+			// Finish building the link
+			a += ">" + base.options.levelText.replace('%', $(element).text()) + '</a>';
+			return a;
+		};
+		
+		base.changeDepth = function(new_depth, last){
+			if(last !== true) last = false;
+			
+			// If straight links, just change depth and return
+			if(!base.tieredList()){
+				base.current_depth = new_depth;
+				return true;
+			};
+			
+			// If nested
+			if(new_depth > base.current_depth){
+				// Add enough opening tags to step into the heading
+				// as it is possible that a poorly built document
+				// steps from h1 to h3 without an h2
+				var opening_tags = [];
+				for(var i = base.current_depth; i < new_depth; i++){
+					opening_tags.push('<' + base.listStyle + '>' + "\n");
+				};
+				var li = "<li>\n";
+				
+				// Add the code to our TOC and an opening LI
+				base.toc += opening_tags.join(li) + li;
+				
+			} else if (new_depth < base.current_depth){
+				// Close all the loops
+				var closing_tags = [];
+				for(var i = base.current_depth; i > new_depth; i--){
+					closing_tags.push('</' + base.listStyle + '>' + "\n");
+				};
+				
+				// Add closing LI and any additional closing tags
+				base.toc += "</li>\n" + closing_tags.join('</li>' + "\n");
+				
+				// Open next block
+				if (!last) {
+					base.toc += "</li>\n<li>\n";
+				}
+			} else {
+				// Just close a tag and open a new one
+				// since the depth has not changed
+				if (!last) {
+					base.toc += "</li>\n<li>\n";
+				}
+			};
+			
+			// Store the new depth
+			base.current_depth = new_depth;
+		};
+		
+		base.buildSlug = function(text){
+			text = text.toLowerCase().replace(/[^a-z0-9 -]/gi,'').replace(/ /gi,'-');
+			text = text.substr(0,50);
+			return text;
+		};
+		
+		base.depthClass = function(depth){
+			// Normalizes the depths to always start at 1, even if the starting tier is a h4
+			return base.options.levelClass.replace('%', (depth - ( base.starting_depth - 1 ) ) );
+		};
+		
+		base.addSpacing = function(){
+			var start = base.$headings.filter(':first').position().top;
+			
+			base.$headings.each(function(i,el){
+				var $a = base.$el.find('a:eq(' + i + ')');
+				var pos = (
+						( $(this).position().top - start ) / 
+						( base.$scope.height()   - start )
+					) * base.$el.height();
+				$a.css({
+					position: "absolute",
+					top: pos
+				});
+			});
+		};
+        
+        return base.init();
+    };
+
+	
+    $.TableOfContents.defaultOptions = {
+		// One option is set by the container element, and not by changing
+		// a setting here. That is the type of TOC to output. For a nested ordered list
+		// make sure your wrapping element is an <ol>. For a nested bulleted list
+		// make sure your wrapping element is an <ul>. For a straight outputting of links
+		// use any other element.
+	
+		// Which H tags should be the root items. h1 = 1, h2 = 2, etc.
+		startLevel: 1,
+		
+		// How many levels of H tags should be shown, including the startLevel
+		// startLevel: 1, depth: 3 = h1, h2, h3
+		// startLevel: 2, depth: 3 = h2, h3, h4
+        depth: 3,
+
+		// Each link in a straight set is give a class designating how deep it is. 
+		// You can change the class by changing this option,
+		// but you must include a % sign where you want the number to go.
+		// Nested lists do not add classes, as you can determine their depth with straight css
+		levelClass: "toc-depth-%",
+		
+		// When each link is formed, you can supply additional html or text to be formatted
+		// with the text of the header. % represents the text of the header
+		levelText: "%",
+
+		// This plugin can add "To Top" links to each header element if you want.
+		// Set topLinks to true to use the text "Top" or set it to some text or html
+		// content you wish to use as the body of the link
+		topLinks: false,
+		
+		// If topLinks is either true or a text/html value, you can also set the following options:
+		
+		// Class of the link that is added to the headers
+		topLinkClass: "toc-top-link",
+		
+		// Which class should be added to the body element if it does not
+		// already have an id associated with it
+		topBodyId: "toc-top",
+		
+		// To have the TOC spaced proportionatly to the spacing of the headings,
+		// you must have a fixed height on the TOC wrapper, and it must "haveLayout"
+		// either position = fixed | absolute | relative
+		// Finally, the TOC wrapper must not be a UL or an LI or this setting will
+		// have no effect
+		proportionateSpacing: false
+		
+    };
+	
+
+    $.fn.tableOfContents = function(scope, options){
+        return this.each(function(){
+            var toc = new $.TableOfContents(this, scope, options);
+			delete toc; // Free memory
+        });
+    };
+
+	
+})(jQuery);

data/api/views/index.html.haml

@@ -1,112 +1,88 @@
-!!! html
-%html
-  %head
-    %title Poll Everywhere API
-  %body
-    %header
-      %h1 Poll Everywhere API Documentation
+%section#main
+  %p This documentation assumes that you are familar with the low-level semantics of HTTP, including the use of tools like cURL, and JSON.
+  
+  %h1 Authentication
+  %p A Poll Everywhere username and password is used to login to the API and manipulate polls on an account. These credentials can be created at <a href="http://www.polleverywhere.com/reserve">Poll Everywhere</a>.
+  
+  %p The credentials can be configured on the Poll Everywhere gem or manually via HTTP Basic authentication (More information on HTTP Basic credentials an encoding can be found at <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">Wikipedia</a>).
+  
+  %pre.ruby
+    :preserve
+      PollEverywhere.config do
+        username  "my_pollev_username"
+        password  "my_pollev_password"
+      end
+  
+  %h1 Its all JSON
+  %p JSON key-value data structures are used throughout the API application to persist and modify data to the web application. Typically resources will include a root key that corresponds with the name of the name of the resource; from example, multiple choice polls all have the root key 'multiple_choice_poll'.
 
-    %section
-      %p This API assumes that you are familar with the low-level semantics of HTTP, including the use of tools like cURL, and JSON.
-      
-      %h1 Authentication
-      %p HTTP Basic authentication is currently used for logging into Poll Everywhere accounts. More information can be found at <a href="http://en.wikipedia.org/HTTP Basic">Wikipedia</a>.
+  %h1 Polls
+  %h2 Multiple choice polls
+  %p These polls are great for collecting structured information from audiences if you want to define a set of answers that participants may choose from.
 
-      %h1 We use JSON
-      %p Simple JSON key-value data structures are used throughout the API application to persist and modify data to the web application. Typically resources will include a root key that corresponds with the name of the name of the resource; from example, multiple choice polls all have the root key 'multiple_choice_poll'.
+  %h3 Attributes
+  %dl.attributes
+    %dt=PollEverywhere::MultipleChoicePoll.root_key
+    %dd Root key for multiple choice poll data.
+    %dd
+      %dl
+        -PollEverywhere::MultipleChoicePoll.props.each do |_, prop|
+          %dt=prop.name
+          %dd=prop.description
+          -if prop.name == :options
+            %dd
+              %dl
+                -PollEverywhere::MultipleChoicePoll::Option.props.each do |_, prop|
+                  %dt=prop.name
+                  %dd=prop.description
+  
+  %h3 Creating a multiple choice poll
+  %p Specify a title and a few options to create a multiple choice poll.
+  :example
+    @mcp = PollEverywhere::MultipleChoicePoll.from_hash(:title => 'Hey dude!', :options => %w[red blue green]).save
+  
+  %h3 Changing the title of a multiple choice poll
+  :example
+    @mcp.title = "I like different titles"
+    @mcp.save
 
-      %h1 Polls
-      %h2 Multiple choice polls
-      %p These polls are great for collecting structured information from audiences if you want to define a set of answers that participants may choose from.
+  %h3 Starting and stopping multiple choice polls
+  %p To prevent audience members from responding to a poll, change the poll state to "closed".
+  :example
+    @mcp.stop
+  
+  %p To open it back up and allow responses to come on through change the state to "opened".
+  :example
+    @mcp.start
 
-      %h3 Attributes
-      %dl.attributes
-        %dt=PollEverywhere::MultipleChoicePoll.root_key
-        %dd Root key for multiple choice poll data.
-        %dd
-          %dl
-            -PollEverywhere::MultipleChoicePoll.props.each do |_, prop|
-              %dt=prop.name
-              %dd=prop.description
-              -if prop.name == :options
-                %dd
-                  %dl
-                    -PollEverywhere::MultipleChoicePoll::Option.props.each do |_, prop|
-                      %dt=prop.name
-                      %dd=prop.description
-      %h3 Creating a multiple choice poll
-      :ruby
-        example do
-          @mcp = PollEverywhere::MultipleChoicePoll.from_hash(:title => 'Hey dude!', :options => %w[red blue green]).save
-        end
-      
-      %h3 Changing the title of a multiple choice poll
-      :ruby
-        example do
-          @mcp.title = "I like different titles"
-          @mcp.save
-        end
+  %h3 Delete a multiple choice poll
+  %p When you're totally finished with the poll and you want to tidy things up a bit, you can delete polls
+  :example
+    @mcp.destroy
+  
+  %h2 Free text polls
+  %p These polls are used to collect short answers or unstructured responses from participants.
+  %h3 Attributes
+  %dl.attributes
+    %dt=PollEverywhere::FTP.root_key
+    %dd Root key for free text poll data.
+    %dd
+      %dl
+        -PollEverywhere::FTP.props.each do |_, prop|
+          %dt=prop.name
+          %dd=prop.description
 
-      %h3 Closing and opening multiple choice polls
-      %p To close a poll, change the state to "closed"
-      :ruby
-        example do
-          @mcp.stop
-        end
-      
-      %p To open it back up (and allow responses to come on through) change the state to "opened"
-      :ruby
-        example do
-          @mcp.start
-        end
+  %h3 Create free text polls
+  %p Creating a free text poll is similar to building a multiple choice poll, just without the options attribute.
+  :example
+    @ftp = PollEverywhere::FreeTextPoll.from_hash(:title => "What is the meaning of life?").save
 
-      %h3 Delete a multiple choice poll
-      %p When you're totally finished with the poll and you want to tidy things up a bit, you can delete polls
-      :ruby
-        example do
-          @mcp.destroy
-        end
-      
-      %h2 Free text polls
-      %p These polls are used to collect short answers or unstructured responses from participants.
-      %h3 Attributes
-      %dl.attributes
-        %dt=PollEverywhere::FTP.root_key
-        %dd Root key for free text poll data.
-        %dd
-          %dl
-            -PollEverywhere::FTP.props.each do |_, prop|
-              %dt=prop.name
-              %dd=prop.description
+  %h3 Modify a free text poll
+  %p Change the title attribute to change the poll
+  :example
+    @ftp.title = "No really, what is the meaning of life?"
+    @ftp.save
 
-      %h3 Create free text polls
-      %p Creating a free text poll is similar to building a multiple choice poll, just without the options attribute.
-      :ruby
-        example do
-          @ftp = PollEverywhere::FreeTextPoll.from_hash(:title => "What is the meaning of life?").save
-        end
-    
-      %h3 Modify a free text poll
-      %p Change the title attribute to change the poll
-      :ruby
-        example do
-          @ftp.state = "opened"
-          @ftp.save
-        end
-
-      %h3 Delete a free text poll
-      :ruby
-        example do
-          @ftp.destroy
-        end
-
-    %footer
-      %p
-        This documentation was automatically generated by the Poll Everywhere rubygem at
-        =succeed '.' do
-          %a(href="http://github.com/polleverywhere/polleverywhere") http://github.com/polleverywhere/polleverywhere
-        Community support for the API is available on the
-        %a(href="http://groups.google.com/group/polleverywhere-dev") Poll Everywhere Developer mailing list
-        and paid professional support at
-        =succeed '.' do
-          %a(href="http://www.polleverywhere.com/professional-support") Poll Everywhere
+  %h3 Delete a free text poll
+  :example
+    @ftp.destroy

data/api/views/layout.haml

@@ -1,21 +1,45 @@
 !!! 5
-%html{ :lang => "en" }
+%html(lang="en")
   %head
-    %meta{ :charset => "utf-8" }    
-
+    %title The Poll Everywhere API
+    %meta(charset="utf-8")
     / Always force latest IE rendering engine (even in intranet) & Chrome Frame
-    %meta{ :content => "IE=edge,chrome=1", "http-equiv" => "X-UA-Compatible" }
-
-    / Comment in layout
-
-    = stylesheet_link_tag "site.css"
-
+    /[if IE]
+      %meta(content="IE=edge,chrome=1" http-equiv="X-UA-Compatible")
+    =stylesheet_link_tag "site.css"
+    =javascript_include_tag 'jquery-1.6.2.min', 'jquery.tableofcontents'
+    =yield_content :head
     :javascript
-      // Comment in javascript
+      $(function(){
+        $('#toc').tableOfContents('#main');
+      });
+      
+  %body(class=page_classes)
+    %header
+      %h1 The Poll Everywhere API
+    %aside#nav
+      %section
+        %ol.toc#toc
+    %article#main=yield
+    %footer
+      %h2 Additional Resources
+      %dl
+        %dt
+          %a(href="http://github.com/polleverywhere/polleverywhere") Source Code
+        %dd Review or contribute to the source code that generated this documentation.
+
+        %dt 
+          %a(href="http://groups.google.com/group/polleverywhere-dev") Community Mailing List Support
+        %dd Free support from the Poll Everywhere development community.
 
-    = yield_content :head
-    
-  %body{ :class => page_classes }
+        %dt 
+          %a(href="http://www.polleverywhere.com/professional-support") Paid Professional Support
+        %dd If you need more responsive support or a custom API feature, engage Poll Everywhere's professional support services.
 
-    #main{ :role => "main" }
-      = yield
+        %dt
+          %a(href="http://www.polleverywhere.com/") Poll Everywhere
+      %p
+        This documentation was automatically generated by the
+        %a(href="https://rubygems.org/gems/polleverywhere/versions/#{PollEverywhere::VERSION}")==Poll Everywhere Ruby Gem v#{PollEverywhere::VERSION}
+        at
+        ==#{Time.now.utc}

data/api/views/stylesheets/site.css.sass

@@ -10,7 +10,7 @@ body
   width: 40em
   margin: auto auto
 
-code
+pre
   font-family: monaco, courier
   font-size: $code-font-size
   line-height: $base-font-size
@@ -19,10 +19,12 @@ code
   padding: 1em
   background: #eee
   margin: 1em 0
+  overflow: hidden
+  &:hover
+    overflow: visible
 
 h1,h2,h3,h4,h5,h6
   font-weight: normal
-
 h1
   font-size: 30px
 h2

data/lib/polleverywhere/haml.rb

@@ -0,0 +1,13 @@
+# Renders various formats of code for a given piece of Ruby API code.
+module Haml::Filters::Example
+  include Haml::Filters::Base
+
+  def render(text)
+    # TODO move this into a klass so that different formats are supported 'n' such
+    formats = {}
+    formats[:ruby] = text
+    eval(text, self.send(:binding)) # Run the ruby code so we can get at the curl formats, etc
+    formats[:curl] = PollEverywhere.config.http_adapter.last_requests.map(&:to_curl).join("\n\n")
+    formats.map{ |format, example| %(<pre class="#{format}">#{example}</pre>) }.join
+  end
+end

data/lib/polleverywhere/http/request_builder.rb

@@ -1,6 +1,3 @@
-require 'uri'
-require 'base64'
-
 module PollEverywhere
   module HTTP # :nodoc
     # DSL for building requests within our application that build a Request object and send them to 

data/lib/polleverywhere/version.rb

@@ -1,3 +1,3 @@
-module Polleverywhere
-  VERSION = "0.0.4"
+module PollEverywhere
+  VERSION = "0.0.5"
 end

data/lib/polleverywhere.rb

@@ -1,7 +1,6 @@
 module PollEverywhere
   autoload :Configuration,  'polleverywhere/configuration'
   autoload :HTTP,           'polleverywhere/http'
-  autoload :API,            'polleverywhere/api'
   autoload :CoreExt,        'polleverywhere/core_ext'
   autoload :Serializable,   'polleverywhere/serializable'
   autoload :Configurable,   'polleverywhere/configurable'

data/polleverywhere.gemspec

@@ -4,7 +4,7 @@ require "polleverywhere/version"
 
 Gem::Specification.new do |s|
   s.name        = "polleverywhere"
-  s.version     = Polleverywhere::VERSION
+  s.version     = PollEverywhere::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Brad Gessler, Steel Fu"]
   s.email       = ["opensource@polleverywhere.com"]

data/spec/spec_helper.rb

@@ -6,6 +6,4 @@ require 'polleverywhere'
 PollEverywhere.config do
   username      "test"
   password      "test"
-  url           "http://localhost:3000"
-  http_adapter  :sync
 end